Every archive of data exported from the Survey Solutions Headquarters contains among the user data the following system-generated data files:
assignment__actionsinterview__actionsinterview__commentsinterview__diagnosticsinterview__errors
The above data files are saved in the same data format as the main survey data, for example, if the main data is requested in Stata format, the system-generated data files will also be exported in Stata format.
The data files are also accompanied by an automatically generated text file named export__readme.txt. This file documents which version of the Survey Solutions software was used to export the data, when the export was done, and placement of variables into the data files. Here is an example of such a file that may be accompanying, e.g. an agricultural survey.
The contents of the system-generated data files is described in the table below:
assignment__actions | |||
| Variable | Type | Meaning | Example |
|---|---|---|---|
| assignment__id | numeric | Unique id of the assignment. | 6037 |
| date | string | Date when the action was taken | 2018-12-12 |
| time | string | Time when the action was taken | 10:11:12 |
| action | numeric | Type of action taken. See assignment action codes. | 12 |
| originator | string | Login name of the person performing the action | JohnSup |
| role | numeric | System role of the person performing the action. See role codes. | 2 |
| responsible_name | string | Login name of the person now responsible for the interview | JackInt |
| responsible_role | numeric | System role of the person now responsible for the interview. See role codes. | 1 |
| old__value | string | Value that was changed (optional). | 3 |
| new__value | string | New value that was specified (optional). | 5 |
| comment | string | Any comment left by the action originator. | Complete this assignment by Friday! |
interview__actions | |||
| Variable | Type | Meaning | Example |
| interview__key | string | Interview key (identifier in XX-XX-XX-XX format) | 12-34-56-78 |
| interview__id | string | Unique 32-character long identifier (GUID) of the interview. | 5b3c8288289646699580e16f5d1b6d1e |
| date | string | Date when the action was taken | 2018-12-12 |
| time | string | Time when the action was taken | 10:11:12 |
| action | numeric | Type of action taken. See action codes. | 12 |
| originator | string | Login name of the person performing the action | JohnSup |
| role | numeric | System role of the person performing the action. See role codes. | 2 |
| responsible_name | string | Login name of the person now responsible for the interview | JackInt |
| responsible_role | numeric | System role of the person now responsible for the interview. See role codes. | 1 |
interview__comments | |||
| Variable | Type | Meaning | Example |
| interview__key | string | Interview key (identifier in XX-XX-XX-XX format) | 12-34-56-78 |
| interview__id | string | Unique 32-character long identifier (GUID) of the interview | 5b3c8288289646699580e16f5d1b6d1e |
| roster | *string | Name of the roster containing the variable | members |
| id1 | *numeric | Roster ID of the 1st level of nesting | 7 |
| id2 | *numeric | Roster ID of the 2nd level of nesting | 7 |
| id3 | *numeric | Roster ID of the 3rd level of nesting | 7 |
| id4 | *numeric | Roster ID of the 4th level of nesting | 7 |
| variable | string | Variable name for the commented question | age |
| order | numeric | Sequential order of the comment | 1 |
| date | string | Date when the comment was left | 2018-12-31 |
| time | string | Time when the comment was left | 12:34:56 |
| originator | string | Login name of the person leaving the comment | JohnSup |
| role | numeric | System role of the person leaving the comment. See role codes. | 2 |
| comment | string | Text of the comment | Age is confirmed by document |
interview__diagnostics | |||
| Variable | Type | Meaning | Example |
| interview__key | string | Interview key (identifier in XX-XX-XX-XX format) | 12-34-56-78 |
| interview__id | string | Unique 32-character long identifier (GUID) of the interview | 5b3c8288289646699580e16f5d1b6d1e |
| interview__status | numeric | Last status of interview. See status codes. | 100 |
| responsible | string | Last responsible person | JohnSup |
| interviewers | numeric | Number of interviewers who worked on this interview | 1 |
| rejections__sup | numeric | How many times this interview was rejected by supervisors | 0 |
| rejections__hq | numeric | How many times this interview was rejected by HQ | 1 |
| entities__errors | numeric | Number of questions and static texts with errors | 10 |
| interview__duration | string | Active time it took to complete the interview, DD.HH:MM:SS | 00.05:28:39 |
interview__errors | |||
| Variable | Type | Meaning | Example |
| interview__key | string | Interview key (identifier in XX-XX-XX-XX format) | 12-34-56-78 |
| interview__id | string | Unique 32-character long identifier (GUID) of the interview | 5b3c8288289646699580e16f5d1b6d1e |
| roster | *string | Name of the roster containing the variable | members |
| id1 | *numeric | Roster ID of the 1st level of nesting | 7 |
| id2 | *numeric | Roster ID of the 2nd level of nesting | 7 |
| id3 | *numeric | Roster ID of the 3rd level of nesting | 7 |
| id4 | *numeric | Roster ID of the 4th level of nesting | 7 |
| variable | string | Variable name for the question, where validation error occurred | age |
| type | numeric | Type of the variable where the validation error occurred. See type codes. | 2 |
| message__number | numeric | Numeric index of the validation rule that has fired | 1 |
| message | string | Text of the error message | Age may not be negative |
Fields indicated with a star (*) are optional and present only if the questionnaire template contains rosters.
Code tables
For coded variables in the system-generated data files the following tables outline the meaning of the codes:
- coding of roles;
- coding of assignment actions;
- coding of interview actions;
- coding of interview statuses;
- coding of object types.
Coding of roles | |
| Code | Meaning |
|---|---|
| 0 | <UNKNOWN ROLE> |
| 1 | Interviewer |
| 2 | Supervisor |
| 3 | Headquarter |
| 4 | Administrator |
| 5 | Api User |
Coding of assignment actions | |
| Code | Meaning |
| 0 | Unknown |
| 1 | Created |
| 2 | Archived |
| 3 | Deleted |
| 4 | ReceivedByTablet |
| 5 | Unarchived |
| 6 | AudioRecordingChanged |
| 7 | Reassigned |
| 8 | QuantityChanged |
| 9 | WebModeChanged |
Coding of interview actions | |
| Code | Meaning |
| 0 | SupervisorAssigned |
| 1 | InterviewerAssigned |
| 2 | FirstAnswerSet |
| 3 | Completed |
| 4 | Restarted |
| 5 | ApprovedBySupervisor |
| 6 | ApprovedByHeadquarter |
| 7 | RejectedBySupervisor |
| 8 | RejectedByHeadquarter |
| 9 | Deleted |
| 10 | Restored |
| 11 | UnapprovedByHeadquarter |
| 12 | Created |
| 13 | InterviewReceivedByTablet |
| 14 | Resumed |
| 15 | Paused |
| 16 | TranslationSwitched |
| 17 | OpenedBySupervisor |
| 18 | ClosedBySupervisor |
| 19 | InterviewSwitchedToCawiMode |
| 20 | InterviewSwitchedToCapiMode |
Coding of interview statuses | |
| Code | Meaning |
| -1 | Deleted |
| 0 | Restored |
| 20 | Created |
| 40 | SupervisorAssigned |
| 60 | InterviewerAssigned |
| 65 | RejectedBySupervisor |
| 80 | ReadyForInterview |
| 85 | SentToCapi |
| 95 | Restarted |
| 100 | Completed |
| 120 | ApprovedBySupervisor |
| 125 | RejectedByHeadquarters |
| 130 | ApprovedByHeadquarters |
Coding of types | |
| Code | Meaning |
| 1 | Section |
| 2 | Question |
| 3 | StaticText |
| 4 | Variable |