User Tools

Site Tools


questionnaireheaderguide

Differences

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

Link to this comparison view

Next revision
Previous revision
questionnaireheaderguide [2025/03/10 09:29] – created gloriaquestionnaireheaderguide [2025/03/10 09:41] (current) gloria
Line 1: Line 1:
 ====== ✅ Steps to Fill in the QuestionnaireHeader Table (Complete Guide) ====== ====== ✅ Steps to Fill in the QuestionnaireHeader Table (Complete Guide) ======
  
-This guide provides a comprehensive step-by-step approach to correctly populate the **fw_questionnaireheader** table in the database.\ +This guide provides a comprehensive step-by-step approach to correctly populate the **fw_questionnaireheader** table in the database.   
-This table contains the core metadata and configuration settings for each questionnaire, defining how it behaves in both the **backend system** and the **survey interface**.\+This table contains the core metadata and configuration settings for each questionnaire, defining how it behaves in both the **backend system** and the **survey interface**.
  
-Each entry in this table represents a **unique questionnaire** with associated questions, start/end dates, configurations, and key control settings.\+Each entry in this table represents a **unique questionnaire** with associated questions, start/end dates, configurations, and key control settings.
  
-You can refer to the detailed structure of the **QuestionnaireHeader Table** here:\+You can refer to the detailed structure of the **QuestionnaireHeader Table** here:  
 → [[questionnaireheader|QuestionnaireHeader Table Structure]] → [[questionnaireheader|QuestionnaireHeader Table Structure]]
  
Line 12: Line 12:
  
 ==== 1. Add the ID (id) ==== ==== 1. Add the ID (id) ====
-This is the **primary key** (auto-incremented) for the table.\ +This is the **primary key** (auto-incremented) for the table.   
-**Do not manually enter** this value if inserting data directly via the database.\ +**Do not manually enter** this value if inserting data directly via the database.   
-It is automatically generated.\+It is automatically generated.
  
-**Example:**\+**Example:**  
 - Leave this field blank when inserting data. - Leave this field blank when inserting data.
  
Line 22: Line 22:
  
 ==== 2. Link to Module ID (moduleid) ==== ==== 2. Link to Module ID (moduleid) ====
-This field connects the questionnaire to a **specific module** in the **modulesettingoptions** table.\ +This field connects the questionnaire to a **specific module** in the **modulesettingoptions** table.   
-It determines which module the survey belongs to.\+It determines which module the survey belongs to.
  
-**Example:**\+**Example:**  
 - For KTO Customer Survey: moduleid = 1001 - For KTO Customer Survey: moduleid = 1001
  
Line 31: Line 31:
  
 ==== 3. Set the Start Date (startdate) ==== ==== 3. Set the Start Date (startdate) ====
-Defines when the survey becomes active.\ +Defines when the survey becomes active.   
-Enter the date in the format: **YYYY-MM-DD**.\+Enter the date in the format: **YYYY-MM-DD**.
  
-**Example:**\+**Example:**  
 - startdate = 2025-04-01 - startdate = 2025-04-01
  
Line 40: Line 40:
  
 ==== 4. Set the End Date (enddate) ==== ==== 4. Set the End Date (enddate) ====
-Defines when the survey expires.\ +Defines when the survey expires.   
-Ensure the end date is **after** the start date.\+Ensure the end date is **after** the start date.
  
-**Example:**\+**Example:**  
 - enddate = 2025-12-31 - enddate = 2025-12-31
  
Line 49: Line 49:
  
 ==== 5. Capture Last Question Detail ID (lastqdetailid) ==== ==== 5. Capture Last Question Detail ID (lastqdetailid) ====
-Tracks the **last question ID** the respondent answered.\ +Tracks the **last question ID** the respondent answered.   
-Leave this field blank if inserting manually — it is system-generated.\+Leave this field blank if inserting manually — it is system-generated.
  
-**Example:**\+**Example:**  
 - lastqdetailid = 34 - lastqdetailid = 34
  
Line 58: Line 58:
  
 ==== 6. Capture Last Option ID (lastoptionids) ==== ==== 6. Capture Last Option ID (lastoptionids) ====
-Tracks the **last option ID** the respondent selected.\ +Tracks the **last option ID** the respondent selected.   
-Leave this blank when inserting manually — it is system-generated.\+Leave this blank when inserting manually — it is system-generated.
  
-**Example:**\+**Example:**  
 - lastoptionids = 178 - lastoptionids = 178
 +
  
  
 ==== 7. Define Anonymous Options (anonymousoptions) ==== ==== 7. Define Anonymous Options (anonymousoptions) ====
-Lists option IDs that will be treated as **anonymous**.\ +Lists option IDs that will be treated as **anonymous**.   
-Separate multiple option IDs with a comma (,).\+Separate multiple option IDs with a comma (,).
  
-**Example:**\+**Example:**  
 - anonymousoptions = 123,124,125 - anonymousoptions = 123,124,125
 +
  
  
 ==== 8. Track Anonymous Invitation Count (anonymousinvcnt) ==== ==== 8. Track Anonymous Invitation Count (anonymousinvcnt) ====
-Keeps track of how many **anonymous invitations** were sent.\ +Keeps track of how many **anonymous invitations** were sent.   
-This count starts at **0**.\+This count starts at **0**.
  
-**Example:**\+**Example:**  
 - anonymousinvcnt = 0 - anonymousinvcnt = 0
  
Line 83: Line 85:
  
 ==== 9. Set Case Anonymous Options (caseanonymoptions) ==== ==== 9. Set Case Anonymous Options (caseanonymoptions) ====
-Specifies which **action lists** or **data sets** exclude identifiable respondent information.\ +Specifies which **action lists** or **data sets** exclude identifiable respondent information.   
-Provide option IDs separated by commas.+Provide option IDs separated by commas.
- +
  
  
  
 ==== 10. Set the Status (status) ==== ==== 10. Set the Status (status) ====
-Defines the current state of the survey.+Defines the current state of the survey.
- +
-**Allowed Values:**\ +
-- **1** = Active\ +
-- **0** = Inactive\ +
-- **2** = Archived\+
  
 +**Allowed Values:**  
 +- **1** = Active  
 +- **0** = Inactive  
 +- **2** = Archived  
  
  
  
 ==== 11. Exclude Filter Questions (filterquestions) ==== ==== 11. Exclude Filter Questions (filterquestions) ====
-Defines which questions should be excluded from the survey.\ +Defines which questions should be excluded from the survey.   
-Provide question IDs separated by commas.\+Provide question IDs separated by commas. 
 + 
 +**Example:**   
 +- filterquestions = 43,47
  
-**Example:**\ 
- filterquestions = 43,47 
  
  
 ==== 12. Set Number of Tiles per Page (nooftilesperpage) ==== ==== 12. Set Number of Tiles per Page (nooftilesperpage) ====
-Determines how many question tiles appear per page.\+Determines how many question tiles appear per page.
  
-**Example:**\ +**Example:**   
- nooftilesperpage = 9+nooftilesperpage = 9
  
  
  
 ==== 13. Set Number of Columns per Page (noofcolperpage) ==== ==== 13. Set Number of Columns per Page (noofcolperpage) ====
-Defines how many columns should appear per page.\+Defines how many columns should appear per page. 
 + 
 +**Example:**   
 +- noofcolperpage = 3
  
-**Example:**\ 
- noofcolperpage = 3 
  
  
 ==== 14. Define Opt-Out Options (optoutoptionids) ==== ==== 14. Define Opt-Out Options (optoutoptionids) ====
-Defines the option IDs that **terminate the survey** if selected.\ +Defines the option IDs that **terminate the survey** if selected.   
-Separate multiple option IDs with commas.\+Separate multiple option IDs with commas.
  
-**Example:**\ +**Example:**   
- optoutoptionids = 100,101+optoutoptionids = 100,101
  
  
  
 ==== 15. Set Language Conversion (languageconversion) ==== ==== 15. Set Language Conversion (languageconversion) ====
-Defines the primary language conversion for the survey.\ +Defines the primary language conversion for the survey.   
-This is useful for multi-language surveys.\+This is useful for multi-language surveys. 
  
  
 ==== 16. Set Branch Level Question Position (branchlevelqtnposition) ==== ==== 16. Set Branch Level Question Position (branchlevelqtnposition) ====
-Defines the display order and text description for branch-level questions. This is critical for surveys that have multiple sections with distinct question flows.+The `branchlevelqtnposition` field is used to:   
 +  * Group questions under section headers.   
 +  * Define the display order of branch-level questions.   
 +  * Create separate navigation menus per section.
  
-The field uses a complex structure separated by: +[[branchlevelquestionposition|click here to learn more in detail]]
  
-Comma (,to separate question IDs.+==== 17. Set Branch Level Menu ID (branchlevelqtnmenuid==== 
 +Stores the menu ID for branch-level questions.   
 +Identifies the section where the question will appear.
  
-^|||^ to separate sections.+**Example:**   
 +- 80,81,82,83,84^|||^Position1~^|^~Position2~^|^~Position3~^|^~Position4~^|^~Position5^|||^80,81,82,83,84
  
-^|^ to separate text labels within a section. 
-[[ click here to learn more in detail]] 
- 
-==== 17. Set Branch Level Menu ID (branchlevelqtnmenuid) ==== 
-Stores the menu ID for branch-level questions.Identifies the section where the question will appear. 
  
-Example: 
- 80,81,82,83,84^|||^Position1~^|^~Position2~^|^~Position3~^|^~Position4~^|^~Position5^|||^80,81,82,83,84 
  
 ==== 18. Set Maximum Tags (maxtags) ==== ==== 18. Set Maximum Tags (maxtags) ====
 Defines the maximum number of tags displayed in the tag cloud. Defines the maximum number of tags displayed in the tag cloud.
  
-Example:+**Example:**   
 +- maxtags = 50 
  
-maxtags = 50 
  
 ==== 19. Set Tag Frequency (tagfrequency) ==== ==== 19. Set Tag Frequency (tagfrequency) ====
 Defines how often a word must appear to qualify as a tag. Defines how often a word must appear to qualify as a tag.
  
-Example:+**Example:**   
 +- tagfrequency = 5 
  
-tagfrequency = 5 
  
 ==== 20. Count Tags Only Once (counttagonce) ==== ==== 20. Count Tags Only Once (counttagonce) ====
 Ensures each word from a respondent is counted only once in the tag cloud. Ensures each word from a respondent is counted only once in the tag cloud.
  
-Example:+**Example:**   
 +- counttagonce = 1 
  
-counttagonce = 1 
  
 ==== 21. Reference Question Detail ID (vraagreferenceqdetailid) ==== ==== 21. Reference Question Detail ID (vraagreferenceqdetailid) ====
-Links to a referenced question detail ID for tailor-made questions.This automatically updates dispcndtn and dispprms.+Links to a referenced question detail ID for tailor-made questions.   
 +This automatically updates dispcndtn and dispprms. 
 + 
 +**Example:**   
 +- vraagreferenceqdetailid = 234
  
-Example: 
  
-vraagreferenceqdetailid = 234 
  
 ==== 22. Set Emotion Question Detail IDs (emotionqdetailids) ==== ==== 22. Set Emotion Question Detail IDs (emotionqdetailids) ====
-Defines the question detail IDs linked to emotion-related questions.Separate by commas.+Defines the question detail IDs linked to emotion-related questions.   
 +Separate by commas. 
 + 
 +**Example:**   
 +- emotionqdetailids = 45,67,89
  
-Example: 
  
-emotionqdetailids = 45,67,89 
  
 ==== 23. Set Tile Empty Text (settileemptytxt) ==== ==== 23. Set Tile Empty Text (settileemptytxt) ====
 Allows default text to display if graph content is empty. Allows default text to display if graph content is empty.
  
-Example: 
  
-settileemptytxt = 1+ 
  
 ==== 24. Set Maximum Open Answers in Export (noofopenansinexport) ==== ==== 24. Set Maximum Open Answers in Export (noofopenansinexport) ====
 Defines the number of open-ended answers to include in the export. Defines the number of open-ended answers to include in the export.
  
-Example:+**Example:**   
 +- noofopenansinexport = 100 
  
-noofopenansinexport = 100 
  
 ==== 25. Set Emotion Library Type (emotionlibrarytype) ==== ==== 25. Set Emotion Library Type (emotionlibrarytype) ====
 Specifies the type of emotion library used. Specifies the type of emotion library used.
  
-Example: 
  
-emotionlibrarytype = Plutchik+
  
 ==== 26. Set Topic Library Type (topiclibrarytype) ==== ==== 26. Set Topic Library Type (topiclibrarytype) ====
 Defines the type of topic library. Defines the type of topic library.
  
-Example:+**Example:**   
 + topiclibrarytype = modules/ennatuurlijk 
  
-topiclibrarytype = General 
  
 ==== 27. Set Topic Library Version (topiclibraryversion) ==== ==== 27. Set Topic Library Version (topiclibraryversion) ====
 Stores the version of the topic library. Stores the version of the topic library.
  
-Example: +**Example:**   
- + topiclibraryversion = v1.0
-topiclibraryversion = 1.2.3+
  
  
  
 ==== ✅ Notes ==== ==== ✅ Notes ====
-  - Always verify that the **lastqdetaillid** and **lastoptionids** are correct when there are changes in the existing module.\ +  - Always verify that the **lastqdetaillid** and **lastoptionids** are correct when there are changes in the existing module.   
-  - Always verify that the **startdate** and **enddate** are valid.\+  - Always verify that the **startdate** and **enddate** are valid.  
   - For **opt-out options**, ensure those options terminate the survey if selected.   - For **opt-out options**, ensure those options terminate the survey if selected.
-  - +
  
questionnaireheaderguide.1741598942.txt.gz · Last modified: 2025/03/10 09:29 by gloria