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 single or set of logical conditions. These conditions use the same relations that you could use to define collections and destination mappings.
The available relations depends on the source type. CSV sources can use any of the relations listed in OneSync. Roster Server sources have a limited number of relations, including contains, equals, and not equals. Filters are not included in ODBC sources since filtering can be achieved with the appropriate query.
If you already have sources with outmoded filters, but then update OneSync, your filters will be converted into new ones that use the "equals" relation.
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. You can also create and edit custom OneSync fields while mapping to a source.
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 an 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 pre-processor. 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 affected data to revert to their original values. However, these revisions will not be queued as updates in the system logs.
You can now browse for Transform files by clicking on the "Import Transform File" button in the top right-hand corner, instead of moving the desired file to the ClassLink folder. You can also readily download transforms by clicking the "Download Transforms" button. Duplicate transformations will be automatically removed from the list of transforms after saving a source. Sorting can be performed on any of the three fields (OneSync Property, Initial Value, and Replacement Value) by clicking the arrow next to each field header. An up arrow will sort in ascending order and a down arrow will sort in descending order. Drag & drop functionality has been added to each transform so that you can readily sort as you see fit.
A "Replace All" functionality has been included to replace all values for Initial Values. Simply enter an asterisk in the desired field or click the blue "All" button in the desired transform's Initial Value. Note that this functionality is only allowed in Initial Values.
Updated: Mar 2019