ADMJ3920 - Batch Entitlement Request

Purpose This function enables the submission of batch requests for Student Entitlement details to Tribal Submissions
Subsystem Admissions
Normally Run By Administration Specialist
Anticipated Frequency As required
Structure Parameters Parameters
More

 

This job enables the submission of requests to TCSI (via Tribal Submissions) or to HEIMS, for student entitlement details to be retrieved.
To retrieve data from TCSI, an administrator must set the CLOSED_IND to 'Y' for the HEIMS record in the S_CHESSN_CRTN_MTHD table, and to 'N' for the TCSI record in that table. Prior to changing these settings the data will continue to be retrieved from HEIMS. TCSI processing involves calls to the Edge APIs. These are configured in SECF0200 – System Edge Configuration and there may be one or two Edge Instances for an Institution. 
For processing via TCSI, it first determines students to include in processing - only students with an ACTIVE CHESSN that satisfy the parameters. It then calls the SMS-to-Edge (S2E) API for each student ID to get the data. Tribal Submissions on the Edge platform then calls the B2G API, updates the data in Tribal Submissions, and then returns the balances to Callista.

The HELP data retrieved is:

  • Available HELP Balance
  • Pending HELP Balance - Available HELP Balance less any pending loan amounts reported by institutions for units the student has enrolled in where the census date has not yet passed
  • Lifetime HELP Loan Limit
  • OS-HELP Statuses - Student status
  • OS-HELP study period commencement dates

Once the entitlements data is transferred from Tribal Submissions into Callista, Callista will perform entitlement calculations for the student and update the Entitlement Position value. The entitlements details for a student are displayed in ADMF32W0. These further values are:

  • HELP Usage - Lifetime HELP Loan Limit minus Available HELP Balance
  • OS-HELP Usage - Number of OS-HELP study period commencement dates (E521) with Student Status Codes 240 or 241
  • OS-HELP Balance - 2 minus OS-HELP Usage

The HELP Entitlement Position is updated based on the CURRENT context which measures the Entitlement position at the 'As At' date.

Institutions can also retrieve entitlements data for an individual student, using the Retrieve Entitlements button in ADMF32W0.

Errors and Messaging

If Tribal Submissions doesn't receive a response back from the government, it will return the last saved balances or NULL if no balances have ever been retrieved.

Records may be logged to the S_LOG and S_LOG_ENTRY tables and these will include information such as error details and a summary of processing.
All successfully processed records, along with any error messages encountered during processing, are written to the system log tables and can be extracted using GENJ1100. See System Logs for detail on this functionality. Administrators may use this functionality to generate a report on the entitlements of the student records processed. Records in the S_LOG_ENTRY table with S_LOG_TYPE of TCSI_ENTLMT may be generated with associated messages.

This job is accessed directly from the Callista main menu.


Related forms and jobs include:

  • Maintain Person CHESSN Details - ADMF32W0
  • Transfer HE Government Reporting Data to Edge - STAJ3000
  • Transfer VSL Government Reporting Data to Edge - STAJ4000
  • TCSI CHESSN Retrieval - ADMJ3950
  • Maintain Entitlements Position - ADMF0300
  • Note: ADMJ3930 which creates an Entitlement Request Report does not function when TCSI is enabled for student entitlement details.

 

The block contains:

Parameters Tab

The following parameters display on the Parameters tab when TCSI processing has been enabled:

  • Entitlement Request Context
  • Calculation As At Date
  • Available HELP Balance*
  • Pending HELP Balance*
  • OS-HELP Usage
  • Student Status 1
  • Student Status 2
  • Student Status 3
  • Fee Category
  • Person ID Group

*Note: SLE Usage and FEE-HELP Balance display when HEIMS processing is still enabled (TCSI processing has not been enabled). These parameters are replaced by 'Available HELP Balance' and 'Pending HELP Balance' when TCSI processing has been enabled.

More Tab

Enrolment Context

  • Census Date
  • Census Start Range Date
  • Census End Range Date
  • Course Attempt Status - 3 fields

Admission Context

  • Admission Period
  • Admission Outcome Status - 3 fields
Rules/Notes:

The parameters are used to limit the set of students for which details are requested.
Only students with an ACTIVE CHESSN will be included in the processing.

Entitlement Request Context may be ENROLMENT or ADMISSION.
When running in an ADMISSION context:

  • The Course Attempt Status will not be considered when determining the students in the request.
  • The Fee Category and Student Status will be sourced from the ACAI locations rather than the SCA contexts.
  • The user may specify the Admission period and up to three Outcome Statuses to filter the records.

Calculation As At Date - Any student with a 'HELP As at' date or 'OS-HELP As at' date that is prior to the date entered will be included in the request. IF NULL, this parameter will not be considered. The default value is NULL.

Available HELP Balance- students with Available HELP Balance (in ADMF32W0) equal to or less than the amount specified will be included in the batch. If blank, this parameter will not be considered.

Pending HELP Balance- students with a pending HELP Balance (in ADMF32W0) equal to or less than the amount specified will be included in the batch. If blank, this parameter will not be considered.

OS-HELP Usage - students with the number of OS HELP loans used equal to more than the selected number (0,1 or 2) will be returned. If blank, entitlements for students with any number of OS-HELP loans will be returned.

Student Status - Three statuses may be entered. Students with a matching Student Course Student Status or Student Unit Student Status will be included in the batch. If blank, this parameter will not be considered.

For Enrolment and Admission Context:

  • Only one of Census Date or the Date range parameters can be set
  • Both a Start Range Date and End Range Date must be specified

The Person ID is used as the Transaction ID

Single student entitlement requests can be called from ADMF32W0 – Maintain Person CHESSN Details, via the Retrieve Entitlements button.

Last Modified on 12-Mar-2021 11:13 AM

History Information

Release Version Project Change to Document
22.0.0.3, 22.1.0.3, 23.0.0.3 & 23.1.0.2 2466 - TCSI CHESSN and Entitlements Help page rewritten to include new process and job name change.
20.0.0.1 Online Help Improvements Added note re SLE.
12.0 1456 - SLE Usage Added details for new parameters
11.1 1505 - Compliance 2008 Added new explanation for Calculation As At Date parameter.
10.1 1340 -DIISRTE 2007 Pt 2 Added OS-HELP Usage to parameter form. Added comments for each field in the parameter form.