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 enter the name of the connection in the “Integration Name” field (note that you can customize the name of the integration). 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 “Test & Save” button to ensure that a successful connection has been established.
Step 5: Tick all the “Required APIs” and any “Additional APIs” which you would like to sync and then click the “Next” button. Setting up the data sync allows you to choose the type of data you want to sync while also allowing you to set up a schedule for the sync.
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, you can hit “Save”.
Step 7: To view the history of your data sync, go back to the “Integrations” menu on the left side of your screen and select “Sync History”.
