Synchronize AD Users/OUs/Groups to Yeastar Workplace

Limitation

The maximum number of AD organizational units/groups that can be synced depends on the groups that Yeastar Workplace can create.

Maximum number of groups: 50

Prerequisites

You have integrated Yeastar Workplace with Active Directory.

Procedure

1. Log in to Yeastar Workplace admin portal, go to Integration.
2. In the Directory Sync section, click Sync Settings beside Active Directory (AD).

   

3. In the Range drop-down list, specify the range of data synchronisation.

   

   Option	Description
   All in BaseDN	Synchronize all the users and OUs/groups in the connected directory to Yeastar Workplace.
   Specific Organizational Unit	Only synchronize users and OUs/groups from specific organizational unit(s) in Base DN to Yeastar Workplace. You can select the desired organizational unit(s) from the Organizational Unit drop-down list.

4. In the Object Class drop-down list, specify which type(s) of AD data that you want to synchronize to Yeastar Workplace.

   

   Option	Description
   Only User	Synchronize all the AD users within the specified range to Yeastar Workplace as users, without syncing the OUs or groups to which they belong.
   User and Group	Synchronize all the group(s) and its users within the specified range to Yeastar Workplace as groups and users.
   User and Organizational Unit	Synchronize all the organizational unit(s) within the specified range together with its sub-OU(s) and users to Yeastar Workplace as groups and users. Note: OU and its Sub-OU(s) synced to Yeastar Workplace will be displayed as groups in the same layer.

5. In the Automatically Associate the User Account Registered with the Same Email Address drop-down list, decide whether to sync AD users who share the same mailboxes with the existing users on Yeastar Workplace.

   Option	Description
   Enable	AD users with the same mailboxes will be synced to Yeastar Workplace and associated with the existing Workplace users. Note: The original user information on Yeastar Workplace will be overwritten by the user information of the associated AD users.
   Disable	The AD users with the same mailboxes will not be synced to Yeastar Workplace as duplicated email addresses are not allowed on Yeastar Workplace.

6. In the Automatically Send Invite Email After Adding the User Account drop-down list, decide whether to send invitation emails to the synced AD users.

   Option	Description
   Enable	Yeastar Workplace will send invitation emails to the synced AD users, through which they can activate their Yeastar Workplace account and join the organization. Note: AD users associated with existing Workplace users who have joined the organization will not receive the invitation email.
   Disable	No invitation emails will be sent to the synced AD users.

7. Optional: In the Frequency section, select the data synchronization frequency and set a specific time (non-working hours or weekends are recommended).
   • Daily: The system synchronizes data daily at a preset local time.

     For example, set up to synchronize data at 23:45 every day.

     

   • Weekly: The system synchronizes data on the selected days at a preset local time.

     For example, set up to synchronize data at 23:45 every Saturday.

     

8. Click Save.
   Important: Yeastar Workplace will perform periodic directory synchronization based on the preconfigured frequency and time. If you want to apply the synchronization rule immediately, you can manually perform a directory synchronization.

Result

You have set the synchronization rule, Yeastar Workplace will automatically sync the latest data from Active Directory based on this rule.