Sources are pre-existing directories or files containing user accounts and information that OneSync can import data from.
Imports retrieve and stage users per source, so that activity logs are organized by individual source. 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.
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.
Note: Each source must have five fields containing a user’s given name, surname, unique ID, role, and email. The names of these field headers will then be mapped accordingly via OneSync.
Valid sources include Microsoft Active Directory, CSV (comma-separated values) files, and ClassLink OneRoster. Each source requires different forms of credentials or setup:
- Microsoft Active Directory requires credentials including a username, password, protocol, domain, base path, and port number. You can check your connection status by clicking the Test Connection button. The default values for protocol and port number are LDAP and 389, respectively. The domain is the user’s personal preference. The base path is the distinguished name of the domain, including the domain component (DC), and excluding the common name (CN) and organization units (OU).
- CSV files can be uploaded to OneSync by adding CSV files to a OneSync directory. This directory is generated automatically by your installer and can be located at C:\ClassLink OneSync.
- OneRoster requires a URL, API Key, and Secret. If you are importing data from ClassLink Roster Server, you can find the URL at the top right of any page, next to the logout button. You must add “/ims/oneroster/v1p1/users” to the end of the URL.
- You can find the API Key & Secret by navigating to the Applications page, finding the ClassLink app (make sure it has full permissions) and clicking the three dots in the “Actions” column. In the dropdown list, click “API Key and Secret” for the current Key and Secret. Please note that if your server is ever reset, the Key and secret will change. The Key and Secret stored in OneSync will not auto-refresh, so you will need to update the credentials there as well.