IM Connectivity Testing

Part of need analysis is determining what the student and their family can be expected to contribute to cover costs related to attending your school. This topic reviews how to test connectivity with the College Board for their INAS Cloud Service to calculate expected contributions from the student and their family using the College Board's Institutional Methodology (IM) formula and discusses how to:

  • Setup the required PeopleTools Integration Broker Service Operation.

  • Test your connection with the College Board.

Note: The INAS Cloud Service is used to calculation IM for the 2024-2025 and future Aid Years.

For more information on Institutional Methodology (IM), refer to the College Board's Financial Aid Services Information Center (https://groups.collegeboard.org/fas).

These are the pages to setup and text IM Connectivity with the College Board.

Page Name

Definition Name

Navigation

Usage

Service Operations

IB_SERVICE_REST

PeopleTools > Integration Broker > Integration Setup > Service Operations Definitions

Use this page to setup PeopleTools Integration Broker Service Operations for testing IM Connectivity with College Board INAS Cloud Service.

IM Connectivity Tester

SFA_IMTESTER_PGE

Financial Aid > Institutional Application Data > IM Connectivity Tester

Use this page to test IM Connectivity with the College Board INAS Cloud Service.

Use this setup in PeopleTools to test IM Connectivity INAS Cloud Service.

Access the Service Operations page (PeopleTools > Integration Broker > Integration Setup > Service Operations Definitions > General) and search for "SFA_EFCCALC_POST" in the Service Operation field.

In the General tab:

Field or Control

Description

REST Base URL

Using the end point URL provided by the College Board, enter the first part of the URL through the host name; for example, “https://inasapi-partner-XXXXX.finaidservices-prod.collegeboard.org” where XXXXX is an identifier for your school.

URI Template

Using the end point URL provided by the College Board, enter the last part of the URL, after the host name; for example, "/inas-delegate-prod/inascalc".)

Document Template

Confirm a value of "SFA_EFC_URI_DOC_MSG.V1".

Version

Confirm a value of "V1".

Version Description

Confirm a value of "EFC Calc POST".

Request Message.Version and Content-Type

For a Message Instance Type of "Request", confirm a Message.Version value of "SFA_EFC_BATCH_MSG.V1" and Content-Type of "application/json".

Response Message.Version, Content-Type, and Status Code

For a Message Instance Type of "Response", confirm a Message.Version value of "SFA_EFC_BATCH_MSG.V1", Content-Type of "application/json", and Status Code of "200".

In the Routings tab:

Field or Control

Description

Name

Click the link in the Name field of the Routing Definitions group box. This opens the IB Routing Definitions window.

Routing Definitions tab

Confirm the data in the following fields:

Service Operation is "SFA_EFCCALC_POST".

Version is "V1".

Description is "GENERATED".

Sender Node is your designated local database or environment connecting to the College Board.

Receiver Node is "WADL_NODE".

Owner ID is "FA-Need Analysis".

Log Detail is "Header and Detail".

Active check box is checked.

User Exception check box is checked.

Click the Service Operation Security link to open the Web Access Service window and confirm the data in the following fields:

Permission List is "HCCPCSSA1000".

Access is "Full Access".

Parameters tab

Confirm the data in the following fields:

External Alias for both Inbound Response type and Outbound Request type is "SFA_EFCCALC_POST.V1".

Connector Properties tab

Gateway ID is "Local".

Connector ID is "HTTPTARGET".

Delivery Mode is "Guaranteed Delivery".

Property ID is "Header".

Property Name is "Content-Type".

Value is "application/json".

Routing Properties tab

No action needed.

Use this page to test your connection to the INAS Cloud Service for calculating IM.

Access the IM Connectivity Tester page (Financial Aid > Institutional Application Data > IM Connectivity Tester).

Field or Control

Description

Base URL

Displayed from PeopleTools Service Operation setup.

URI Template

Displayed from PeopleTools Service Operation setup.

Refresh

Click this button to update the IM Connectivity Tester page for any updates made in the Service Operation page.

Input JSON

Enter information from the Oracle-provided template with instructions on fields that will need to be updated based on your school.

Test Connection

Click this button to test your connection to the INAS Cloud Service.

Output JSON

Displays JSON Response.

Note: For further information, including troubleshooting your connection, see Testing Connectivity with the College Board INAS Cloud Service for Institutional Methodology (IM) Calculations (Doc ID 2952880.1) on https://support.oracle.com.