Differences

This shows you the differences between two versions of the page.

--- questionnairedetailslangguide [2025/03/10 07:47] – gloria
+++ questionnairedetailslangguide [2025/03/10 08:57] (current) – gloria
@@ Line 1: / Line 1: @@
-====== Steps to Fill in the Clients Table (Complete Guide) ======
-This guide provides a step-by-step approach to correctly fill the **Clients** table. This table stores essential information about each client in the system, including client names, logos, invitation settings, and activation status.
+====== Steps to Fill in the QuestionnaireDetailsLang Table (Complete Guide) ======
-The table is critical for maintaining **multi-client environments**, where each client may have different configurations, logos, and invitation controls.
+This guide provides a step-by-step approach to correctly fill the **QuestionnaireDetailsLang** table. This table is used to store **language-specific text** for each question in the survey. It supports multi-language surveys, allowing the same question to appear in **multiple languages** with corresponding text, labels, and media files.
+The table is linked to the **QuestionnaireDetails** table via **qdetailid**, meaning each question from [[questionnairedetails|QuestionnaireDetails]] has a corresponding language text entry in **fw_questiondetailslang**.
+You can find the detailed structure of the **QuestionnaireDetailsLang** table here:
+👉 [[questionnairedetailslang|QuestionnaireDetailsLang Table Structure]]
-👉 [[fw_clients|Clients Table Structure]]
@@ Line 15: / Line 18: @@
-==== 2. Enter the Client Name (clientname) ====
+==== 2. Link Question to Details (qdetailid) ====
-This column captures the **full name of the client**. This name will appear in:
+**qdetailid** refers to the ID of the question from the **QuestionnaireDetails** table.\\
-  - Email invitations
+This creates a link between the **question text** and the **question details**.\\
-  - Web platforms
+Without this linkage, the text will not appear in the survey.
-  - App interfaces (if applicable)
 **Example:**
-clientname = "People Pulse"
+Suppose your question in **QuestionnaireDetails** has:
+**id = 1001** (This is the question ID in **fw_questiondetails**)\\
+**majorqid = 1**, **minorqid = 0**
+You need to link the text to this question using:
+qdetailid = 1001
-==== 3. Set the Client Type (type) ====
-The **type** column defines the vertical or category of the client. This helps in segmenting and categorizing clients.
-Common examples of **type**:
+==== 3. Set the Language (language) ====
- KTO → Referrer Feedback
+This column specifies the **language** in which the question text appears.\\
+Use standard **language codes** like:
+  - **EN** → English
+  - **NL** → Dutch
+  - **DE** → German
+  - **FR** → French
+**Example:**
+For an English version of the question:
+language = EN
-==== 4. Control Invitation Settings (stopinvitations) ====
+For a Dutch version of the same question:
-This column controls whether the client can receive email invitations.\\
+language = NL
-Use the following values:
-| **Value** | **Meaning**                |
-|-----------|--------------------------|
-| **0**     | Send Invitations           |
-| **1**     | Stop Invitations           |
+==== 4. Add the Question Text (question) ====
+This column holds the **actual text of the question** in the specified language.\\
-==== 5. Upload the Client Logo (clientlogo) ====
+**Example:**
+For an English version:
+question = "How satisfied are you with our service?"
-**Logo Requirements:**
+For a Dutch version:
-- **Size:** 120x32 pixels
+question = "Hoe tevreden bent u met onze service?"
-- **Format:** PNG, JPG
-**File Upload Location:**
-clientlogo = Upload File (Binary Data/BLOB)
+==== 5. Set the Client Sheet Question Text (clientsheetqtext) ====
+This text appears specifically on the **Client Sheet (CS)** report.\\
+It is usually a shorter version of the **full question text** for reporting purposes.
-==== 6. Upload the Client Left Logo (clientleftlogo) ====
+**Example:**
-The **clientleftlogo** is visible on the **left side of the web portal interface**.\\
+For the full question:
+question = "How satisfied are you with our service?"
-**Logo Requirements:**
+For the client sheet:
-- **Size:** 165x60 pixels
+clientsheetqtext = "Service satisfaction"
-- **Format:** PNG, JPG
-**File Upload Location:**
-clientleftlogo = Upload File (Binary Data/BLOB)
+==== 6. Set the Download Question Text (downloadqtext) ====
+This text will appear in the **Excel/CSV export** of the survey data.\\
+It should be a simplified version of the question text to fit within the download file.
-==== 7. Upload the Invitation Header Logo (invitationheader) ====
+**Example:**
-The **invitationheader** appears specifically in email invitations **if it differs from the main client logo**.\\
+For the full question:
-If no logo is uploaded, the **clientlogo** will be used.
+question = "How satisfied are you with our service?"
-**Logo Requirements:**
+For download purposes:
-- **Same size as clientlogo (120x32 pixels)** or
+downloadqtext = "Service Satisfaction Rating"
-- **Custom size based on client preference**
-**File Upload Location:**
-invitationheader = Upload File (Binary Data/BLOB)
+==== 7. Set the Import Question Text (importqtext) ====
+This text will appear if the survey data is being **imported** (bulk response data).\\
+It should clearly reflect the **question context** for easy data mapping.
-==== 8. Upload the App Client Logo (appclientlogo) ====
+**Example:**
-This logo appears in **mobile applications** if the survey is accessible through an app.\\
+For an NPS:
+importqtext = "NPS Score"
-**Logo Requirements:**
+For service satisfaction:
-- **Size:** 299x126 pixels
+importqtext = "Service Satisfaction Level"
-- **Format:** PNG, JPG
-**File Upload Location:**
-appclientlogo = Upload File (Binary Data/BLOB)
+==== 8. Set the Report Question Text (reportqtext) ====
+The **reportqtext** is used in drill-down reports to generate a natural language summary of the respondent's answer instead of showing the raw question text.\\
+The placeholder //^answerQ^// should be used in the text to indicate where the respondent's answer will be inserted.\\
+This helps make the report easier to read and more conversational when reviewing answers.
+**Example:**
+If the response was:
+Answer: **8/10**
+The report will display:
+**The respondent rated us 8 out of 10.**
+Here is a reference table for the **reportqtext**:
+^ **Question Type**      ^ **Actual Question in Survey**                                        ^ **Suggested Report Text (reportqtext)**                                              ^
+| **NPS**                | How likely are you to recommend us to a friend?                      | The respondent rated us //^answerQ^// out of 10.                                      |
+| **Satisfaction**       | How satisfied were you with our service?                             | The customer satisfaction rating was: //^answerQ^//.                                 |
+| **Open Text**          | What can we do to improve our service?                               | The customer suggested: //^answerQ^//.                                                |
+| **Multiple Choice**    | Which service did you use?                                           | The customer used: //^answerQ^//.                                                     |
+| **Yes/No**             | Did the doctor listen to your concerns?                              | The customer answered: //^answerQ^//.                                                 |
+==== 9. Set the App Question Text (appqtext) ====
+This text appears in the **mobile app case details screen** if the survey is accessible via an app.\\
+**Example:**
+For service satisfaction:
+appqtext = "Satisfaction"
+For NPS:
+appqtext = "NPS Score"
+==== 10. Set the Client Sheet Category (cscategory) ====
+This defines the **category** in which the question falls in the Client Sheet.\\
+Common categories include:
+  - Service Quality
+  - Product Quality
+  - Customer Satisfaction
+  - Recommendation
+**Example:**
+For Service Satisfaction:
+cscategory = "Service Quality"
+For NPS:
+cscategory = "Recommendation"
+==== 11. Add Basis Text (basistext) ====
+The **basis text** is shown in the **Voorbeeld Vragenlijst** (Example Questionnaire).\\
+It explains why this question is being asked.
+**Example:**
+basistext = "This question is asked when variable client is Swiesktly."
+For NPS:
+basistext = "This question is asked when the respondent is a promoter."
+==== 12. Set Added From Module Language Settings (addedfrommodlangsettings) ====
+This is a **technical flag** to indicate if the text was auto-generated from module settings.\\
+Use:
+**1** → Yes, text was added from module language settings
+**0** → No, manually added text
+**Example:**
+If you manually entered the text:
+addedfrommodlangsettings = 0
-==== 9. Set the Client Status (status) ====
+==== 13. Upload Audio File (audiofile) (optional) ====
-This column determines whether the client is **active** or **inactive** in the system.\\
+This is an optional column where you can upload an **audio recording of the question**.\\
-Use the following values:
+The file should be uploaded as a **BLOB (binary large object)**.\\
+Supported formats:
+- MP3
+- WAV
-| **Value** | **Status**          |
-|-----------|-------------------|
-| **1**     | Active             |
-| **0**     | Inactive           |
+==== 14. Upload Video File (videofile) (optional) ====
+This is an optional column where you can upload a **video file related to the question**.\\
+The file should be uploaded as a **BLOB**.\\
+Supported formats:
+- MP4
+- MOV
-==== 10. Example: Final Record ====
-Here’s an example of a complete record for a single client:
-| id | clientname   | type | stopinvitations | clientlogo | clientleftlogo | invitationheader | appclientlogo | status |
-|----|-------------|------|-----------------|------------|----------------|-----------------|---------------|--------|
-| 1  | People Pulse | KTO  | 0               | [BLOB]     | [BLOB]         | [BLOB]          | [BLOB]        | 1      |
+====  Example: Final Record ====
+Here’s an example of a complete record for a single question:
+| id | qdetailid | language | question                                | clientsheetqtext  | downloadqtext | importqtext     | reportqtext                     | appqtext | cscategory       | basistext                     | addedfrommodlangsettings | audiofile | videofile |
+| 1  | 1001      | EN      | How satisfied are you with our service?  | Service Satisfaction | Service Rating | Satisfaction Level | The respondent rated us //^answerQ^//. | Satisfaction | Service Quality | Understand customer satisfaction |                        |       |       |
 ==== ✅ Notes ====
-  -  Always use **high-quality logos** to ensure professional branding..
+ Always ensure the **qdetailid** matches the ID from [[questionnairedetails|QuestionnaireDetails]].\\
-  -  If you do not want email invitations, set **stopinvitations = 1**.
+ The **reportqtext** should always use //^answerQ^// to dynamically insert the response.
-  -  Avoid uploading large-sized images; adhere to the dimensions specified.
+💡 **In most cases:**  \\
+  -     The **question** text and **reportqtext** are usually identical.
+  -    The **clientsheetqtext**, **downloadqtext**, **importqtext**, and **appqtext** often have the **same text** unless there's a specific reason to differentiate them.