Survey
The Survey module is the main entity of the three mentioned and contains all the information that can be useful for decision-making purposes. In this module, all fields related to email sending cannot be changed because the notification email can only be sent upon survey creation.
Below is the list of available fields and their meaning for the Survey module:
| Field | Description |
|---|---|
| Template | Text field auto-populated with the survey template related to this survey. |
| Name | The text field used to name the survey. This field can be selected in the dashboard model to verify the survey results. It will be inherited from the survey template and can be changed. |
| Model Alias | A survey can be related to another model which can trigger the survey creation. It can be changed. |
| Model Id | The ID of the model related to the survey. It can be changed. |
| Intro Notes | Displayed at the beginning of the survey before all the questions. Inherited from the survey template and can be changed. |
| Final Notes | Displayed at the end of the survey after all the questions. Inherited from the template and can be changed. |
| Description | Internal description field for the surveys. Inherited from the template and can be changed. |
| Is Anonymous | If set to Yes, permits anonymous answers by recipients. Inherited from the template and cannot be changed. |
| Show Submit in All Pages | If set to Yes, shows the "Submit" button on all survey pages if provided. Inherited from the template and cannot be changed. |
| Expires in Days | Numerical field that sets a time of expiration for the survey. The count starts from the moment the survey is created. Once the survey expires, the main status will be changed automatically to "Expired" and the flag "Is Expired" will be set to Yes. Inherited from the template and can be changed. |
| Expires in Hours | Numerical field that sets a time of expiration for the survey. The count starts from the moment the survey is created. Once expired, the status changes automatically to "Expired" and the "Is Expired" flag is set to Yes. Inherited from the template and can be changed. |
| Expires in Minutes | Numerical field that sets a time of expiration for the survey. The count starts from the moment the survey is created. Once expired, the status changes automatically to "Expired" and the "Is Expired" flag is set to Yes. Inherited from the template and can be changed. |
| Is Expired | If set to Yes, indicates that the survey has expired. |
| Frontend Visibility | Enables the surveys for the User Portal (portal for unregistered users). Inherited from the template and cannot be changed. |
| Send Email | If set to Yes, sends a mail on survey creation. Inherited from the template and cannot be changed. |
| Groups | Multiselect field where you can choose the groups who should have visibility on this survey. Creation: Upon survey creation, used to send an email to all users in the specified group (assuming all other email fields are correctly configured). Creation/Edit: You can modify this field to enable or disable the visibility of the survey for a specific group. It is also used to allow using the survey as a filter in the "Charts" tab within the dashboard module. Inherited from the template and can be changed. |
| Users | Multiselect field where you can choose the users who should have visibility on the created survey. Creation: Upon survey creation, used to send an email to all selected users (assuming all other email fields are correctly configured). Creation/Edit: You can modify this field to enable or disable the visibility of the survey for a specific user. It is also used to allow using the survey as a filter in the "Charts" tab within the dashboard module. Inherited from the template and can be changed. |
| Send Emails | If set to Yes, permits email sending on survey creation. Note: All other email fields should be configured to allow sending mail. |
| Mailbox | Field where you can choose a specific mailbox to use for sending emails. Inherited from the template and cannot be changed. |
| Use Template | If set to "ON", enables "Email Template ID" to be used for email sending on survey creation. Inherited from the template and cannot be changed. |
| Email Template Id | Field where you can select a preconfigured email template for emails sent on survey creation. Inherited from the template and cannot be changed. |
| Subject | Displayed only if the "Use Template" field is set to "OFF". Used to set a subject for the email sent on survey creation. You can use the variables "users" and "survey" to create a dynamic template. Example: to get the survey ID you can use: {{var survey.getId()}}. Inherited from the template and cannot be changed. |
| Email HTML Body | Displayed only if the "Use Template" field is set to "OFF". Used to set a mail body for the email sent on survey creation. You can use the variables "users" and "survey" to create a dynamic template. Example: to get the survey ID you can use: {{var survey.getId()}}. Inherited from the template and cannot be changed. |
| Status | Enables or disables a survey. Inherited from the template and can be changed. |
| Results | A relation grid that shows all the survey results in progress or completed. You can also directly add a Result by clicking the "Add Result" button. |
| Emails | A relation grid for all the emails that have been sent for this survey to users and groups on survey creation. |
Here are the Results and Email grids related to the survey:
Manual Usage
By clicking the Add Result button on the Results relation grid, you can add a new result for a survey and relate it to a specific user.
No email will be sent to recipients when adding a result manually. The email for the survey is only sent upon survey creation.
The available fields are the following:
| Field | Description |
|---|---|
| Template Id | Auto-populated field with the ID of the survey template related to this survey. |
| Survey | Auto-populated field with the related survey name. |
| Username | A select field with all users, where you can choose the user who will fill out the survey. |
| Company Id | Auto-populated field with the company of the selected user. |
| Status | Select field with the status of the result (values: In progress, Completed, Expired). To permit filling out the survey, its status should be "In progress". |
After the result creation, an Operator can fill out the survey by clicking the Fill Out button at the end of the Result record:
Result creation and survey filling from the main survey module are exclusive prerogatives of Deepser internal users.
Default Usage
Generally, the survey module relies on the User Portal, as it allows for the completion of survey questions.
Normally, within the email sent during the survey creation phase, a direct link to the portal is included, enabling access to the survey. Upon accessing the survey, a Result record is automatically created and associated with the respective survey.
Additionally, you can access the survey management section directly from the User Portal menu:
In the User Portal, the grids related to surveys exclusively display records of type "Result". To view a new survey, users must go through the email sent during the survey creation phase. By clicking on the survey link in the email, the Result record will be created and can then be viewed in the grid.
From the Deepser Backend, a user can edit, change, or add a new visualization grid for the survey module in the User Portal by navigating to System > Portal > Survey.