Overview

A Questionnaire is a submittable form which allows information to be provided by online users to the web application. Questionnaires are a flexible way to create and present forms and collect user information.

Customer Self Service Questionnaires can be employed to collect non-standard information from users. Some common uses include:

  • Contact Us
  • Returns
  • Warranties
  • Quotes
  • Feedback 

This help page will outline the processes required to create a Questionnaire including creation of Questionnaire Questions, mapping to a Questionnaire Group and displaying it to the end user.


Questionnaire functionality is defined by 3 sections:

  1. Questionnaire Questions - Questions created here can be used by one or many questionnaires. read more
  2. Questionnaire Groups - Questionnaire Groups allow questionnaires to be set up utilising the questions contained in Questionnaire Questions. read more 
  3. Questionnaire Maintenance - Questionnaires using templates allow for common uses such as Contact Us, Returns, Warranties, Quotes, Feedback, etc. read more

Step-by-step guides

Questionnaire Questions

To Create a Questionnaire Question:

  1. Login as an Administrator.
  2. Navigate to 'Preferences' -->'Questionnaire Questions' (/questionmaintenance.aspx).
  3. Click 'New'
  4. Set the field values as follows:
    1. Question Code - A unique code that will easily identify this question for selection later on.
    2. Question Text - The question prompt which will be displayed to the user.
    3. Sequence - This determines the order in which the question appears in the maintenance screen. This will default to the next available sequence number, but can be overwritten. 
    4. Answer Format - From the drop-down list of available options, select the required format for responses to this question. 
    5. Length - The number of characters the field is to be restricted to (if applicable).
    6. Required - Tick this box if this question is to be mandatory.
    7. Help - Enter tooltip text here. This can be a further explanation or example; any information which might assist the user in completing the questionnaire.
    8. Hidden - Tick this box if the question should NOT appear on the questionnaire (used to render hidden HTML elements on a questionnaire page).
  5. Click 'OK' to save.

Good to Know

Questions created here can be used in multiple questionnaires.


To Modify a Question:

  1. Login as an Administrator.
  2. Navigate to 'Preferences' --> 'Questionnaire Questions' (/questionmaintenance.aspx).
  3. Select the required question via radio button.
  4. Click 'Modify'.
  5. Edit fields as required.
  6. Click 'OK' to save.


To Delete a Question:

  1. Login as an Administrator.
  2. Navigate to 'Preferences' --> 'Questionnaire Questions' (/questionmaintenance.aspx).
  3. Select the required question via radio button.
  4. Click 'Delete'.

    Warning

    Be sure you have selected the correct question to delete - there is no 'confirm' option.

Questionnaire Groups

To Create a Questionnaire Group:

  1. Login as an Administrator.
  2. Navigate to 'Preferences' --> 'Questionnaire Groups' (/questionnairemaintenance.aspx).
  3. Click 'New'. 
  4. Set the field values as follows:
    1. Questionnaire Code - A unique code to identify this questionnaire.
    2. Email Address - An internal email address to which questionnaire responses will be sent.
    3. Top Template - From the drop-down list, select the template to be shown at the top of the questionnaire. An example might be the "Conditions of Return" template for a Returns questionnaire.
    4. Bottom template - From the drop-down list, select the template to be shown at the bottom of the questionnaire.
    5. *Field to Validate - Nominates a question to be validated against a field within a table (refer 'Table to validate against' and 'Field to validate against', below). Select an available question from the drop-down list.
    6. *Field for users email address - Nominates a question to be used as the email address for the user. Select an available question from the drop-down list.
    7. *Table to validate against - This is the table to be used if a question was chosen under 'Field to Validate'. Select an available table from the drop-down list.
    8. *Field to validate against - This the field within the Table that the question is to be validated against. If a table is chosen, a drop-down list of available fields is provided to choose from.
    9. *Page to run on validation true - If validation is used, the page to be displayed on successful validation can be selected from the drop-down list.
    10. *Email to send on validation true - If validation is used, the email to be sent on successful validation can be selected from the drop-down list.
    11. *Page to run on validation false - If validation is used, the page to be displayed on validation fail can be selected from the drop-down list.
    12. *Email to send on validation false - If validation is used, the email to be sent on validation fail can be selected from the drop-down list.
    13. *Field to store validation result - If validation is used, the question field in which to store the validation result can be selected from the drop-down list.
    14. *Spam Validation - Tick this box to activate anti-spam emails by requiring the user who completes to enter a validation code.
    15. *Attachment Upload - Tick this box to allow the user to upload attachments to the questionnaire.
    16. *Completion message displayed to user - The message displayed to the user on submission of the questionnaire.
    17. *Use User Email As Sender Address - Tick this box if you want the "from" email address to be the notification email address of the user completing the questionnaire.
  5. Click 'OK' to save.

Good to Know

Fields can be added (and some removed) by modifying the 'Questionnaire Maintenance' Field Group. Fields added will appear before the hard coded fields. Hard coded fields are designated by '*' above.


To Add Questionnaire Questions:

  1. Login as an Administrator.
  2. Navigate to 'Preferences' --> 'Questionnaire Groups' (/questionnairemaintenance.aspx).
  3. Select the required Questionnaire via radio button.
  4. Click 'Questions'.
  5. Click 'New'.
  6. Select the required 'Question Code' from the drop-down list (these are the questions which were created under 'Questionnaire Questions' or /questionmaintenance.aspx).
  7. Enter a 'Field Sequence'. This will default to the next available sequence number, but can be overridden. (If the sequence entered has already been used, the new entry will replace the previous entry with all other subsequent sequences increased by one).
  8. Click 'OK' to save.
  9. Repeat steps 5 - 8 as required.
  10. When all required questions have been added, click 'Return to Main Page' to return to Questionnaire Maintenance.
  11. Refresh the dictionary to make the questions available in the questionnaire:
    1. Navigate to 'Settings' -->'Dictionary'
    2. Click 'Refresh Cache'.


To Modify a Questionnaire:

  1. Login as an Administrator.
  2. Navigate to 'Preferences' --> 'Questionnaire Groups' (/questionnairemaintenance.aspx).
  3. Select the required Questionnaire via radio button.
  4. Click 'Modify'.
  5. Edit values as required.
  6. Click 'OK' to save.

    TIp

    Questionnaire Questions attached to the Questionnaire can also be added to, modified (ie sequence changed) or deleted from this page by clicking 'Questions'. This will take you to the Questions screen where New, Modify and Delete options are available


To Delete a Questionnaire:

  1. Login as an Administrator.
  2. Navigate to 'Preferences' --> 'Questionnaire Groups' (/questionnairemaintenance.aspx).
  3. Select the required Questionnaire via radio button.
  4. Click 'Delete'.

    Warning

    Be sure you have selected the correct questionnaire to delete - there is no 'confirm' option.


Questionnaire Maintenance

Questionnaires using templates allow common uses such as Contact Us, Returns, Warranties, Quotes, Feedback, etc.

Tip

Questions set up here can be used in multiple questionnaires.

Questionnaires using Templates

The following code must be added to the template.

<input type="hidden" id="QuestionnaireCode" name="QuestionnaireCode" value="code" />
  • This new hidden field, if defined in page HTML, will indicate that the values in the form (prefixed with the value CVFormField_ in their name) will need to be saved to the table QuestionnaireResults
  • The value after CVFormField_ in the input name will indicate the field in the QuestionnaireResults table to save the user input into. eg. CVFormField_Age
  • If the field in the QuestionnaireResults table does not exist, the submission of the form will continue saving data for those fields that do exist and not storing the data for the missing fields. It will then send a CVNotify email to indicate which fields are missing from the QuestionnaireResults table
  • The value in the new hidden field will be what is recorded in the field Code in the table QuestionnaireResults.
  • The value in the EmailAddress field in the QuestionnaireResults table will be the EmailAddress of the current user in session (i.e. this could be a guest user).

Questionnaires Implementation

After questionnaires have been created, they must be made available to end users via links on the relevant pages or via menu items or page routes. Refer to:
Add a New Menu Item 
SEO Friendly URLs / Page Routes 
 

Tip

For menu items linked to questionnaires, the following need to be included in the set-up:
Page Name - Questionnaire.aspx
Parameter - questionnaire=[questionnairecode] where [questionnairecode] is the relevant questionnaire code. eg questionnaire=contactus


 Related help