Configuring the Integration Broker

You need to set up these elements to ensure that you can connect to the Apply API.

Updating the REST Base URL

1. Go to PeopleTools, and then Integration Broker, and then Integration Setup, and then Service Operations.

2. In Service Operation, search for SAD_UC_DFE_APPL_GET.

3. Click Search.

4. In the results, click the service operation name.

5. In REST Base URL, provide the new URL.

6. Click Save.

7. Repeat steps 2 to 6 for SAD_UC_DFE_APPL_POST and SAD_UC_DFE_APPL_V1_1_POST.

Configuring the Routing Definition

You must set up the routing to connect to the API.

1. Go to PeopleTools, and then Integration Broker, and then Integration Setup, and then Routings.

2. Click Add New Value.

3. In Routing Name, enter SAD_UC_DFE_GET_APPL.

4. Click Add.

5. From the Routing Definitions page, provide these values:

   • Service Operation: SAD_UC_DFE_APPL_GET

   • Version: This field is automatically populated when you select the service operation.

   • Description: DFE Get Applications

   • Sender Node: Select the local node for the environment.

   • Receiver Node: WADL_NODE

   • Owner ID: Admissions — UK

6. Click Parameters.

   1. In Outbound Request, Message.Ver into Transform 1, remove any value (if there’s any).

   2. In Inbound Response, Message.Ver out of Transforms, remove any value (if there’s any).

7. Click Connector Properties.

   1. In Gateway ID, enter LOCAL.

   2. In Connector ID, enter HTTPTARGET.

   3. In Delivery Mode, select Guaranteed Delivery.

   4. In Connector Properties, delete any rows with values.

8. Click Save.

9. Repeat steps 3 to 7 for:

   • Routing Name: SAD_UC_DFE_GET_POST

   • Service Operation: SAD_UC_DFE_APPL_POST

   • Description: DFE Post Applications

10. Repeat steps 3 to 7 for:

    • Routing Name: SAD_UC_DFE_APPL_V1_POST

    • Service Operation: SAD_UC_DFE_APPL_V1_1_POST

    • Description: DFE Post Applications v1.1

    In step 6, update External Alias to SAD_UC_DFE_APPL_V1_1_POST.v1.

Configuring the Gateway

Note:

This setup isn't typically required to connect to UCAS test environments.

1. Go to PeopleTools, and then Integration Broker, and then Configuration, and then Gateways.

2. In Integration Gateway ID begins with, enter LOCAL.

3. Click Search.

4. From the Gateways page, click Gateway Setup Properties.

5. Enter your user ID and password.

6. Click Advanced Properties Page.

7. In Gateway Properties, scroll to the end of the box and look for ig.UseDomainName.ExternalOperationNames.

   The line looks similar to this: #ig.UseDomainName.ExternalOperationNames=MYSOP1.v1,MYSOP2.v1.

8. When you locate the line:

   • Remove any leading hashtag.

   • Add all the service operations that are being used for UCAS applicant and reference data.

     For example, with only the first five reference data service operations included:

     ig.UseDomainName.ExternalOperationNames=getReferenceABLSubjects, getReferenceAddressHistoryReason,
     getReferenceApplicantsStatus, getReferenceAwardingBodies. getReferenceCare

     If you are also using the Apply system, those service operations should also be included.

9. Click OK.

10. On the PeopleSoft Node Configuration page, click Save.

11. On the Gateways page, click Save.

Testing Your Connection

1. Go to PeopleTools, and then Integration Broker, and then Service Utilities, and then Service Operation Tester.

2. In Service, enter SAD_UC_DFE_API.

3. Click Search.

4. From the results, click the service operation name.

5. From the Service Operation page, click Populate Document Template.

6. From the URI Template Builder page, click since.

7. From the Set Value page, in Long, enter 2020-01-01T10:00:00Z.

8. Click OK, then click Return.

9. Click Invoke Operation.

   You may get a 401 unauthorized error message. This is okay; it means that a connection to the Apply API was successfully established.