Clipboard Sync

From Studentnet Wiki
Jump to navigation Jump to search

Setting up Clipboard Sync

Creating Studentnet Activity in Clipboard

  1. Login to Clipboard Dashboard
  2. Under Settings>Environmemnt
  3. Scroll to bottom of page and click Add a Department
  4. Enter Studentnet
  5. Scroll up to Studentnet
  6. Under Studentnet click Add an Activity
  7. Enter Studentnet while minding the spelling and capitalisation. If spelling or capitalisation is not matching, then Cloudwork will sync to an unintended activity

General Sync Settings

  1. In the Cloudwork Dashboard>Side Menu>Clipboard Sync
  2. Click Add New Clipboard Config
  3. Fill out the form:
    Clipboard Description: A short description of the Clipboard Sync profile
    Authorization Token: Enter the Token used for Clipboard API provided by Clipboard
    Deactivated User Action: Select from choices what should occur for users who are suspended or moved out of a select Clipboard Sync OU
    Sync Users To Clipboard: Enable this setting to allow users to be synced to Clipboard
  4. Only maintain Clipboard users with matching Cloudwork accounts: If this option is enabled, users in Cloudwork who have a SISid that corresponds to a matching Employeeid in Clipboard will be synced
  5. Restrict account updates to activation status in Clipboard

Selecting OU for Clipboard Sync

  1. After completing the General Sync Settings> go to OU Sync Selections>Edit
  2. Select OUs that you wish to sync to Clipboard. Note that if no OUs are selected, the Clipboard Sync will not run


Forcing a Clipboard Resync

In the Clipboard Sync Profile, there is a Force Sync Clipboard, this will force the sync process to start

User Sync Criteria

  • User must be apart of one of the following roles:
    Teacher
    Staff
    Employee
  • Users must have a SISid to be allowed to be synced
  • Users must be active to be synced; when a user is suspended and Disable User Action is set to Suspend, only the user's status will be updated in Clipboard

What data will be synced to Clipboard

What data will be synced to Clipboard
Attribute How will the data be populated in Clipboard
SIS ID The SIS ID will be synced from the SIS ID value from Cloudwork's User Information; the Clipboard Sync will not sync SIS ID value from custom attributes
First Name The first name will be synced from the first name value from Cloudwork User Information
Last Name First Name and Last Name will combine to form the Name value in Clipboard
Email Email value will be taken from Cloudwork and used directly in Clipboard
Role Regardless of whether a user is a teacher, staff or faculty in Cloudwork, the user will be synced as staff in Clipboard
Payroll ID Depending on the selected mapping attribute, if the custom attribute exists for the user, Cloudwork will sync the value into Clipboard. If the value for the user does not exist, we will leave this attribute blank
Mobile Number Depending on the select custom attribute, if the selected custom attribute cannot be found for a user, then the mobile number will be synced as a blank value
User Status Based on the user status and the suspended user action, Cloudwork will either activate or suspend the user in Clipboard. Users are not deleted in Clipboard

Clipboard Activities

An activity is required to create users in Clipboard. As part of neatly organising the information the Clipboard dashboard, we request that you create the Studentnet activity to easily sort through users who are coming from Cloudwork.
If there is no Studentnet activity found in Clipboard, Cloudwork will use the first avaliable activity to create users into. Once users have been synced to Clipboard, IT admins will need to manually assign and unassign activities to user.

When updating users, Cloudwork will not touch the activities of users. Management of activities for users will be managed by Clipboard and IT admins


Reports

There are 3 events in the Provisioning section of the Report that correspond to Clipboard:

Event What does the event mean
Clipboard Sync Processed The Clipboard sync was successful with no error, as well as telling which activity was used for Clipboard sync. The event will also list the total number of users processed, how many were created, updated or suspended.
Clipboard Sync Processed with Errors The Clipboard sync was either able to create or update users. The event will specify whether there was an issue with creating or updating users and which activity was used for Clipboard sync. The event will also list the total number of users processed, how many were created, updated or suspended.
Clipboard Sync Failed The Clipboard sync completely failed; No users were created or updated

Why are users not being created or updated in Clipboard

User will not sync to Clipboard if there are no changes detected in Cloudwork. What this means is that if you change a value in Clipboard but there have been no user changes to user in Cloudwork, we will not update the user in Clipboard. If a IT admin changes the email of a user in Clipboard, this will cause data integrity issues between Cloudwork and Clipboard, which can cause duplicate users or a mismatch of user information