Audience: (ClassLink Administrator)
Sources are pre-existing directories or files containing user accounts and information that OneSync can import data from. There are three different source types, which are explained in depth here.
- Imports and Sync Schedules
- Import Filter
- Source Mappings
- Data Transforms
Thresholds allow you to limit and monitor the number of users or edits imported from a source. Click here to read more about thresholds.
Imports and Sync Schedules
When creating a source, you have the option to enable or disable automatic imports using the toggle at the top right. If disabled, you will have to run the import manually by clicking the play button included in the sources table. If enabled, syncs will run on a schedule. When creating a source, you can set a Sync Schedule including the day(s) and time(s). If no sync schedule is set, syncs will automatically run every Sunday at midnight.
Filters allow you to select a specific set of users to import into OneSync based on a chosen property and set value. Currently, you can only select one property by which to filter by. Additional filters will be added in later versions.
Source Mappings define and edit how imported users and their properties will map to OneSync fields. Source fields are loaded from the source file or program. These fields can then be mapped to OneSync fields.
For example, source fields would include the field headers of a CSV file. A typical CSV file might contain field headers such as first name, last name, and employeeNumber. These fields can then be mapped, or linked to, OneSync fields such as givenName, surname, and uniqueId, respectively. Additional fields and mappings may be added for a source, such as email and role in the above image. However, each source must have fields containing a user’s given name, surname, and unique ID.
Before you map fields and import users from a source, you can modify field values and data with OneSync's preprocessor. Select a field, provide an initial value, and a replacement value to change the initial value to, then run an import from that source to apply the changes. This process is case sensitive. You can set data transforms before or after you run an import. Deleting data transforms will cause the effected data to revert to their original values. However, these revisions will not be queued as updates in the system logs.
Updated: Jan 2019