Integrate Using PeopleSoft Webservices
Anthology Reach provides an integration using PeopleSoft Admissions Application Web Services (AAWS) to send application and related data via real-time webservice requests.
This topic describes a framework where application records in which the value of the Application Status field is Submitted will be synced with PeopleSoft in real time, i.e., when they are created in Anthology Reach or on the portal.
Application information, along with other information of contact and lifecycle records on the many side of one-many relationships, will be sent to PeopleSoft in a predefined XML structure using SOAP web services.
PeopleSoft Integration Flows
The following flows will be triggered when the Application Status in an application record is Submitted:
- PeopleSoft Integration - Integrate Application with PeopleSoft
- PeopleSoft Integration - Send Message to PeopleSoft
The PeopleSoft Integration - Integrate Application with PeopleSoft Flow
This flow will create a placeholder for the application record. Basic information about the record will be sent in XML format to PeopleSoft.
- A new integration message record (SAD_CREATEAPPL) with the Integration Status as Pending will be created when the Application Status in an application is Submitted.
- This flow includes logic to prepare the XML data structure of the application which will be stored in the Message Data area.
The PeopleSoft Integration - Send Message to PeopleSoft Flow
This flow will be triggered on the creation of the integration message record in the PeopleSoft Integration - Integrate Application with PeopleSoft flow. In addition, an integration log record that’s associated with the SAD_CREATEAPPL record will also be created.
Records Created for an Application Record Sent to PeopleSoft
For each application record exported to PeopleSoft, the following records will be created in Anthology Reach:
-
Two Integration Message records (under Settings > Integration): Records of this entity serve as intermediate containers to store the XML structure sent to PeopleSoft and the subsequent response that's received.
-
SAD_CREATEAPPL – Created when the PeopleSoft Integration - Integrate Application with PeopleSoft flow is triggered.
-
SAD_SUBMITAPPL – Created when the PeopleSoft Integration - Send Message to PeopleSoft flow is triggered.
-
- An Integration Log record.
Samples of the above files can be downloaded from the following links to understand how the message sent to PeopleSoft will be constructed:
Sending the First Message to PeopleSoft
-
An Azure function will be called which will send the XML data structure stored in the Message Data area along with other authentication related XML structures.
-
The response from PeopleSoft will be stored in the Response area of the SAD_CREATEAPPL record.
-
The value of the SCC_TEMP_ID tag in the response will be stored in the External Temporary Id field of the application. By default, the field is not displayed.
-
The Integration Status field in the SAD_CREATEAPPL record will then be updated to Success, indicating that information sent to Peoplesoft is acknowledged.
Note: In a successful integration scenario, a single integration log record will be created. However, if the application record is not exported to PeopleSoft, the value of the Integration Status field will be set to Failed. The administrator can change this value to Pending, which will:
- Enable the application record to be exported to PeopleSoft in a later run of the PeopleSoft Integration - Integrate Application with PeopleSoft flow.
- Trigger the creation of a second integration log record that will be associated with the SAD_CREATEAPPL record.
Sending the Second Message to PeopleSoft
In addition to the instance of this flow that ran above, a second instance of the same flow will run when the new integration message record (SAD_SUBMITAPPL) is created. The initial value of the Integration Status field of this new record will be Pending.
- The Azure function will be called again and will send the XML data structure to PeopleSoft. The structure will also be stored in the Message Data area of the integration message record.
- The response from Peoplesoft will be saved in the Response area in the SAD_SUBMITAPPL record.
- The value of the ADM_APPL_NBR tag in the response will get updated in the application record in the External Enrollment ID field, indicating that all application information is successfully exported to PeopleSoft.
- The value of the Integration Status field in the integration message record will be set to Success.
Field Mappings for Webservice Requests
Administrators must download the files indicated above along with the file that describes mappings of the Application entity and its related entities. Administrators must use these attachments to customize their implementation of how application information will be exported to PeopleSoft.