This is an old revision of the document!
Table of Contents
Module Setup - Step-by-Step Guide
All 52 tables start empty. This guide explains how to fill them in the correct order to set up a questionnaire, module, invitations,dashboard and settings.
1️⃣ Initial Setup – Start with Empty Tables
Before setting up a module, ensure that:
- All related tables are empty
- No pre-existing questionnaires, modules, or invitations exist
2️⃣ Setting Up the Questionnaire
The questionnaire is the core of the module setup. Start by populating the questionnaire-related tables.
3️⃣ Configure Modules
Once the questionnaire is set up, link it to a module.
🔹 Tables to Fill Next (Sidebar → Modules Section)
| Table Name | Purpose |
|---|---|
| `modules` | Defines the module and links it to a questionnaire. |
| `questionnaireheader` | Stores header settings for the questionnaire. |
| `modulesettings` | Stores module-wide settings. |
| `modulesettingoptions` | Stores available settings/options for modules. |
| `modulelangsettings` | Multilingual labels for modules. |
| `clientbranchmodulesettings` | Links modules to clients and their branches. |
🛠 How to Fill These Tables?
- Create a module entry in `modules`.
- Link the questionnaire using `questionnaireheader`.
- Set module-wide configurations in `modulesettings`.
- Specify available options using `modulesettingoptions`.
- Ensure multilingual support via `modulelangsettings`.
- Assign the module to clients using `clientbranchmodulesettings`.
4️⃣ Step 3: Configure Invitations
To allow respondents to access the questionnaire, invitations need to be set up.
🔹 Tables to Fill Next (Sidebar → Invitations Section)
| Table Name | Purpose |
|---|---|
| `invitations` | Stores invitation details (who is invited). |
| `invitationfields` | Defines fields used in invitation emails. |
| `invitationfieldtypevalues` | Stores predefined values for invitation fields. |
🔹 Tables to Fill Next (Sidebar → Invitation Settings Section)
| Table Name | Purpose |
|---|---|
| `fw_invemailsettings` | Stores email templates for invitations. |
| `fw_invremindersettings` | Defines reminder settings for follow-ups. |
🛠 How to Fill These Tables?
- Create an invitation entry in `invitations`.
- Define email fields in `invitationfields`.
- Store pre-defined values in `invitationfieldtypevalues`.
- Set up email content in `fw_invemailsettings`.
- Configure reminder settings in `fw_invremindersettings`.
5️⃣ Step 4: Assigning Modules to Clients & Branches
After setting up the questionnaire and invitations, the module must be assigned to the correct clients and branches.
🔹 Tables to Fill Next (Sidebar → Clients & Branches Section)
| Table Name | Purpose |
|---|---|
| `fw_clients` | Stores client details. |
| `fw_branches` | Stores branch details for each client. |
| `fw_branchquestions` | Defines which questions apply to each branch. |
🛠 How to Fill These Tables?
- Create client entries in `fw_clients`.
- Add branches under each client in `fw_branches`.
- Define branch-specific questionnaire rules in `fw_branchquestions`.
✅ Final Check: Ensuring Everything Works
Before launching, perform a final check: ✔ Check if the questionnaire appears correctly in the frontend. ✔ Verify that module settings are applied correctly. ✔ Test sending invitations to confirm email configuration. ✔ Ensure that clients and branches are properly linked.
💡 Additional Notes
- 📌 If the questionnaire does not appear, check if it is linked in `modules`.
- 📌 If emails are not sent, verify `fw_invemailsettings`.
- 📌 If a module is not assigned, ensure `clientbranchmodulesettings` is filled correctly.
📺 Video Tutorials (Optional)
For a visual walkthrough, watch these tutorials:
your_video_id
or
Dummy Survey for Module Setup
This survey is used to demonstrate module configuration in a step-by-step manner.
📌 Click here for the full guide(dummy_survey_setup)
🚀 Summary of the Process
- 1️⃣ Start with empty tables
- 2️⃣ Set up the questionnaire (Questionnaire tables)
- 3️⃣ Configure the module (Module tables)
- 4️⃣ Set up invitations & email settings
- 5️⃣ Assign modules to clients & branches
- 6️⃣ Test and validate the setup