User Tools

Site Tools


modulesettingsguide

This is an old revision of the document!


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.

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.

modulesettingsguide.1741675275.txt.gz ยท Last modified: 2025/03/11 06:41 by gloria