Skip to end of banner
Go to start of banner

Export entries and results file

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

The following lists the fields of the Export entries and results file XML file and where their source can then be seen within Synergetic.

NZQA Element Description

Field Description

DataExtractionDateTimeDate 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
AcademicYearAcademic 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
SoftwareVersionNumberIdentifies 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.
ProviderNumberMoE 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
ProviderLocationNumberProvider 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 value is defined using the Short Course field of Subject Area Assessment Maintenance. See Maintaining subject assessments.
    • 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.
NationalStudentNumberStudent’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.
FirstNameStudent’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.
MiddleNameStudent’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.
MiddleNameStudent’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.
LastNameStudent’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.
GenderCodeGender Code
Key configuration details
Mandatory
  • Has the 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.
BirthDateStudent’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.
EthnicityCodeStudent’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
EthnicityCodeStudent’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
EthnicityCodeStudent’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
IwiCodeStudent’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
IwiCodeStudent’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
IwiCodeStudent’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
CitizenshipCountryCodeStudent’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.
AddressLineTextStudent’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

AddressLineTextStudent’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.
AddressLineTextStudent’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.
AddressLineTextStudent’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.
PostCodePost 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
EnrolmentDateDate student enrolled at this school
Key configuration details
Mandatory
  • This value is defined using the EntryDate field of the NZQA tab of Current Student Maintenance. See Current Student Maintenance - NZQA tab.
  • This value has Format of YYYY-MM-DD
    Example: 2021-05-13
  • This value has a maximum field length of 10.
  • This value has the Type Date.
(Learner Enrolment)
WithdrawnIndicator		Indicates that the student has withdrawn from all assessment
Key configuration details
Optional
  • This value is defined using the Withdrawn field of the NZQA tab of Current Student Maintenance. See Current Student Maintenance - NZQA tab.
  • Has the values: 1, 0, True, False
  • This value has a maximum field length of 5.
  • This value has the Type Alphanumeric.
StudentTypeCodeType of student - funding purposes
Key configuration details
Mandatory
  • This value is defined using the Student Type field of the NZMOE tab in Current Student Maintenance. See Current Student Maintenance - NZMOE tab.
    Example: FF….
    Ref: MoE 2021 SMS Roll Returns Page 52
  • This value has a maximum field length of 6.
  • This value has the Type Alphanumeric.
TertiaryReleaseIndicatorAuthority to release student’s results
Key configuration details
Mandatory
  • This value is defined using the Tertiary Release field of the NZQA tab of Current Student Maintenance. See Current Student Maintenance - NZQA tab.
  • Has the values: 1, 0, True, False
  • This value has a maximum field length of 5.
  • This value has the Type Alphanumeric.
StudentSortCodeStudent’s NZQA sort code
Key configuration details
Mandatory
  • The source of this value is defined using the ExportSortKey field of luYearLevel in Lookup Tables Maintenance. See Lookup Table Maintenance window.
    Default = Form        See: Current Student Maintenance - School tab
    Example: 13AB
  • Sort order for admission slips
    Often form class of student
  • This value has a maximum field length of 6.
  • This value has the Type Alphanumeric.
PaymentAmountAmount paid by student to school for current year NZQA fees
Key configuration details
Optional
  • This value is defined using the Payment Amount field of the NZQA tab of Current Student Maintenance. See Current Student Maintenance - NZQA tab.
    Example: 375.00
  • This value has a maximum field length of 8.
  • This value has the Type N as defined by NZQA
LeavingDateDate student departed this school
Key configuration details

  • This value is defined using the Leaving Date field of the NZQA tab of Current Student Maintenance. See Current Student Maintenance - NZQA tab.
  • This value has a maximum field length of 10.
  • This value has Format of YYYY-MM-DD
    Example: 2021-09-06
  • This value has the Type Date
LeaversCode
Key configuration details
Optional but Mandatory if Leaving Date is not blank
  • This value is defined using the Leaving Reason field of the NZQA tab of Current Student Maintenance. See Current Student Maintenance - NZQA tab.
  • This value has a maximum field length of 1.
  • This value has the Type Alphanumeric.
(Exam Centre Details)
ProviderNumber

MoE Provider Number of school

Key configuration details

Not Exported

  • Note: Synergetic does not provide because for the non-Synergetic Schools: Correspondence School and Westmount use only
    Example: 75
  • Optional but mandatory if Provider location number is suppled
  • This value has a maximum field length of 5.
  • This value has the Type Alphanumeric.
(Exam Centre Details)
ProviderLocationNumber		School location code
Key configuration details

Not Exported

  • Note: Synergetic does not provide because for the non-Synergetic Schools: Correspondence School and Westmount use only
    Example: 01
  • Optional but mandatory if Provider location number is suppled
  • This value has a maximum field length of 2.
  • This value has the Type Alphanumeric.
FinancialAssistanceTypeCode
Financial assistance type
Key configuration details
Optional

B = Benefit
I = Income
F= Family

  • This value has a maximum field length of 1.
  • This value has the Type Alphanumeric.
CommunityServicesCardNumberCommunity Services Card Number
Key configuration details
Mandatory if Assistance Type = “B”
Optional if Assistance Type = “I”
  • This value is defined using the Benefit Number field of the NZQA tab of Current Student Maintenance. See Current Student Maintenance - NZQA tab.
  • This value has a maximum field length of 15.
  • This value has the Type Alphanumeric.
NumberOfStudentsCountNumber of students on application
Key configuration details
Mandatory if Assistance Type is not blank
  • This value is defined using the Number of Siblings (Candidate Count) field of the NZQA tab of Current Student Maintenance. See Current Student Maintenance - NZQA tab.
    Example: 2
  • This value has a maximum field length of 2.
  • This value has the Type N as defined by NZQA
StandardNumberNQF Standard
Example: 744
Key configuration details
Mandatory
  • This value is defined using the Number field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
    Example: 744
  • This value has a maximum field length of 5.
  • This value has the Type N as defined by NZQA
StandardVersionNumberNQF Standard Version
Key configuration details

  • This value is defined using the Version field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
    Example: 1
  • This value has a maximum field length of 2.
  • This value has the Type N as defined by NZQA
ContextCodeContext Code
Key configuration details
Mandatory if standard requires a context code.
Left in schema in case it is re-introduced in later years.
  • This value is defined using the Context field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
  • This value has a maximum field length of 3.
  • This value has the Type Alphanumeric.
SecondaryCourseNumberA unique identifier that links a standard to a school course for a learner
Key configuration details
Optional
  • This value is defined using the Course (Assessment Code) field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
  • This value has a maximum field length of 10.
  • This value has the Type Alphanumeric.
TeReoPaperIndicatorRequest for a translated exam paper
Key configuration details
Optional
  • This value is defined using the Te Reo Paper Req field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
  • Only valid for externally assessed standards as indicated on standards file.
    Values: 1, 0, True, False
  • This value has a maximum field length of  5.
  • This value has the Type Alphanumeric.
TeReoAnswerIndicatorIndicates the student will submit work in te reo Māori
Key configuration details
Optional
  • This value is defined using the Te Reo Answer Req field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
  • Applies to both externally and internally assessed standards
    Values: 1, 0, True, False
  • This value has a maximum field length of 5.
  • This value has the Type Alphanumeric.
AssessmentRequestTypeDenotes the request is for a Digital Exam/ Paper Exam or Digital Submission / Physical Submission.
Key configuration details
Optional

DE = Digital Exam
PE = Paper Exam
DS = Digital Submission
PS = Physical Submission

  • This value has a maximum field length of 2.
  • This value has the Type Alphanumeric.
DigitalPracticeExamIndicatorIndicates that the student will be doing the Digital Practice Exam.
Key configuration details
Optional
  • This value is defined using the Digital Practice Exam Requested field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
    Values: 1, 0, True, False
  • This value has a maximum field length of 5.
  • This value has the Type Alphanumeric.
AssessmentOpportunityIndicates which external assessment opportunity for a given standard the student will participate in.
Key configuration details
Mandatory for externally assessed standards as indicated on standards file.
  • This value is defined using the Assessment Opportunity field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
    Values: 1 to the number indicated by Field 29 “Assessment Opportunities” of the current Standards file.
  • Please note only one opportunity can be selected per entry.
  • This value has a maximum field length of 2.
  • This value has the Type N as defined by NZQA
EntrySortCodeIndicates an entry-based sort key that can be used for externally assessed standards to assist teachers in rooming learners for CAAs or filtering learners for digital submissions.
Key configuration details
Optional

Note: Synergetic does not provide

  • This value has a maximum field length of 2.
  • This value has the Type N as defined by NZQA
(Entry Details)
WithdrawnIndicator		Indicates Student has withdrawn from assessment in this entry
Key configuration details
Optional
  • This value is defined using the Withdrawn field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
    Values: 1, 0, True, False
  • This value has a maximum field length of 5.
  • This value has the Type Alphanumeric.
CompletionDateDate standard was assessed.
Key configuration details
Mandatory if Result is not blank
  • This value is defined using the Completed field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
  • This value has Format of YYYY-MM-DD
    Example: 2021-05-23
  • This value has a maximum field length of 10.
  • This value has the Type Date.
SecondaryResultCodeThe result reported by the school for internally assessed standards (the assessed result), or externally assessed standards (derived grade for unexpected events).
Key configuration details
Mandatory if CompletionDate is not blank.
  • This value is defined using the Result field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
  • Merit and Excellence not available for all Unit Standards, identified by Field 16 “Achieved/Merit/Excellence Permissible” of the current Standards file.
  • This value has a maximum field length of 5.
  • This value has the Type Alphanumeric.
(Assessing Provider Details)
ProviderNumber		MoE Provider Number
Key configuration details
Mandatory where standard is assessed by another provider
  • This value is defined using the Provider field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
    (Provider Number includes Number and Location - Proc splits these.)
    Example: 498
  • This value has a maximum field length of 5.
  • This value has the Type N as defined by NZQA
(Assessing Provider Details)
ProviderLocationNumber		Provider location code
Key configuration details
Mandatory where standard is assessed by another provider
  • This value is defined using the Provider field of the NCEA tab of Current Student Maintenance. See Current Student Maintenance - NCEA tab.
    (Provider Number includes Number and Location - Proc splits these.)
    Value: 01 thru 99
  • This value has a maximum field length of 2.
  • This value has the Type N as defined by NZQA
LearnerRowCountA count of learner records
Key configuration details
Mandatory
  • This value is calculated by the Procedure that produces the Export.
    Example: 775
  • This value has a maximum field length of 6.
  • This value has the Type N as defined by NZQA
EntryRowCountA count of Standard records
Key configuration details
Mandatory
  • This value is calculated by the Procedure that produces the Export.
    Example: 7550
  • This value has a maximum field length of 6.
  • This value has the Type N as defined by NZQA
EmailEAddressE-mail address of person submitting file to NZQA
Key configuration details

  • This value is the default email of logged in User.
  • This value has a maximum field length of 255.
  • This value has the Type Alphanumeric.
CommentTextComments supplied for this file for the Data Group
Key configuration details

Note: Synergetic does not provide.

  • Appended to file when file submitted to NZQA.
  • Optional but if needed must be filled in once the file is uploaded.
  • This value has a maximum field length of 255.
  • This value has the Type Alphanumeric.

  • No labels