Ellucian Colleague Integration

Coursedog Support

Modified on: Thu, Mar 2, 2023 at 9:50 AM

Table of Contents

Overview

Coursedog supports real-time integration for both scheduling, curriculum planning, and student analytics data from Colleague.
Coursedog is an Ellucian Partner and supports a validated integration pathway for both Ethos and non-Ethos institutions.
Coursedog has successfully deployed this integration with both on premise and hosted, cloud, and SaaS 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.

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.
The Ethos integration is the best fit for institutions who are currently Ethos enabled.
See the 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.
- To see supported areas and objects for the read-only integration between Course Demand Projections (CDP) go here.

Coursedog has a pre-built non-Ethos solution for bidirectional integration ready to deploy to your environment. 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.
This is a best fit for institutions that are not Ethos enabled, or highly customized.
See the Colleague Direct 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.
- To see supported areas and objects for the read-only integration between Course Demand Projections (CDP) go here.

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

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)

Coursedog assumes that Ethos has been fully configured and is ready for use by external parties project kickoff.

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.