An open API service indexing awesome lists of open source software.

https://github.com/simplicitesoftware/module-questionsandanswers

Q&A module
https://github.com/simplicitesoftware/module-questionsandanswers

Last synced: 4 months ago
JSON representation

Q&A module

Awesome Lists containing this project

README

          

![](https://docs.simplicite.io//logos/logo250.png)
* * *

`QuestionsAndAnswers` module definition
=======================================

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=simplicite-modules-QuestionsAndAnswers&metric=alert_status)](https://sonarcloud.io/dashboard?id=simplicite-modules-QuestionsAndAnswers)

### Introduction

This is a sample **Q&A** application (backend and frontend).

### Import

To import this module:

- Create a module named `QuestionsAndAnswers`
- Set the settings as:

```json
{
"type": "git",
"origin": {
"uri": "https://github.com/simplicitesoftware/module-qa.git"
}
}
```

- Click on the _Import module_ button

### Configure

In order to have the frontend working the password for the
webservices-only user `qa` must be `simplicite`.

This can be acheived by importing the following XML:

```xml

UserPwd
update

qa
simplicite

```

### Load data

Sample data is provided as a module's dataset.

Open this dataset and click on the _Apply_ button after having imported the module and made a full clear cache.

`QAQuestionAndAnswerHistoric` business object definition
--------------------------------------------------------

### Fields

| Name | Type | Required | Updatable | Personal | Description |
|--------------------------------------------------------------|------------------------------------------|----------|-----------|----------|----------------------------------------------------------------------------------|
| `row_ref_id` link to **`QAQuestionAndAnswer`** | id | yes* | | | Record row ID |
| `row_idx` | int(11) | yes* | yes | | History record index |
| `created_by_hist` | char(100) | yes* | | | Created by |
| `created_dt_hist` | datetime | yes* | | | Created date |
| `qaQaaQuestion` | html(1000000) | yes* | | | Question |
| `qaQaaAnswer` | html(1000000) | yes | yes | | Answer |

`QASection` business object definition
--------------------------------------

Section

### Fields

| Name | Type | Required | Updatable | Personal | Description |
|--------------------------------------------------------------|------------------------------------------|----------|-----------|----------|----------------------------------------------------------------------------------|
| `qaSecNumber` | char(20) | yes* | yes | | Section number |
| `qaSecParent` link to **`QASection`** | id | | yes | | Parent section |
| _Ref. `qaSecParent.qaSecNumber`_ | _char(20)_ | | | | _Section number_ |
| `qaSecTitle` | char(100) | yes | yes | | Section title |
| `qaSecDescription` | html(1000000) | | yes | | Description |

`QAQuestionAndAnswer` business object definition
------------------------------------------------

Question and answer

### Fields

| Name | Type | Required | Updatable | Personal | Description |
|--------------------------------------------------------------|------------------------------------------|----------|-----------|----------|----------------------------------------------------------------------------------|
| `qaQaaSection` link to **`QASection`** | id | yes* | | | Section |
| _Ref. `qaQaaSection.qaSecNumber`_ | _char(20)_ | | | | _Section number_ |
| `qaQaaKeywords` | multi(1000) using `QA_QAA_KEYWORDS` list | | | | Keywords |
| `qaQaaDate` | datetime | | | | Date |
| `qaQaaQuestion` | html(1000000) | yes* | | | Question |
| `qaQaaAnswer` | html(1000000) | yes | yes | | Answer |
| `qaQaaDocument` | document | | yes | | Document |
| `qaQaaURL` | url(255) | | yes | | URL |

### Lists

* `QA_QAA_KEYWORDS`
- `KEYWORD1` Keyword 1
- `KEYWORD2` Keyword 2
- `KEYWORD3` Keyword 3

`qa` external object definition
-------------------------------

Questions and answers frontend