Setting Up The eCAF Integration

eCAFs (Electronic Commonwealth Assistance Forms) are required to be completed by eligible students wishing to use HECS-HELP or FEE-HELP for the payment of their tuition fees. These are essential for capturing required information as part of your training delivery needs, and utilise online services to collect and report these details.

  Required: External TCSI Resources

Your organisation will need to have been registered and accepted to provide training via TCSI (Tertiary Collection of Student Information) services.

Help Resources to assist with this are available on the TCSI Support website:

TABLE OF CONTENTS


Enabling the eCAF Integration

  1. Under the Administration heading, select Preferences:
  2. On the left-hand side, expand the Integration item and select Integrated Systems. This will open the Integrations Page, displaying any existing Integrated services/systems:
  3. Click the [+] New button to start the process to implement a new integration:

  4. The page that appears will display a range of Integrations available to set up, with search items and filters. Locate the eCAF item that appears like so:
  5. Press the Connect button will open a new page to enter your eCAF Integration Settings Information.
     

Entering eCAF Integration Settings

This page is comprised of different fields to enter information necessary to drive communication with the eCAF web service.

  Required: Complete Government eCAF API system access request form

In order for your system to communicate with the eCAF web service (API) your organisation will need to have an eCAF user set up with an eCAF Provider API Access role. This can be set up by filling out the Government eCAF API system access request form.
Note: only one account of this type can be created per organisation.

The fields in this section require:

  • System: Will be set as the default 'eCAF'
  • Name: A custom name can be provided for this integration - Otherwise 'eCAF Integration' is sufficient
  • System URL: The system URL for accessing the eCAF system, provided as part of your eCAF access form request response
  • Username: Enter in the eCAF username defined as part of your eCAF access form request
  • Password: Enter in the eCAF password defined as part of your eCAF access form request
  • Automatically submit eCAF enrolments: When ticked, active enrolments with a deferral loan amount will be automatically submitted to the eCAF system within an hour
  • Enabled: Indicates if this integration is active. When unchecked this will disable the eCAF Integration

When ready, press the Save button to record the integration details:


  Next Steps: Managing eCAF Information

Now that the eCAF Integration has been set up globally you can now start managing eCAF details within your system, via the areas that record and submit eCAF data:

A
Ash is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.