Difference between revisions of "TASS Sync Profiles"

From Studentnet Wiki
Jump to navigation Jump to search
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Tass=
+
=TASS=
Tass Syncing will allow IT admins to pull selected users from Tass.
+
TASS Syncing will allow IT admins to import selected users from TASS via Cloudwork Sync Profile.
  
 
These users include Students, Staff and Parents.
 
These users include Students, Staff and Parents.
  
Parents can also be classified as split parents in Tass.
+
Cloudwork can automatically detect and manage parent accounts for split families.
 
 
Cloudwork is able to tell apart split parents.
 
 
 
==Split Parents==
 
===Split Parent in Cloudwork===
 
Split parents are handled in Cloudwork by determining whether both split parents have the same or different '''user_code'''
 
 
 
====Split Parents with different user_codes====
 
Split Parents created in Tass with user_codes are displayed on Cloudwork as:
 
 
 
[[File:tass_split_parent-1.png|1100px|center|frame|Splits Parents in User List using different user_codes]]
 
 
 
[[File:tass_split_parent_2.png|500px|center|frame|Parent 1 using user_code for username]]
 
 
 
[[File:tass_split_parent_3.png|500px|center|frame|Parent 2 using user_code for username]]
 
 
 
====Split Parents with same user_code====
 
 
 
Split Parents sharing one user_code, when creating separate accounts, in Cloudwork, the '''sfa_num''' will be added to Parents user_code to distinguish them.
 
 
 
[[File:tass_split_parent_4.png|1100px|center|frame|Splits Parents in User List using usercode and sfa_num]]
 
 
 
[[File:tass_split_parent_5.png|250px|center|frame|Parent 1 usercode and sfa_num for username]]
 
 
 
[[File:tass_split_parent_6.png|250px|center|frame|Parent 2 usercode and sfa_num for username]]
 
  
 
==Cloudwork Syncing Instructions==
 
==Cloudwork Syncing Instructions==
Line 40: Line 15:
 
*Endpoint
 
*Endpoint
  
Credentials located in Tass>System Admin>Utilities>API Gateway Maintenance
+
Credentials located in '''TASS'''>'''System Admin'''>'''Utilities'''>'''API Gateway Maintenance'''
  
 
Login to Cloudwork Dashboard and click '''Sync Profile'''  
 
Login to Cloudwork Dashboard and click '''Sync Profile'''  
Line 50: Line 25:
 
[[File:tass_2.png|1100px|tass Setup 2]]
 
[[File:tass_2.png|1100px|tass Setup 2]]
  
Select '''Tass Sync Profile''' from sync profile types
+
Select '''TASS Sync Profile''' from sync profile types
  
 
[[File:tass_3.png|1100px|tass Setup 3]]
 
[[File:tass_3.png|1100px|tass Setup 3]]
  
Under Basic Settings, input a simple description for this profile, and credentials provided by Tass.
+
Under Basic Settings, input a simple description for this profile, and credentials provided by TASS.
  
 
[[File:tass_4.png|1100px|tass Setup 4]]
 
[[File:tass_4.png|1100px|tass Setup 4]]
  
Select the attribute to be mapped to Cloudwork for Tass under '''Parents Usercode Mapping''', '''Students Usercode Mapping''', '''Staff Usercode Mapping''' , choices include SIS ID (highly recommended) and User Name.
+
*Select the attribute to be mapped to Cloudwork for Tass user_code for Parent Usercode Mapping, Students Usercode Mapping, and Staff usercode Mapping, choices include SIS ID(highly recommended) and username.
 +
*Under '''User Settings''', for each type of users, parents, students, and staff, there are choices sync users, organisational unit, maintain ou for existing users, actions for users no longer meet the condition web_access = True, and send welcome message to users
 +
*By ticking '''Do not change orgunits for current users''', existing users will not be moved to ou set by the previous three fields.
 +
*'''Action for disabled users''' works if users no longer meet the condition web_access = True. Actions include '''Do nothing''', '''Suspend User''', and '''Delete User'''.
 +
*By ticking '''Send welcome''', the selected welcome template will be sent to the type of users during the next sync.
  
 
[[File:tass_5.png|1100px|tass Setup 5]]
 
[[File:tass_5.png|1100px|tass Setup 5]]
  
Under '''User Settings''', there are 3 types of users:
+
For parents, there are extra 5 settings:
*Parents
+
*'''Address block for person1''', default ‘4’
*Students
+
*'''Address block for person2''', default ‘5’
*Staff
+
*'''Address block for fallback''', when person1 and person2 address blocks are empty, default ‘1’
 
+
*'''Enable fallback even when person1 and person2 exist'''
For each type of user there are 4 settings:
+
*'''Nuclear family accounts settings'''
*Sync users: Sync users
+
**'''One account for each user_code'''
*Organisational Unit: Users pulled from Tass will be moved into the specified orgunit
+
**'''Separate accounts for parents in each user_code'''
*Do not change orgunits for existing users: Existing users will not be moved to orgunit set by the previous three fields
 
*Actions for disabled users: if users no longer meet the condition web_access = True, the selected action will occur. These actions include '''Do nothing''', '''Suspend User''', and '''Delete User'''.
 
 
 
[[File:tass_6.png|1100px|tass Setup 6]]
 
 
 
Save the settings, there will be a green flash showing the creation is successful, and the information input creates a successful connection with TASS
 
  
 
[[File:tass_7.png|1100px|tass Setup 7]]
 
[[File:tass_7.png|1100px|tass Setup 7]]
Line 91: Line 64:
 
[[File:tass_10.png|1100px|tass Setup 10]]
 
[[File:tass_10.png|1100px|tass Setup 10]]
  
Click '''Force Sync''' for pulling users from Tass.
+
Click '''Force Sync''' for pulling users from TASS.
 
A green flash shows the pulling process is successful.
 
A green flash shows the pulling process is successful.
  
Line 103: Line 76:
  
 
[[File:tass_13.png|1100px|tass Setup 13]]
 
[[File:tass_13.png|1100px|tass Setup 13]]
 +
 +
==Split Parents==
 +
===Split Parent in Cloudwork===
 +
Split parents are handled in Cloudwork by determining whether both split parents have the same or different '''user_code'''
 +
 +
====Split Parents with different user_codes====
 +
Split Parents created in TASS with user_codes are displayed on Cloudwork as:
 +
 +
[[File:tass_split_parent-1.png|1100px|center|frame|Splits Parents in User List using different user_codes]]
 +
 +
[[File:tass_split_parent_2.png|500px|center|frame|Parent 1 using user_code for username]]
 +
 +
[[File:tass_split_parent_3.png|500px|center|frame|Parent 2 using user_code for username]]
 +
 +
====Split Parents with same user_code====
 +
 +
Split Parents sharing one user_code, when creating separate accounts, in Cloudwork, the '''sfa_num''' will be added to Parents user_code to distinguish them.
 +
 +
[[File:tass_split_parent_4.png|1100px|center|frame|Splits Parents in User List using usercode and sfa_num]]
 +
 +
[[File:tass_split_parent_5.png|250px|center|frame|Parent 1 usercode and sfa_num for username]]
 +
 +
 +
[[File:tass_split_parent_6.png|250px|center|frame|Parent 2 usercode and sfa_num for username]]
 +
 +
===Notes===
 +
If an email address is being duplicated across both parents, the accounts will not be split.
 +
To split the parents, the email address that is being duplicated needs to be removed from one of the parents so Cloudworks can make the spilt account as expected.
 +
 +
[[Category: Sync Profiles]]

Latest revision as of 23:20, 6 May 2024

TASS

TASS Syncing will allow IT admins to import selected users from TASS via Cloudwork Sync Profile.

These users include Students, Staff and Parents.

Cloudwork can automatically detect and manage parent accounts for split families.

Cloudwork Syncing Instructions

Credentials needed

  • Token key
  • App Code
  • API Version
  • Company Code
  • Endpoint

Credentials located in TASS>System Admin>Utilities>API Gateway Maintenance

Login to Cloudwork Dashboard and click Sync Profile

tass Setup 2

Click New Sync Profile

tass Setup 2

Select TASS Sync Profile from sync profile types

tass Setup 3

Under Basic Settings, input a simple description for this profile, and credentials provided by TASS.

tass Setup 4

  • Select the attribute to be mapped to Cloudwork for Tass user_code for Parent Usercode Mapping, Students Usercode Mapping, and Staff usercode Mapping, choices include SIS ID(highly recommended) and username.
  • Under User Settings, for each type of users, parents, students, and staff, there are choices sync users, organisational unit, maintain ou for existing users, actions for users no longer meet the condition web_access = True, and send welcome message to users
  • By ticking Do not change orgunits for current users, existing users will not be moved to ou set by the previous three fields.
  • Action for disabled users works if users no longer meet the condition web_access = True. Actions include Do nothing, Suspend User, and Delete User.
  • By ticking Send welcome, the selected welcome template will be sent to the type of users during the next sync.

tass Setup 5

For parents, there are extra 5 settings:

  • Address block for person1, default ‘4’
  • Address block for person2, default ‘5’
  • Address block for fallback, when person1 and person2 address blocks are empty, default ‘1’
  • Enable fallback even when person1 and person2 exist
  • Nuclear family accounts settings
    • One account for each user_code
    • Separate accounts for parents in each user_code

tass Setup 7

Scroll down, there will be 3 tables showing custom attributes for parents, students, and staff.

tass Setup 8

Click Edit for three tables and add custom attributes for three types of users.

tass Setup 9

A green flash will show after the attributes are added.

tass Setup 10

Click Force Sync for pulling users from TASS. A green flash shows the pulling process is successful.

tass Setup 11

In the sync details table, the pulling result of three types of users will be shown here.

tass Setup 12

Heading to Users, select a pulled user, the extra attributes will be added.

tass Setup 13

Split Parents

Split Parent in Cloudwork

Split parents are handled in Cloudwork by determining whether both split parents have the same or different user_code

Split Parents with different user_codes

Split Parents created in TASS with user_codes are displayed on Cloudwork as:

Splits Parents in User List using different user_codes
Parent 1 using user_code for username
Parent 2 using user_code for username

Split Parents with same user_code

Split Parents sharing one user_code, when creating separate accounts, in Cloudwork, the sfa_num will be added to Parents user_code to distinguish them.

Splits Parents in User List using usercode and sfa_num
Parent 1 usercode and sfa_num for username


Parent 2 usercode and sfa_num for username

Notes

If an email address is being duplicated across both parents, the accounts will not be split. To split the parents, the email address that is being duplicated needs to be removed from one of the parents so Cloudworks can make the spilt account as expected.