Batch Entitlement Request Report

ADMJ3930 - Batch Entitlement Request Report

Purpose	This function enables the request for, and processing of, results from a Batch HEIMS Entitlement Allocation Request (ADMJ3920)
Subsystem	Admissions
Normally Run By	Administration Specialist
Anticipated Frequency	As required
Structure	Block	Batch Entitlement Request Report
	Tab	Parameters

Specifically, this job will:

Identify outstanding results
Request Results from HEIMS
Receive results from HEIMS
Load the results into table PERSON_STUDENT_ENTITLEMENT
Record errors (see ADMR3930 report).

This allows a report to be produced (ADMR3930) for a previous request, or if the 'Process Results' check box is ticked, the results from a request can be retrieved from HEIMS and stored in the PERSON_STUDENT_ENTITLEMENT table. Pre-existing values for fields in that table are written to the PERSON_STUDENT_ENTTLMNT_HIST table.
e.g. For a student, the oshelp_usage = 1 in the PERSON_STUDENT_ENTITLEMENT table. If a new OS-HELP Balance usage for this student of 2 is included in a transaction record, then that student's oshelp_usage in the PERSON_STUDENT_ENTITLEMENT table will change to 2 and a new record, where oshelp_usage = 1, will be created in the PERSON_STUDENT_ENTITLEMENT_HIST table.

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.
PROCESS	SUCCESS	The request was received successfully by HEIMS and is queued for processing.
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.

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

Other HEIMS related forms and jobs include:

Maintain Person CHESSN Details - ADMF32W0
Batch CHESSN Allocation Request - ADMJ3900
Batch CHESSN Allocation Results - ADMJ3910
Batch Entitlement Request Report - ADMJ3930
Entitlement Request Report - ADMR3930
HEIMS Password Change - GENJ0030
Maintain HEIMS Interface Configuration - ORGF0123

This job is accessed from the main menu. There is no parameter form for this job.

The block contains:

Tab

Parameters tab

Process Results check box
Request ID (LOV)
Transaction Status (Pop)

Rules/Notes:

If the 'Process Results' checkbox is ticked, the job can only be run in batch mode. If unchecked (only running a report), it can be run in immediate mode.

Select all the requests for which results need to be processed in the ascending order, by request ID, and process one at a time.

Any unexpected errors that are encountered during the request processing will be logged (a message entered in the HEIMS_REQUEST_MESSAGE table) and the job aborts. The exception handler will update the Callista Status column to 'FAILED'.

Any unexpected errors encountered during the processing of individual transactions are recorded in the HEIMS_TRANSACTION_MESSAGE table and processing continues.

If the request is set to a FAILED Callista status then any transactions for the request with a status of PROCESS are set to FAILURE.

The following is the structure of the RequestControlTable (outgoing from HEP):

Field	Format	Callista Table	Callista Column	Comments	Mandatory?
Request ID	VARCHAR2 (36)	HEIMS_REQUEST	REQUEST_ID	Request ID of the original batch	Y
Client Organisation Code	NUMBER (4)	INSTITUTION	GOVT_INSTITUTION_CD	Where Local_Institution_Ind = ‘Y’. NB – data definition is actually “string” where all characters are digits.	Y
Request Local Time Date	DATE	HEIMS_REQUEST	REQUEST_TIME	Server time. Type is (XML) xs:dateTime	Y

A Batch results Response Object consists of:

Response Control data (Response Control Table)
Transaction data (Allocated CHESSN Out).

The following is the structure of the Response Control Table (incoming to HEP):

Field	Format	Callista Table	Callista Column	Comments	Mandatory?
Request ID	Alphanumeric	HEIMS_ REQUEST	REQUEST_ID	Request ID as sent with original request	Y
Client Organisation Code	NUMBER (4)	INSTITUTION	GOVT_INSTITUTION_CD	Home institution Government Institution Code. NB – data definition is actually “string” where all characters are digits. As sent with original request.	Y
Current Date Time	Date	HEIMS_ REQUEST PERSON_STUDENT_ ENTITLEMENT	LATEST INTERACTION_DT RETRIEVAL_DT	Type is (XML) xs:dateTime	Y
Received Date Time	Date	-	-	Type is (XML) xs:dateTime	Y
Schema Version	VARCHAR2 (10)	HEIMS_ REQUEST	SCHEMA_VERSION	Schema version number of the method which was called	Y
Request Status	Contains two fields: Request Status Code and Messages. Request Status Code contains information on the status of the request. The Messages element contains a list of messages concerned with the request itself.				Y
Request Status.Status Code	VARCHAR2 (9)	HEIMS_REQUEST	HEIMS_ RESULTS_ STATUS	Status code, which will be in (Success, Duplicate, Failure, Process, Archive).	Y
Request Status.Messages	Complex data type – see below 1 Occurrence				Y
Request Status. Messages. Message	Repeating Complex Field – 0 to many occurrences				N
Request Status. Messages. Message. Code	XML Integer	HEIMS_REQUEST_MESSAGE	MESSAGE_CD	Refer to HEIMS Web Service Interface Technical Specification Appendix C Mandatory within a Message complex data type	C
Request Status. Messages. Message Description	VARCHAR2 (255)	HEIMS_REQUEST_MESSAGE	DESCRIPTION	Refer to HEIMS Web Service Interface Technical Specification Appendix C Mandatory within a Message complex data type.	C
Request Status. Messages. Message Severity	VARCHAR2 (11)	HEIMS_REQUEST_MESSAGE	SEVERITY	Value in (Error, Warning, Information). Refer to HEIMS Web Service Interface Technical Specification Appendix C for mapping to message codes. Mandatory within a Message complex data type.	C

The following is the structure of a transaction record, Allocated Entitlement Out (Mand? => Mandatory: Y => Yes, N => No, C => Conditional):

Field	Format	Callista Table	Callista Column	Comments	Mandatory?
Record ID	VARCHAR2 (20)	HEIMS_TRANSACTION	RECORD_ID	Cross reference to Record ID in outgoing file. Suggested value is Person ID.	Y
Ordinary SLE Usage	XML Double	PERSON_STUDENT_ENTITLEMENT	SLE_USAGE	Inclusion of this element depends on transaction status = “Success” or “Warning”	C
Fee HELP Loan Balance	XML Double	PERSON_STUDENT_ENTITLEMENT	FEE_HELP_LOAN_BALANCE	Inclusion of this element depends on transaction status = “Success” or “Warning”	C
Calculation AS At Date	Date	PERSON_STUDENT_ENTITLEMENT	CALCULATION_DT	Inclusion of this element depends on transaction status = “Success” or “Warning
Ordinary SLE Balance	Alphanumeric	PERSON_STUDENT_ENTITLEMENT	SLE_BALANCE	Inclusion of this element depends on transaction status = “Success” or “Warning
OS-HELP	Number (9)	PERSON_STUDENT_ENTITLEMENT	OSHELP_LIMIT	Inclusion of this element depends on transaction status = “Success” or “Warning	C
OS-HELP Balance	Number (9)	PERSON_STUDENT_ENTITLEMENT	OSHELP_USAGE	Inclusion of this element depends on transaction status = “Success” or “Warning	C
OS-HELP Limit	Number (9)	PERSON_STUDENT_ENTITLEMENT	OSHELP_BALANCE	Inclusion of this element depends on transaction status = “Success” or “Warning	C
Transaction Status	Complex data type – see below				Y
Transaction Status. Status Code	VARCHAR2 (7)	HEIMS TRANSACTION	Record Status	Status code, which will be in (Success, Failure, Warning).	Y
Transaction Status. Messages	(Nested) Complex data type – see below 1 Occurrence				Y
Transaction Status. Messages. Message	Repeating Complex Field – 0 to many occurrences				N
Transaction Status. Messages. Message.Code	XML Int	HEIMS TRANSACTION	Message	Refer to HEIMS Web Service Interface Technical Specification Appendix C Mandatory within a Message complex data type.	C
Transaction Status. Messages. Message. Description	VARCHAR2 (255)	HEIMS TRANSACTION	Message	Refer to HEIMS Web Service Interface Technical Specification Appendix C Mandatory within a Message complex data type.	C
Transaction Status. Messages. Message. Severity	VARCHAR2 (11)	HEIMS TRANSACTION	Message	Value in (Error, Warning, Information). Refer to HEIMS Web Service Interface Technical Specification Appendix C for mapping to message codes. Mandatory within a Message complex data type.	C

An Example of a Report Printed From this Job

admj3930

Last Modified on 10 October, 2006

History Information

Release Version	Project	Change to Document
10.1	1240 DEST 2007 Pt 2	Modified Report image and added os-help fields to table with an additional explanatory comment in the introduction.
9.1.0.0.0.0	1230 - DEST 2007	Added picture of an example of the report
9.0.0.0.0.0	1219 - SLE and FEE HELP Balances	New form