The CCCTC Colleague API College Adaptor 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
Please contact the implementation team to obtain the latest version of the custom envision code.
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 custom transactions, subroutines and tables used exclusively by the Colleague APICollege Adaptor. It does not contain any changes to Ellucian - delivered code.
Follow these steps to import it into your system:
- 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.
- Run CPIE to import the software into the Colleague LPR.
- 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 College Adaptor 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:
...
- 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 and DMI Account Information
The Colleague APICollege Adaptor, 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.
Custom Code Details
The custom code consists entirely of Colleague Transactions. Colleague transactions are pretty much the same as subroutines: they accept parameters, perform actions and return data. They may read and write data, call subroutines, etc - basically anything that a subroutine could do.
...