Functionalities
The Ellucian Ethos Connector is a provisioning only connected system.
-
The Identity functionalities of this connector enable you as an Identity administrator to configure Ellucian Ethos as a connected system.
- The Provisioning functionalities of this connector enable importing and exporting and importing of different api data formats by connecting either Banner or Collegue API key. This is a REST based connector and supports the following data formats.
Supported Features
Global Data Formats
| Data Format |
Rest Endpoints Supported Version |
Export |
Create |
Modify |
Delete |
|
Persons |
Persons(v12) |
Y |
Y |
Y |
N |
|
Organizations |
Organizations (v6) |
Y |
Y |
Y |
N |
|
Employees |
Employees (v12) |
Y |
N |
N |
N |
|
*Students |
Students (v7) |
Y |
N |
N |
N |
|
Course |
Courses(v16) |
Y |
Y |
Y |
N |
Cases to be Special handled if needed
please refer https://app.asana.com/0/1171326086222553/1170943831979530/f for details (Internal purpose)
| Data Format | Comment |
|---|---|
| Academic Level | Colleague does not support Create whereas banner supports it. The case where colleague and banner supporting different operations might be fixed by Ellucian in their coming releases. |
| Academic Period Enrollment Status | Banner supports version 7 where as colleague supports version 6. The case where colleague and banner supporting different versions might be addressed by Ellucian in their coming releases. |
| Residency Type | As per availability doc, banner supports version 7 and colleague supports version 6 ,7. But unfortunately 7 is found to be NOT supported in colleague. |
| Student | Student export failed in colleague only due to the above issue. Residency type fetch call was going from student. |
Sub Data Formats
| Data Format |
Rest Endpoints Supported Version |
Export |
Create |
Modify |
Delete |
|
Academic Discipline |
academic-disciplines (v10) |
Y |
Y |
Y |
N |
|
*Academic Levels |
Academic-levels (v6) |
Y |
Y |
Y |
N |
|
*Academic Period Enrollment Status |
Academic-period-enrollment-statuses (v7) |
Y |
N |
N |
N |
|
Academic Periods |
Academic-periods (v16) |
Y |
N |
N |
N |
|
Academic Program |
academic-programs (v15) |
Y |
N |
N |
N |
|
Address Type |
Address-types (v6) |
Y |
N |
N |
N |
|
Addresses |
Addresses (v6) |
Y |
N |
N |
N |
|
Administrative Periods |
Administrative-periods (v1) |
Y |
N |
N |
N |
|
AdministrativeInstructionalMethods |
administrative-instructional-methods(v1) |
Y |
N |
N |
N |
|
Admission Application Type |
admission-application-types (v6) |
Y |
N |
N |
N |
|
Admission Application Withdrawal Reason |
admission-application-withdrawal-reasons (v6) |
Y |
N |
N |
N |
|
Admission Population |
admission-populations (v6) |
Y |
N |
N |
N |
|
Admission-applications |
Admission-applications (v11) |
Y |
Y |
Y |
N |
|
Alternative Credential Types |
alternative-credential-types(v1) |
Y |
N |
N |
N |
|
Buildings |
buildings(v6) |
Y |
N |
N |
N |
|
Campus-involvement |
Campus-involvement (v7) |
Y |
N |
N |
N |
|
campus-organizations |
campus-organizations (v7) |
Y |
N |
N |
N |
|
campus-organization-types |
campus-organization-types (v7) |
Y |
N |
N |
N |
|
Charge Assessment Methods |
Charge-assessment-methods(v13) |
Y |
N |
N |
N |
|
Citizenship Statuses |
citizenship-statuses(v6) |
Y |
N |
N |
N |
|
Course Categories |
course-categories(v11) |
Y |
N |
N |
N |
|
Course Levels |
course-levels |
Y |
N |
N |
N |
|
Course Status |
Course-status |
Y |
N |
N |
N |
|
Course Title Types |
course-title-types(v1) |
Y |
N |
N |
N |
|
Course Topic |
course-topics |
Y |
N |
N |
N |
|
Credit Categories |
Credit-categories(v6) |
Y |
N |
N |
N |
|
Educational Institution |
educational-institutions (v6) |
Y |
N |
N |
N |
|
Educational Institution Unit |
educational-institution-units (v7) |
Y |
N |
N |
N |
|
Email Type |
Email-types (v6) |
Y |
N |
N |
N |
|
Ethnicities |
ethnicities (v6) |
Y |
N |
N |
N |
|
Gender Identities |
gender-identities(v1) |
Y |
N |
N |
N |
|
Geographic area types |
geographic-area-types(v6) |
Y |
N |
N |
N |
|
Geographic Areas |
geographic-areas(v6) |
Y |
N |
N |
N |
|
Grade Definitions |
grade- definitions(v6) |
Y |
N |
N |
N |
|
Grade Modes |
Grade-modes(v6) |
Y |
Y |
Y |
N |
|
Grade Schemes |
grade-schemes(v6) |
Y |
N |
N |
N |
|
Instructional Events |
Instructional-events(v8) |
Y |
Y |
Y |
N |
|
Instructional Methods |
instructional-methods(v6) |
Y |
Y |
Y |
N |
|
Instructional Platforms |
Instructional-platforms(v6) |
Y |
N |
N |
N |
|
InstructionalDeliveryMethods |
instructional-delivery-methods(v11) |
Y |
N |
N |
N |
|
Instructor |
instructors(v9) |
Y |
N |
N |
N |
|
Instructor Categories |
instructor-categories (v9) |
Y |
N |
N |
N |
|
Instructor Staff Types |
instructor-staff-types (v9) |
Y |
N |
N |
N |
|
Instructor Tenure Types |
instructor-tenure-types (v9) |
Y |
N |
N |
N |
|
Interests |
interests (v6) |
Y |
N |
N |
N |
|
Marital Statuses |
marital-statuses (v6) |
Y |
Y |
Y |
N |
|
Person Guardians |
Person Guardians (v7) |
Y |
N |
N |
N |
|
Person Name Types |
Person-name-types (v12) |
Y |
N |
N |
N |
|
Personal Pronouns |
personal-pronouns (v1) |
Y |
N |
N |
N |
|
Persons-credentials |
Persons-credentials (v11) |
Y |
N |
N |
N |
|
Phone Type |
Phone-types (v6) |
Y |
N |
N |
N |
|
Races |
races (v6) |
Y |
N |
N |
N |
|
Religions |
religions (v6) |
Y |
N |
N |
N |
|
*Residency Types |
Residency-types (v7) |
Y |
N |
N |
N |
|
Rooms |
rooms(v10) |
Y |
N |
N |
N |
|
Section Description Types |
Section-description-types(v1.0.0) |
Y |
N |
N |
N |
|
Section Grade Types |
Section-grade-types(v6) |
Y |
N |
N |
N |
|
Section Registration Statuses |
Section-registration-statuses(v8) |
Y |
N |
N |
N |
|
Section Registrations |
Section-registrations(v16.0.0) |
Y |
N |
N |
N |
|
Section Registrations Grade Options |
Section-registrations-grade-options(v1) |
Y |
N |
N |
N |
|
Section Statuses |
Section-statuses(v11) |
Y |
N |
N |
N |
|
Sections |
Sections(v16) |
Y |
Y |
N |
N |
|
Sections Maximum |
Section-maximum(v8) |
Y |
N |
N |
N |
|
Site |
sites (v6) |
Y |
N |
N |
N |
|
Social media types |
Social-media-types |
Y |
N |
N |
N |
|
sources |
sources (v6) |
Y |
N |
N |
N |
|
Student Classifications |
Student-classifications (v7) |
Y |
N |
N |
N |
|
Student Statuses |
Student-statuses (v7) |
Y |
N |
N |
N |
|
Student Tags |
Student-tags (v7) |
Y |
N |
N |
N |
|
Student Types |
Student-types (v7) |
Y |
N |
N |
N |
|
Student-academic-period-profiles |
Student-academic-period-profiles (v7) |
Y |
N |
N |
N |
|
Student-academic-standings |
Student-academic-standings (v8) |
Y |
N |
N |
N |
|
Student-registration-eligibilities |
Student-registration-eligibility (v9) |
Y |
N |
N |
N |
|
Student-section-waitlists |
Student-section-waitlists (v10) |
Y |
N |
N |
N |
|
Student-unverified-grades |
Student-unverified-grades (v1) |
Y |
N |
N |
N |
|
Student-unverified-grades-submissions |
Student-unverified-grades-submissions (v1) |
N |
Y |
Y |
N |
|
Subjects |
subjects (v6) |
Y |
Y |
Y |
N |
Prerequisites
Ensure that these prerequisites are satisfied:
- An administrator account that can be used to establish a connection and has authority to manage the above data formats in Elucian Ethos.
- Identity Administrator rights to create the connected system from the AdminUI.
Creating the Connected System in the Admin UI
- Log in to Identity Administration and click the Systems tab.
-
On the Connected System View page, click the Add button and select the Ellucian Ethos connected system from the Type drop-down list. The Connected System Details page displays the default values.
-
Enter the desired information.
Definition Supported Connectors
Displays whether the connected system is Identity only, Provisioning only, or both. Type Select the connected system type. Locale
Select the preferred language (default: English). Locale specific information such as Display Name and Description can be added only while modifying the connected system. Name The name for this connected system. Note: The name cannot be modified later. Display Name The display name of the new connected system. Description The description of the connected system. Associated With
Select how the connector associated with this system will run:
- Server (default) - Runs locally on the Provisioning/Identity Server.
- Global Identity Gateway - Runs remotely on a Global Identity Gateway cluster member. Note: Only GIG clusters that have at least one registered and enabled member will display in this list.
- See Using the Global Identity Gateway with Connected Systems for additional information.
Password Reset By Enables administrators to configure password management functions normally available to Users and OBO (On Behalf Of) Users: - OBO User Only - Connected system and account association information is displayed only in Self-Service user management (for OBO Users). OBO Users can reset passwords for accounts on this connected system. Administrators can perform all user management functions for this connected system (e.g., enable/disable, validate, associate user, and password reset). End users will not see their accounts on this connected system in Self-Service and Kiosk; therefore, they cannot reset passwords for accounts on this connected system.
- Users and OBO User - Connected system and account association information is displayed in Self-Service password reset, Self-Service - Kiosk, and Self-Service user management. Self-Service users, Kiosk users, and OBO Users can reset passwords for accounts on this connected system. Administrators can perform all user management functions for this connected system (e.g., enable/disable, validate, associate user, and password reset).
- External - Connected system and account association information is not displayed in Self-Service password reset, Self-Service - Kiosk, and Self-Service user management. Self-Service users, Kiosk users, and OBO Users cannot reset passwords for accounts on this connected system.
Note: When user management configuration enables OBO Users to perform password resets, this definition must be set to OBO User Only or Users and OBO User. For connectors that support Provisioning only, there is no password reset capability.
Provisioning Option Select the provisioning option: - Automated (default) - The connected system functions as a normal connected system; there are no restrictions.
- Administrative - The connected system cannot be used as an object in a workflow.
Enable HPAM Support Select to make the connected system HPAM enabled (default: cleared). Note: This can only be set for systems that support Identity. Connection Information API Key
Unique Identifier key to connect Ellucian Ethos.
System Owner (Optional) Adds or removes users assigned as the owners of the system. Displays the Connected System Owner Search page for selecting users. To select owners of the system, click the System Owner Add button. The Connected System Owner Search page displays: Can select the users to be added as system owner.
-
Click the Test Connection button to test the Connection Information:
- If successful, this message may display:
Message: Connection from Provisioning to the connected system was established successfully.
- If unsuccessful, this message may display:
Error: Failed to establish connection from Provisioning to the connected system.
Note: If the connection fails, additional messages may display providing more information regarding the failure, and additional information may be posted to the Provisioning and Identity logs.
-
On the Connected System Details page, click the Add button to save the configured connected system. The Object Category Association page displays a list of categories that are already associated and/or can be selected to add additional associations to this connected system.
Using the Connected System for Provisioning
Perform these procedures to configure the connector:
Note: If the number of records to be processed exceeds one thousand, we recommend configuring the workflow to use bulk mode, which lowers the memory consumption of the system by streaming data to files. Because data is streamed for every task, performance of the workflow execution will be decreased due to increased read-write operations. See the Workflow and Connectivity Studio document for details on how to configure bulk mode.
Configuring for Export
Perform these procedures to configure the connector for data export:
Configuring the Export Connector
- In the Design pane, double-click the export object (the first workflow object after the Start object).
The Configure Data Source window displays:
-
From the Configure Plug-in tab, set these properties as required:
Associated Connected System Select the connected system from the list. The export operation will be done from this connected system. Data Formats Select the type of data format to use: Person (default) DeltaExportMode Select the type of attribute to export if a change takes place (this works in conjunction with ExportMode when DeltaExport is selected):
- OnlyChangedAttributes - Performs a partial export of only the changed attributes from the last time the query was run.
- ChangedAndMandatoryAttributes (default) - Performs a partial export of both changed and mandatory attributes from the last time the query was run. Mandatory attributes are exported whether they have been changed or not.
- AllAttributes - Performs a full export of all attributes that contain a value.
DynamicConnectedSystem Select the global variable to use as the dynamic connected system name. This works in conjunction with DynamicCon- nectedSystemOption when GlobalVariable is selected.
DynamicConnectedSystemOption Select how to control Dynamic System Support:
- None - There will not be any Dynamic System Support.
- Transaction-SystemName - The value of the Transaction- SystemName attribute in data will be used as the dynamic connected system. The connected system name must be passed as the value of the attribute Transaction- SystemName; if it is missing in data, the operation will fail.
- GlobalVariable - Select a global variable to use as the dynamic connected system name from the property
ExportEntryByID
Option to fetch the details of an entry by providing id. ExportMode Select the type of data to export:
- FullExport - Exports all
- DeltaExport - Exports changed, mandatory, or all attributes, depending on the DeltaExportMode property setting.
Max Results
Results Per PageMaximum Number of results to be returned.
Number of entries fetched in a single call. If paging is not required set this to 0.
Configuring the Export Link
-
In the Design pane, double-click the export link between the export object (the first workflow object after the Start object) and the Data Mapper object. The Configure Link window displays:
Element Description Source Attributes Select the attributes to export.
Selected Attributes Displays default attributes and those attributes that have been selected from the Source Attributes.
Notes: The check boxes are used only for delta export operations. These checked attributes will always be exported whether they were changed or not. Usually, the attributes that are selected as mandatory attributes help in identifying or verifying an entry when completing mapping functions.
Format Displays the Format Date window to specify a date/time format to be applied to the selected date type attribute, for example, BirthDate. During export, the attribute's value is converted to the specified format. See the Format Date steps below for additional information.
Note: The Format button is only enabled for date attributesAdvanced Settings Displays the Configure Attributes window for selecting any attributes that need to be encrypted. - From the Attribute Selection tab, select attributes to export. Usually, these attributes that are selected (mandatory attributes) help in identifying or verifying an entry when completing Data Mapper functions.
- Deploy the workflow by selecting Deploy ► New Deployment.
See the Workflow and Connectivity Studio document for details of deployment options. - Manage and run the deployed workflow from the Admin UI ► Server tab.
See the Identity Suite Administration Guide for details.
Configuring the Import
Perform these procedures to configure the connector for data import:
- "Configuring the Import Connector"
- "Configuring the Import Link"
Create an import workflow. See the Workflow and Connectivity Studio document for details on creating import workflows.
Configuring the Import Connector
- In the Design pane, double-click the import object (the last workflow object). The Configure Data Source window displays:
-
From the Configure Plug-in tab, set these properties as required:
Element Description Associated Connected System Select the connected system from the list. The import operation will be done to this connected system. Data Formats Select the type of data format to use: Person(Default) DynamicConnectedSystem Select the global variable to use as the dynamic connected system name. This works in conjunction with DynamicConnectedSystemOption when GlobalVariable is selected. DynamicConnectedSystemOption Select how to control Dynamic System Support (DSS): - None - There will not be any Dynamic System Support.
- Transaction-SystemName - The value of the Transaction-SystemName attribute in data will be used as the dynamic connected system. The connected system name must be passed as the value of the attribute Transaction-SystemName; if it is missing in data, the operation will fail.
- GlobalVariable - Select a global variable to use as the dynamic connected system name from the property DynamicConnectedSystem.
See the Dynamic System Support appendix in the Workflow and Connectivity Studio document for additional information.
Configuring the Import Link
-
In the Design pane, double-click the import link between the Data Mapper object and the import object (the last workflow object). The Configure Link window displays:
Element Description Source Attributes Select the attributes to import.
Check for attribute-level auditing If auditing is enabled and these attributes below are checked, Provisioning will log all events for auditing purposes.
Selected Attributes Displays default attributes and those attributes that have been selected from the Source Attributes. Check the box of any attribute required for attribute-level auditing.
Advanced Settings Displays the Configure Attributes window for selecting any attributes that need to be encrypted.
Lookup Data
To lookup data from Ellucian Ethos, use the Data Mapper rule Lookup Data.
- Log in to the Workflow and Connectivity Studio and double-click the Data Mapper object on the Design pane.
The Configure Data Mapper window displays. - Select the Lookup Data rule under the Mapping Rule column, and then click the Source Value.
The Configure Lookup window displays. - Select the Ellucian Ethos system from the Select System drop-down list:
-
In the Enter Lookup Prefix field, enter the prefix to be added to the Lookup fields.
- Select the Lookup Type from the drop-down list User of Group by Id.
- Click the Pick button to set the Id.
- Click the Fields Pick button to select the attributes to be fetched after a successful lookup.
-
Select the Exit as Mapper Task Failed on Lookup Failure check box to exit the task with Failed status on lookup failure. It will not process the succeeding entries and will ignore the already processed entries and will not return any data. This is selected by default.
-
Click OK.