Overview
The Ellucian Colleague integration uses Ellucian Ethos to provide Room Reservations with read-only access to academic terms, class sections, meeting schedules, instructors, instructional methods, section statuses, and room assignments.
This article lists the information and configuration Concept3D needs from your institution before the connection can be configured and tested.
What Is Ellucian Ethos?
Ellucian Ethos is Ellucian’s integration platform and API layer. It gives authorized applications standardized access to Colleague data.
Using Colleague does not automatically mean your institution has Ethos access. Before beginning implementation, confirm that your institution can:
-
Access Ellucian Ethos
-
Create or provide an Ethos API key
-
Grant the key read access to all resources required by the Room Reservations integration
Required Participants
Implementation typically requires these participants from your institution and Concept3D:
-
A Room Reservations Platform Admin or Facilities Manager
-
A Colleague or Ethos administrator
-
A network or security administrator who can update firewall rules
-
A Concept3D Partner Success Manager
Network Requirements
Your institution must allowlist all Concept3D integration IP addresses for the environment being connected so the integration can reach your Ethos environment.
| Environment | IP addresses to allowlist |
|---|---|
| QA or testing | 35.172.132.9 and 23.20.165.255 |
| Production | 34.204.16.78, 54.163.130.168, and 54.204.165.208 |
Allowlist every IP address listed for the environment being configured. If both QA and production connections will be used, allowlist all five addresses.
Information Your Institution Must Provide
Provide the following information to your Concept3D Partner Success Manager:
-
The Ethos API key for the environment being connected
-
Whether the connection is for QA/testing or production
-
Confirmation that all Concept3D integration IP addresses for the environment have been allowlisted
-
Confirmation that the API key has read access to all required Ethos resources
-
A Colleague or Ethos technical contact for connection testing
-
An academic term that can be used for validation
Security: Share the Ethos API key only through the secure credential-delivery process provided by Concept3D. Do not send the key by email or include it in a support ticket, shared document, screenshot, or chat message.
Required Data Access
The Ethos API key must provide read-only access to the information Room Reservations needs to create accurate class reservations. Room Reservations does not write changes back to Colleague.
Academic Scheduling
-
Academic periods and terms, including sub-periods and parts of term
-
Class sections, including section code, number, title, and start and end dates
-
Section statuses
-
Meeting patterns or instructional events
-
Meeting start and end dates
-
Meeting days and times
-
Instructional methods
Read access must cover the complete academic-period structure so Room Reservations can connect a section’s part of term or sub-period to its parent term.
Locations
-
Rooms, including each room’s identifier and room number for mapping and display
-
Buildings, including each building’s identifier, code, and name for display
People and Course Information
-
Instructors, including names and identifiers available through the Ethos Persons resource
-
Courses, including the course code and title used to label reservations
-
Sites or campuses
Section Capacity
- Maximum enrollment or capacity for each section
Colleague Data Readiness
Before connection testing, confirm that the validation term contains representative data:
-
Active class sections
-
Meeting patterns with valid start and end dates
-
Meeting days and times
-
Room assignments
-
Stable room identifiers
-
Instructor names and instructional methods, when used by your institution
Classes without assigned rooms cannot be imported into Room Reservations. Sections may also be excluded based on their status in Colleague.
Your Institution’s Responsibilities
-
Provide the Ethos API key through the approved secure process
-
Grant the required read-only access
-
Allowlist all Concept3D integration IP addresses for the environment
-
Provide a representative validation term
-
Correct inaccurate academic schedule data in Colleague
-
Maintain the Ethos API key and notify Concept3D before rotating or revoking it
Concept3D Responsibilities
-
Provide the QA and production IP addresses
-
Configure your institution’s SIS connection
-
Store connection credentials securely
-
Validate authentication and required data access
-
Make the integration available in Room Reservations
-
Assist with the initial term and room-mapping validation
Validate the Connection
Work with Concept3D to confirm that:
-
Current and upcoming academic terms load successfully
-
Sections can be retrieved for the validation term
-
The complete set of classes for the validation term is available
-
Meeting days and times are present
-
Room assignments and recognizable room and building details are present
-
Section statuses are available
-
Instructor and instructional-method data are available when expected
-
The connection does not return authentication, authorization, or firewall errors
After connection validation, continue with Map SIS Rooms to Room Reservations Spaces.
Troubleshooting
| Issue | Likely cause | Resolution |
|---|---|---|
| Connection times out or is refused | One or more Concept3D integration IP addresses are not allowlisted | Confirm that both QA addresses or all three production addresses are allowlisted, depending on the environment |
| Authentication fails | The API key is invalid, expired, revoked, or belongs to a different environment | Generate or provide a valid key for the intended environment through the approved secure process |
| Terms load but sections do not | The API key lacks access to one or more required resources | Review the key’s read access with your Colleague or Ethos administrator |
| Expected classes are missing | Sections are outside the selected term, excluded by status, or missing usable meeting data | Review the term, section status, and meeting information in Colleague |
| Classes appear without usable rooms | Sections do not have room assignments or stable room identifiers in Colleague | Assign rooms in Colleague, then run the import again |
| Colleague data is incorrect in Room Reservations | The source record is incorrect in Colleague | Correct the class in Colleague and re-sync the term |