STAJ2050 - Import eCAF Details

Purpose

To import Students' Progression data from eCAF Portal back to Callista SMS using the API provided by the Government

SubSystem

Statistics

Normally Run By Statistics specialist
Anticipated Frequency On demand, when the files are required for statistics processing.
Structure Tab Parameters

 

For VET students to continue to receive a VET student loan, they are required to demonstrate to the Government that they are continuing with their studies.
To do this they must complete the survey (engagement and progression form) accessed via the Government-provided eCAF System.

The STAJ2050 job imports Student Progression data from the eCAF Portal back to Callista SMS using the API provided by the Government. For each student this data indicates their participation in these surveys over the duration of their course.

The Import Job matches records from eCAF Portal to records held in Callista SMS using eCAFID and student ID and the imported data is displayed in the Progression Survey T-list table in the Student Course Attempt block of the ENRF3000 form.  

Preceding STAJ2050, the STAJ2040 job exports records of continuing students and these students are invited to complete the survey by the eCAF Portal.

STAJ2050 is only available to VET sector and cross sector institutions.

This job is accessed via the main menu.

 

Parameters

  • From
  • To

Notes

The From and To parameters define a date range.
Both parameters are required fields.

If a date range of more than 90 days is defined, a message 'The date range selected may result in import of large number of records. Are you sure you wish to continue?' is displayed.
Choosing Yes will proceed with the import process and No will stop the job from running.

Configuration

For the system configuration required to connect Callista with the eCAF Portal refer to eCAF Portal Configuration.

Processing Summary

  • Get the Request URL,  eCaf Login, Proxy, https Host and Oracle wallet by calling the stap_prc_ecaf_config function.
  • Create an s_log record of type ‘ECAF-P-IMP’ to enable the creation of s_log_entry records during processing.
  • Call an API GET request to retrieve all the institution's Progression Surveys having a creation date within From and To date range specified by the job parameters.
  • If the job completes successfully (Response Code = 200), read the results into a JSON list containing the following details:
    • ecafId - The eCAF ID is used to match records from the eCAF Portal to records within Callista SMS
    • number - If a progression number is matched to a record in Callista the record will be updated otherwise a new progression survey record will be created in Callista
    • status - The status of a Progression Survey may have the following values. Created, InvitationSent, Expired, StudentDraft and StudentSubmitted
    • outcome - The outcome of the survey will be imported and may include the following values: Blank, Deferred or Continuing,
    • creationDate - The date the survey was created will be imported in case the record was created in eCAF Portal,
    • dueDate - This is automatically set within eCAF Portal 14 days after Progression survey invitations are sent to students,
    • submittedDate - The date the survey is submitted by the student,
    • lastModifiedDate - The last modified date is the date the record was last modified by Administrative staff or students
  • Add the new data to callista SMS so that it displays in the Progression T-list in ENRF3000
  • If the job fails (Response Code = 400, 401, 403, 404, 429 or 500), then a record is inserted into the S_LOG_ENTRY table with log_type ECAF-P-IMP and a message to say the data could not be exported.

 

Technical Information

Tribal Callista interacts with the Government Web Services to manage all aspects of dealing with an external API, including authentication when calling the API and managing the response details to correctly record audit details and process error details appropriately.
The Government API uses HTTP status codes to indicate the success or failure of a request. Error codes are returned with a JSON object in the body containing a message providing further details on the error.
The version 2(1302B-2017) API for the VET Student Loans eCAF provided by the Government eCAF site is used to import the student status information to the Callista SMS.

 

Last Modified on 03-Jul-2017 1:17 PM

History Information

Release Version Project Change to Document
20.0.0.3 & 21.0.0.1 2366 - VSL Progression New Online Help page.