When you download a zip file of the assessment that you wish to change, the downloaded folder will contain the following files:
| Table of Contents |
|---|
A colour guide has been used to help demonstrate how to edit these files:
Field headings coloured in Green are editable
Field heading coloured in Yellow can have a new row created. Existing fields should not be edited
Field headings coloured in Red should not be edited
...
Sections.csv
A CSV file that defines the sections in an assessment. It includes fields such as section id and title (display section name) of the sections in the assessment.
Section id - a unique field used to identify a section
Title - a field which provides a section title for the given section id. It cannot be left blank.
Condition- this field uses expressions to state when a section should appear based on the given conditions. If left blank the section will always appear. Please ask for further details on editing this option
...
Questions.csv
A CSV file that defines the questions in an assessment and the order in which they appear. It includes fields such as question id, section id, question, condition, attachment policy, answer type, display types, min value, max value, answer id and values (for unique answer options).
Question id - a unique field used as a question identifier
Section id - a field which identifies which section the question belongs to. This field should be the same as the section id given in section.csv. Questions in a section should appear to be listed together in the question.csv file
Question - this field is for the header of a question. It cannot be left blank
Condition - this field uses expressions to state when a question should appear based on the given conditions. If left blank the question will always appear. Please ask for further details on editing this option
Attachment policy - this field states whether a question should either allow, require or not require an attachment to be added with the question
Answer type - this field states how the question should be answered e.g freetext, multiple options etc
Display type - this field states how the answer type should be displayed e.g. combobox, date picker
Min value - if a numerical value is required this field validates the answers by checking it against the minimum value which should be given. If left blank the answer value is not validated prior submission
Max value - if a numerical value is required this field validates the answers by checking it against the maximum value which should be given. If left blank the answer value is not validated prior submission
Answer id - a field which identifies which group of answer options should be used. If used, this field should be the same as the ‘answer id’ given in answers.csv. This option is used when a group of answer options will be re-used for another question. This is left blank if value fields are used instead.
Value- a field which represents a single answer option. This option is used when a group of answer options are unique to the question. This is left blank if answer id is used.
...
...
QuestionsDescriptions.csv
A CSV file that
...
holds the text used for each question in an assessment. It includes fields such as question id and Question Description.
question id - this field contains unique question id
Question Description - this field contains exact wording to be displayed on each question (wording of the question itself, not the title)
...
...
Answers.csv
A CSV file
...
that defines answer options for a question. It is used when a particular group of answer options are repeated in an assessment. Each group of answers
...
options must have a unique id. If this csv file is empty then answer options are exclusively in the questions.csv file.
Answer id - a unique field which identifies a group of answer options
Values- a field which represents a single answer option. Answer options are always in two parts and written as an expression, the first part is the ‘answer-option id’ and the second part is the ‘answer choice text’ e.g. answer1=Every day in this example the ‘answer-option id’ is ‘answer1’ and the ‘answer choice text’ which is displayed in the assessment is ‘Every day’.
...
Parameters.
...
csv
A CSV file that
...
defines scoring
...
weights for answers. If this csv file is empty then the assessment is scored solely through a coding script (algo.py)
Param name - a unique field which identifies a weight function given to a score
Values- a field which holds the numerical weight function value
...
Config.json
...
A config file includes basic settings for the assessment, however, the only value that should be amended here is “description” which will be your assessment display name.
...
Algo.py
| Warning |
|---|
This file should NOT be edited in any circumstance. |
...
Questions-descriptions folder
| Info |
|---|
This folder includes auto-generated question |
...
text files and may be ignored. |
To see step-by-step guides for making changes to an assessment, go to Making Assessment Changes