User Tools

Site Tools


modulesettingsguide

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
modulesettingsguide [2025/03/11 11:22] – [21. Add the Reset Half Year Check Module IDs (resethalfyearcheckmoduleids)] gloriamodulesettingsguide [2025/03/11 11:38] (current) – [33. Add the Score Higher Than Value (scorehigherthanvalue)] gloria
Line 232: Line 232:
   * Enter **1** to ignore the reset condition and allow inserting the invitation.   * Enter **1** to ignore the reset condition and allow inserting the invitation.
   * Enter **0** to strictly follow the reset condition.\\   * Enter **0** to strictly follow the reset condition.\\
- 
- Example: 
-^ignoreresethalfyear^ 
-|1| → Insert the invitation but don't send the email.   
-|0| → Prevent invitation insertion if the reset condition is met.   
  
  
Line 247: Line 242:
   * **0** → Only check invitation date regardless of participation.\\   * **0** → Only check invitation date regardless of participation.\\
  
- Example: 
-^considerparticipatedinvitationsforresethalfyear^ 
-|1| → Prevent new invitations if the respondent already participated within 6 months.   
-|0| → Only check the invitation date regardless of participation.   
  
  
Line 263: Line 254:
  
 ==== 25. Add the Response Overview Field (responseoverviewfield) ==== ==== 25. Add the Response Overview Field (responseoverviewfield) ====
-The responseoverviewfield stores the ID of the field (from either fw_invitationfields or fw_orgstructuremaster) that will be used to split the data in the response overview report. +The responseoverviewfield stores the ID of the field (from either fw_invitationfields or fw_orgstructuremaster) that will be used to split the data in the response overview report.\\ 
-\\ How to Fill This Field +How to Fill This Field: 
- Go to the fw_invitationfields table and find the field ID of the column you want to split data by. +  Go to the fw_invitationfields table and find the field ID of the column you want to split data by.\\ 
- Enter that ID here. +  Enter that ID here. 
- Example +Example:\\ 
-If you want to split data based on department, and its field ID is 12+If you want to split data based on department, and its field ID is 12, enter 12
-12+
  
 ==== 26. Add the Response Page Type (responsepagetype) ==== ==== 26. Add the Response Page Type (responsepagetype) ====
 The responsepagetype determines which type of response overview page should be displayed in the report. The responsepagetype determines which type of response overview page should be displayed in the report.
-Performitor type → Provides detailed response breakdown. + 
- Reportal type → Provides a summarized response with minimal details. +  * Performitor type → Provides detailed response breakdown. 
-\\ How to Fill This Field +  Reportal type → Provides a summarized response with minimal details. 
- • If you want a detailed response, enter: Performitor 
 +
- • If you want a simplified response, enter: Reportal +
-+
  
 ==== 27. Add the Redirect Delay (redirectdelay) ==== ==== 27. Add the Redirect Delay (redirectdelay) ====
 The redirectdelay sets the delay (in seconds) before redirecting the respondent to the end page URL after completing the survey. The redirectdelay sets the delay (in seconds) before redirecting the respondent to the end page URL after completing the survey.
-\\ How to Fill This Field +\\ How to Fill This Field: 
- Enter the delay time in seconds. + 
- If you want to redirect immediately, enter 0.+  * Enter the delay time in seconds. 
 +  If you want to redirect immediately, enter 0. 
  Example  Example
-Value +^Value^Result^ 
-Result +|5|Redirect after 5 seconds.| 
-5 +|0|Redirect immediately.|
-Redirect after 5 seconds. +
-0 +
-Redirect immediately.+
  
 ==== 28. Add the End Page URL (endpageurl) ==== ==== 28. Add the End Page URL (endpageurl) ====
 The endpageurl defines the URL to which the respondent will be redirected after completing the survey. The endpageurl defines the URL to which the respondent will be redirected after completing the survey.
- \\How to Fill This Field + \\How to Fill This Field: 
- Enter the full URL with http or https. + 
- Ensure the URL is live and accessible.+  * Enter the full URL with http or https. 
 +  Ensure the URL is live and accessible. 
  Example  Example
 https://www.perfformitor.com/thank-you https://www.perfformitor.com/thank-you
Line 311: Line 300:
 ==== 30. Add the No Invitation Fields (noinvfields) ==== ==== 30. Add the No Invitation Fields (noinvfields) ====
 The noinvfields determines if fields are mandatory for setting up invitations. The noinvfields determines if fields are mandatory for setting up invitations.
-Value + 
-Result + 
-1 +**1**→Fields are mandatory.\\ 
-Fields are mandatory. +**0**→No fields required.
-0 +
-No fields required.+
  
 ==== 31. Add the Invitation Upload Fields (invuploadfields) ==== ==== 31. Add the Invitation Upload Fields (invuploadfields) ====
-The invuploadfields field is used to define which fields are allowed when uploading invitations through Excel or CSV files. These fields usually correspond to the columns present in the fw_invitationfields table or any custom fields required for survey invitations. +The invuploadfields field is used to define which fields are allowed when uploading invitations through Excel or CSV files. These fields usually correspond to the columns present in the fw_invitationfields table or any custom fields required for survey invitations.\\ 
-✅ How to Fill This Field +How to Fill This Field
- List the allowed fields (column names from fw_invitationfields) separated by a comma (,). + 
- If you want all fields to be uploaded, enter ALL. +  List the allowed fields (column names from fw_invitationfields) separated by a comma (,). 
-✅ Example +  If you want all fields to be uploaded, enter ALL. 
-Suppose your invitation file contains fields like Email, Patient ID, and Consultation Date: + 
-email,patient_id,consultation_date +Example: 
-If you want to allow all fields: +  Suppose your invitation file contains fields like Email, Patient ID, and Consultation Date : email, patient_id, consultation_date 
-ALL+  If you want to allow all fields:ALL
  
 ==== 32. Add the Survey Feedback Score Field ID (surveyfeedbackscorefieldid) ==== ==== 32. Add the Survey Feedback Score Field ID (surveyfeedbackscorefieldid) ====
-The surveyfeedbackscorefieldid field defines the ID of the field that contains the feedback score from the respondent (e.g., NPS Score, Satisfaction Score). This is useful for generating statistical reports based on feedback scores. +The surveyfeedbackscorefieldid field defines the ID of the field that contains the feedback score from the respondent (e.g., NPS Score, Satisfaction Score).\\ 
-✅ How to Fill This Field + 
- Go to the fw_invitationfields table and find the Field ID for the feedback score field. +How to Fill This Field: 
- Enter that Field ID here. +  Go to the fw_invitationfields table and find the Field ID for the feedback score field. 
-✅ Example+  Enter that Field ID here. 
 + 
 +Example
 Suppose the feedback score column has an ID of 23: Suppose the feedback score column has an ID of 23:
 23 23
  
 ==== 33. Add the Score Higher Than Value (scorehigherthanvalue) ==== ==== 33. Add the Score Higher Than Value (scorehigherthanvalue) ====
-The scorehigherthanvalue field allows you to filter responses where the feedback score is higher than a specific value. This is typically used in Net Promoter Score (NPS) or similar metrics. +The scorehigherthanvalue field allows you to filter responses where the feedback score is higher than a specific value. This is typically used in Net Promoter Score (NPS) or similar metrics.\\ 
-✅ How to Fill This Field + 
- Enter the minimum score that should be considered for filtering. +How to Fill This Field 
- This value works only when the surveyfeedbackscorefieldid is set. +  Enter the minimum score that should be considered for filtering. 
-✅ Example+  This value works only when the surveyfeedbackscorefieldid is set. 
 + 
 +Example
 If you only want to show feedback where the score is above 8: If you only want to show feedback where the score is above 8:
-8+8\\ 
 💡 This is commonly used in Promoter/Detractor score calculation. 💡 This is commonly used in Promoter/Detractor score calculation.
  
modulesettingsguide.1741692163.txt.gz · Last modified: 2025/03/11 11:22 by gloria