ADMJ3900 - Batch CHESSN Allocation Request Report

Purpose

This function enables the submission of batch requests to HEIMS for CHESSN Allocation or retrieval from the HEIMS database.

Subsystem Admissions
Normally Run By Administration Specialist
Anticipated Frequency As required
Structure There is no parameter form for this job, however Message Box (6636) displays: 'No parameters exist for this job. Do you wish to schedule the job to run as soon as possible?'

 

This job enables the submission of batch requests to HEIMS for Student CHESSN Details from the HEIMS database. The function:

  • Checks the Batch Limit

    The maximum number of requests per day (HEIMS time) is defined in the configuration form ORGF0123.

  • Creates a Request Record

    In the context of processing the request, the request statuses and their meanings are:

Status HEIMS Request Status Meaning
PENDING NULL Request has been created but not submitted to HEIMS.
PROGRESS SUCCESS The request was received successfully by HEIMS.
FAILED DUPLICATE

HEIMS have rejected the request because it has already been used in a CHESSN request.

Callista will treat the request as complete so that students included in this request can be included in another.

FAILED ARCHIVE Shouldn’t occur as would be a DUPLICATE request as per above.
FAILED FAILURE HEIMS have rejected the request because of an invalid ClientOrganisationCode, access is denied or the request id has already been used for another request type.
FAILED NULL SOAP error. No status received from HEIMS.
  • Identifies Students for Inclusion in the Request

    The maximum number of students that can be included in the request is defined in the configurations form ORGF0123

    The set of students being transmitted can be new students, continuing students or a mix of both. This function will assume all students are ‘New’ until a data issue is identified. The process will then determine if the person’s continuing vs. new to identify if the data problem can be avoided. For example, the person is continuing and the data is optional for a continuing student.

    If the data required for Year 12 Details or HEP details is not known and the Attended Year 12 or Attended Previous HEP is ‘Attended Year 12’ or ‘Attended Previous HEP’, the Attended Year 12 or Attended Previous HEP value should change to ‘Unknown’.

  • Validates Transaction Data

    Data is collected for those students requiring a CHESSN and validations are performed to ensure the required data is present. This also includes Gender Code and Citizenship Code are valid.

  • Creates Transaction Records

    A HEIMS transaction record is created for each student included in the batch.

    The transaction statuses applicable during the request process are:

Status Meaning
PROCESS The transaction is included in the request to HEIMS
INVALID The transaction failed validation and will not be submitted to HEIMS
  • Performs Authentication with HEIMS

    HEP confirms with HEIMS that it has a valid request. When approved, the next process continues.

  • Transmits the Request

    The Request Control Data and Request Transaction data are sent to HEIMS for processing.

  • Handles HEIMS Validation and Error Responses

    Acknowledges HEIMS validation and any error messages

  • Receives HEIMS Acknowledgement

    HEIMS returns a status report including any invalid records, such as DUPLICATE, ARCHIVE or FAILURE.

  • Performs Error Handling

For further information see Maintain Person CHESSN (ADMF32W0); Person CHESSN Detail History (AUDF3192), Batch CHESSN Allocation Results (ADMJ3910), or CHESSN Allocation Report (ADMR3910).

This job is accessed from the main menu. Message 6636 is displayed - 'No parameter exists for this job. Do you wish to schedule the job to run as soon as possible.' N/Y. view the job in progress in JBSF5300, or check the job log in JBSF5301.

 

Before undertaking any processing, the batch CHESSN allocation limit must be assessed. If the limit has been reached for the current 24-hour period, the request cannot proceed.

The transaction limit is based on a 24-hour from Midnight period from the perspective of the HEIMS server. The HEIMS sever is based in Canberra on Australian Eastern Standard Time (AEST).

HEIMS will be online 24 hours seven days a week with 3 schedules service outages. Clients will need to schedule the Request and Results processes outside the defined outage periods. If the processes are run during outage periods timeouts will occur and the process will fail. If the HEIMS server is down, or the HEIMS site is down, the message returned from HEIMS will indicate HTTP/1.1 404 Not Found or HTTP/1.1 500 Internal Server Error.

Rules/Notes:

Validations include:

  • For any Exception Update, the status of the current HEIMS request to FAILED before logging parameters.
  • Only one instance of this job can be run at any given time.
  • The Person ID is used as the Transaction ID.
  • The Gender Code value submitted via the CHESSN interface is either 'M' or 'F' or 'X'; 'U' is not a valid value.
  • The Citizenship Code submitted via the CHESSN interface must map to a Government Citizenship Code that is one of (1, 2, 3, 4, 5 or 8); 9 is not a valid code
  • If the Country Code is 1100, then the Postcode must not be null, but in the range of 0001 to 9999
  • Postal address must be present.

 

The following table definition of 'Mandatory' is 'Y' = Yes, 'N' = No, and 'C' = Conditional

Field Callista Table Callista Column Mandatory?
Record ID HEIMS Transaction Record ID Y
Given Name PERSON GIVEN_NAMES N
Other Given Name PERSON GIVEN_NAMES N
Family Name PERSON SURNAME Y
Previous Name  Complex data type. Repeating Field - 0 to many occurances N
Previous Names. Given Name PERSON_ALIAS (Derive from GIVEN_NAMES) N
Previous Names. Other Given Name PERSON_ALIAS (Derive from GIVEN_NAMES) N
Previous Names. Family Name PERSON_ALIAS SURNAME N
Birth Date PERSON BIRTH_DT Y
Gender Code PERSON SEX Y
Postal Address  Complex data type - see below. Mandatory for new students. Optional for continuing students C
Postal Address. Address Line 1 HEIMS_REQ_PERSON_ADDRESS_V Address Line 1 C
Postal Address. Address Line 2 HEIMS_REQ_PERSON_ADDRESS_V Address Line 2 N
Postal Address. Locality Name HEIMS_REQ_PERSON_ADDRESS_V Locality N
Postal Address. State Code HEIMS_REQ_PERSON_ADDRESS_V    
Postal Address. Country Code HEIMS_REQ_PERSON_ADDRESS_V Country Code N
Postal Address. Country Name HEIMS_REQ_PERSON_ADDRESS_V Country Name N
Postal Address. Post Code HEIMS_REQ_PERSON_ADDRESS_V Post Code C
Citizenship Status Code PERSON_STATISTICS CITIZENSHIP_CD N
Continuing Student ID PERSON PERSON_ID C
Attended Year 12 Code AUS_SCNDRY_EDUCATION - and/or - OS_SCNDRY_EDUCATION - and/or - PERSON_STATISTICS Derive from presence of data C
Year 12 Details  Complex data type - see below. Mandatory if Attended Year 12 Code = AttendedYear12. Applies to continuing students C
Year 12 Details. Year 12 State Code AUS_SCNDRY_EDUCATION STATE_CD C
Year 12 Details. Year 12 Year AUS_SCNDRY_EDUCATION RESULT_OBTAINED_YR C
Year 12 Details. Year 12 Number AUS_SCNDRY_EDUCATION CANDIDATE_NUMBER N
Year 12 Details. Year 12 School Name AUS_SCNDRY_EDUCATION lookup from SECONDARY_SCHOOL_CD N
Attended Previous HEP Code TERTIARY_EDUCATION   C
Previous HEP Details  Complex data type - see below. Mandatory (for both new and continuing students) if 'AttendedPreviousHEP' returned above C
Previous HEP Details. HEP Code TERTIARY_EDUCATION INSTITUTION_CD (Must be valid HEP Code) N
Previous HEP Details. HEP Name TERTIARY_EDUCATION INSTITUTION_NAME C
Previous HEP Details. HEP Number TERTIARY_EDUCATION STUDENT_ID C
Previous HEP Details. HEP Year TERTIARY_EDUCATION ENROLMENT_LATEST_YR C

 

Last Modified on 02-Sep-2014 3:11 PM

History Information

Release Version Project Changes to Document
17.1 2055 - Gender Diversity Changed 'Sex' field label to 'Gender'.
9.1.0.0.0.0 1230 - Com[pliance 2007 Added two validations on Postcode and first sentence in Introduction
8.0.0.0.0.0 1070 - Exceptions to 702 - 2005 Added Table at end of file on HEP Code