PeopleSoft Integration

The Ready Education integration follows the PeopleSoft Integration Broker standard to bring in personalized Course Schedule, Grades, Bursar, Holds, Financial Aid, Enrollment, and To Do integrations to the mobile app.

Table of Contents

1. Introduction to PeopleSoft Integration

The Ready Education integration follows the PeopleSoft Integration Broker standard to bring in personalized Course Schedule, Grades, Bursar, Holds, Financial Aid, Enrollment, and To Do data into the mobile app.

In order to integrate we require:

1. Ready Education Message Node

2. Ready Education External User

The Ready Education Message Node is a Dedicated Web Service Message Node (i.e. external routing node) created in your PeopleSoft Integration Broker that enables Ready Education to make calls to your published PeopleSoft web services with an External User on behalf of the app user.

For more details on the Integration Broker and Message Node, refer to the documentation below, or to the Ready Education FAQ: PeopleSoft Integration Broker summary at the bottom of the document.

• Oracle Documentation: Introduction to PeopleSoft Integration Broker

• Oracle Documentation: Using Peoplesoft Integration Broker

2. Integration Access Requirements

Step 1: PeopleSoft Web Service Access and Whitelist IPs

Ready Education needs to access your PeopleSoft Web Services through our Middleware Server.

To access your Web Services, we require:

1. Confirm Ready Education Middleware Servers IPs are whitelisted: 54.165.247.9, 44.205.146.231, 44.215.89.61, 54.224.36.245, 3.97.24.129, 15.135.2.173, 79.125.26.52

2. Test PeopleSoft Access:

   • The Integration Gateway (web services URL) e.g. https://<machine>:<port>/PSIGW/PeopleSoftServiceListeningConnector

   • The default local node

3. Prod PeopleSoft Access:

   • The Integration Gateway (web services URL) e.g. https://<machine>:<port>/PSIGW/PeopleSoftServiceListeningConnector

   • The default local node

For more information on the Integration Gateway (web services URL) and acceptable formats, see the PeopleSoft documentation on Web Services.

• Acceptable formats include Integration Gateway (web services URL) with local nodes e.g. http://<machine>:<port>/PSIGW/PeopleSoftServiceListeningConnector /<defaultlocalnode>

Additional Configuration Details Required:

1. Institution Codes:

   • Provide your institution code(s).

   • Indicate if you have more than one institution code.

2. Node Naming Convention

   • Do you have a naming convention for your Nodes? ****

   • If yes, provide instructions on how to name your Nodes.

Note: [uncommon] If your team has modified the Default PeopleSoft Web Services (Service Operations), please inform your Ready Education representative.

Step 2: App Designer Access

We require:

1. User credentials for accessing App Designer (usually the same account as PeopleTools)

2. Database Name

3. Instructions for accessing App Designer on DEV environment

We require all the information needed to log-on to the below screen for App Designer: 

Example of App Designer Instructions are:

• VPN Connection

  • Instructions for accessing the PeopleSoft DEV environment e.g. VPN URL, software if applicable, and username/password

• Remote Desktop

  • Instructions to Remote Desktop to App Designer

Step 3: PeopleTools (e.g. Integration Broker) Access

We require:

1. User Credentials for PeopleTools to access Integration Broker (usually the same account as App Designer)

2. PeopleSoft Portal URL for PeopleTools e.g. https://csdev.readyed.edu/csdev/signon.html

3. PeopleTools Version Number

3. Integration Configuration

Integration Requirements:

1. Import PeopleSoft Project(s)

2. Create the Ready Education Message Node and Ready Education External User

   • Steps to Create the Ready Education Message Node and Ready Education External User

3. Verify Service Operation Configuration

   • List of Service Operations to Verify

   • How to Find a Service Operation

   • How to verify the Service Operation is configured correctly

   • How to set the Service Operation to Active and to generate the Local-to-Local Routing

4. Route the Ready Education Message Node to the Local Node

   • List of Service Operations to Route to Local Node

   • Steps to Route to Local Node

   • How to return to Add a Routing Page

5. List of Service Operations

6. Integration Form - Provide required Integration Details to Ready Education

Step 1: Import PeopleSoft Project(s)

Import the Ready Education PeopleSoft Project into App Designer. Importing the project enables and makes active the required Web Services. The project also loads into the PeopleSoft database the required process type definitions, permission lists, and component interfaces.

There are two projects:

• [Required] DUB_MOBILEAPP_DELIVERED

• [Optional] DUB_MOBILEAPP_CUSTOM

The Delivered Project is required for Courses and Enrollment integrations. The Custom Project is required for Financial Aid, Holds, Bursar, and To Do integrations. If you do not know which integrations are included in your package, please contact your Technical Project Manager.

Steps to Install Project:

1. Remote into computer with Application Designer.

2. Download (e.g. mount) the DUB_MOBILEAPP_DELIVERED and DUB_MOBILEAPP_CUSTOM (if applicable) PeopleSoft projects onto the workstation.
   
   

3. Log-in to App Designer: Start the Application Designer and from the sign-on window select to start the Application Designer in tier-two mode by entering the following information provided by the client in the Integration Form:

   • Connection Type: Database e.g. Oracle

   • Database Name**:** Database name e.g. CS92DEV1

   • User ****ID: PeopleSoft Operator name e.g. davidbro

   • Password ****of user ID: *****

4. Copy Ready Education Project(s) From File: Go to Tools —> Copy Project —> From File —> Select Ready Education Project(s) from Step 2. Click Copy. Import the Delivered Project first, followed by the Custom Project. 

Step 2: Create the Ready Education Message Node and External User

In Integration Broker's PeopleTools, create a dedicated external web services message node (referred to as the Ready Education Message Node) and external user (referred to as Ready Education External User).

Steps to Create a Dedicated External Web Service Message Node:

1. PeopleTools —> Integration Broker —> Integration Set-up —> Nodes —> Add a New Value

2. Node Name: <Follow school's naming convention>

3. Description: Ready Education Dedicated Message Node or Ready Edu External Node

4. Node Type: External

5. Authentication Option: None

6. Active Node: Check Yes

7. Default User ID: Provide a Default user for non-authenticated Web Services such as Course Catalog. For more information on Default Users, refer to the FAQ.

8. External User ID: READY_EDUCATION

9. External Password: <Generate a strong password>. You will need to confirm the External Password again before saving.

10. Compare against screenshot below

Step 3: Add Route from Ready Education Message Node to the Local Node

In Integration Broker's PeopleTools, add a route for each service operation required in the the Ready Education project imported in Step 1 from the Ready Education Message Node to your Local Node.

Route each Service Operation in the below Delivered Projects List to the Local Node:

Steps for Routing from Ready Education Message Node to Local Node:

1. PeopleTools —> Integration Broker —> Integration Set-up —> Nodes —> <Ready Education Message Node Name>

2. Click the Routing Tab

3. Routing Name: Input "Name of Service Operation" + "_GET" e.g. SSR_SWAP_ENROLLMENT_GET

• Follow the school's naming convention

4. Configure the Routing Definition per below: 

• Service Operation: Look up the corresponding Service Operation

• Description: Name of Service Operation + "inbound" e.g. SSR_SWAP_ENROLLMENT inbound

• Sender Node: Ready Education Message Node e.g. CHAPMAN_READY

• Receiver Node: Name of Client's Local Node e.g. CS92DEV1

5. Compare against the screenshot below:

6. Repeat for each Service Operation in the Delivered and (if applicable) Custom Ready Education Projects.

Step 4: Verify Service Operations configuration

For each Service Operation imported in the Ready Education PeopleSoft Web Services Project(s), verify in PeopleTools' Integration Broker:

• The Service Operation is active

• The Local-to-Local node exists

• The Ready Education Message Node Route to the Local Node exists

Table of Contents:

1. Example of Service Operation List from Delivered and Custom Projects

2. How to Find a Service Operation

3. How to Set the Service Operation to Active and to generate the Local-to-Local Routing

4. How to Confirm the Ready Education Message Node Route to the Local Node exists

Example of Service Operation List from Delivered and Custom Projects:

• Ready Education Delivered Web Service Project (Default)

• Ready Education Custom Web Service Project

How to Find a Service Operation:

A Service Operation must be found through the Service. For example, the SSR_ADD_ENROLLMENT Service Operation is part of the SSR_ENROLLMENT Service.

Steps to Find a Service Operation:

1. Go to PeopleTools —> Integration Broker —> Integration Set-up —> Service Operation

2. Search <Service> e.g. "SSR_ENROLLMENT"

3. Select the desired <Service Operation> e.g. "SSR_ADD_ENROLLMENT" or "SSR_DROP_ENROLLMENT"

Open

How to Set the Service Operation to Active and Generate the Local-to-Local Routing:

In the Service Operation Page:

1. Check the boxes for:

   • Active

   • Generate Local-to-Local

2. Click Save

3. Repeat for each Service Operation in the Project(s)

Open

Example of an Active and Local-To-Local Routing generated Service Operation:

Open

How to Confirm the Ready Education Message Node Route to the Local Node is Active and Exists:

In the Service Operation Page:

1. Click the Routings Tab

2. Confirm a Routing exists where:

   • The Name of the Routing is what you named the Routing for the Service Operation

   • The Sender Node is the Ready Education Message Node

   • Direction is Inbound

   • Status is Active

3. (Optional): Confirm the the Local-to-Local Routing exists and is active:

   • The Name is ~Generated~

   • The Sender Node is the Local Node

   • The Direction is Local

   • The Status is Active

4. Repeat for each Service Operation in the Project(s)

Example:

• The First Routing in the list "DUB_SSC_GET_LOV" is an example of a Ready Education Message Node Route to the Local Node

• The Second Routing in the list "~GENERATED~4716892" is an example of a Local-to-Local Routing

Open

Step 5: Web Service Permission List

Ready Education integrates with PeopleSoft through their delivered Web Service Operations. Per the PeopleSoft Integration Broker process, users must be granted permission to invoke the Service Operations required in your integration package.

For each Service Operation imported in the Ready Education PeopleSoft Web Services Project(s), verify in PeopleTools' Integration Broker:

• The Service Operation permission list has the required lists allowed (e.g. Default User, Student, and/or Faculty)

Steps to Grant Access to invoke a Service Operation:

1. Open Integration Broker

2. Go to Integration Setup > Service Operation

3. Click the Service Operation Security link

4. In the Permission List field, enter a permission list for the service operation. 

5. From the Access drop-down list, select the access level for the service operation to Full Access. 

6. Click Save

7. Repeat steps 1 - 6 for each integration in the Ready Education Delivered Project (and Ready Education Custom Project).

For more details on the Integration Broker Service Operations permissions, refer to the Oracle Documentation: 

• Oracle Documentation - Setting Permissions to Service Operations

Additional Requirement: Hold Integration and To Do integration are a PeopleSoft Component Interface based Service Operation. If integrating with Holds or To Dos, there is an additional step of configuring the Component Interface Security.

Steps to Configure Component Interface Security

1. Open PeopleTools, Security, User Profiles*, and Permissions & Roles and then click Permission Lists. *some versions skip User Profiles and goes directly to Permissions & Roles.

2. Search and Select the relevant permission list (typically the Student Permission List) 

3. Click the right arrow next to Sign-on Times to reveal the Component Interface tab. 

4. Click the Component Interface tab

5. Click the + button

6. Search for Component Interface (DUB_SS_HOLDS or DUB_SS_TODOS integrations) 

7. Click edit and grant Full Access to Methods: Get and Find

8. Click OK

9. Click Save

10. Repeat as needed for each Component Interface. 

For step-by-step instructions with screenshots on the Component Interface Security, refer to the Oracle Documentation:

• Oracle Documentation - Using Component Interfaces

Search for the section "Configuring Component Interface Security for PeopleSoft Version 8.4 or Higher". 

Why does Ready Education need to access granted on the Permission List?

Service Operations work similar to APIs - access to the Service Operations is restricted to only authorized users. Ready Education is authorized to access the Service Operations via the external user generated during the project installation. Only the Ready Education external user is allowed to make calls to the dedicated Ready Education Message Node on behalf of the users to retrieve data.

• Successful Integration: In order to integrate, we need the Service Operation to allow users to access their data. Data is returned by the Service Operations if users (students, faculty, etc.) are granted access to invoke the Service Operation via the permission lists.

• Unsuccessful Integration: Data is not returned by the Service Operations if users are not granted access to invoke the Service Operation via the permission lists.

For more details, refer to the Oracle Documentation on Web Services Permissions. Open the link and search for "Setting Web Services Permissions":

• Oracle Documentation: Defining Permissions - Setting Web Services Permissions

Why does Ready Education need the Component Interface to be added to the Permission List?

PeopleSoft requires it for Component Interface integrations. Component Interfaces must be configured on the Permission List in addition to the baseline requirement of the Service Operation being granted access on the Permission List mentioned in the previous FAQ.

For more details on the Component Interfaces, refer to the Oracle Documentation:

• Oracle Documentation - Using Component Interfaces

Where do I find the list of integrations included in my package?

For a list of the integrations in your package, please contact your Ready Education representative.

Where do I find the Service Operations that need to grant access to the Security or Permission List?

For a list of the Service Operations in each package, refer to the List of Service Operations by Integration section.

Still have questions? Refer to our FAQs. 

4. List of Service Operations by Integration

For each integration included in your package, ensure the Permission List for the Service Operation to allow access as specified. Instructions for how to allow access are detailed in Step 4: Permission List Permissions. 

For example, for the below General Integration: SSR_GET_ENROLLMENT the permission must be set to allow the Student List permission access to invoke the service operation. For the SCC_USERREG_AUTHENTICATE Service Operation, both Student and Faculty Lists need permission to invoke the service operation. These two service operations are required for any PeopleSoft integration. 

Permissions labelled "Default User" are those that support features that do not require login, for example Course Catalog. 

For Holds and To Do integrations, ensure the Permission List is configured for the Component Interfaces.  Instructions for how to configure component interface security are also detailed in Step 4: Web Service Permission List. 

General Integration

Required for ALL PeopleSoft Integrations: The Courses Integrations allows students to view their Course Schedule and PeopleSoft Mid-term and Final Grades.

Course Integration

The Courses Integrations allows students to view their Course Schedule and PeopleSoft Mid-term and Final Grades.

Bursar Integration

The Bursar (Account Balance) integration allows students to view their Account Balance including charges, payments, and account summary.

Holds Integration

The Holds integration allows students to view Financial and Administrative holds. 

Financial Aid Integration

The Financial Aid integration allows students to view financial aid, and to accept or decline pending offers. 

To Do’s Integration

The To Do's Integration allows students to view their To Do's/Tasks. 

5. Test User  

Test User requirements to verify integrations: 

Provide Test User:

• PS username and password for DEV environment

  • NOTE: The user needs to exist in your PeopleSoft database as a user with an associated userID. 

  • Provide the associated employeeID and oprID

• If integrating with SAML or CAS for the mobile app, the test user must: 

  • Exist in your Active Directory with the (6) required attributes: SAML or CAS requirements

  • Be able to authenticate in your SAML or CAS system

Provide Test Data for Test User (as applicable):

• Course - Enrollment in courses (preferred in Current Semester)

• Course - Mid-term and/or Final Grades

• Holds - Financial and Administrative holds

• Financial Aid - Offered, Pending, and Accepted Financial Aid. For a robust test, provide data for grants, loans (subsidized and unsubsidized), work study, etc.

• Bursar - Charges and Payments

For more information about our test user requirements, go to Test User and Test Data Requirements.

6. Provide the following information to your Technical Consultant

Provide the following information to your Implementation Project Manager to create a ticket.

We require all the following information in order to proceed:

1. App Designer User Credentials

2. App Designer Access Instructions

3. PeopleTools User Credentials (indicate if same as App Designer)

4. PeopleTools Portal URL, Version Number, and Database Name

5. TEST Integration Gateway (web services URL)and Local Node

6. PROD Integration Gateway (web services URL) and Local Node

7. Provide your Institution Code(s)

8. (Optional): Provide your Naming Convention for Nodes

9. Ready Education Messaging Node Name

10. Ready Education External User Password