Audience: ClassLink Administrator
Syncs are the devices by which OneSync operates. They include imports from sources, exports to destinations, and dry runs which act as trial runs for exports. When properly set up with automatic syncs, OneSync will provision user accounts from sources to destinations and will require minimal maintenance thereafter. OneSync also allows for manual imports and exports if you want to more closely monitor sync activity.
Manual imports can be run by clicking the Run button next to the desired source on the source page. Alternatively, you can enable an automatic import to run for each source by clicking the Automatic Run toggle next to the Run button. By default, automatic imports are set to run every Sunday at midnight. However, you can set a sync schedule within a source's details.
Automatic exports for destinations run continuously and are inherent to OneSync. However, they must be enabled for the desired destinations via the Automatic Export toggles on the destinations page, as well as in the Settings. If Automatic Exports are disabled, an alert will be displayed in the navigation bar. In addition, any changes made to a destination's mappings or user collections will trigger an export if automatic exports are enabled.
There are three ways to trigger manual exports:
- On the destinations page, click the actions list for the desired destination, and select "Manual Sync". Exports will only be queued if any changes have been made to the destination.
- In the user list, next to the desired user, click the blue play button to export that user to all applicable destinations. The desired destinations must be locally enabled on the destinations main page.
- In the user list, filter the users with any combination of filters and/or search queries. You can then click the grey "Export Filtered Users" button at the top-right to export all the filtered users to their applicable destinations. The desired destinations must be locally enabled on the destinations main page.
Dry runs are an optional trial runs, or mock exports, meant to assess a destination for potential errors. Their activity logs will highlight errors that should be corrected before exporting. They will only queue users to be added or updated, not including already existing users.
To run a dry run, you can click the Dry Run button next to the desired destination on the destinations page. You can then view the dry run activity for that destination to check for errors and fix them prior to actual exports.
Updated: Jan 2019