SIS - Colleague

Ready Education integrates with Colleague through the Colleague API to bring in personalized Course Schedule, Grades, and Holds integrations to the mobile app.

Table of Contents

1. Overview

Ready Education integrates with Colleague through the Colleague API to bring in personalized Course Schedule, Grades, and Holds integrations to the mobile app.

2. Integration Requirements

We require the following information for your Test and Production Colleague Instances:

1. Colleague API Server URL - e.g. http://mobile.client.edu:8140/ColleagueApi

2. Colleague API Utility Account (set-up with ability to act as a Proxy User)

Step 1: Proxy User Set-up

Ready Education requires a Proxy User in order to access the Colleague API. We make calls to the Colleague API on behalf of authenticated users in the mobile app for their personalized course schedule, grades, and holds. We specifically require Colleague Utility Account with permission to call the /session/proxy-login API.

Here are the instructions for How to Set-up a Proxy User from Ellucian: https://ellucian.force.com/clients/s/article/How-to-create-a-proxy-user-for-Colleague

There are a number of Colleague software components that may require a proxy user; including Mobile, Self-Service and the Colleague API. The same proxy user can be used with each software component or a separate proxy user can be created for each one. The steps below can be followed to create the proxy user and assign the appropriate security.Please note that the steps in this article pertain to proxy users that are used to authenticate on behalf of other users. It does not pertain to the Self-Service person proxy users for parents or guardians.

1. Define the appropriate security class (for example, PROXY.RESTRICTED) using the Security Class Definition (UT-SCD) form in UI.

   • In the Do Only These column, enter LO to restrict general UI and WebAdvisor access. Also enter DMI_SEC_DCFG to allow DMI session proxying.

   • In the Privileged column, enter DMI_SEC_DCFG.

   • Make sure DMI_SEC_DCFG exists in BOTH the Privileged and Do Only These columns.

2. Define an Opers Equivalent on the Operator Definition (UT-SOD) form in UI (for example, PROXY).

   • In the Name field, enter any name. For example, Proxy Opers Equivalent.

   • In the User Interface field, enter WEB.

   • In the Security Classes field, enter the security class you defined using the SCD form in step 1. For example, PROXY.RESTRICTED.

3. Create the proxy user using the Name and Address (NAE) form in UI.

   • Enter a name that you will recognize. For example, Proxy User. Make sure the user has both a first and last name.

   • Make a note of the Person ID.

4. Set up the proxy user in the DMI Registry using the DMI Registry User Setup (DRUS) form in UI.

   • Call up the proxy user ID with the Person ID you recorded in step 3.

   • In the Person User ID field, create a login name. For example, proxyuser.

   • In the Initial Password field, give the proxy a temporary password.

   • In the Env Operator Equivalent field, assign a WebAdvisor user Opers Equivalent record. For example, WEBSTUDENT. When you run the proxy user through the DMI Registry User Setup (DRUS) form in UI for the first time, in the Env Operator Equivalent field, enter WEBSTUDENT or another Opers equivalent that will allow you to login as the proxy to change its password in WebAdvisor.

   NOTE: After setting up the proxy new user, the next thing you will do is change the proxy user's password. Do not enter the PROXY.RESTRICTED Opers equivalent (created in step 2) yet, because that security class will not allow you to you change passwords.

5. Change the password of the proxy user as follows:

   • Access the Colleague System Credentials Def (CCDF) form.

   • In the Credential ID column of the Colleague Systems Credentials table, enter the ID of the person that you created in Step 3.

   • When the Colleague System Credential Setup (CCSU) form is displayed, change the value in the Credential Password field.

   • Save your changes on the CCSU form.

   • If not already set, set up an email notification on the CCDF form to notify you when the password is going to expire.

   • Save your changes on the CCDF form.

   NOTE: If you are using LDAP synchronization then the proxy user would have been created in LDAP after completing step 4. CCDF will not update the password in LDAP. Manually change the password in LDAP to the same password that was used on CCSU. If desired, set the password for the proxy user to never expire in LDAP.

6. Return to the DRUS form and change the Opers Equivalent of the proxy user (created in step 3) to use the Opers Equivalent created in step 2. For example, PROXY.

7. Click Save.

8. Set the proxy user password to never expire in Colleague using the following steps:

   • Access EDRC and enter ORG.ENTITY as the filename.

   • Enter the Colleague ID number of the proxy user as the record ID.

   • Take note of the value in field 14.

   • Cancel from EDRC.

   • Access EDRC again and enter ORG.ENTITY.ENV as the filename.

   • Enter the value from field 14 of the ORG.ENTITY record as the record ID.

   • Enter '99999' (without the quotes) in lines 31 and 32.

   • Save from EDRC.

Step 2: Create Test User

Provide a test user account that can pass authentication, and has overlapping course data in both your SIS and LMS. Click here to view more information about our test user requirements: Test User and Test Data Requirements.

3. Provide the following information to your Technical Consultant

Provide the following information to your Technical Consultant by emailing integrations@readyeducation.com to create a ticket.

1. Colleague TEST

• Confirm Colleague API server is set-up and accessible

• 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

• Colleague API Server URL

• Colleague Utility Account (username + password):

  • Confirm set-up with ability to act as a Proxy User

2. Colleague PROD

• Confirm Colleague API server is set-up and accessible

• 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

• Colleague API Server URL

• Colleague Utility Account (username + password):

  • Confirm set-up with ability to act as a Proxy User

3. Test User

Must be enrolled in overlapping courses in both Banner and your LMS. Click here to view more information about our test user requirements: Test User and Test Data Requirements.

4. FAQs

Why does the Colleague Utility Account need to have the ability to act as a Proxy User?

We need the Colleague Utility Account to have the ability to act as a Proxy User in order to make calls to the Colleague API on behalf of the users. When users authenticate into the Ready mobile app, we use the Proxy User to generate a user proxy session token with Colleague. The token is used to call the Colleague API to return data for the specified user. By using the user proxy session token, Ready Education can make calls to the Colleague API to return data without requiring the users credentials.

What does "the user must exist in your Colleague database as a user" mean?

A test user needs to mirror the configuration of a real student or faculty member. The Colleague API only returns data for users that exist in your Colleague database. We expect these users to have an associated Colleague userID.

We recommend comparing the configuration between the test user and a real student if you're unsure.

Ready Education says they don't have access to generate the user proxy session token. I followed the instructions in the documentation. What do I do next?

We recommend reaching out to Ellucian Colleague support. Explain the steps you took, and let them know you're setting up the Colleague Utility Account with permission to call the /session/proxy-login API to generate the user proxy session token. Colleague support will be able to help you with the configuration.