Extraction of standard Information for External Exam / Reporting at NZQA.
The data is extracted into an XML format file according to NZQA specifications.
An additional PDF report is generated, listing some possible errors/warnings if any.
Setup: | ||||||||||||||||||||||||||||||||
Setup System Operational Definitions on {SMNT-12}:
|
||||||||||||||||||||||||||||||||
Setup Conversion Codes on {GOPS-21} :
External body MOE, External code types INS and SID will be setup in {SNZQAR-9} and {SNZQAR-8}. |
||||||||||||||||||||||||||||||||
Setup context textual type with SOD LC for subsystem DM, in {SCODE3-8}. |
||||||||||||||||||||||||||||||||
Setup reporting period with SOD LP for subsystem DM, in {SCODE3-11}. | ||||||||||||||||||||||||||||||||
Setup context
textual type per reporting period for standards with SODs LP - Learning
Context Reporting Period and LC - Learning Context Textual type in
{SCODE3-12}. Use Entity Indicator = 'S'. |
||||||||||||||||||||||||||||||||
Make sure NZQA School Setup is correct on {SNZQAR-8}. |
||||||||||||||||||||||||||||||||
Make sure NZQA Institution Setup is correct on {SNZQAR-9}. |
||||||||||||||||||||||||||||||||
Make sure External Exam Extraction Matrix is correct on {SNZQAR-10}. |
||||||||||||||||||||||||||||||||
Academic Setup must be complete, Curriculum Modules - {SACAD-10} is very important. |
||||||||||||||||||||||||||||||||
Rubric definitions in {SSTUD3-26} and setup of assessments in {SSTUD3-7} is very important.
|
||||||||||||||||||||||||||||||||
Operational: | ||||||||||||||||||||||||||||||||
Normal registration activities, including changes and cancellations. |
||||||||||||||||||||||||||||||||
Identify
Students who should not be reported/registered at NZQA by linking the
status in SOD NR - No NZQA Reporting Student Status to the student on {SREGL-2}. |
||||||||||||||||||||||||||||||||
Update context information for student, standard subject(s) combination where needed in {SREGB-12}. |
||||||||||||||||||||||||||||||||
Create 'External Exam Registration' service request for students with {SNZQAR-1}. |
||||||||||||||||||||||||||||||||
Update needed
'External Exam Registration' service request information (outcome, exam
attendance and coded data fields) on {SSTUDS-3b3}. |
||||||||||||||||||||||||||||||||
Complete data for students who moved from another provider to Te Kura, and Te Kura must now report their standards to NZQA.
|
Enter data and click the "Generate File" button to generate extraction/enties file.
Field | Type & Length |
Description |
---|---|---|
Year | YYYY | Academic Year |
Software ID | N3 | Unique identifier for the Software System. A code is available on request from the NZQA. |
Extraction Type | A1 | C / F / T / U
|
Remarks | A2500 | Any Remark on this generation |
Generate File | Button | When this button is pressed the program will run and generate 2 output files that is described below. |
|
All the history for the UPDATE runs of the program will have an entry here.
The 'base' XML output can be viewed in {BATCH-14}.
Field | Type & Length |
Description |
---|---|---|
Year | YYYY | Academic Year |
Generation Date | DD-MON-YYYY HH24:MI |
Date that the file was generated |
Generation User | A8 | User ID of the person that generated the file |
Remarks | A2500 | Remarks that was entered when file was generated
|
View File | Button | When this button is pressed the file that was generated on the Generation Date will display |
|
Processing Rules |
||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Include Students if: | All
students that are/were registered sometime during the year for a
'standard' subject ('Standard Type' field is not null in the Subject
definition {SACADO-10} (Some cancelled records are also included.) and There is a service request for the student for the year. and There is 'Entry Data' (see rules regarding entry data) for the student. and comply with the following inclusion rules:
(See rules regarding duplicate students) |
|||||||||||||||||||||||||||||||
Exclude Students if: | Student have status SOD NR, subsystem DM. |
|||||||||||||||||||||||||||||||
Exclude Qualification: | Where student cancelled and moved to another (known) school (see rules regarding move to another known school). Where qualification was cancelled because of human error (cancelreason where 'Pass Full Financial Credit' = 'Y' on {SCODE-25}). |
|||||||||||||||||||||||||||||||
Entry Data | For Full Replacement Trial and Full Replacement extraction run types the entry data is:
|
|||||||||||||||||||||||||||||||
Financial Assistance Data | Coded data fields:
|
|||||||||||||||||||||||||||||||
Include Standard Subjects | Subject is a 'standard' subject when the "Standard Type" in the Subject definition {SACADO-10} is not null.
|
|||||||||||||||||||||||||||||||
Exclude Subjects | Subject was cancelled because of human error (cancelreason where 'Pass Full Financial Credit' = 'Y' on {SCODE-25}). |
|||||||||||||||||||||||||||||||
Previous Years' Result Date | Internal standard subjects' results from previous years:
|
|||||||||||||||||||||||||||||||
Catch-up Result Date | Date results obtained reported in a catch-up run:
|
|||||||||||||||||||||||||||||||
Duplicate Students | Only report data from the primary qualification of the latest year in the <EnrolmentDetails> segment. All qualifing standards, for all qualifications, will be reported in the <NCEAEntries> segment. |
|||||||||||||||||||||||||||||||
Duplicate External Standard Subjects | When
a
student is registered again for the same external standard subject in
the same
year and the 'old' registration's attendance flag is set to 'Y', make
sure only the new registration will be picked up by setting its
attendance flag to 'Y' in {SSTUDS-3}. |
|||||||||||||||||||||||||||||||
Duplicate Internal Standard Subjects |
(See rules regarding internal standard subject results). |
|||||||||||||||||||||||||||||||
Internal Standard Subject Results | The highest and lowest result will be determined by the rubric linked to the assessment of the subject in {SSTUD3-7b3}. The result linked to the highest sequence of the rubric in {SSTUD3-26} will be the highest result. |
|||||||||||||||||||||||||||||||
Coded Data Fields Reported | Financial Assistance Fields 5-9: When a student
qualify for inclusion in the run based on subjects to be reported /
registered, this information will only be reported when the data
complies to the above rules regarding Financial Assistance data.
Coded data fields 10-17: Can only be reported when field 18 - Receipt Confirmation, is 'Y'.
|
|||||||||||||||||||||||||||||||
Move to another known school | Cancellation
reason = 'Transfered to another school ' ({GOPS-21}, External
Body = 'MOE', External Code Type = 'RFL', Internal Code = cancellation reason and External Code = 'S') and Moving Provider detail (type and code) is entered. |
|||||||||||||||||||||||||||||||
Flag the record as being previously selected | The subject record of the result reported will be flagged with the date that the extraction was run. This date is visible on {SNZQAR-22b1} 'Transfer date'. |
|||||||||||||||||||||||||||||||
Lookup the context information (if it still exists) for the standard subject according to SOD LC, subsystem DM. | ||||||||||||||||||||||||||||||||
'Empty/null' not required elements will not be included in the XML output. | ||||||||||||||||||||||||||||||||
The date field format is ccyy-mm-dd with leading zeros. | ||||||||||||||||||||||||||||||||
The true/false elements' format is lower case. |
Segment | Field Description | Type | Length | Notes |
---|---|---|---|---|
DataExtractionDateTime | Date Time | 19 | Date and time the file was created Example: 2011-05-23T13:20:00 Mandatory field |
|
AcademicYear | YYYY | 4 | Academic Year {SACADO-17}, (iakcyr) = {SDREGA-1}, (iagcyr). | |
SMSSoftware | (Start, Mandatory) | |||
SoftwareID | N | 3 | Unique identifier for an SMS Mandatory field |
|
SoftwareVersionNumber | A | 60 | Identifies the SMS software version number used to generate the file | |
SMSSoftware | (End) | |||
ReportingProvider | (Start, Mandatory) | Institution running the report | ||
ProviderNumber | N | 4 | Required field. Value = {GOPS-21} Body/Type NZQ/SID, External code with Internal code = {GCS-1} Code (gaocode). |
|
ProviderLocationNumber | Hardcoded: 1 | |||
ReportingProvider | (End) | |||
SecondaryCourses | (Start) | Distinct list of all main subjects of standards reported as entries. Segment will be empty when no students or no standards are reported. |
||
FileTypeCode | A | 3 | Course Endorsement file type Must be 'FR' (Full Replacement) or UP (Update). Mandatory field |
|
SecondaryCourse | (Start, Zero or more repetitions) | |||
SecondaryCourseNumber | A | 10 | A unique number that identifies a secondary course (iahsubj), {SDREGA-1} Optional but must be supplied if Secondary Course Name is supplied. This is the Main Subject of the Standard Tree. |
|
SecondaryCourseName | A | 60 | Description of course. Optional but must be supplied if Secondary Course Number is supplied. (ialdesc) {SACADO-10} |
|
ShortCourseIndicator |
A | 5 | Subject Endorsable Indicator {SACAD-10} If subject endorsable = 'Y' then <ShortCourseIndicator> = false If subject endorsable = 'N' then <ShortCourseIndicator> = true if subject endorsable = null then do not include <ShortCourseIndicator> in the entries file. |
|
SecondaryCourse | (End) | |||
SecondaryCourses | (End) | |||
LearnerEnrolments | (Start) | Distinct list of all students reported. Segment will be empty when no students are reported. |
||
FileTypeCode | A | 3 | Course Endorsement file type Must be 'FR' (Full Replacement) or UP (Update). Mandatory field |
|
LearnerEnrolment | (Start, Zero or more repetitions) | |||
LearnerDetails | (Start) | |||
NationalStudentNumber | A | 10 | Required field, value = {SREGB-1} Student Number (iadstno) | |
LearnerName | (Start) | |||
FirstName | A | 60 | Required field, value = {SREGB-1} First Names (iadnames) from beginning to first space | |
MiddleName | A | 30 | Not Required field, value = {SREGB-1} First Names (iadnames) from first space to next space | |
MiddleName | A | 30 | Not Required field, value = {SREGB-1} First Names (iadnames) from second space to the end | |
LastName | A | 60 | Required field, value = {SREGB-1} Surname (iadsurn) | |
LearnerName | (End) | |||
GenderCode | A | 1 | Required field, value = {SREGB-1} Gender (iadsex) | |
BirthDate | Date |
10 | Required field, value = {SREGB-1} Birth Date (t) format DD/MM/YYYY | |
LocalIdentifier | A | 10 | Required field, School's own unique student id, example" ABC4880 | |
EthnicityCode | N | 5 | Required field. Value = {GOPS-21} Body/Type MOE/ETH, Internal Code = {SREGB-1} Ethnic Group 1 (iadethn) |
|
EthnicityCode | N | 5 | Not Required field. Value = {GOPS-21} Body/Type MOE/ETH, External Code with Internal Code = {SREGB-1} Ethnic Group 2 (iadethn2) |
|
EthnicityCode | N | 5 | Not Required field. Value = {GOPS-21} Body/Type MOE/ETH, External Code with Internal Code = {SREGB-1} Ethnic Group 3 (iadethn3) |
|
IwiCode | N | 4 | Required field. Value = {GOPS-21} Body/Type MOE/IWI, External Code with Internal Code = {SREGB-1} IWI Code 1 (iadiwi1) |
|
IwiCode | N | 4 | Not Required field. Value = {GOPS-21} Body/Type MOE/IWI, External Code with Internal Code = {SREGB-1} IWI Code 2 (iadiwi2) |
|
IwiCode | N | 4 | Not Required field. Value = {GOPS-21} Body/Type MOE/IWI, External Code with Internal Code = {SREGB-1} IWI Code 3 (iadiwi3) |
|
CitizenCountryCode | A | 3 | Required field. Value = {GOPS-21} Body/Type NZQ/CIT, External Code with Internal Code = {SREGB-1} Citizenship 1 (iadcitz) |
|
Address | (Start) | |||
AddressLineText | A | 40 | Required field, value = {SREGB-1} First Line of Primary Postal Address | |
AddressLineText | A | 40 | Required field, value = {SREGB-1} Second Line of Primary Postal Address - Roll Data up e.g. from line 3 into line 2 where line 2 is empty and line 3 is not empty and so on. Display the postal code in the next available/empty address line and where all four lines are populated concatenate it to the line 4. | |
AddressLineText | A | 40 | Not Required field, value = {SREGB-1} Second Line of Primary Postal Address - Roll Data up e.g. from line 3 into line 2 where line 2 is empty and line 3 is not empty and so on. Display the postal code in the next available/empty address line and where all four lines are populated concatenate it to the line 4. | |
AddressLineText | A | 40 | Not Required field, value = {SREGB-1} Second Line of Primary Postal Address - Roll Data up e.g. from line 3 into line 2 where line 2 is empty and line 3 is not empty and so on. Display the postal code in the next available/empty address line and where all four lines are populated concatenate it to the line 4. | |
PostCode | N | 4 | Students Address Postal Code = {SREGB-1}. Optional |
|
Address | (End) | |||
LearnerDetails | (End) | |||
EnrolmentDetails | (Start) | Data from the student's primary qualification of the latest year | ||
EnrolmentDate | Date | 10 | Date student enrolled at this school = {SDREGA-1} (iagsdate). Mandatory field. |
|
WithdrawnIndicator | Indicates that the student has withdraw from all assessments {SREGC-3}, (iagcancreason, iagcancdate). Because we are not reporting standards for students who moved to other schools, the only time when the withdrawnflag will be Y will be when a student moved to another institution. |
|||
StudentTypeCode | A | 6 | Required
field. Value = {GOPS-21} Body/Type MOE/SST, External Code with Mnemonic = Qualification Registration Student Type (iagstudtype) and Internal Code = Qualification Registration Offering type (iagot) |
|
FundingYearLevelCode | N | 2 | Required field. Value = {GOPS-21} Body/Type MOE/CYL, Internal Code with External Code = Qualification Registration Study Period (iagperstudy). |
|
TertiaryReleaseIndicator | A | 5 | Not Required field. If Field 18 on Tab 'Coded Data' of {SSTUDS-3} for student and Service Code on SOD 'AA' for subsystem SR, on {SMNT-12} : N - value is null Y - value = Field 17; A blank value will translate to Y. |
|
StudentSortCode | Not Required field, value = NULL. | |||
PaymentAmount | N | 8 | Not Required field, value = Field 10 on Tab 'Coded Data' of {SSTUDS-3} for student and Service Code on SOD 'AA' for subsystem SR, on {SMNT-12} | |
Leaving Details | (Start) | This information will only be populated when:
|
||
LeavingDate | Date | 10 | Date student departed this School {SREGC-3}, (iagcancdate}. Optional but Mandatory if the Leaving Code is not blank. | |
LeavingCode | A | 1 | Reason student departed this School, {SREGC-3}, (iagcancreason). Optional but mandatory if Leaving Date is not blank. | |
Leaving Details | (End) | |||
ExamCentre | (Start) | Use coded data fields 14 - Exam Centre Type and 15 - Exam centre Provider number from Tab
'Coded Data' of {SSTUDS-3} for student and Service Code on SOD 'AA' for subsystem SR, on
{SMNT-12}. |
||
(ExamCentreDetails) ProviderNumber |
N | 5 | Correspondence School and Westmount use only | |
ProviderLocationNumber | Mandatory if Provider number is given.
|
|||
ExamCentre | (End) | |||
FinancialAssistanceDetails | (Start) | Use coded data fields 5 to 8 from Tab
'Coded Data' of {SSTUDS-3} for student and Service Code on SOD 'AA' for subsystem SR, on
{SMNT-12}. This information will only be reported when the data complies to the above processing rules regarding Financial Assistance Detail. |
||
FinancialAssistanceTypeCode | A | 1 | Financial Assistance Type Values = Field 5 - Financial Assistance Type Code: B = Benefit I = Inc, Internal Code = Qualification Registration Offering type (iagot) F = Family Optional field. |
|
CommunityServicesCardNumber | A | 15 | Mandatory if Assistance type = 'B'. Value = Field 6 - Benefit / CSC Number |
|
ApplicationNumber | A | 15 | Required field if Assistance Type is not NULL. Value = Field 8 - Application Number. |
|
NumberofStudentsCount | N | 2 | Required field if Assistance Type is not NULL. Value = Field 7 - Number of Students Count |
|
FinancialAssistanceDetails | (End) | |||
EnrolmentDetails | (End) | |||
NCEAEntries | (Start, Zero or more repetitions ) | Distinct list of standards to report. Check Processing rules regarding duplicates. Segment will be empty when there are no standards to report for the student. |
||
Entry | (Start) | |||
Standard | (Start) | |||
StandardNumber | N | 5 | Required field, value = {SACADO-10} Standard Code (ialnzqacode) | |
StandardVersionNumber | N | 2 | Required field, value = {SACADO-10} Standard Version (ialstdver) | |
ContextCode | N | 2 | Not Required field, value = NULL (need information from client) | |
Standard | (End) | |||
SecondaryCourseNumber | A | 3 | A unique identifier that links a standard to a subject for a student (SACAD-18} = (jqtstdnum), {SACADO-10} = (ialnzqacode). | |
TeReoPaperIndicator | A | 5 | Request
for a translated exam paper. Only valid for external
standard subjects, Evaluation Code for subject on {SACAD-14} is (E)xternal. Values: 1,0, True or False |
|
TeReoAnswerIndicator | A | 5 | Indicates the student will submit work. Applies to both external and internal standard subjects. Values: 1,0, True or False |
|
WithdrawnIndicator | A | 5 | Indicates Student has withdrawn from assessment in this entry. {SREGC-4} = (iahcancreason / iahcanceldate). Values: 1,0, True or False Because we are not reporting standards for students who moved to other schools, the only time when the withdrawnflag will be Y will be when a student moved to another institution. |
|
SecondaryResult | (Start) | |||
CompletionDate | Date | 10 | Required field if previous field is not NULL, value = {SSTUDY-21} Result Date (iaheresdate) | |
SecondaryResultCode | A | 5 | Assessed result for internal standard subject {SCODE-23}. Achievement Standards = A, M, E, N and V. Unit Standards = A, N, V or M (M only if indicated as allowed on Standards file. Optional but must be supplied if completed date is supplied. |
|
SecondaryResult | (End) | |||
AssessingProvider | (Start) | Linked to the subject. {SREGC-12}, {SDREGA-3} or {SSTUDY-36} - multi view or single view. |
||
ProviderNumber | N | 5 | MoE Provider Number, example: .498. Mandatory where standard is assessed by another provider. |
|
ProviderLocationNumber | N | 2 | Provider location code, value: 01 thru 99. Mandatory where standard is assessed by another provider. |
|
AssessingProvider | (End) | |||
Entry | (End) | |||
NCEAEntries | (End) | |||
LearnerEnrolment | (End) | |||
LearnerEnrolments | (End) | |||
LearnerRowCount | N | 6 | A count of learner records, example: 775. Mandatory |
|
EntryRowCount | N | 6 | A count of Standard records, example: 7550 | |
ReportingPerson | (Start) | |||
FullName | A | 255 | Full name of person submitting file to NZQA. Appended to file when file submitted to NZQA. Must be filled in once the file is uploaded. | |
EmailEAddress | A | 255 | E-mail address of person submitting file to NZQA. Appended to file when file submitted to NZQA. Must be filled in once the file is uploaded. | |
ReportingPerson | (End) | |||
CommentText | A | 255 | Comments supplied for this file for the Data Group. Appended to file when file submitted to NZQA. Optional but if needed must be filled in once the file is uploaded. |
|
|
Processing Rules |
|
---|---|
Use school / institution information {SNZQAR-8} / {SNZQAR-9} regarding approved exam centres to check for valid exam centres and report warning in PDF output. | |
Check for missing NSN number or Birthdate for the student and report warning in PDF output. |
Date | System Version | By Whom | Job | Description |
---|---|---|---|---|
15-Feb-2011 | v02.0.0.0 | Bea Swart | T161194 | New manual. |
18-Nov-2011 | v02.0.0.1 | Magda vd Schyff | F178415 | 173838: Extraction Type, XML Output, Date format
|
19-Oct-2011 | v02.0.0.2 | Magda van der Westhuizen | T179936 | New XML layout / fields. |
31-Jan-2012 | v02.0.0.3 | Phlip Pretorius | T178415 | Correct reference to fixed length file |
21-May-2012 | v02.0.0.4 | Bea Swart | T181113 | Change manual with new fixed data for NZQA T178250 |
11-Dec-2012 | v02.0.0.5 | Magda van der Schyff | T182256 | Update manual |
26-Jan-2019 |
v04.1.0.0 |
Frans Pelser |
T237245 |
Update Academic Structure references |