English (EN)
العربيةThis article provides a comprehensive guide for deploying the LDAP Agent method within the organization. It outlines the technical requirements, configuration steps, and automate user data integration.
Set up in Beem
- Follow the steps below to configure Directory Sync using the CSV method in Beem:
- Navigate to Beem Admin Suite → Basic Settings → Directory Sync → Sync with LDAP → Set up in Beem.

- A pop-up window would prompt you to select the way of building up the connection between your directory and Beem.
- Select Beem Agent.
WARNING
Note: You can only utilize one Directory Sync method, either "Sync with Entra ID", "Sync with LDAP - Beem Agent" or "Sync with LDAP - CSV method". Each method uses a completely distinct data structure. Switching between sync methods is currently not supported.

General Settings
- You will be redirected to the setup page. Please follow the sequential steps provided to complete all configuration sections.
Member deletion rule:
- "Delete members directly" is set as the default option in this version.
Select attributes for identifying existing users when creating new users:
- Choose either phone number or email address as the attribute to identify existing users when creating new users.
WARNING
Note: The Email Login feature is only available in versions 3.10.0 and above.
Set up the email domain validation:
- You can choose if any validation you want to add for specific domain of the emails, in order to avoid any wrongly added member.
- You can directly input the email suffix after "@". For example "beem.sa". Any member with email suffix other than "beem.sa" would not be synced to Beem.
- You can add 10 validation rules at maximum.
Select how you configured the 'department' attributes in the directory:
- If you maintain a complete department structure string in your directory, Beem Admin will automatically set the department display on user profiles to "Current department only" to avoid redundant names.
Select what to process when more than one duplicate departments are found:
- 'Sync with LDAP' maps department attribute names from your directory service to department names in Beem Admin suite.
- If multiple duplicate departments exist for a member, you can specify the target department for the member (this can be modified later).

Agent Configuration
Download Beem Agent:
Beem Agent is a secure bridge between your internal directory service and Beem Cloud Platform.
Following the attached (Configuration Guidance), input your own server URLs, bindDN, bindPassword and baseDN into the agent.
Select the data structure:
- Start to select the data structure used by your directory service.
- Different data structures correspond to different attribute mapping and processing rules.
Set up the attributes mapping rules:
- Beem fields and directory attributes follow a universal framework with standardized mapping rules.
- For most mappings, you can enter your own custom directory attributes to associate with the corresponding Beem fields.

Sync Schedule
- Select the time zone for the integration to run, with the default set to GMT+3:00 (Saudi Arabia Time).
- Select a recurrence pattern: daily, weekly, or monthly.
- Click on 'Save and Activate' and wait for the first run.

- Return to the main page to view all synchronization logs. Click Details to see a sync overview and access attachments with error details.
- You may edit the sync at any time by selecting Set up in Beem, completing the process outlined above, and activating the sync.

Stop the Sync
- While directory sync is deactivated, all changes must be managed manually.

Recommendations
- Secure your credentials:
- Always protect sensitive information such as bindDN and bindPassword. Avoid exposing them in shared environments or unsecured files.
- Validate attribute mapping before activation:
- Incorrect attribute mapping may lead to missing or wrongly assigned user data. Always double-check mappings before enabling the sync.
- Monitor synchronization logs regularly:
- Even after successful activation, regularly review logs to identify any hidden or partial sync issues.

