1. Implementing Student Financial Planning
  2. Integration Guiding Principles

Integration Guiding Principles

Student Financial Aid has a REST-Based Interface and uses two primary message types, event based and asynchronous.

Student Financial Aid Primary Message Types:

  • Event-Based: Triggered at the time certain events occur

  • Asynchronous Request/Reply: Triggered when a system makes a request for the information

Messages are Directional and are considered to be either Inbound or Outbound. Inbound messages are transmitted to Student Financial Aid from an external system. Outbound messages are created by Oracle Fusion Cloud Student Financial Aid Cloud Service and are intended to be consumed by an external system or the Student Portal.

Every message contains a Globally Unique Identifier (GUID) in the MessageId content to identify it as a unique message. Each message is validated before the data in the message is persisted to database. If an invalid message is received, an error is logged to the database and the message is discarded.

A message is considered invalid if:

  • It does not match the XML schema.

  • It has at least one field that is not compliant with the business validation rule(s) specified for that field.

XML Schema Definition

The latest XSD files can be found in the API Update in the Release Notes. See Doc ID 2613016.1 on My Oracle Support. You may find downloading the latest API assets beneficial as you work through the implementation process.

Testing Your MPG and VUG Credentials

SFA APIs for MPG and the SAIG File Repository for VUG are usually accessed using integration software, not a website through an Internet browser like you would access the Administration (FAS) and Student Self-Service UIs. You can test your credentials to the MPG and VUG using the following procedure to trigger the ping service for each.

For MPG:
  1. Identify the API URL, username, and password provided in the SFA Welcome Letter from Oracle with the subject "Welcome to Oracle Student Financial Aid Cloud".
  2. In your browser, enter the URL into the address space and add "/info/ping" to the end:
    1. Non-production example: https://<username>@sfp.ocs.oc-test.com/<customer>-test/mpg/info/ping.
    2. Production example: https://<username>@sfp.ocs.oraclecloud.com/<customer>/mpg/info/ping.
  3. Most modern browsers will open a dialog asking for a user ID and password. When it does, enter the appropriate username and password.
  4. An example of a response for the MPG ping would be: "SFA MPG 19.12.2.0-SNAPSHOT (build b631f1d_202001071806)".
For VUG:
  1. Identify the SAIG File Repository URL, username, and password provided in the SFA welcome letter from Oracle with the subject "Welcome to Oracle Student Financial Aid Cloud".
  2. In your browser, enter the URL into the address space and add "/info/ping" to the end:
    1. Non-production example: https://<username>@sfp.ocs.oc-test.com/<customer>-test/vug/info/ping.
    2. Production example: https://<username>@sfp.ocs.oraclecloud.com/<customer>/vug/info/ping.
  3. Most modern browsers will open a dialog asking for a user ID and password. When it does, enter the appropriate username and password.
  4. An example of a response for the VUG ping would be: "SFA USDE Gateway 19.12.2.0-SNAPSHOT (build 0f835a6_202001071805)".