Coursedog

Submit a ticket My Tickets
Welcome
Login  Sign up

Ellucian Colleague Integration

Coursedog has built a real time bi-directional integration to both GET and POST schedule & curriculum planning data into 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 in mind 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. 

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

Direct Database (Stored Procedure) queries

Coursedog has a 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 ETL data mapping work once the data is pulled from Colleague. 

See the Colleague data workbook for a list of current supported fields and objects.  



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

  • Not currently Ethos enabled.
  • Highly customized data structures
  • Legacy system configurations (e.g. UniData)

Benefits

  • Does not require an upgrade (Ethos)
  • Security - You have full control of who has access to each table and run the client scripts. 
  • Flexible to your needs. IT staff will likely have the expertise to help close any gaps due to customizations.

Considerations

  • May not be the long term vision of the IT staff (See Ethos)
  • Shared Support Model - Support responsibility is shared given the need for a local client  
  • Client IT staff may not have expertise or resources to assist with the deployment.

Transfer Protocol

UniData institutions: Coursedog interfaces with Colleague on UniData through the creation of SQL tables & virtual attributes for use as a translation layer between Coursedog and the Colleague UniData database files. 

Ellucian Ethos APIs

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.

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

  • Currently using Ethos APIs to expose data externally.
  • Your institution has minimal Colleague data structure customizations
  • Updated system configurations (e.g. SQL)
  • IT staff is available to install any extensions necessary to close gaps due to customizations.

Benefits

  • 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).

Considerations

  • Requires an upgrade to Ethos. 
  • IT staff may not have expertise/resources to perform upgrades.
  • Ethos extensions may be required. 
  • IT staff may not have expertise or availability to install extensions (if necessary)
    *See our Ethos Access and API Requirements for more information

Requirements & Assumptions

Coursedog assumes you meet the following minimum 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.
  • Ethos has been installed and endpoints are exposed (If using Ethos)
  • 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)
  • Non Ethos 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)
    • VPN for access to 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

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)

Please see the Colleague Ethos installation guide for a list of required resources (see bottom of page)

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.