Step 1: Log in to your account and click on “Integrations” from the navigation panel on the left.
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 “Connection 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 “Test & Save” button to ensure that a successful connection has been established.
Step 5: Go back to the “Integrations” menu on the left side of your screen and select “Data Sync“. Click on the ‘Schedule New Data Sync’ button located on the top right.
Note: 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.
Step 6: Select your Sync Connection from the dropdown and click on “Test Connection”. Once the connection is successful, you can map your fields. When you’re done mapping the fields hit “Next”.
Step 7: Select whether you want to sync data ‘Daily’ or ‘Manual Only’. If you select the Daily option, you can choose the time of the daily sync execution. If you select the Manual Only data sync, you will be able to use the “Sync Now” option on the dashboard page.
Step 8: Here you will need to choose one of the following options:
Option 1: Add New Data & Ignore Existing Records. Select if you’d like to receive notifications, then click ‘Save’.
Option 2: Add New Data & Update Existing Records. Select the actions for existing records missing from your system, then click ‘Save’.
Step 9: To view the status of your data sync, go back to the “Integrations” menu on the left side of your screen and select ‘Sync Statistics’.