If you are still using the Legacy version of the software (that is you haven't upgraded to Release 2020) then the documentation here applies. 

1. Assessment Name.  The free format name for the assessment
2. Assessment Description. The Description is used in the Respondent Portal and the Available Assessments List, to give a longer description of what the assessment provides.  Assessments only appear in the respondent portal or the Available Assessments List if you have them specified in the Assessment Availability table (Read more about Assessment Availability)
3. Version. While you can name the version how you wish; we recommend it should be an incrementing number. When creating a response the system will default to the latest version (highest number).  You can copy an assessment to make a new version.  Once you are using the assessment live to gather responses, it is best practice to make a new version when making substantial changes in the assessment so that responses match the assessment.  If you are making small changes (maybe just adding one question) you can update the same version.
4. External ID. The External ID is used on a URL when there is an “Auto Create Response.” The system will automatically create a response when a user enters the system using a URL with this code.  The Is Auto-Create Response indicator must also be on (detailed below).   External ID's must not contain blanks or special characters other than - or _ (More details on linking to assessments from your website or email)
5. Language. The Language field is only completed if multilingual assessments are in use.  Select the language for this assessment.
6. Default Days To Completion. If you want to specify a requested completion date, specify the number of days after the assessment date that you would like that.
   • The next three fields only appears if Certification is enabled in the Settings Screen.
7. Days to Resit if Not Certified.   If the assessment is a certification and the certification is not passed this is the number of days before an email will be automatically sent to re-sit the assessment (providing the template exists). The indication of whether the certification is passed is the Certified Checkbox on the Rating record (Read more about Ratings).
8. Days to Resit if Certified. If the assessment is a certification and the certification is passed this is the number of days before an email will be automatically sent (providing the template exists) for the respondent to update the certification (e.g.365 days for annual).
9. Certificate Template.  Upload a Certificate Template for printing if the certification is passed. 
10. Top Banner Color. Specify the color code for the banner at the top of the response. Normally this would match the background color of the logo or image you specify for the top of the response (by adding an entry to the graphic table with the type of Survey Logo).  The banner will be the full width of the screen.
    • Tip: You can enter the Hex Code for the color directly on the top of the selector.
11. Bottom Banner Color. Specify the color code for the banner at the bottom of the response. Normally this would match the background color of the logo or image you specify for the bottom of the response (by adding an entry to the graphic table with the type of Survey Footer).  The banner will be the full width of the screen.
12. Default Color. Specify the default color code for the look and feel of the response.  This determines the color of the boxes and buttons.
13. Open Response. Only select this checkbox if you want the response to remain open and continue to be able to be updated when the Respondent finishes the response.  This will normally only be used with Assessor Functionality
    • Show Completed. This field will only be displayed if Open Response is selected.  You can select who will be given the option to indicate an open response is Completed. (An extra button is shown, Finish and Complete.  The Finish button will close the response and update the status of the Assessment to Answered or Assessed depending on who updated the response.  Complete will set the status to Completed.    After it is completed it can no longer be updated by the respondent.  The options are Respondent, Assessor, Both or None.  
14. Assessment Type. Set to Normal unless Phased Assessments are used. Phased Assessments are most often used when Credit Card payment is required for a second phase or part of the assessment. Read more on setting up phased assessments.
15. Credit Card Payment Required. If Credit Card Payment is required to respond to this assessment, select this indicator.  This is one of the two options for Credit Card Processing, this option is best when there is a single assessment, Available Assessments is better when you have a list of assessments.  Credit Card Processing is integrated with Stripe.  Enter your stripe details into the Settings Form.
    • The following two fields only appear if Credit Card Processing is selected. 
16. Charge. The amount to charge.
17. Currency. The currency of the charge.
    • Phase. If Credit Card Processing is selected for a phased assessment you can select the phase (1 or 2) that the credit card processing applies to. 
18. Auto Create Response. This indicates that a response can be created automatically for this assessment. Usually, this will be when it is linked to from your website or group email.  The system will create a response automatically.  The URL must include the External ID. (More details on linking to assessments from your website or email)
19. Assessor Only Answers. Do not Tick this box unless an assessor is entering responses rather than an end-user. If an assessor is using the system, it does not display the report on completion but rather returns to the administration screen.  Also, a field for an adviser's name does not appear on the response.  Emails are not sent if this box is ticked.
20. Take User To Respondent Portal. Tick this if you wish to display the Respondent Portal on completion. The respondent will be asked to register (if they aren't already) by supplying a password.  From that point on they can log in at any time to view their previous responses.  
21. All Questions Must Be Answered. Tick this box if all questions must be answered to move between sections and save the completed survey. Respondents can “Save Progress,” but not complete the survey until all answers are selected.  If only some questions are compulsory, use the Required Checkbox on those questions.
22. Show Score in Assessment. This checkbox indicates that the score page should be a menu item. To be effective, the system requires that the Section Menu Checkbox in the Settings screen is also selected. This is useful for checking scoring at all different levels (assessment, sections, subsections, segmentations), or to allow assessors completing assessments access to the scores.  
23. Benchmarking Enabled Tick this checkbox to enable benchmarking for this assessment.  The system will then automatically calculate benchmarking data nightly.
24. Parent Assessment associates this assessment with a parent assessment for benchmarking.  This is intended for use with multilingual or copies of assessment made for cobranding purposes etc.  The assessments must be aligned on section, subsection, and segmentations.  The responses for all related (assessments that have a parent specified or are the parent) will be totaled into the benchmark.
25. Benchmark Label This might be "All companies" or "All employees", etc. depending on the context of your assessment.  This label is used if you report "all responses on your feedback or cohort report.
26. Save  / Save and go to Assessment Builder. You can save the assessment (and return to the assessment list or save it and proceed immediately to the assessment builder.

Legacy Version

If you hare still using the Legacy version of the software (haven't upgraded to Release 2020) then the documentation below applies. 

1. Assessment Name.  The free format name for the assessment
2. Assessment Description. The Description is used in the Respondent Portal and the Available Assessments List, to give a longer description of what the assessment provides.  Assessments only appear in the respondent portal or the Available Assessments List if you have them specified in the Assessment Availability table (Read more about Assessment Availability)
3. Version. While you can name the version how you wish; we recommend it should be an incrementing number. When creating a response the system will default to the latest version (highest number).  You can copy an assessment to make a new version.  Once you are using the assessment live to gather responses, it is best practice to make a new version when making substantial changes in the assessment so that responses match the assessment.  If you are making small changes (maybe just adding one question) you can update the same version.
4. External ID. The External ID is used on a URL when there is an “Auto Create Response.” The system will automatically create a response when a user enters the system using a URL with this code.  The Is Auto Create Response indicator must also be on (detailed below).   External ID's must not contain blanks or special characters other than - or _ (More details on linking to assessments from your website or email)
5. Language. The Language field is only completed if multilingual assessments are in use.  Select the language for this assessment.
6. Default Days To Completion. If you want to specify a requested completion date, specify the number of days after the assessment date that you would like that.
   • Note Additional fields may appear when the system is being used for training.  They are documented below. 
7. Report Template. Use this field to upload the Report Template for this assessment, used for the creation of the Feedback Report. Once a report template is uploaded there is also a link to download the latest version from the system. (Read more on Giving Feedback)
8. Top Banner Colour. Specify the color code for the banner at the top of the response. Normally this would match the background color of the logo or image you specify for the top of the response (by adding an entry to the graphic table with the type of Survey Logo).  The banner will be the full width of the screen.
9. Bottom Banner Colour. Specify the color code for the banner at the bottom of the response. Normally this would match the background color of the logo or image you specify for the bottom of the response (by adding an entry to the graphic table with the type of Survey Footer).  The banner will be the full width of the screen.
10. Default Colour. Specify the default color code for the look and feel of the response.  This determines the color of the boxes and buttons.
11. Assessment Type. Specify if this is a Phased Assessment. Use the Assessment type of Normal unless you want a Phased Assessment.  A phased assessment is completed by different respondents.  (Read more on Phased Assessments)
12. Default BCC Email. The Default BCC is used to set up the Response BCC field. It is primarily intended for use when the Auto-Create Response is used and might be set to the email address of the Assessment Administrator for this assessment, so they are notified when someone completes a response.
13. Auto Create Response. Indicates that a response can be created automatically for this assessment. Usually, this will be when it is linked to from your website or group email.  The system will create a response automatically.  The URL must include the External ID. (More details on linking to assessments from your website or email)
14. Assessor Answers. Do not Tick this box unless an assessor is entering responses rather than an end-user. If an assessor is using the system, it does not display the report on completion but rather returns to the administration screen.  Also, a field for an adviser name does not appear on the response.  Emails are not sent if this box is ticked.
15. Show Report On Completion. Tick this if the PDF report should be accessible to the user on completion. In this case, the system will display a screen at the end with a button to view the PDF Report.  Explanatory text for this screen can be added to the Website Text table.
16. Take User To Respondent Portal. Tick this if you wish to display the Respondent Portal on completion. The respondent will be asked to register (if they aren't already) by supplying a password.  From that point on they can log in at any time to view their previous responses.  
17. All Questions Must Be Answered. Tick this box if all questions must be answered to move between sections and save the completed survey. Respondents can “Save Progress,” but not complete the survey until all answers are selected.  If only some question are compulsory, use the Required Checkbox on those questions.
18. Email Report On Completion. Tick this box if you want the system to email the report on completion automatically. If this is ticked, make sure you have an email template with an email type of Completion.
19. Show Score in Assessment. This checkbox indicates that the score page should be a menu item. To be effective, the system requires that the Section Menu Checkbox in the Settings screen is also selected. This is useful for checking scoring at all different levels (assessment, sections, subsections, segmentations), or to allow assessors completing an assessments access to the scores.  
20. Save  / Save and go to Assessment Builder. You can save the assessment (and return to the assessment list or save it and proceed immediately to the assessment builder.

There are additional fields displayed on this screen if Settings field “Certifications Issued” checkbox is ticked.

  22. Days to Resit if Not Certified. If the assessment is a certification and the certification is not passed this is the number of days before an email will be automatically sent to re-sit the assessment (providing the template exists). The indication of whether the certification is passed is the Certified Checkbox on the Rating record (Read more about Ratings).

  23. Days to Resit if Certified. If the assessment is a certification and the certification is passed this is the number of days before an email will be automatically sent (providing the template exists) for the respondent to update the certification (e.g.365 days for annual).

24. Certificate Template. If the assessment is a certification and the certification is passed this is the template for the certificate that will be produced.