Submit a Ticket My Tickets
Login  Sign up

Ellucian Colleague Integration

Table of Contents

Supported Fields & Objects
Colleague Integration Pathways
Requirements & Assumptions
Related Articles


  • Coursedog supports real-time integration for both scheduling and curriculum planning data from Colleague.

  • Coursedog is an Ellucian Partner and supports a validated integration with Ellucian Ethos and direct database exposure via an API.

  • Coursedog has successfully deployed this integration with both on premise and hosted/Cloud solutions. Both solutions are built to follow Ellucian designation best practice standards around architecture and security. All data exchanges are handled through REST APIs that are exposed through our middleware.

  • The direct query model is accessed through stored procedures and does not require direct modifications to Colleague.

  • Please visit our Coursedog Integration Methodology for more information about our approach.  

Supported Fields & Objects

  • See the Colleague Direct and Colleague Ethos data workbooks for a list of fields and objects that are currently supported.

  • If it’s in the spreadsheet linked above, that means the integration can support it. If you wish to do less, you can. However, if you want to do something beyond what is documented, then that would be considered a custom integration and will require scoping. 

Colleague Integration Pathways

There are two integration pathways for Colleague: Direct Database and Ellucian Ethos APIs. 

Direct Database / Stored Procedure Queries (“Colleague Direct”)

Overview | Institution Type | Benefits | Considerations | UniData Institutions


  • Coursedog has pre-built stored procedures for bidirectional integration ready to deploy to your environment.

  • Direct database queries are the backbone of most integrations to Colleague and allow controlled direct access to data regardless of the level of customization.

  • Coursedog will handle the Extract, Transform, Load (ETL) data mapping work once the data is pulled from Colleague. 



Institution Type

This is the best fit for the following types of institutions:

  • Those not currently Ethos enabled.

  • Highly customized data structures.

  • Legacy system configurations (e.g. UniData).



  • Simplicity – Does not require an upgrade (Ethos).

  • Security – You have full control of who has access to each table and run the client scripts. 

  • Flexibility – IT staff will likely have the expertise to help close any gaps due to customizations.



  • May not be the long-term vision of your IT staff (See Ethos).

  • Shared Support Model – Support responsibility is shared given the need for a local client.  

  • Your IT staff might not have expertise or resources to assist with the deployment.


UniData Institutions

Coursedog interfaces with Colleague through the AMSA Colleague Adapter (java client hosted on a client side server) which performs a login to Colleague, executes AMSA's custom IS Subroutines inside Colleague to read/write data with Colleague over the database listener port, and then logs out to end the connected session.


Ellucian Ethos APIs

Overview | Institution Type | Benefits | Considerations


  • Ethos is Ellucian’s preferred integration pathway for Colleague. It boasts a unified data model across all platforms built on Open standards (REST, JSON).

  • Coursedog is a trusted Ellucian Partner and boasts an Ethos validated solution.


Institution Type

Ethos is the best fit for institutions who:


  • Are currently using Ethos APIs to expose data externally.

  • Have minimal Colleague data structure customizations.

  • Have updated system configurations (e.g. SQL).

  • Have IT staff available to install any extensions necessary to close gaps due to customizations.



  • Modern standards based (REST, JSON) approach to expose your data.

  • Supported Ellucian solution.

  • Security is consistent with Ellucian and industry standards.

  • Flexible to your needs. IT staff will likely have the expertise to help close any gaps due to customizations (see Ethos extensions).



  • Requires an upgrade to Ethos. 

  • IT staff may not have expertise/resources to perform upgrades.

  • Ethos extensions might be required. 

  • Any downtime such as planned server maintenance and Colleague Cloning, refreshes, migrations, or network reconfiguration on the client side must be communicated in advance by at least two weeks notice 

  • IT staff might not have expertise or availability to install extensions (if necessary). See our Ethos Access and API Requirements for more information.


Requirements & Assumptions

General Requirements | Colleague Direct/AMSA Requirements | Ethos Requirement | Installation Guides

General requirements apply to both Colleague Ethos and Colleague Direct; others are specific to each solution.


General Requirements

  • Institution is using corresponding baseline Colleague Student processes and data structures (e.g. Course Scheduling, Course and Program inventory). The Institution is responsible to meet the needs of their specific environment.

  • Ability to whitelist IPs as needed for Test and Production. Coursedog supports an industry standard transfer protocol for both approaches. Coursedog will install a lightweight client that will pull the information from your database and expose the information externally via SSL/HTTPS. All transmissions will be handled over SSL so no need for you to open any additional ports (443).

  • Ports 443, 3001(test), 3000(prod)


Colleague Direct/AMSA Requirements

  • Virtual or Physical Server with Web Access. Windows 10 Server, 4 CPU Cores, 8 GB Memory, >10 GB of hard disk storage. For Windows, sometimes AD services may need to be added to the server (if not enabled already)

  • Server Public Domain Name configured as “integration.<domain>.edu”

  • Assist with CNAME setup for Certificate installation (Networking Resource).

  • Both domain specific and wildcard certificates are acceptable. However, the Certificate must be CA signed and not self signed. The format of the Cert should be .jks 

  • VPN for access to the network.

  • RDP for access to Integration Web Server.

  • Admin User with ability to install software and URL to Colleague UI for Dev/Test accounts.

  • Hostname of the Colleague Server (IP address or domain name).

  • The path to the app server. Can be obtained through SA Valet or the DWEB screen in Colleague UI (e.g. J:/Ellucian/coll18/test/apphome).

  • Provide Database Listener Port.

  • Colleague Service Account (Username & Password).

  • Unidata Server Login (Username & Password). Typically the same as the Colleague Service account).

  • Colleague Studio access for Development/Test accounts.

  • Upcoming expiration dates of SSL certificates must be provided and the requirement is two weeks notice.


Ethos Requirement

Ethos has been installed and endpoints are exposed (If using Ethos).

Installation Guides

Coursedog commonly partners with N2N for the SIS API integration and requires Docker for a streamlined installation process (See N2N Docker Requirements for on premise solutions).


Related Articles

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.