Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

The CCCTC Colleague API relies on custom envision code to handle some of its processes as well as a proxy DMI user to handle requests to Colleague. This document details how to install the custom envision code and setup the proxy DMI account.


Obtaining the latest version of the custom envision code

The latest version of the envision code is attached to this page. Click the link below to download it.

Installing the custom envision code

The custom envision code is a standard package created using CPIE from the development school's Colleague environment.

Note: This code contains several transactions and subroutines used exclusively by the Colleague API. It does not contain any changes to Ellucian-delivered code.

Follow these steps to import it into your system:

  1. Get the .zip file of the latest version of the software above. Upload the zip file to a folder of your choice on the application server of the environment you are first installing the software. Unzip the file.
  2. Run CPIE to import the software into the Colleague LPR.
  3. Run MSUG to install the package into the Colleague environment(s).

Creating the Proxy DMI Account

The proxy DMI account is a DMI account that you create on DRUS. This account is used by the Colleague API to perform data reads and the envision transactions that you installed in the previous step. Depending on your setup you may have different standards for creating DRUS accounts, so the following steps are just a suggested method:

  1. Create a PERSON record for the DMI account using ORGP (or NAE if you prefer). This will give you a Colleague ID. Suggested name: Glue Proxy.
  2. Create a DRUS record for the PERSON you just created. Suggested login name: glueproxy
    1. The Env Operator Equivalent is not required but not important for this user. If in doubt, use the account your use for WebAdvisor students. Security for DMI connections of this type is not dictated by the Env Operator Equivalent record, hence anything will work.
  3. The implementation team will need to know the username and password of the DRUS account. You can communicate with them the best way to send that password securely (don't email the password). Per the note below, make sure the password does not expire!
  4. Log in to a service to verify the DRUS account before sending over, such as WebAdvisor or Colleague Studio, just to ensure that the password is valid.

Important note!

  1. You need to create a DMI account with a password that does not expire! Generally I believe this can be accomplished by having your registry linked to Active Directory so that you can set the password policy there.

Sharing the Shared Secret

The Colleague API, like other web services including WebAdvisor, requires the Shared Secret to connect. Please send the shared secret along with the Proxy DMI Account information to the implementation team securely (don't use email). You will also need to provide the following connection information to the implementation team: environment name, server and port. These items can be found on DWEB if you're not sure what they are off hand.

If you have not yet set up a shared secret for the environment, you may do so on WSPD.



  • No labels