This is an old revision of the document!
Table of Contents
Steps to Fill in the ModuleSettings Table (Complete Guide)
This guide provides a step-by-step approach to correctly fill the ModuleSettings table. This table is used to configure the behavior, display, and functionality of each survey module.
The table is linked to the fw\_modules table via moduleid, allowing different survey modules to have their own configuration settings.
You can find the detailed structure of the ModuleSettings table here:
👉 Module Settings Table Structure
1. Add the ID (id)
The id column is the primary key and uniquely identifies each module setting record.
Input:
- Automatically generated (AUTO\_INCREMENT) - No manual entry is required.
Example:
| id |
| 1 |
✅ Notes:\ 💡 This field acts as the unique identifier for each module setting.
2. Link the Module (moduleid)
This field links the setting to a specific module in the fw\_modules table.
Input:
- Enter the id of the module from the fw\_modules table. - The moduleid must already exist in fw\_modules.
Example:
| moduleid |
|---|
| KTO-MKT-01 |
✅ Notes:\ 💡 Without this, the module will not recognize the settings.
3. Define the Module Type (moduletype)
This field defines whether the module is continuous or wave-based.
Input:
- `continuous` → Ongoing survey without time restriction. - `wave` → Survey conducted periodically.
Example:
| moduletype |
| ———- |
| continuous |
✅ Notes:\ 💡 If you select `wave`, make sure to configure wave schedules.
4. Set the Survey Display Type (surveydisplaytype)
Defines how the survey will appear to respondents.
Input:
- `singlepage` → All questions on one page. - `default` → One question per page.
Example:
| surveydisplaytype |
| default |
✅ Notes: 💡 `singlepage` can increase survey abandonment rates.
5. Set the Invitation Expiry Period (sendbeforedays)
Defines how long an invitation remains valid.
Input:
Integer value (number of days before an invitation is discarded).
Example:
| sendbeforedays |
| ————– |
| 30 |
✅ Notes: 💡 Set a reasonable expiry to avoid outdated feedback.
6. Configure Email Type (emailtype)
Controls the email layout.
Input:
`logoontop` → Logo at the top of the email.
`logoonside` → Logo on the side of the email.
Example:
| emailtype |
| logoontop |
✅ Notes:\ 💡 Choose a layout matching your brand guidelines.