Synchronize Active Directory Users to Yeastar P-Series Software Edition

Limitation

The number of AD users that can be synced depends on the number of extensions that PBX system can create.

Prerequisites

You have integrated Yeastar P-Series Software Edition with Active Directory .

Procedure

You can either bulk synchronize AD users within a specified range and automatically assign PBX extensions, or synchronize specific users and assign PBX extensions for them individually.

Follow the corresponding instructions below to complete the synchronization configuration according to your needs.

Synchronize AD users within a specified range

Specify the range of AD users to be synchronized and set up extension auto assignment rule accordingly. In this way, the AD users and PBX extensions can be associated automatically after a data synchronization.

1. Log in to PBX web portal, go to Integrations > Collaboration.
2. In the User Synchronization section, turn on the switch.

   

3. In the User Range for Extension Auto Creation drop-down list, specify the range of AD users that you want to synchronize to PBX and create extensions for them.

   

   Table 1.

   Option	Description
   All Users	Synchronize all AD users within the connected directory to PBX and create extensions for them.
   Users in Specific Organizational Unit	Synchronize the AD users within the specified organization unit(s) to PBX and create extensions for them. You need to select the desired organizational unit(s) in the Organizational Units drop-down list.
   Users in Specific Group	Synchronize the AD users within the specified group(s) to PBX and create extensions for them. You need to select the desired group(s) in the Group drop-down list.
   Users Searched by Filter	Synchronize the AD users that match the filter criteria to PBX and create extensions for them. You need to specify the LDAP search filter in the Search Filter for User field to locate specific users. For example, enter (&(objectCategory=person)(objectClass=user)(cn=sales*)) to search users with the name starting with "sales".

   Note: In future use, if you change the range of the AD users to be synced, you can decide how to deal with the extensions that are no longer synced from the AD users via the Auto delete the Extensions no longer in sync option.

   

   • If selected, the extensions will be deleted during the next synchronization.
   • If unselected, the extensions will be retained and fully managed by the PBX.
4. In the User's Extension Number drop-down list, configure the extension numbers assignment rule.

   

   Table 2.

   Option	Description
   Assign Automatically	Assign extension numbers from a specified starting number. You can specify the starting number in the Start Extension Number from field.
   Read Specific Property Value	Assign extension numbers based on users' property value. This can be used in the scenario that the AD users already have phone extensions assigned, and you want to keep their extension number instead of assigning new ones. You can specify the property where the AD users' extension numbers are stored (e.g. ipPhone) in the Property Name field. Tip: Refer to Active Directory User Object Property for the property name.

5. In the Delete the Extension when its associated user account is drop-down list, specify the AD user account status(es) at which PBX will stop syncing from the AD users, and delete the associated extensions.

   

   Table 3.

   Option	Description
   Expired	If the AD user account is expired, PBX will stop syncing from the AD user and delete the associated extension.
   Disabled	If the AD user account is disabled, PBX will stop syncing from the AD user and delete the associated extension.
   Deleted	If the AD user account is deleted, PBX will stop syncing from the AD user and delete the associated extension.

6. On the Auto associate Extensions with the Users that share the same email address option, decide whether to sync AD users to PBX when the users have same email addresses with existing extensions.
   • If selected, the AD users with same mailboxes will be synced to PBX and associated with the existing extensions, the extensions' user information will then be overwritten by that of the AD users.
   • If unselected, the AD users with same mailboxes will not be synced to PBX as the PBX system does not allow duplicated email addresses.
7. If you want to send Linkus Welcome Email to the synced AD users, select the checkbox of Send Welcome Email automatically after an extension is created.
8. Click Save.
   Note:

   • If it is the FIRST time you save the synchronization-related settings, PBX will perform the initial synchronization immediately.
   • Otherwise, you can manually perform a directory synchronization or wait for the automatic directory synchronization.

Synchronize specific AD users

Specify the organizational unit(s) or group(s) where the PBX can search for AD users, then manually select the desired AD users to be synchronized to PBX, and individually associate PBX extensions for these users.

1. Log in to PBX web portal, go to Integrations > Collaboration.
2. In the User Synchronization section, turn on the switch.

   

3. In the User Range for Extension Auto Creation drop-down list, select Specific Users.

   

   Note: In future use, if you change the range of the AD users to be synced, you can decide how to deal with the extensions that are no longer synced from the AD users via the Auto delete the Extensions no longer in sync option.

   

   • If selected, the extensions will be deleted during the next synchronization.
   • If unselected, the extensions will be retained and fully managed by the PBX.
4. In the Search Criteria drop-down list, specify the search scope (organizational unit or group) in which PBX can search the AD users.

   Option	Description
   Search Users by Organizational Unit	Search AD users within the specified organization unit(s). You need to select the desired organization unit(s) in the Organizational Unit drop-down list.
   Search Users by Group	Search AD users within the specified group(s). You need to select the desired group(s) in the Group drop-down list.

5. Click Search AD Users.

   PBX searches AD users within the specified scope, and displays the AD users in the Search Result List.

   

   Tip: You can quickly locate the desired AD users by entering their username on the Search field at the top-right corner.
6. Select the desired AD user(s) for synchronization, then click Synchronize to PBX.

   

   The selected AD users are added to the Synchronization List.

7. In the Associate with Extension drop-down list beside the AD user, select an extension to assign to the AD user.

   

   Tip: To disassociate a synced AD user with the PBX extension, select the desired AD user and click Disassociate button on the top of the list. After you save the setting, the AD user will be successfully disassociated with the extension.
8. In the Delete the Extension when its associated user account is drop-down list, specify the AD user account status(es) at which PBX will stop syncing from the AD users, and delete the associated extensions.

   

   Table 4.

   Option	Description
   Expired	If the AD user account is expired, PBX will stop syncing from the AD user and delete the associated extension.
   Disabled	If the AD user account is disabled, PBX will stop syncing from the AD user and delete the associated extension.
   Deleted	If the AD user account is deleted, PBX will stop syncing from the AD user and delete the associated extension.

9. If you want to send Linkus Welcome Email to the synced AD users, select the checkbox of Send Welcome Email automatically after an extension is created.
10. Click Save.
    Note:

    • If it is the FIRST time you save the synchronization-related settings, PBX will perform the initial synchronization immediately.
    • Otherwise, you can manually perform a directory synchronization or wait for the automatic directory synchronization.

Result

You have created your custom synchronization rule for AD users.

During a synchronization process, the PBX system performs LDAP queries within the Active Directory based on the rule, and synchronize the desired AD users as well as the updated information to PBX. After the synchronization, the followings can be implemented:

What to do next

If you want to allow the synced AD users to log in to Linkus Web Client and Mobile Client by their AD domain accounts directly, see Allow Users to log in to Linkus UC Clients with AD Domain Accounts.