Step 1: Log in to your IDMS account and click on the “Integrations” icon from the navigation panel on the left menu.
Step 2: If this is your first attempt at setting up the integration, click on “Sync Connections”.
Step 3: Once you are on the Sync Connections page, click the ‘Add New Connection’ button on the top right.
Step 4: Select ‘Ellucian’ from the “Connection Type” dropdown and name the connection in the “Integration Name” field. Then, select “Colleague” from the “Product” dropdown. Once the product is selected, you must provide a generated API Key from Ellucian. Once the generated API Key is entered, click the ‘Next’ button.
Note: If you need assistance generating an API key from Ellucian, please contact firstname.lastname@example.org.
Step 5: Ensure that all the APIs are selected in the ‘Required APIs’ section. You can select the optional APIs in the “Additional APIs”. Click the “Next” button when finished.
Note: If you extend your database model by adding a custom field to the Persons API then we can consume the custom field and map it to a field on the digital ID card.
Step 6: Click on “Test Connection”. Once the connection is successful, hit “Save”.
Step 7: To view the history of your data sync, tap on the “Logs” menu from the navigation panel on the left and select ‘Sync Log’.