Ministry Interfaces {SMOE-1}

There are 7 specific interfaces that are talking to the Ministry of Education (MoE).

Student Get/Check {SMOE-1} (right click of Student Number on Tab Run Status)
Student Leavers {SMOE-1}
Student Arrivals {SMOE-1}
Roll Returns {SMOE-2}
SRT Download {SMOE-1}
SRT Upload {SMOE-1}
SRT Bulk Search {SMOE-4}

There is a transaction that must run at the start of each of these interface procedures that will check the connectivity between the SMS and the MoE. If connectivity cannot be established, then the actual request will not start.

Setup that needs to be done before this option can be run:
Click here to see more information on {BATCH-7}
Click here to see more information on {GOPS-21}
Click here to see more information on {SMNT-12}
Click here to see more information on {GCS2-18}

For function CT (Connectivity Test)
For function DEX (MoE Server)
For function ENROL Home URL
For function ARRIVALS
For function LEAVERS
For function RollReturn
For function SRTBULKNSN
For function SRTDOWN
For function SRTUPL

Processing rules for:
Arrivals
Leavers
SRTDownload
SRTUpload
Fields in this option:

Block 1: MoE Processes

Field	Type & Length	Description
Code	A10	Fixed Code that was located to the Process. For the processing rules click here, ARRIVALS, LEAVERS, SRTDOWN, SRTUPL
Description	A80	Description of the Process
Year	N4	Year on {GCS2-18} for Code 'MOE', Parameter Type 'YEAR'
Up to	DD-MON-YYYY	Start Date on {GCS2-18} for Code 'MOE', Parameter Type 'STARTDATE'
Ready	N10	Number of Students that is ready to be transferred to the Ministry
Errors	N10	Number of Students that has errors on them, go to next Tab to see more information
Ingore	N10	Number of Students that has been put on hold by the user. This typically happens if the user is aware of a problem with the student's detail and does not want the interface to include the student until further notice.
Identify the Students	Button	Identify all the students that should be included in a specific interface. I.e. if you are standing on the "LEAVERS" record and hit this button, the system will try to identify all students that have cancelled their enrollment at the school and should be notified as "moving to another school". For each record found, an entry will be created on the next block and will be included in the interface until successfully transferred to the MoE or flagged as Ignore.
Start the Above Process	Button	This will kick off the specific interface in bulk. It will pick up all the users identified via the first button and not flagged in the next block as "Ignore" and try to transfer the request to the MoE as individual transactions. The status on the next block will be updated. The user will be informed of the stages of process via the "Status" field. Note: After starting this process, the button description will change to "Stop" whick will allow the user to request the process to abort. After clicking on the "Stop" button the description will again chan ge to "Terminating" and will stay this way until the program was stopped. A terminate instruction will not stop with an abnormal end (abend) but will wait for the current student to be processed and will only stop before goin to the next student in the list. Because of this process, starting a transfer on the second block (right click on student number) will not supply the user with a "Stop" functionality as this process is only one student at a time and terminating the process will not be possible.
Status		This field will update while the "Start the Above Process" button was pressed to inform the user what is happening.

Example:

Block 2: Run Status

Field	Type & Length	Description
Process	N10	Description will display
Student	N9	Student Name (NSN Number) will display The following is available on Right click on the Student Number Check NSN Send Request Show Last Response When the interface process involved is an 'SRT Download' transaction and the transaction was successfull, the message will change to "Show Response Data". On choosing this option, the form will display 4 more tabs containing views into the actual XML response data as received from the MoE. Note that this information is NOT stored in ITS Database fields but are picked up directly from the XML as it is stored in the Document Storage System (DSR) of ITS. Purging of the DSR will remove these records and a user will then have to re-submit this request.
Year	YYYY	Registration Year
Stage	A1	Y - Ready (The record is ready to be transferred) N - Not Ready (User has put a Hold onto the record. It will be ignored) E - Errors (Record was transferred but had a problem. Will re-try next time) I - Invalid/Missing NSN Number (Cannot be included if the NSN Number is missing or wrong) S - Successfully Transferred. Transfer was done and an OK was received from the MoE
Status	A20	Status and Description fields will indicate what is wrong with a specific record. In most of the cases, this is a MoE supplied message.
Date	DD-MON-YYYY	The date of the last time that this record was updated/changed.

Example:

Tab 3: SRT Student Record

This tab only dispalys if the SRTUpload has been run successfully.

Data can only be queried here and the fields are:
Student Details
NSN Number, Has NZQA Registration Indicator, Highest Qualification, Ethnic Codes, Nationality, Home Language, Tuition Language, IWI Codes, Start Date,
Last Attendance Date, Eligibility, FTE Percent, Year Level, ORRS Status, Funding, E-mail, Addr 01, Addr 02, Land Line, Mobile, Fax, Phone, Notes

Cargiver Details (press down arrow to seen more records)
Title, Name, Surname, Is Primary, Is Emergency Contact, Is Paying Fees, Relationship, Other, Occupation, Address, Overseas, Land Line, Mobile, Fax, Phone, Spoken Language, E-mail
Example:

Tab 4: SRT Attendance Medical

This tab only dispalys if the SRTUpload has been run successfully.

Data can only be queried here and the fields are:
SRT Attencance Medical Details
NSN Number, Emergency Procedure, Service Care, Present, Justified Absent, Unjustified Absent

Doctor Details
Title, Name, Surname, Medical Centre, Address 01, E-mail, Land Line, Mobile, Fax, Phone

Dentist Details
Title, Name, Surname, Medical Centre, Address 01, E-mail, Land Line, Mobile, Fax, Phone

Immunisations Details
Code

Medical Conditions
Code, Severity, Note

Example:

Tab 5: SRT Standards

This tab only dispalys if the SRTUpload has been run successfully.

Data can only be queried here and the fields are:
NQF Credits Details
Level, Literacy, Numeracy, Total

Standards Details
Standard, Code, Version, Level, Credit, Type, Title, Purpose

Tab 6: SRT Results

This tab only dispalys if the SRTUpload has been run successfully.

ASTTLE Details
Type, Code, Date, Attitude, Desc, Overall Score, Level, Next Step, Deep Score, Level

Variable Details
Code, Score, Level

STAR Details
Form, Code, Date, Type, Summary, Year Level, Stanine, Next Step, Test Period, Code 1, Score 1, Code 2, Score 2, Code 3, Score 3, Code 4, Score 4, Code 5, Score 5, Code 6, Score 6
Example:

DETAILS ABOUT THE INFORMATION INCLUDED IN THE ARRIVALS, LEAVERS, SRTDOWN AND SRTUPL FILES.

Enter the directory that the files can be saved on {BATCH-7} System STUD, Function MOERR (Back to top of document)
Please note that in all cases where external conversion codes {GOPS-21} are used, the External Body is “MOE”. (Back to top of document)

External Code Type	Description	Internal Code	External Code	Mnemonic	How is this used in programs	Used In
ART	Address Role Type	Address Type on {SREGB-1}	Address Roll Type from the MoE		Use the Function and Parameter Type in {GCS2-18} (See additional Worksheet) to get the address Type (stored in the Parameter Value field) in order to pickup the specific address. Then use this address Type to do a lookup here in order to get the Role	Arrivals
CIT	Citizenship	Citizenship 1 on {SREGB-1}	Citizenship Code from the MoE		Match the values in ITS to the List	Arrivals
ELI	Eligibility Criteria	Study Permit Category on {SREGB-1}	Eligibility Criteria from the MoE	Sort order	Match the values in ITS to the list. NOTE: that if no conversion is setup for this ITS value, then the system will default to '20211' (Dependent of a valid Work Permit Holder) and then use the value in IADINDALIEN as follows: If "N", then use '20199' (NZ Citizen Incl Tokelau,The Cook Ils, Niue) if "P", then use '20200' (NZ Resident)	Arrivals
ETH	Ethnic	Ethnic Group 1, Ethnic Group 2 and Ethnic Group 3 on {SREGB-1}	Ethnic Group from the MoE	Sort order	Match the values in ITS to the List	Arrivals
IWI	IWI Codes	IWI Code 1, IWI Code 2 and IWI Code 3 on {SREGB-1}	IWI Codes from the MoE		Match the values in ITS to the List	Arrivals
IYC	Instructional Year Level	Qualification Study Period on {SSTUDY-21}	Instructional Year Level from the MoE		Match the values in ITS to the List	Arrivals
VDL	Verification Document Link	Eligibility Criteria (MoE Code)	Verification Document (MoE Code)	Certificate/Indicator on {SREGB-8}	Match each Eligibility Criteria (See list for ELI) with the set of possible types of verification Documents (See list for VDR) and then add the Certificate Seen indicator into the Mnemonic field that will point to the actual document.	Arrivals
VDR	Verification Document Rank	Sort of External Code	Verification Document (MoE Code)	Y should indicate if the Expiry Date is Mandatory for this Verification Document	No Matching needed to ITS values This set is used in order to get the best ranked Document if more than one type of legal verification document exist. Mnemonic value is used to indicate which of the Verification Documents needs an Expiry Date.	Arrivals
XO2	Exclude Offering Types	Qualification Offering Type			Exclude students that match all relevant offering types	Arrivals
XS2	Exclude Student Types	Qualification Offering Type		Qualification Student Type	Exclude students that match all relevant offering type / student type combinations	Arrivals

System Operation Definition {SMNT-12} (Back to top of document)

SOD Code	Subsystem	Descritpion	Note	Used In
DE	MI	Default Eligibility Code if No 'ELI'-Dependant of a valid work permit holder entry on {GOPS-21}	If Student does has a value in "Study permit Category" on {SREGB-1} but no value on {GOPS-21} (MOE, ELI) then use this value as default for Eligibility. Enter the Default Eligibility Code for the MoE here. (Old Eligibility 20211 - Dependent of a valid Word Permit holder), New Eligibility 60006 - Domestic Time-bound)	Arrivals
DW	MI	28 Day Waiver	Eligibility for 28 Day Waiver	Arrivals
ED	RE	Enrolment days for EFTS	"The number of days in which a student can be uncancelled. Note that this value is also used elsewhere and then indicates the number of days that a student does not need to return work since his/her registration. Default: 28"	Arrivals
EW	MI	Extended 28 Day Waiver	Eligibility for Extended 28 Day Waiver	Arrivals
FT	MI	Full Time Students	Qualification Offering Type to calculate the FTE for the student	Arrivals
NR	MI	MOE New Zeeland Resident Code	If Student does not have a value in "Study permit Category" and "Non Resident Indicator" on {SREGB-1} is 'P', then the student will get this as value for Eligibility. (Old Eligibility 20200 - NZ Resident, New Eligibility 60003 - NZ Resident)	Arrivals
NZ	MI	MOE New Zeeland Citizen Code	If Student does not have a value in "Study permit Category" and "Non Resident Indicator" on {SREGB-1} is 'N', then the student will get this as value for Eligibility. (Old Eligibility 20199 - NZ Citizen (incl. Tokelau, the Cook Island, Niue, New Eligibility 60001 - NZ Citizen (incl. Tokelau, the Cook Islands, Niue)	Arrivals
YA	MI	Young Adults	Qualification Offering Type to calculate the FTE for the student	Arrivals

B2b Parameters {GCS2-18} data needs to be set up for Code MOE, Function ARRIVALS, CT, DEX, LEAVERS, ROLLRETURN, SRTBULKNSN, SRTDOWN AND SRTUPL(Back to top of document)

These entries are used every time a request is made to the Ministry of education via a single sign on server. Depending on the content, the data will be forwarded to the correct machine for processing. All responses are then re-routed via this server.

Function ARRIVALS (Back to top of document)

Parameter Type

Parameter Name

Parameter Value

Explanation

Sequence

Reference Type

DPROC

stud.iyapkg.checkResponse

This is a function that check each Request. This value is set for each program and should not change.

EPROC

stud.iyapkg.checkRequest

This is a function that check each Response. This value is set for each program and should not change.

HDR

Content-Type

text/xml

This set the content type of the xml files

IYAACK

This defines the Stylesheet for this request. This value is set for each program and should not change.

INFC

XML

This indicates that the Above Stylesheet is in XML format.

INTC

REP

This indicates that the above Stylesheet is of type Report.

KEEPHISTORY

365

This is the number of days that the control records will be kept in {SMOE-1b2}

OUT

IYAREQ

This defines the Stylesheet for this request. This value is set for each program and should not change.

OUTFC

XML

This indicates that the Above Stylesheet is in XML format. This value is set for each program and should not change.

OUTTC

REP

This indicates that the above Stylesheet is of type Report. This value is set for each program and should not change.

PROXYHOST

If client uses a proxy server, this stores the url. Leave empty for Te Kura

PROXYPASS

If client uses a proxy server, this stores the User password. Leave empty for Te Kura

PROXYPORT

If client uses a proxy server, this stores the Port Number. Leave empty for Te Kura

PROXYUSER

If client uses a proxy server, this stores the Username. Leave empty for Te Kura

SERVICE

Set this to either the Test,Compliance or production service of the MoE.

Environment	WSDL URL / Name
Test	http://webtest.minedu.govt.nz/webservices/DEX-DexServiceX509-Tst-01.00.00.wsdl
Compliance	http://webtest.minedu.govt.nz/webservicescompl/DEX-DexServiceX509-Compl-01.00.00.wsdl
Production	http://web.minedu.govt.nz/webservices/DEX-DexServiceX509-Prd-01.00.00.wsdl

STARTDATE

This is the day that this interface will start looking for information on the system. This date gets updated after each search in order to stop posiible duplicates being picked up

STUDADRGENERIC

Defines an Address Type to use for this Communication. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Student System (IADBIO)

URL

This is the URL of the WSS Wrapper service supplied by the Moe and stored at http://wsswrapper.sourceforge.net/index.html
Something like "http://budgie.its.co.za:7123"

URLPATH

/wrapper

Set this to the path for above software

USEWALLET

If client uses a Secure service (SSL) set to "Y"

YEAR

This is the Year that the interface will be running against. To select the students.

Function CT (Back to top of document)

Parameter Type

Parameter Name

Parameter Value

Explanation

Sequence

Reference Type

DPROC

stud.iy8pkg.checkResponse

This is a function that check each Request. This value is set for each program and should not change.

EPROC

stud.iy8pkg.checkRequest

This is a function that check each Response. This value is set for each program and should not change.

HDR

Content-Type

text/xml

This set the content type of the xml files

IY8ACK

This defines the Stylesheet for this request. This value is set for each program and should not change.

INFC

XML

This indicates that the Above Stylesheet is in XML format.

INTC

REP

This indicates that the above Stylesheet is of type Report.

NSNCERT

Allows system to create a Cert Seen containing the NSN number and status. Add a Certificate Seen indicator for storing/updating the NSN Number and NSN number status against the student. Code is defined at {SCODE-22}

OUT

IY8REQ

This defines the Stylesheet for this request. This value is set for each program and should not change.

OUTFC

XML

This indicates that the Above Stylesheet is in XML format. This value is set for each program and should not change.

OUTTC

REP

This indicates that the above Stylesheet is of type Report. This value is set for each program and should not change.

PROXYHOST

If client uses a proxy server, this stores the url. Leave empty for Te Kura

PROXYPASS

If client uses a proxy server, this stores the User password. Leave empty for Te Kura

PROXYPORT

If client uses a proxy server, this stores the Port Number. Leave empty for Te Kura

PROXYUSER

If client uses a proxy server, this stores the User password

If client uses a proxy server, this stores the Username. Leave empty for Te Kura

SERVICE

Set this to either the Test,Compliance or production service of the MoE.

Environment	WSDL URL / Name
Test	http://webtest.minedu.govt.nz/webservices/DEX-DexServiceX509-Tst-01.00.00.wsdl
Compliance	http://webtest.minedu.govt.nz/webservicescompl/DEX-DexServiceX509-Compl-01.00.00.wsdl
Production	http://web.minedu.govt.nz/webservices/DEX-DexServiceX509-Prd-01.00.00.wsdl

URL

This is the URL of the WSS Wrapper service supplied by the Moe and stored at http://wsswrapper.sourceforge.net/index.html
Something like "http://budgie.its.co.za:7123"

URLPATH

/wrapper

Set this to the path for above software

USEWALLET

If client uses a Secure service (SSL) set to "Y"

Function DEX (Back to top of document)

Parameter Type	Parameter Name	Parameter Value	Explanation	Sequence	Reference Type
ID	PASSWORD		This is the MoE assigned password for a specific school – it is used to authenticate and authorize the sending schoo	1	V
ID	PROGVERS	v02.0.0.0	Version of the SMS used to send the message	1	V
ID	SCHOOLID	498	This is the MoE ID of the school used to identify the sender school. Defaults from {GCS-1}. Leave at 498 for Te Kura	1	V
ID	SCHOOLNAME		Name of the SMS used to send the message. Use something like "ITS Tertiary Software"	1	V
ID	SCHOOLUSER		This is the username of the user logged onto the SMS that is sending the message. Add an overriding value here if needed. If empty, the system will use the persons Oracle/ITS user. Suggest you keep it empty in order to differentiate between users.	1	V

Function HOME (Back to top of document)

Parameter Type	Parameter Name	Parameter Value	Explanation	Sequence	Reference Type
URL	x		This is the URL of the ENROL Home that will be used on the button on MoE Lookup, where the NSN Number can be checked	1	V

Function LEAVERS (Back to top of document)

Parameter Type

Parameter Name

Parameter Value

Explanation

Sequence

Reference Type

ACADEMICNOTES

Indicates if student has any academic related notes. Add a Note Type from {GCS2-10}.

ATTENDANCENOTES

Indicates if student has any attendance related notes. Add a Note Type from {GCS2-10}.

BEHAVIOURNOTES

Indicates if student has any behavour related notes. Add a Note Type from {GCS2-10}.

CUSTODIALNOTES

Indicates if student has any custodial related notes. Add a Note Type from {GCS2-10}.

DPROC

stud.iy9pkg.checkResponse

This is a function that check each Request. This value is set for each program and should not change.

EPROC

stud.iy9pkg.checkRequest

This is a function that check each Response. This value is set for each program and should not change.

HDR

Content-Type

text/xml

This set the content type of the xml files

HEALTHNOTES

Indicates if student has any health related notes. Add a Note Type from {GCS2-10}.

IY9ACK

This defines the Stylesheet for this request. This value is set for each program and should not change.

INFC

XML

This indicates that the Above Stylesheet is in XML format.

INTC

REP

This indicates that the above Stylesheet is of type Report.

KEEPHISTORY

365

This is the number of days that the control records will be kept in {SMOE-1b2}

LVRSREASON

PS2

This indicates the External conversion set that will contain the Result codes which will indicate a student becoming a "School Leaver". Add the external type to be used with an external body of "MOE" in {GOPS-21}.

LVRSRESULT

PS1

This indicates the External conversion set that will contain the cancellation reason codes which will indicate a student becoming a "School Leaver". Add the external type to be used with an external body of "MOE" in {GOPS-21}.

NOTECATEGORY

This is the Category for the following notes that will be used to see if a student has any of these types of notes. Note that these notes (if setup) will only send an indication that notes of this type exists. Add a Note Category from {GCS2-8}. If left empty, the net notes records wont be included in the logic. Please ensure that any of the note types used are linked to this Category, otherwise that note type will be ignored.

OUT

IY9REQ

This defines the Stylesheet for this request. This value is set for each program and should not change.

OUTFC

XML

This indicates that the Above Stylesheet is in XML format. This value is set for each program and should not change.

OUTTC

REP

This indicates that the above Stylesheet is of type Report. This value is set for each program and should not change.

PERSONALNOTES

Indicates if student has any personal notes. Add a Note Type from {GCS2-10}.

PROXYHOST

If client uses a proxy server, this stores the url. Leave empty for Te Kura

PROXYPASS

If client uses a proxy server, this stores the User password. Leave empty for Te Kura

PROXYPORT

If client uses a proxy server, this stores the Port Number. Leave empty for Te Kura

PROXYUSER

If client uses a proxy server, this stores the Username. Leave empty for Te Kura

SERVICE

Set this to either the Test,Compliance or production service of the MoE.

Environment	WSDL URL / Name
Test	http://webtest.minedu.govt.nz/webservices/DEX-DexServiceX509-Tst-01.00.00.wsdl
Compliance	http://webtest.minedu.govt.nz/webservicescompl/DEX-DexServiceX509-Compl-01.00.00.wsdl
Production	http://web.minedu.govt.nz/webservices/DEX-DexServiceX509-Prd-01.00.00.wsdl

STARTDATE

This is the day that this interface will start looking for information on the system. This date gets updated after each search in order to stop posiible duplicates being picked up

URL

This is the URL of the WSS Wrapper service supplied by the Moe and stored at http://wsswrapper.sourceforge.net/index.html
Something like "http://budgie.its.co.za:7123"

URLPATH

/wrapper

Set this to the path for above software

USEWALLET

If client uses a Secure service (SSL) set to "Y"

YEAR

This is the Year that the interface will be running against.

Function ROLLRETURN (Back to top of document)

Parameter Type

Parameter Name

Parameter Value

Explanation

Sequence

Reference Type

DPROC

stud.iyepkg.checkResponse

This is a function that check each Request. This value is set for each program and should not change.

EPROC

stud.iyepkg.checkRequest

This is a function that check each Response. This value is set for each program and should not change.

HDR

Content-Type

text/xml

This set the content type of the xml files

IYEACK

This defines the Stylesheet for this request. This value is set for each program and should not change.

INFC

XML

This indicates that the Above Stylesheet is in XML format.

INTC

REP

This indicates that the above Stylesheet is of type Report.

OUT

IYEREQ

This defines the Stylesheet for this request. This value is set for each program and should not change.

OUTFC

XML

This indicates that the Above Stylesheet is in XML format. This value is set for each program and should not change.

OUTTC

REP

This indicates that the above Stylesheet is of type Report. This value is set for each program and should not change.

PROXYHOST

If client uses a proxy server, this stores the url. Leave empty for Te Kura

PROXYPASS

If client uses a proxy server, this stores the User password. Leave empty for Te Kura

PROXYPORT

If client uses a proxy server, this stores the Port Number. Leave empty for Te Kura

PROXYUSER

If client uses a proxy server, this stores the Username. Leave empty for Te Kura

SERVICE

Set this to either the Test,Compliance or production service of the MoE.

Environment	WSDL URL / Name
Test	http://webtest.minedu.govt.nz/webservices/DEX-DexServiceX509-Tst-01.00.00.wsdl
Compliance	http://webtest.minedu.govt.nz/webservicescompl/DEX-DexServiceX509-Compl-01.00.00.wsdl
Production	http://web.minedu.govt.nz/webservices/DEX-DexServiceX509-Prd-01.00.00.wsdl

STARTDATE

This is the day that this interface will start looking for information on the system. This date gets updated after each search in order to stop posiible duplicates being picked up

STATSMONTH

This is the default Month for extracting Roll Return Statistics via stud.iyfpkg.stats_pipeline(). It can be overridden by supplying parameter 2 to above. Add month. Either 3 for March return or 7 for July return. Leave empty if supplied via statistics select.

STATSSEQ

This is the default Seq for extracting Roll Return Statistics via stud.iyfpkg.stats_pipeline(). It can be overridden by supplying parameter 1 to above. "Add Run number sequence as generated via {SMO-2}. Leave empty if supplied via statistics select."

STATSYEAR

This is the default Year for extracting Roll Return Statistics via stud.iyfpkg.stats_pipeline(). It can be overridden by supplying parameter 3 to above. "Add Year i.e 2011. Leave empty if supplied via statistics select."

URL

This is the URL of the WSS Wrapper service supplied by the Moe and stored at http://wsswrapper.sourceforge.net/index.html
Something like "http://budgie.its.co.za:7123"

URLPATH

/wrapper

Set this to the path for above software

USEWALLET

If client uses a Secure service (SSL) set to "Y"

YEAR

This is the Year that the interface will be running against.

Function SRTBULKNSN (Back to top of document)

Parameter Type

Parameter Name

Parameter Value

Explanation

Sequence

Reference Type

DPROC

stud.iydpkg.checkResponse

This is a function that check each Request. This value is set for each program and should not change.

EPROC

stud.iydpkg.checkRequest

This is a function that check each Response. This value is set for each program and should not change.

HDR

Content-Type

text/xml

This set the content type of the xml files

IYDACK

This defines the Stylesheet for this request. This value is set for each program and should not change.

INFC

XML

This indicates that the Above Stylesheet is in XML format.

INTC

REP

This indicates that the above Stylesheet is of type Report.

KEEPHISTORY

365

This is the number of days that the control records will be kept in {SMOE-1b2}

OUT

IYDREQ

This defines the Stylesheet for this request. This value is set for each program and should not change.

OUTFC

XML

This indicates that the Above Stylesheet is in XML format. This value is set for each program and should not change.

OUTTC

REP

This indicates that the above Stylesheet is of type Report. This value is set for each program and should not change.

PROXYHOST

If client uses a proxy server, this stores the url. Leave empty for Te Kura

PROXYPASS

If client uses a proxy server, this stores the User password. Leave empty for Te Kura

PROXYPORT

If client uses a proxy server, this stores the Port Number. Leave empty for Te Kura

PROXYUSER

If client uses a proxy server, this stores the Username. Leave empty for Te Kura

SERVICE

Set this to either the Test,Compliance or production service of the MoE.

Environment	WSDL URL / Name
Test	http://webtest.minedu.govt.nz/webservices/DEX-DexServiceX509-Tst-01.00.00.wsdl
Compliance	http://webtest.minedu.govt.nz/webservicescompl/DEX-DexServiceX509-Compl-01.00.00.wsdl
Production	http://web.minedu.govt.nz/webservices/DEX-DexServiceX509-Prd-01.00.00.wsdl

URL

This is the URL of the WSS Wrapper service supplied by the Moe and stored at http://wsswrapper.sourceforge.net/index.html
Something like "http://budgie.its.co.za:7123"

URLPATH

/wrapper

Set this to the path for above software

USEWALLET

If client uses a Secure service (SSL) set to "Y"

Function SRTDOWN (Back to top of document)

Parameter Type

Parameter Name

Parameter Value

Explanation

Sequence

Reference Type

DPROC

stud.iycpkg.checkResponse

This is a function that check each Request. This value is set for each program and should not change.

EPROC

stud.iycpkg.checkRequest

This is a function that check each Response. This value is set for each program and should not change.

HDR

Content-Type

text/xml

This set the content type of the xml files

IYCACK

This defines the Stylesheet for this request. This value is set for each program and should not change.

INFC

XML

This indicates that the Above Stylesheet is in XML format.

INTC

REP

This indicates that the above Stylesheet is of type Report.

KEEPHISTORY

365

This is the number of days that the control records will be kept in {SMOE-1b2}

LVRSREASON

PS2

LVRSRESULT

PS1

OUT

IYCREQ

This defines the Stylesheet for this request. This value is set for each program and should not change.

OUTFC

XML

This indicates that the Above Stylesheet is in XML format. This value is set for each program and should not change.

OUTTC

REP

This indicates that the above Stylesheet is of type Report. This value is set for each program and should not change.

PROXYHOST

If client uses a proxy server, this stores the url. Leave empty for Te Kura

PROXYPASS

If client uses a proxy server, this stores the User password. Leave empty for Te Kura

PROXYPORT

If client uses a proxy server, this stores the Port Number. Leave empty for Te Kura

PROXYUSER

If client uses a proxy server, this stores the Username. Leave empty for Te Kura

SERVICE

Set this to either the Test,Compliance or production service of the MoE.

Environment	WSDL URL / Name
Test	http://webtest.minedu.govt.nz/webservices/DEX-DexServiceX509-Tst-01.00.00.wsdl
Compliance	http://webtest.minedu.govt.nz/webservicescompl/DEX-DexServiceX509-Compl-01.00.00.wsdl
Production	http://web.minedu.govt.nz/webservices/DEX-DexServiceX509-Prd-01.00.00.wsdl

STARTDATE

This is the day that this interface will start looking for information on the system. This date gets updated after each search in order to stop posiible duplicates being picked up

URL

This is the URL of the WSS Wrapper service supplied by the Moe and stored at http://wsswrapper.sourceforge.net/index.html
Something like "http://budgie.its.co.za:7123"

URLPATH

/wrapper

Set this to the path for above software

USEWALLET

If client uses a Secure service (SSL) set to "Y"

YEAR

This is the Year that the interface will be running against.

Function SRTUPL (Back to top of document)

Parameter Type

Parameter Name

Parameter Value

Explanation

Sequence

Reference Type

CAREADRGENERIC

Defines an Address Type to use for this Address. Query the records using the code/function/parameterType and enter an Address Type into the parameter value field for Other Users (GAZPAT)

CAREADRGENERIC

Defines an Address Type to use for this Address. Query the records using the code/function/parameterType and enter an Address Type into the parameter value field for Student System (IADBIO)

CAREADRGENERIC

Defines an Address Type to use for this Address. Query the records using the code/function/parameterType and enter an Address Type into the parameter value field Personnel System (PAAPR1)

CAREADROVERSEAS

Defines an Address Type to use for this Address. Query the records using the code/function/parameterType and enter an Address Type into the parameter value field for Other Users (GAZPAT)

CAREADROVERSEAS

Defines an Address Type to use for this Address. Query the records using the code/function/parameterType and enter an Address Type into the parameter value field for Student System (IADBIO)

CAREADROVERSEAS

Defines an Address Type to use for this Address. Query the records using the code/function/parameterType and enter an Address Type into the parameter value field for Personnel System (PAAPR1)

CARECELLPHONE

Defines an Address Type to use for this Cell Phone Number. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Other Users (GAZPAT)

CARECELLPHONE

CAREEMAIL

Defines an Address Type to use for this E-mail. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Other Users (GAZPAT)

CAREEMAIL

Defines an Address Type to use for this E-mail. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Student System (IADBIO)

CAREEMAIL

Defines an Address Type to use for this E-mail. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Personnel System (PAAPR1)

CAREFAXNUMBER

Defines an Address Type to use for this Fax Number. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Other Users (GAZPAT)

CAREFAXNUMBER

Defines an Address Type to use for this Fax Number. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Student System (IADBIO)

CAREFAXNUMBER

Defines an Address Type to use for this Fax Number. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Personnel System (PAAPR1)

CARENOTECATEGORY

If setup, all notes of this category linked to the student will be included into the transfer to the Ministry. Add a Note Category from {GCS2-8}

CARETELGENERIC

Defines an Address Type to use for thisTelephone Number. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Other Users (GAZPAT)

CARETELGENERIC

Defines an Address Type to use for this Telephone Number. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Student System (IADBIO)

CARETELGENERIC

Defines an Address Type to use for this Telephone Number. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Personnel System (PAAPR1)

CARETELLANDLINE

Defines an Address Type to use for this Land Line Number. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Other Users (GAZPAT)

CARETELLANDLINE

DPROC

stud.iybpkg.checkResponse

This is a function that check each Request. This value is set for each program and should not change.

EPROC

stud.iybpkg.checkRequest

This is a function that check each Response. This value is set for each program and should not change.

HDR

Content-Type

text/xml

This set the content type of the xml files

IYBACK

This defines the Stylesheet for this request. This value is set for each program and should not change.

INFC

XML

This indicates that the Above Stylesheet is in XML format.

INTC

REP

This indicates that the above Stylesheet is of type Report.

KEEPHISTORY

365

This is the number of days that the control records will be kept in {SMOE-1b2}

LVRSREASON

PS2

LVRSRESULT

PS1

OUT

IYBREQ

This defines the Stylesheet for this request. This value is set for each program and should not change.

OUTFC

XML

This indicates that the Above Stylesheet is in XML format. This value is set for each program and should not change.

OUTTC

REP

This indicates that the above Stylesheet is of type Report. This value is set for each program and should not change.

PROXYHOST

If client uses a proxy server, this stores the url. Leave empty for Te Kura

PROXYPASS

If client uses a proxy server, this stores the User password. Leave empty for Te Kura

PROXYPORT

If client uses a proxy server, this stores the Port Number. Leave empty for Te Kura

PROXYUSER

If client uses a proxy server, this stores the Username. Leave empty for Te Kura

SERVICE

Set this to either the Test,Compliance or production service of the MoE

Environment	WSDL URL / Name
Test	http://webtest.minedu.govt.nz/webservices/DEX-DexServiceX509-Tst-01.00.00.wsdl
Compliance	http://webtest.minedu.govt.nz/webservicescompl/DEX-DexServiceX509-Compl-01.00.00.wsdl
Production	http://web.minedu.govt.nz/webservices/DEX-DexServiceX509-Prd-01.00.00.wsdl

STARTDATE

This is the day that this interface will start looking for information on the system. This date gets updated after each search in order to stop posiible duplicates being picked up

STUDADRGENERIC

Defines an Address Type to use for this Address

STUDCELLPHONE

Defines an Address Type to use for this Address. Query the records using the code/function/parameterType and enter an Address Type into the parameter value field for Student System (IADBIO)

STUDEMAIL

Defines an Communication Type to use for this E-mail. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Student System (IADBIO)

STUDFAXNUMBER

Defines an Communication Type to use for this Fax Number. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Student System (IADBIO)

STUDTELGENERIC

Defines an Communication Type to use for this Telephone Number. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Student System (IADBIO)

STUDTELLANDLINE

Defines an Communication Type to use for this Land Line Number. Query the records using the code/function/parameterType and enter an Communication Type into the parameter value field for Student System (IADBIO)

URL

This is the URL of the WSS Wrapper service supplied by the Moe and stored at http://wsswrapper.sourceforge.net/index.html
Something like "http://budgie.its.co.za:7123"

URLPATH

/wrapper

Set this to the path for above software

USEWALLET

If client uses a Secure service (SSL) set to "Y"

YEAR

This is the Year that the interface will be running against.

Arrivals (iyapkg.sql) (Back to top of document)

Processing rules:

Select all students that has a qualification registration for the year {GCS2-18} (MOE, ARRIVALS, Year)
Include if the qualification Offering Type is equal to the SOD(FT,MI) OR if the Offering Type is not equal to the SOD then there should be subjects for the same year, qualification number and student number
Exclude where the qualification, Offering Type {GOPS-21} (MOE, XO2)
Exclude where the qualification, Offering Type, Student type Combination {GOPS-21} (MOE, XS2)
Cancelled Student enrollments that is uncacnelled within a "28" day period, will be picked up as an "Arrival student" BUT if more than "28" days has gone past since the cancellation an uncancelling of the orignal record will not flag this student as an "Arrival". Suggest to the client to re-enroll this student. Use the number of days from {SMNT-12} (RE, ED), iF this value is not a number: Reset to 28

Required Core Identity Details

Attribute	Validation Rules	Data obtained from	Database reference
Enrolled At	This is the official MOE number of the calling school This must be the same as the schoolID in the parameters section of the XML message	Code MOE, Function DEX, Parameter Type ID and Parameter Name SCHOOLID as from {GCS2-18}	GMKPARVAL from GMKPSS
NSN	must be 10 digit numeric with leading zeros and valid check digit	NSN Number as from {SREGB-1}	IADNSN from IADBIO
Gender	must be either male or female XML message must be populated with M of F	Gender as from {SREGB-1}	IADSEX from IADBIO
Date of Birth (DOB)	must be a valid date must be in the past	Birthdate as from {SREGB-1}	IADBIRDATE from IADBIO

Required Data

Attribute	Validation Rules	Data obtained from	Database reference
First day of attendance (FDA)	must be a valid date must be less than or equal to the current date	Qualification Registration Date.	IAGDATE from IAGENR
Entry year level	numeric, must be between 1 and 13 must be valid for the school type	On {GOPS-21} for External Body-MOE and External Code Type-IYC and Internal Code-Study Period on {SSTUDY-21}	IAGPERSTUDY from IAGENR
Eligibility Criteria	Entry must be restricted to the list of Eligibility Criteria the XML message must be populated with the code	If Study Permit Category is not NULL use {GOPS-21} for External Body-MOE and External Code Type-ELI and Internal Code-Study Permit Category on {SREGB-1} If Study Permit Category is NULL, check the Non Resident Indicator if the value is 'N' the Eligibility Criteria is SOD (NZ,MI) = 'NZ Citizen (Incl Tokelau,The Cook Ils, Niue)' on {SMNT-12} if the value is 'P' the Eligibility Criteria is SOD (NR,MI) = 'NZ Resident' {SMNT-12}	IADSPCCODE from IADBIO IADINDALIEN from IADBIO
FTE	Entry must be restricted to the list between 0.0 and 1.0	Use the Student's Qualification Offering Type to determine the value of FTE. If the student has the same value as SOD (FT,MI) on {SMNT-12} then the FTE value is set to 1.0 If the student has the same value as SOD (YA,MI) on {SMNT-12} then use the main stubjects to calculate what the FTE value should be.: For 1 Main Subject set FTE value to 0.2 For 2 Main Subject set FTE value to 0.4 For 3 or more Main Subject set FTE value to .1 Any other Offering Type will get a FTE value of 0.0	IAGOT from IAGENR

Optional Arrival Data

Attribute

Validation Rules

Data obtained from

Database reference

Verification Document Type

Entry must be restricted to this list supplied by the Ministry
the XML message must be populated with the code

Get the Type of Verification Document available for this Criteria. on {GOPS-21} for Get the Type of Verification Document available for this Criteria.
On {GOPS-21} for External Body-MOE and External Code Type-VDL and External Code is MoE Verification Document, Internal Code is MoE Eligibility Code, Mnemonic is the internal certificate on {SREGB-8}.
Also on {GOPS-21} for External Body-MOE and External Code Type-VDR External Code is MoE Verification Document, Internal Code is the sort/ranking and Mnemonic use ‘Y’ to indicate that Document Date is compulsory

IDICERT from IDICER

Verification Document Serial Number

Must be alphanumeric, up to 50 characters in length
Must be included if Verification Document Type has been included
Must not be present if Verification Document Type has not been included

Council Number on {SREGB-8} for Certificate/Indicator in previous field

IDIRNUM from IDICER

Document Expiry Date

Must be a valid date
Must only be present if Verification Document is one of:

Code	Eligibility Criteria
61023	Visa Domestic
61024	Visa with conditions of study
61031	Principal Discretion
61032	MoE Approval

Must be no more than 1 year in the past and no more than 50 years in the future

Date will only be included if the Date is not empty on {SREGB-8} and if the certificate is indicate on {GOPS-21} External Body-MOE and External Code Type-VDR External Code is MoE Verification Document, Internal Code is the sort/ranking and Mnemonic use ‘Y’ to indicate that Document Date is compulsory

IDIEXPDAT from IDICER
if NULL
use IADALIENPERMIT from IADBIO

Exchange Scheme

is required if the Eligibility Criteria is 20215 -Student on Government approved exchange scheme
must not be incuded with any other Eligibility Criteria
entry must be rectricted to the list supplied by the Ministry
the XML message must be populated with the code

Not applicable

Citizenship

Entry must be restricted to the list supplied by the Ministry
the XML message must be populated with the code
must be included if Verification Document Type has been included
must not be present if Verification Document Type has not been included

Note: Only one Citizenship can be supplied - it must therefor be the one that corresponds to the eligibility criteria

On {GOPS-21} for External Body-MOE and External Code Type-CIT and Internal Code-Citizenship on {SREGB-1}

IADCITZ from IADBIO

Ethnicity (1 to 3)

entry must be restricted to the list supplied by the Ministry
the XML message must be populated with the code

On {GOPS-21} for External Body-MOE and External Code Type-ETH and Internal Code-Ethnic 1 on {SREGB-1}
On {GOPS-21} for External Body-MOE and External Code Type-ETH and Internal Code-Ethnic 2 on {SREGB-1}
On {GOPS-21} for External Body-MOE and External Code Type-ETH and Internal Code-Ethnic 3 on {SREGB-1}

IADETHN from IADBIO
IADETHN2 from IADBIO
IADETHN3 from IADBIO

Iwi (1 to 3)

entry must be restricted to the list supplied by the Ministry
the XML message must be populated with the code

On {GOPS-21} for External Body-MOE and External Code Type-IWI and Internal Code-Iwi 1 on {SREGB-1}
On {GOPS-21} for External Body-MOE and External Code Type-IWI and Internal Code-Iwi 2 on {SREGB-1}
On {GOPS-21} for External Body-MOE and External Code Type-IWI and Internal Code-Iwi 3 on {SREGB-1}

IADIWI1 from IADBIO
IADIWI2 from IADBIO
IADIWI3 from IADBIO

Address

Include the following attributes:

steet name and number, mandatory
suburb/RD, optional
town/city, mandatory
post code, optional

Note: while the address as a whole is optional - if a address is included then at least street name and number and town/city must be present

Get the students address on {SREGB-1} for Address Type on {GCS2-18} where the Code MOE, Function ARRIVALS, Parameter Type STUDADRGENERIC.

Address Type is then converted on {GOPS-21} for External Body-MOE and Address Type-ART and Internal Code-Address Type on {SREGB-1}

GETADDR1 from GETARD
GETADDR2 from GETARD
GETADDR3 from GETARD
GETADDR4 from GETARD
GETPCODE from GETARD

Weekly Tuition Fee

must be numeric with two decimal places
must be greater than 0.00
mustonly be included if the Eligibility Criteria of the student is 20213 - International Fee Paying

Not applicable

Leavers (iy9pkg.sql)(Back to top of document)

Processing rules:

Get all students that has einter a Qualification Result Code (linked on {GOPS-21} for External Body-MOE and External Code Type-Code on Parameter value as defined on {GCS2-18} Code MOE, Function DEX, Parameter Type LEAVERS and Parameter Name LVRSRESULT and Internal Code-Qual Result on {SDREGA-1}) or a Qualification Cancelation Reason (linked on {GOPS-21} for External Body-MOE and External Code Type-Code on Parameter value as defined on {GCS2-18} Code MOE, Function DEX, Parameter Type LEAVERS and Parameter Name LVRSREASON and Internal Code-Qual Result on {SDREGA-1} )
Exclude where the qualification, Offering Type {GOPS-21} (MOE, XO2)
Exclude where the qualification, Offering Type, Student type Combination {GOPS-21} (MOE, XS2)

Required Core Identity Details

Attribute	Validation Rules	Data obtained from	Database reference
Enrolled At	This is the official MOE number of the calling school This must be the same as the schoolID in the parameters section of the XML message	Code MOE, Function DEX, Parameter Type ID and Parameter Name SCHOOLID as from {GCS2-18}	GMKPARVAL from GMKPSS
NSN	must be 10 digit numeric with leading zeros and valid check digit	NSN Number as from {SREGB-1}	IADNSN from IADBIO
Gender	must be either male or female XML message must be populated with M of F	Gender as from {SREGB-1}	IADSEX from IADBIO
Date of Birth (DOB)	must be a valid date must be in the past	Birthdate as from {SREGB-1}	IADBIRDATE from IADBIO

Required Data

Attribute

Validation Rules

Data obtained from

Database reference

Last day of attendance

must be a valid date
can be in the past and up to 1 month into the future

If the student's qualification cancel date {SREGC-3} is less than the registration end date use the cancel date as Last day of attendance,
If Last day of attendance is grater than System Date (Today's date) then make Last day of attendance NULL(blank)
If Last day of attendance is NULL
Check if there is an application {SNAPPA-1} with a cancel date
Use the application cancel date as the Last day of attendance,
If Last day of attendance is grater than system date then make last day of attendance NULL

IAGCANCDATE FROM IAGENR
IAGEDATE FROM IAGENR
IERCANCDATE FROM IERAAD

Leaving year level

numeric, must be between 1 and 13
must be valid for the schools school type

Get the student's qualification study period on {SDREGA-1}
OR
Get the application study period on {SNAPPA-1}
Convert the Study Period with {GOPS-21} for External Body-MOE and External Code Type-IYC and Internal Code-Qual Study Period on {SDREGA-1} or {SNAPPA-1}.

IAGPERSTUDY FROM IAGENR
IERPERSTUDY FROM IERAAD

Leaving reason

Entry must be restricted to the list of Leaving Reason
The SMS user must be shown the textual values rather than the codes
The XML message must be populated with the code

Code	Text
S	Transferred to another school in NZ
H	Trafnsferring to home-schooling
O	Gone Overseas	1)
D	Deceased
X	Expulsion	1) 2)
L	End of Schooling	1) 2)
E	Granted Early Exemption	1) 3)
K	Exclusion	4)
C	Continuous Absence

The following additional rules apply:

1) If code = O, X, L or E	Post School activity is mandatory
2) If code = X or L	Last day of attendance must be > (DOB + 15 years + 10 months)
3) If code = E	(DOB + 14 years + 10 months) < Last day of attendance > DOB + 16 years
4) If code = K	Last day of attendance

If Qualification Result is not NULL

get the conversion code for Leaving Reason on {GOPS-21} for External Body-MOE and External Code Type-SLR and Internal Code-Qual Result on {SDREGA-1}

If Qualification Result is NULL

get the conversion code for Leaving Reason on {GOPS-21} for External Body-MOE and External Code Type-RFL and Internal Code-Qual Cancel Reason on {SDREGA-1}

IAGRESULT FROM IAGENR
IAGCANCREASON FROM IAGENR

Post-school Activity

is mandatory if Leaving reason is O, X, L or E
must not be included if leave reason is S, H, D, K or C
entry must be restricted to this list
the SMS user must be shown the textual values rather than the codes
the XML message must be populated with the code

Code	Activity
10	Further Education or Training
11	Employment and further education/training
12	Employment
13	Other
88	Unknown

If converted Leaving Reason (previous field) has the value of L or O or X or E

If Qualification Result is not NULL

then Post-school Activity is converted on {GOPS-21} for External Body-MOE and External Code Type-Code

on Parameter value as defined on {GCS2-18} Code MOE, Function DEX, Parameter Type LEAVERS and Parameter Name LVRSRESULT

and Internal Code-Qual Result on {SDREGA-1}

If Qualification Result is NULL

then Post-school Activity isconverted on {GOPS-21} for External Body-MOE and External Code Type-Code

on Parameter value as defined on {GCS2-18} Code MOE, Function DEX, Parameter Type LEAVERS and Parameter Name LVRSREASON

and Internal Code-Qual Cancel Reason on {SDREGA-1}

IAGRESULT FROM IAGENR
IAGCANCREASON FROM IAGENR

Teaching and Learing notes Academic Indicator

indicator – most likely to be represented by tick-boxes on the front end
The XML message must be populated with either true or false

Use the Note Code from Code MOE, Function LEAVERS and Parameter Type ACADEMICNOTES as from {GCS2-18}

This is the Category for the following notes that will be used to see if a student has any of these types of notes. Note that these notes (if setup) will only send an indication that notes of this type exists. Add a Note Category from {GCS2-8}. If left empty, the net notes records wont be included in the logic. Please ensure that any of the note types used are linked to this Category, otherwise that note type will be ignored.

FROM VIEW GEN.G40V_NOTES_AND_CORR

Teaching and Learing notes Attendance Indicator

indicator – most likely to be represented by tick-boxes on the front end
The XML message must be populated with either true or false

Use the Note Code from Code MOE, Function LEAVERS and Parameter Type ATTENDANCENOTES as from {GCS2-18}

This is the Category for the following notes that will be used to see if a student has any of these types of notes. Note that these notes (if setup) will only send an indication that notes of this type exists. Add a Note Category from {GCS2-8}. If left empty, the net notes records wont be included in the logic. Please ensure that any of the note types used are linked to this Category, otherwise that note type will be ignored.

FROM VIEW GEN.G40V_NOTES_AND_CORR

Teaching and Learing notes Behavioural Indicator

indicator – most likely to be represented by tick-boxes on the front end
The XML message must be populated with either true or false

Use the Note Category from Code MOE, Function LEAVERS and Parameter Type BEHAVIOURNOTES as from {GCS2-18}

This is the Category for the following notes that will be used to see if a student has any of these types of notes. Note that these notes (if setup) will only send an indication that notes of this type exists. Add a Note Category from {GCS2-8}. If left empty, the net notes records wont be included in the logic. Please ensure that any of the note types used are linked to this Category, otherwise that note type will be ignored.

FROM VIEW GEN.G40V_NOTES_AND_CORR

Teaching and Learing notes Custodial Indicator

indicator – most likely to be represented by tick-boxes on the front end
The XML message must be populated with either true or false

Use the Note Category from Code MOE, Function LEAVERS and Parameter Type CUSTODIALNOTES as from {GCS2-18}

This is the Category for the following notes that will be used to see if a student has any of these types of notes. Note that these notes (if setup) will only send an indication that notes of this type exists. Add a Note Category from {GCS2-8}. If left empty, the net notes records wont be included in the logic. Please ensure that any of the note types used are linked to this Category, otherwise that note type will be ignored.

FROM VIEW GEN.G40V_NOTES_AND_CORR

Teaching and Learing notes Health Indicator

indicator – most likely to be represented by tick-boxes on the front end
The XML message must be populated with either true or false

Use the Note Category from Code MOE, Function LEAVERS and Parameter Type HEALTHNOTES as from {GCS2-18}

This is the Category for the following notes that will be used to see if a student has any of these types of notes. Note that these notes (if setup) will only send an indication that notes of this type exists. Add a Note Category from {GCS2-8}. If left empty, the net notes records wont be included in the logic. Please ensure that any of the note types used are linked to this Category, otherwise that note type will be ignored.

FROM VIEW GEN.G40V_NOTES_AND_CORR

Teaching and Learing notes Personal Indicator

indicator – most likely to be represented by tick-boxes on the front end
The XML message must be populated with either true or false

Use the Note Category from Code MOE, Function LEAVERS and Parameter Type PERSONALNOTES as from {GCS2-18}

This is the Category for the following notes that will be used to see if a student has any of these types of notes. Note that these notes (if setup) will only send an indication that notes of this type exists. Add a Note Category from {GCS2-8}. If left empty, the net notes records wont be included in the logic. Please ensure that any of the note types used are linked to this Category, otherwise that note type will be ignored.

FROM VIEW GEN.G40V_NOTES_AND_CORR

Optional Data

Attribute

Validation Rules

Data obtained from

Database reference

Intended region

Entry must be restricted to this list

Code	Region	Code	Region
999	Area Outside Territorial Authority	5	North Shore City
63	Ashburton District	27	Opotiki District
7	Auckland City	18	Othorohanga District
61	Banks Peninsula District	40	Palmerston North
55	Buller District	9	Papkura District
49	Carterton District	44	Porirua City
31	Central Hawkes Bay	70	Queenstown-Lakes District
69	Central Otago District	38	Rangitikei District
67	Chatham Islands	4	Rodney District
60	Christchurch City	24	Rotorua District
72	Clutha District	36	Ruapehu District
71	Dunedin City	62	Selwyn District
1	Far North District	35	South Taranaki District
10	Franklin District	19	South Waikato District
28	Gisborne District	50	South Wairarapa District
74	Gore District	73	Southland District
56	Grey District	34	Stratford District
16	Hamilton City	41	Tararua District
30	Hastings District	51	Tasman District
12	Hauraki District	21	Taupo District
42	Horowhenua District	23	Tauranga District
58	Hurunui District	11	Thames-Coromandel District
75	Invercargill City	64	Timaru District
54	Kaikoura District	45	Upper Hutt City
3	Kaipara District	13	Waikato District
43	Kapiti Coast District	59	Waimakariri District
26	Kawerau District	66	Waimate District
46	Lower Hutt City	17	Waimate District
39	Manawatu District	29	Wairoa District
8	Manukau City	6	Waitakere City
53	Marlborough District	68	Waitaki District
48	Masterton District	20	Waitomo District
15	Matamata-Piako District	37	Wanganui District
65	Mc Kenzie District	47	Wellington City
31	Napier City	22	Western Bay of Plenty District
52	Nelson City	57	Westland District
33	New Plymouth District	25	Whakatane District
		2	Whangarei District

The SMS user must be shown the textual values rather than the codes
The XML message must be populated with the code

Not Applicable

Intended Destination School (1 to 6)

Entry must be restricted to this list of current schools
The SMS user must be shown the school names rather than the codes
The XML message must be populated with the MOE school Number (numeric 1 to 4 digits)

If Moving Provider Type is 'S'

get the conversion code for Provider on {GOPS-21} for External Body-MOE and External Code Type-SID and Internal Code-Moving Provider on {SDREGC-3}

If Moving Provider Type is 'I'

get the conversion code for Provider on {GOPS-21} for External Body-MOE and External Code Type-INS and Internal Code-Moving Provider on {SDREGC-3}

IAGMOVPROVIDER From IAGENR

SRTDownload (iycpkg.sql) (Back to top of document)

Processing rules:

The SRT Download transaction can supply a lot of information that has been uploaded by the previous school for a specific student. This information contains elements like doctor/dentist information, caregiver contact detail as well as ASSTLE and STAR details. This transaction can also contain any NQF credits and Standards that the student has received previously. Please not that this information is not loaded into the standard ITS tables but are supplied as view-only.
When the interface process involved is an 'SRT Download' transaction and the transaction was successfull, the message will change to "Show Response Data" on right click of the Student Number. On choosing this option, the form will display 4 more tabs containing views into the actual XML response data as received from the MoE. Note that this information is NOT stored in ITS Database fields but are picked up directly from the XML as it is stored in the Document Storage System (DSR) of ITS. Purging of the DSR will remove these records and a user will then have to re-submit this request.

Required Core Identity Details

Attribute	Validation Rules	Data obtained from	Database reference
NSN	must be 10 digit numeric with leading zeros and valid check digit	NSN Number as from {SREGB-1}	IADNSN from IADBIO

SRTUpload (iybpkg.sql) (Back to top of document)

Processing rules:

Get all students that has einter a Qualification Result Code (linked on {GOPS-21} for External Body-MOE and External Code Type-Code on Parameter value as defined on {GCS2-18} Code MOE, Function DEX, Parameter Type LEAVERS and Parameter Name LVRSRESULT and Internal Code-Qual Result on {SDREGA-1})

OR
a Qualification Cancelation Reason (linked on {GOPS-21} for External Body-MOE and External Code Type-Code on Parameter value as defined on {GCS2-18} Code MOE, Function DEX, Parameter Type LEAVERS and Parameter Name LVRSREASON and Internal Code-Qual Result on {SDREGA-1} )

Exclude where the qualification, Offering Type {GOPS-21} (MOE, XO2)
Exclude where the qualification, Offering Type, Student type Combination {GOPS-21} (MOE, XS2)

Get eligibility status by doing an external lookup using Study Permit Category

if Study Permit Caregory IS NULL, check the Non Resident indicator

IF Study Permit Category is used

If nothing found, then use '20211' : 'Dependant of a valid Work Permit Holder'

If not, then check the Non-Resident Indicator

'20199' = 'NZ Citizen (Incl Tokelau,The Cook Ils, Niue)'

'20200' = 'NZ Resident'

c1_rec.iadspccode IS NOT NULL

Get First Schooling date at ANY institution
For this report, I am assuming the input year as the Roll Return Year
For this report, I am assuming the 1st of July as the "Official" Roll Return date at all times.

Get the ORRS Status

NOTE: Available values is:
: N - Not an ORRS student
: H - A High Level ORRS Student
: V - A Very High Level ORRS Student

Get the Caregivers detail {GCS2-28}

NOTE: Only legal ext. values for the relationship code( See ikxetr "MOE"/"REL")
01:Mother
02:Father
03:Aunt
04:Uncle
05:Brother
06:Sister
07:Parent
08:Legal Guardian
09:Other
10:Grandfather
11:Grandmother
NOTE: For PRC,EMY,ENC,FPP The client needs only to add the relevant
: JRMRELAT codes into the Internal fields and dont bother with external info

                     AND r.ikxextbody(+) = 'MOE' AND r.ikxextctype(+) = 'REL'
                     AND p.ikxextbody(+) = 'MOE' AND p.ikxextctype(+) = 'PRC'
                     AND e.ikxextbody(+) = 'MOE' AND e.ikxextctype(+) = 'EMY'
                     AND n.ikxextbody(+) = 'MOE' AND n.ikxextctype(+) = 'ENC'
                     AND f.ikxextbody(+) = 'MOE' AND f.ikxextctype(+) = 'FPP'

Get all notes linked to a specific category

NOTE: multiple notes can be stored in the XML
v_noteCategory := stud.iy8pkg.getB2Bval('SRTUPL','CARENOTECATEGORY');

Send all relative Assessment and Attendance data

NOTE: The following parts are ignored because it is not Applicable to client TCS
: Ignoring Medical procedures
: Ignoring: Emergency procedures
: Ignoring: Doctors info
: Ignoring: Dentists info
NOTE: NQF Credits (See Task 161192) for New table
Get the summarized NQF Credit detail for all years before this one

Get the detailed NQF Credit for this year

ASTTLE info (See Task 160713/4,

Tables JTBESD/JTCESA)
Get the e-asTTle info (See tasks 160713/4, {SREGMS-7}

STAR info (See Task 160948,

Tables JSUSSN/JSVSNE)
Get the STAR Results info (See task 160948, {SREGMS-5}

Note: These 3 fields are mandatory for Assessment and Attendance
: BUT since client does not store/maintain this info,
: we are forced to default zero
add_node('halfDayCount','0',v_dataNode);
add_node('absentCount','0',v_dataNode);
add_node('awolCount','0',v_dataNode);

Required Core Identity Details

Attribute	Validation Rules	Data obtained from	Database reference
NSN	must be 10 digit numeric with leading zeros and valid check digit	NSN Number as from {SREGB-1}	IADNSN from IADBIO
Gender	must be either male or female XML message must be populated with M of F	Gender as from {SREGB-1}	IADSEX from IADBIO
Date of Birth (DOB)	must be a valid date must be in the past	Birthdate as from {SREGB-1}	IADBIRDATE from IADBIO
Enrolled At	This is the schools MoE number of the calling school This must be the same as the schoolID in the parameters section of the XML message	Code MOE, Function DEX, Parameter Type ID and Parameter Name SCHOOLID as from {GCS2-18}	GMKPARVAL from GMKPSS

Optional Data

Attribute

Validation Rules

Data obtained from

Database reference

Intended Destination School (1-6)

This attribute is optional
This attribute may be repeated up to 6 times
Entry must be restricted to this list of current schools
The XML message must be populated with the MOE school number (numeric 1 to 4 digits)

We only store one Destination as the Moving Provider.
If Moving Provider Type is 'S'

get the conversion code for Provider on {GOPS-21} for External Body-MOE and External Code Type-SID and Internal Code-Moving Provider on {SDREGC-3}

If Moving Provider Type is 'I'

get the conversion code for Provider on {GOPS-21} for External Body-MOE and External Code Type-INS and Internal Code-Moving Provider on {SDREGC-3}

IAGMOVPROVIDER From IAGENR

List of fields in xml/xsl object (delete if not applicable):

See Also:

Procedures:

None

History of Changes

Date	System Version	By Whom	Job	Description
17-Mar-2011	v02.0.0.0	Bea Swart	T160942	New manual.
14 -Mar-2012	v02.0.0.1	Bea Swart	T177842	Changes that the MoE has on Arrival Upload Specification for SMS VendorsV1.2.doc
14-Sep-2012	v02.0.0.2	Bea Swart	T182802	On Arrivals, inclide Full Time students no matter if they have subjects or not.