Differences

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

--- module_setup [2025/03/07 06:20] – gloria
+++ module_setup [2025/03/10 10:54] (current) – gloria
@@ Line 1: / Line 1: @@
-===== Setting Up a Questionnaire =====
+====== Module Setup - Step-by-Step Guide ======
-This guide explains how to set up a questionnaire in the system.
-====== 📌 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**.
-All **52 tables start empty**. This guide explains how to fill them **in the correct order** to set up a **questionnaire, module, invitations, and settings**.
-----
 ===== 1️⃣ Initial Setup – Start with Empty Tables =====
@@ Line 13: / Line 9: @@
   * **No pre-existing questionnaires, modules, or invitations exist**
-----
+===== 2️⃣ Setting Up the Questionnaire =====
-===== 2️⃣ Step 1: Setting Up the Questionnaire =====
 The **questionnaire is the core** of the module setup. Start by populating the **questionnaire-related tables**.
-==== 🔹 Tables to Fill First (Sidebar → Questionnaire Section) ====
+[[click here to see how a questionnaire is setup in detail]]
-^ **Table Name**                ^ **Purpose** |
-| `questionnairedetails`       | Stores basic questionnaire details (name, type, etc.). |
-| `questionnairedetailslang`   | Stores multilingual versions of questionnaire details. |
-| `questionoptions`            | Stores possible responses for each question. |
-| `questionoptionslang`        | Multilingual labels for response options. |
-| `replacementvariables`       | Stores dynamic content for personalized questions. |
-==== 🛠 How to Fill These Tables? ====
+===== 3️⃣ Configure Modules =====
-  - **Create a questionnaire entry** in `questionnairedetails`.
-  - **Add questions** to `questionoptions`.
-  - **Link response options** using `questionoptionslang`.
-  - **Use replacement variables** to personalize content dynamically.
-----
-===== 3️⃣ Step 2: Configure Modules =====
 Once the questionnaire is set up, link it to a **module**.
-==== 🔹 Tables to Fill Next (Sidebar → Modules Section) ====
+[[click here to see how a module is configured in detail]]
-^ **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? ====
+===== 4️⃣  Configure Invitations =====
-  - **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) ====
+[[click here to see how invitations are setup]]
-^ **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** |
+✅ Final Check: Ensuring Everything Works**
-| `fw_invemailsettings`     | Stores email templates for invitations. |
+Before launching, **perform a final check**: \\
-| `fw_invremindersettings`  | Defines reminder settings for follow-ups. |
+✔ **Check if the questionnaire, dashboard appears correctly** in the frontend.\\
+✔ **Verify that module settings are applied correctly**.\\
-==== 🛠 How to Fill These Tables? ====
+✔ **Test sending invitations** to confirm email configuration.\\
-  - **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:
-{{youtube>your_video_id}}
-or
-{{:videos/module_setup.mp4|Watch: Module Setup Guide}}
-----
 ===== 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**
-----