Difference between revisions of "TASS Sync Profiles"

From Studentnet Wiki
Jump to navigation Jump to search
 
(19 intermediate revisions by 2 users not shown)
Line 33: Line 33:
 
[[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 user_code for parents, students, and staff, choices include sis_id (highly recommended) and username.
+
*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
−
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 ‘Do not change orgunits for current users', existing users will not be moved to ou set by the previous three fields.
+
*By ticking '''Send welcome''', the selected welcome template will be sent to the type of users during the next sync.
−
 
 
−
“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]]
 +
[[File:Tass_username_format.PNG|1100px|tass Setup 14]]
  
−
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
+
**'''Nuclear Primary Parent Username Format''': '''P$usercode''' is the default format. An example of username that would appear in Cloudwork following this format would be '''p123456'''
−
*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'''.
+
**'''Nuclear Secondary Parent Username Format''': '''S$usercode''' is the default format. An example of username that would appear in Cloudwork following this format would be '''s123456'''
−
 
+
**'''Split Primary Parent Username Format''': '''$usercode_$sfanum''' is the default format. An example of username that would appear in Cloudwork following this format would be '''123456_1'''
−
[[File:tass_6.png|1100px|tass Setup 6]]
+
**'''Split Secondary Parent Username Format''': '''$usercode_$sfanum''' is the default format. An example of username that would appear in Cloudwork following this format would be '''123456_2'''
  
−
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 107: Line 103:
  
 
[[File:tass_split_parent_5.png|250px|center|frame|Parent 1 usercode and sfa_num for username]]
 
[[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]]
 
[[File:tass_split_parent_6.png|250px|center|frame|Parent 2 usercode and sfa_num for username]]
  
−
[[Category: Cloudwork Dashboard]]
+
===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.
 +
 
 +
 
 +
===Parent Sync Criteria===
 +
For parents to be synced from TASS to Cloudwork, parents need to have the following:
 +
*Parent Access Lounge Enabled
 +
*Parent has a student listed in their profile
 +
*The corresponding Address block in Cloudwork's TASS Sync is populated in TASS
 +
**Example: If in the '''Cloudwork Dashboard'''>'''Sync Profile'''>''<TASS Sync Profile>''>'''Address block for person1''', '''Address block 4''' has been selected, then the person1's details in TASS must be populated in ''Address block 4'' and if in '''Address block for person2''', '''Address block 5''' has been selected, then the person2 information in TASS must be populated in ''Address block 5''
 +
* '''Email 1''' must be present in the selected Address blocks for '''person1''' and '''Email 2''' must be present in the selected Address blocks for '''person2'''
 +
**Example: If for '''Address block for person1''', '''Address block 4''' has been selected. Then in TASS, '''Address block 4''', Email 1 needs to be populated with person1's email address
 +
**Example: If for '''Address block for person2''', '''Address block 5''' has been selected. Then in TASS, '''Address block 5''', Email 2 needs to be populated with person2's email address
 +
 
 +
[[Category: Sync Profiles]]

Latest revision as of 01:43, 3 November 2026

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 tass Setup 14

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
    • Nuclear Primary Parent Username Format: P$usercode is the default format. An example of username that would appear in Cloudwork following this format would be p123456
    • Nuclear Secondary Parent Username Format: S$usercode is the default format. An example of username that would appear in Cloudwork following this format would be s123456
    • Split Primary Parent Username Format: $usercode_$sfanum is the default format. An example of username that would appear in Cloudwork following this format would be 123456_1
    • Split Secondary Parent Username Format: $usercode_$sfanum is the default format. An example of username that would appear in Cloudwork following this format would be 123456_2


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.


Parent Sync Criteria

For parents to be synced from TASS to Cloudwork, parents need to have the following:

  • Parent Access Lounge Enabled
  • Parent has a student listed in their profile
  • The corresponding Address block in Cloudwork's TASS Sync is populated in TASS
    • Example: If in the Cloudwork Dashboard>Sync Profile><TASS Sync Profile>>Address block for person1, Address block 4 has been selected, then the person1's details in TASS must be populated in Address block 4 and if in Address block for person2, Address block 5 has been selected, then the person2 information in TASS must be populated in Address block 5
  • Email 1 must be present in the selected Address blocks for person1 and Email 2 must be present in the selected Address blocks for person2
    • Example: If for Address block for person1, Address block 4 has been selected. Then in TASS, Address block 4, Email 1 needs to be populated with person1's email address
    • Example: If for Address block for person2, Address block 5 has been selected. Then in TASS, Address block 5, Email 2 needs to be populated with person2's email address
Retrieved from "https://wiki.studentnet.net/index.php?title=TASS_Sync_Profiles&oldid=2878"