Audience: ClassLink Administrator
OneSync exports and updates users in a destination via connections called User Destination Links. These links connect users in OneSync to their respective accounts in a destination. To manage these links, OneSync offers an additional tool called Correlation.
The goal of correlation is to link users in OneSync to users who already exist in the target application for any subsequent actions taken in OneSync and to avoid any user duplication on export. For this reason, it is best to perform correlation before exporting. The process of correlation involves creating sets of increasingly specific conditions to match OneSync Users to users already present in the target application. Any remaining users can be correlated or matched manually.
Correlation also offers additional tools to manage user destination links. You can break these links between accounts if you want to restart the provisioning process. These links may also become broken, rendering a OneSync user useless until that link is unlinked. In any case, correlation can help you manage these links.
Before Correlating users, you can select specific Organization Units from which to stage destination users. Selecting no specific Organizational Units will stage all users in the Destination. While OneSync stages users for correlation, an animation will play to show you the visual progress of the staging. You can always come back to this tab to Re-Stage Users.
Correlation will stage users into two columns, a OneSync column with OneSync users and a destination column with destination users. User destination links are depicted as blue lines connecting one user from each column to each other. In addition users in both columns are staged with a full list of their mappings and properties. You can view any user's mappings by clicking the dropdown arrow to the right of their name to expand their user information cell.
There is also an advanced setting called Include disabled OneSync users in correlation which will include all users from OneSync in the correlation even if they are disabled. This setting is on the right side during User Selection.
Unlinked Users include OneSync users that have not been exported or matched to corresponding accounts in a destination. Unlinked Users also include those users in a destination that have not been linked to an existing OneSync user. The purpose of this tab is to match as many users as possible through automatic rulesets and manual matching to minimize duplicate accounts with subsequent exports.
To start, you can create and run a Ruleset. Access rule creation by clicking the View & Add Rulesets button in the top right of the page. In this view, you will be guided in the creation of conditions and the review of matches based on those conditions. Create rules to reduce the amount of manual matching you will have to do. Try creating rulesets that will, first, accurately match as many users as possible. Subsequent rulesets can consist of more specific conditions to match users not yet matched by broader conditions. Rulesets output a list of matched users. After running a ruleset, click Re-Match to revise a ruleset, or Accept to apply that ruleset and match the outputted users.
You can also manually match users. Select users, one from each table, and review their properties by expanding each of their rows. If selected users are a match, press the Match Selected button at the bottom left of the view.
Linked Users include OneSync users that are connected to their respective user accounts in a destination via user destination links. This tab will include users that were successfully exported from OneSync to a destination.
Here, you can unlink users which will effectively delete their user destination links. You can either unlink users individually by clicking on an individual link between the desired user accounts, or you can unlink all users by pressing the Unlink All Users button in the top right corner.
Broken Links include OneSync users who have user destination links to a destination, but found no corresponding users to match those users. This means that the corresponding user accounts within a destination were somehow deleted. Thus, attempts to update users through these broken links will force an error within OneSync since there are no corresponding users within the destination to update.
Users with broken user destination links cannot be updated until their links have been unlinked. To unlink all broken links, simply click the Unlink All Broken button in the top right corner.
The Disable Users tab displays destination users within your selected organization units. Here, you can manually disable individual or groups of users. You can highlight an individual user to disable it. You can click the Disable All Users button in the top right corner. Or, you can you can search for and disable more specific groups of users. To do so, use the search bar to enter your query, then click the Disable Filtered Users button in the top right corner. This filter is currently only available for names, but will be expanded to more fields. More about disabled users can be reviewed here.
Correlation is complete when there are no more OneSync users to match to users in the target destination or when no more accurate matches can be made. Correlated OneSync users will have user destination links connecting them to corresponding destination users so that they can update these accounts in subsequent syncs. Any remaining OneSync users still do not have user destination links, but can be exported as new users to the destination.
When finishing a correlation, you will be prompted to run a Dry Run or Export. It is advised to run an export to update all accounts analyzed during correlation.
Updated: Oct 2019