NZQA Element Description | Field Description |
---|
DataExtractionDateTime | Date and time file created Example: 2021-05-23T13:20:00 |
Key configuration details |
---|
Mandatory |
---|
- This value records the Date and Time the file was created.
- This value has a maximum field length of 19.
- This value has the Type Date-Time
- This value has the format YYYY-MM-DDTHH:MM:SS
|
AcademicYear | Academic Year |
Key configuration details |
---|
Mandatory |
---|
- This value is defined using the Year field on the NZQA tab of Student Data Import/Export… window. See below.
- This value has a maximum field length of 4.
- This value has the Type Integer
- This value has the format YYYY.
|
SoftwareID | Software ID for Synergetic provided by NZQA, for Synergetic is 525 |
Key configuration details |
---|
Mandatory |
---|
- This value is hardcoded, and is the Unique identifier for an SMS, available on request from NZQA (Synergetic = 525)
- This value has a maximum field length of 3.
- This value has the Type N as defined by NZQA
|
SoftwareVersionNumber | Identifies the SMS software version number used to generate the file |
Key configuration details |
---|
Optional |
---|
- The version number of Synergetic that the school is running
- This value has a maximum field length of 60.
- This value has the Type Alphanumeric.
|
ProviderNumber | MoE Provider Number of School. Example: 75 |
Key configuration details |
---|
Mandatory |
---|
- This value is defined using the Configuration Key field Students|DataExport|NZQA|ExportResults|DefaultProviderCode. See Configuration File Maintenance window.
- This value has a maximum field length of 5.
- This value has the Type N as defined by NZQA
|
ProviderLocationNumber | Provider Location Number Example: 01 |
Key configuration details |
---|
|
---|
- This value is defined using the Configuration Key field Students|DataExport|NZQA|ExportResults|DefaultProviderLocationCode. See Configuration File Maintenance window.
- This value has a maximum field length of 2.
- This value has the Type N as defined by NZQA
|
(Course Details) FileTypeCode (This is actually an attribute of the SecondaryCourses element) | File Type Code - Secondary Courses File type |
Key configuration details |
---|
|
---|
- This value is hard-coded as FR
- This value has a maximum field length of 2.
- This value has the Type Alphanumeric.
|
(Course Details) SecondaryCourseNumber | Secondary Course Number A unique number that identifies a secondary course. Optional but must be supplied if Secondary Course Name is supplied |
Key configuration details |
---|
Optional |
---|
- This value is defined using the Assessment Code (Code) field of Subject Area Assessment Maintenance. See Maintaining subject assessments.
- This value has a maximum field length of 10.
- This value has the Type Alphanumeric.
|
(Course Details) SecondaryCourseName | Description of Course Optional but must be supplied if SecondaryCourseNumber is supplied |
Key configuration details |
---|
Optional |
---|
- This value is defined using the Assessment Heading (Heading) field of Subject Area Assessment Maintenance. See Maintaining subject assessments.
- This value has a maximum field length of 60.
- This value has the Type Alphanumeric.
|
(Course Details) ShortCourseIndicator | Short Course Indicator Indicator to advise NZQA that course does not have sufficient credits for endorsement |
Key configuration details |
---|
Optional |
---|
- This field is defined using the Short Course field of Subject Area Assessment Maintenance. See Maintaining subject assessments.
- This field has the values: 1, 0, True, False
- This value has a maximum field length of 5.
- This value has the Type Alphanumeric.
|
(Learner Enrolment Details) FileTypeCode (This is actually an attribute of the LearnerEnrolment element) | File Type Code - Learner Enrolment File Type |
Key configuration details |
---|
Mandatory |
---|
- This value is always FR (Full Replacement)
- This value has a maximum field length of 2.
- This value has the Type Alphanumeric.
|
NationalStudentNumber | Student’s National Student Number |
Key configuration details |
---|
Mandatory |
---|
- Value examples, eg: 0123456789 or 123456789 leading 0 optional. No separators eg: ‘-’ or ‘/’
Ref: MoE 2021 SMS Roll Returns Page 45 - This value is defined using the NSN field of the NZMOE or Codes tabs in Current Student Maintenance. See Current Student Maintenance - NZMOE tab or Current Student Maintenance - Codes tab.
- This value has a maximum field length of 10.
- This value has the Type N as defined by NZQA
|
LocalIdentifier | Community ID. |
Key configuration details |
---|
Mandatory |
---|
- School’s own unique student id, example: ABC4880
Ref: MoE 2021 SMS Roll Returns Page 51 - This value is defined using the ID field of Community Maintenance. See Community.
- This value has a maximum field length of 10.
- This value has the Type Alphanumeric.
|
FirstName | Student’s first name |
Key configuration details |
---|
Mandatory |
---|
- Ref: MoE 2021 SMS Roll Returns Page 51
- This value is defined using the Given 1 field of the Name tab of Community Maintenance. See Community Maintenance - Name tab.
- This value has a maximum field length of 60.
- This value has the Type Alphanumeric.
|
MiddleName | Student’s first middle name |
Key configuration details |
---|
Optional |
---|
- Ref: MoE 2021 SMS Roll Returns Page 51
- This value is defined using the Given 2 field of the Name tab of Community Maintenance. See Community Maintenance - Name tab.
- This value has a maximum field length of 30.
- This value has the Type Alphanumeric.
|
MiddleName | Student’s second middle name |
Key configuration details |
---|
Optional |
---|
- Ref: MoE 2021 SMS Roll Returns Page 51
- This value is defined using the Given 2 field of the Name tab of Community Maintenance. See Community Maintenance - Name tab.
Given 2 is broken into two names if there is space in it. - This value has a maximum field length of 30.
- This value has the Type Alphanumeric.
|
LastName | Student’s surname |
Key configuration details |
---|
Mandatory |
---|
- Ref: MoE 2021 SMS Roll Returns Page 51
- This value is defined using the Surname field of the Name tab of Community Maintenance. See Community Maintenance - Name tab.
- This value has a maximum field length of 60.
- This value has the Type Alphanumeric.
|
GenderCode | Gender Code |
Key configuration details |
---|
Mandatory |
---|
- Values: M or F
Ref: MoE 2021 SMS Roll Returns Page 42 - This value is defined using the Gender field of the Name tab of Community Maintenance. See Community Maintenance - Name tab.
- This value has a maximum field length of 1.
- This value has the Type Alphanumeric.
|
BirthDate | Student’s date of birth |
Key configuration details |
---|
Mandatory |
---|
- This value is defined using the Date of Birth field of the Name tab of Community Maintenance. See Community Maintenance - Name tab.
- This value has Format of YYYY-MM-DD
Example: 1989-05-19 - This value has a maximum field length of 10.
- This value has the Type Date.
|
EthnicityCode | Student’s 1st ethnicity code |
Key configuration details |
---|
Mandatory |
---|
- Example: 111
Ref: MoE 2021 SMS Roll Returns Page 42,43 - This value is defined using the Ethnic Group 1 field of the NZMOE tab in Current Student Maintenance. See Current Student Maintenance - NZMOE tab.
- This value has a maximum field length of 5.
- This value has the Type N as defined by NZQA
|
EthnicityCode | Student’s 2nd ethnicity code |
Key configuration details |
---|
Optional |
---|
- Example: 211
Ref: MoE 2021 SMS Roll Returns Page 42,43 - This value is defined using the Ethnic Group 2 field of the NZMOE tab in Current Student Maintenance. See Current Student Maintenance - NZMOE tab.
- This value has a maximum field length of 5.
- This value has the Type N as defined by NZQA
|
EthnicityCode | Student’s 3rd ethnicity code |
Key configuration details |
---|
Optional |
---|
- Example: 421
Ref: MoE 2021 SMS Roll Returns Page 39 - This value is defined using the Ethnic Group 3 field of the NZMOE tab in Current Student Maintenance. See Current Student Maintenance - NZMOE tab.
- This value has a maximum field length of 5.
- This value has the Type N as defined by NZQA
|
IwiCode | Student’s 1st Iwi affiliation |
Key configuration details |
---|
Mandatory where ethnicity is Māori |
---|
- Example: 0101
Ref: MoE 2021 SMS Roll Returns Page 42 - This value is defined using the IWI 1 field of the NZMOE tab in Current Student Maintenance. See Current Student Maintenance - NZMOE tab.
- This value has a maximum field length of 4.
- This value has the Type N as defined by NZQA
|
IwiCode | Student’s 2nd Iwi affiliation |
Key configuration details |
---|
Optional |
---|
- Example: .0809
Ref: MoE 2021 SMS Roll Returns Page 42 - This value is defined using the IWI 2 field of the NZMOE tab in Current Student Maintenance. See Current Student Maintenance - NZMOE tab.
- This value has a maximum field length of 4.
- This value has the Type N as defined by NZQA
|
IwiCode | Student’s 3rd Iwi affiliation |
Key configuration details |
---|
Optional |
---|
- Example: 1004
Ref: MoE 2021 SMS Roll Returns Page 342 - This value is defined using the IWI 3 field of the NZMOE tab in Current Student Maintenance. See Current Student Maintenance - NZMOE tab.
- This value has a maximum field length of 4.
- This value has the Type N as defined by NZQA
|
CitizenshipCountryCode | Student’s country of citizenship |
Key configuration details |
---|
Mandatory for student type FF |
---|
- Ref: MoE 2021 SMS Roll Returns Page 36
- This value is defined using the Country of Citizenship field of the NZMOE tab in Current Student Maintenance. See Current Student Maintenance - NZMOE tab.
- This value has a maximum field length of 3.
- This value has the Type Alphanumeric.
|
AddressLineText | Student’s address line 1 |
Key configuration details |
---|
Mandatory |
---|
- This value is defined as per the Note below.
- This value has a maximum field length of 40.
- This value has the Type Alphanumeric.
Note: Override Address If Students > Current Student Maintenance > NZQA > Override Address (for Export Only) is ticked Address comes from the Address field of NZQA tab. (ignore next cases.) See: Current Student Maintenance - NZQA tab Whose Address? If the Configuration Key: Students | DataExport | NZQA | AddressContact = SC1 then the Primary Contact's Address is used If the Configuration Key: Students | DataExport | NZQA | AddressContact is left blank then the highest "Lives With" Contact's Address is used See: Configuration File Maintenance window Which Address? If Students | DataExport | NZQA | AddressType = H then Home Address is used, otherwise Postal Address. See: Configuration File Maintenance window and Community Maintenance - Home Address tab or Community Maintenance - Postal Address tab |
AddressLineText | Student’s address line 2 |
Key configuration details |
---|
Mandatory |
---|
- This value is defined as per the Note above.
- This value has a maximum field length of 40.
- This value has the Type Alphanumeric.
|
AddressLineText | Student’s address line 3 |
Key configuration details |
---|
Optional |
---|
- This value is defined as per the Note above.
- This value has a maximum field length of 40.
- This value has the Type Alphanumeric.
|
AddressLineText | Student’s address line 4 |
Key configuration details |
---|
Optional |
---|
- This value is defined as per the Note above.
- This value has a maximum field length of 40.
- This value has the Type Alphanumeric.
|
PostCode | Post Code |
Key configuration details |
---|
Optional |
---|
- This value is defined as per the Note above.
- This value has a maximum field length of 4.
- This value has the Type N as defined by NZQA
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
---|
|
|
|
|
---|
|
---|
|
|
|
Key configuration details |
---|
|
---|
|