Audience: ClassLink Administrator
- Google Sheets
- CSV Destinations
- Authorization Module
- User Details
- For All Users
- Destinations: Automatic Collection
- Log Settings/Retention
- Event & Actions- VB Script and Remove From Unmanaged Groups, User Is Edited
- Collection Membership
- Verify Network Share
- Email Notification Improvements
- Export Log Actions
- Data Transforms on Blank Values
- Active Directory Advanced Fields
- STRIP_SUFFIX() Function
- User Email Recovery Prompt
- Sync All Confirmation Modal
- Source Thresholds
- Collections List
- Description Field
We've added a brand new source: Google Sheets! This will allow you import your spreadsheet data into OneSync.
Similar to GSuite, Google Sheets will need its own API key and secret. To create a new API key and secret for Google Sheets navigate to https://console.developers.google.com and enter the credentials of the Google account that you will be using to create API credentials with. From the dashboard you will want to navigate to the Google Library and select Google Sheets:
Make sure that you have your ClassLink application selected in the top left corner. Refer to the Authorization & API credentials document to learn how to set this up: https://support.classlink.com/hc/en-us/articles/360009284674-Authorization-API-Registration
After clicking on the Google Sheets API box, you will now want to enable the API connection:
After you enable your Google Sheets API you now have an API key and secret that you can use. Before using these credentials you will first want to alter the scope of credentials by navigating back to the Dashboard -> then navigate to the OAuth Credential Screen (which will be on the left navigation bar) and adding these two new scopes down below:
For security purposes OneSync will only accept Google Sheets that are not publicly accessible, this means that the Google user that is authorizing must have full access to the Google Sheet. For security reasons it is best to only import Google Sheets that you have created or a Sheet that has been created and managed by somebody within your organization.
When creating a google sheet you will be required to fill in the following fields:
- Source Name: This will be the name of your Google Sheets source in OneSync
- Source Type: This will be the type of source (in this case Google Sheets)
- Authorization Credential: The authorization credentials that you have set up in the Google Developers Console. You will need to sign into the account that has access to this Google Sheet.
- Sheet URL: The URL of the Google Sheet (make sure to use the entire URL)
- Sheet Name: A drop down that will list all of the available Sheets on that Google Sheet
- Description: This provides a description for your OneSync source
- Cell Range: You have the option to specify a cell range of the particular sheet selected. For example if you were to use A1:D15 OneSync would read from range of cell A1 to the cell D1.
Once setup you will be able to import from this Google Sheet similar to how you would import from a CSV source.
CSV Sources: Network Share
Network share has been added to the retrieval options for CSV Sources, this means that you will now be able to import data from a CSV over a Network Share. To use this option select Network Share from the CSV Retrieval Protocol dropdown. The required properties are:
- Domain: The domain that this file is being retrieved from. OneSync must be on the same domain to retrieve the file.
- Username: A username that is on the domain specified.
- Password: The password for the user.
- Base Path: The basepath of Network Share, which will be the Network Share path for the computer or server that the file is being retrieved from.
- File Path: The path of the file being retrieved which can be a path of directories for which the file is in.
We have made some improvements to CSV destinations to improve stability and reliability. With these behind the scenes improvements we have also added a CSV Destination Protocol that will allow you to remotely export CSVs via SFTP, FTPS, and Network Share.
When creating or editing a CSV destination select your desired protocol by clicking the dropdown CSV Destination Protocol. After selecting your protocol fill in the file configuration and don't forget to test your connection!
Here's an example of an SFTP configuration that's retrieving a file from the local computer over an SFTP connection:
We have also added a new feature called Generate CSV which will re-download the CSV destination without re-exporting the user set. This is particularly useful to see what data these users have within OneSync without having to reprocess all of the configurations through an export.
A new feature that has been added to keep authorization credentials together in a single place is the Auth Credentials tab in OS Settings. You can add new credentials by clicking the blue Add Auth Credential button in the top right corner of the page which is shown below:
You can also edit previously made credentials by clicking the edit button which is a pencil and paper icon. When creating or editing a credential you can either Save or Save + Authorize, Save doesn't prompt an authorization pop-up whereas Save + Authorize prompts for the appropriate credentials for the account being authorized.
We've added a small new feature to help with keeping track of a user's history within OneSync. There are now three fields that will display when previewing a user: Date Added, Date Updated (user is edited), and Date Disabled. These fields will not be able to be mapped to in a destination, they are just OneSync properties that are being tracked for user convenience and knowledge.
For All Users
We've updated the behavior of the condition For All Users, before this was a condition that could be selected similar to how any condition is setup, but now we've added a toggle that will set this condition.
Destinations: Automatic Collection
Another small change that we've made is when creating a new destination the collection that is automatically generated will have the condition No Condition. This means that no users will be included within the collection and the condition will need to be manually updated to include the user set for this destination.
Google Group Assignment
Google group assignments now have the option to set users as a member, manager, or owner. To set these values when creating or editing a group navigate to the action tab of the group mapping slide-over and click on the blue cog next to your group name:
After clicking the blue cog you will be navigated to a page where you can chose the membership type for the users being mapped to this group.
Log settings have been moved into its own tab in OS Settings (which can be accessed by clicking the blue cog in the top right corner of your navigation bar). As you can see there are still three different log types to choose from: Default, Verbose, and Debug.
We've also added more options when setting Log Retention which means you can now specify how long you store Import, Export, Dry Run, Correlation, and System Logs. Not only that but you can also specify the retention period for each type of log.
Event & Actions- VB Script and Remove From Unmanaged Groups
Two new actions have been added to the Events & Actions section within Destinations. First we have Execute Visual Basic Script, which will run a specified VB script with any given parameters.
Here's an an example of an event with a test.vbs file that is on the same computer as OneSync:
By clicking the blue cog you can enter any parameters (in order) for your script here:
The second action that we've added is Remove From Unmanaged Groups which as it sounds removes the selected users from any groups that OneSync hasn't created. Use this action by creating a new Event with a condition and under the Actions tab select Remove From Unmanaged Groups under the type. This event will now trigger for each user that meets the condition for this event.
User Is Edited
The last action that we've added is User Is Edited which is a condition that triggers anytime that a user is edited during an export.
Collection membership has been revamped for a simpler experience when manually adding/removing users from collections via the user list. As you see below the flow of manually removing and manually adding users to collections is the same, it has been improved visually for an easier experience.
Verify Network Share
A new feature has been added that allows the Events & Action Verify Network Share to set the user permissions on the network share being set during the export.
There are two user permissions:
- Full Control: Allows users to read, write, change, and delete files and subfolders. In addition, users can change permissions settings for all files and subdirectories.
- Modify: Allows users to read and write of files and subfolders.
Email Notification Improvements
A new email template has been implemented to go out on import cancellation action. This feature will help the user to differentiate between cancellation, fail, and success action emails.
To start seeing this new email template, simply navigate to the main settings page, then navigate to System Notifications and from there enter the email(s) that these notifications will be sent to. Then toggle the All imports and save your changes.
Export Log Actions
New features have been added to Export and Dry Run logs which include the ability to launch an export to a user directly from his/her logs. Also there are now two new tabs in the Export logs and Dry Run logs windows. The first tab is the User Details tab, which includes all of the exported user’s info. The second new tab is the Export History tab or Export History (Dry) tab. Here, all of the Exports/Dry run logs can be viewed and filtered through for your convenience.
To view and use these new features, navigate to Export Logs or Dry Run Logs and from there choose a user you want to view and there will be two new buttons at the bottom right. There is also two new tabs on the top of the slide over: User Details and Export History.
User Details will show a preview of the fields mapped during the export:
Export History will show the export history of only the selected user for all destinations this user has been exported to:
Data Transforms on Blank Values
A new Feature has been added to Data Transforms, where you are now able to do data transforms on Blank Values. For example, if you have a CSV file with blank values you want to import but want those blank values to be populated with some value of your liking, simply navigate to Data Transforms in that CSV’s settings and add a data transform to the header you want to target, and leave the Initial Value (From Source) input box blank.
Active Directory Advanced Fields
The Advanced Active Directory Fields toggle has been moved to the slide over for Custom Mappings when adding a new Custom Mapping. Previously this toggle was located on the custom mappings page before adding/editing a custom mapping in the slideover.
A new function has been added to OneSync which allows the user strip characters off of the end of a name, or STRIP SUFFIX(). This function removes case insensitive predefined suffixes and/or additional suffixes from the given string. Each optional suffix should be separated by commas and those that are white space sensitive should be entered in double quotes. Suffixes that include commas must include an escape character.
To use this function simply search for it and clicking it in Default Mappings. The function takes in (string, true/false, Optional Suffix1, Optional Suffix2, ….).
User Email Recovery Prompt
The User Email Recovery Prompt has been redesigned to look better, simpler, and be more functional. Users can now choose to add an email address later rather than adding one from the start.
Sync All Confirmation Modal
A new Popup Confirmation Modal has been added to the Sync All button that asks the user to confirm they want to sync all. Sync All with sync every user regardless of any changes that happened to that user or to the OneSync destination.
Source Thresholds have been redesigned to help the user choose better thresholds for their sources. Thresholds will now default to 10, and contain a warning message if the thresholds are too large for the user set.
The suggested user count for thresholds is calculated at 0.5% of all users linked from your source to OneSync. If your thresholds are set above the specified count a warning message will be displayed in the top right on the Navigation Bar and also directly under the Import Thresholds.
Collections List now has a new column which indicates the destinations that particular collection is being used. We have also added the ability of seeing where in the destination that collection is being used, i.e. Custom Mappings, Select Users, Events & Actions, and Group Mappings.
We have added the ability to write descriptions for your Custom Mappings, Group Mappings, and Events & Actions. When adding or editing a destination in either a Custom Mapping, Group Mapping, or Events & Action on the Basic Details tab you will see Description as a field:
The description you enter will just be for you, it does not affect any of the mappings or properties during the export.
You can also add a description to Custom Fields which can be created or edited within a OneSync source. The description will appear when editing or creating a Custom Field: