Skip to main content
All CollectionsGetting StartedStep 3: Configure Employee Onboarding
How do I import employees using Active Directory Agent On-Prem?
How do I import employees using Active Directory Agent On-Prem?
Soumalya Mitra avatar
Written by Soumalya Mitra
Updated over a week ago

You can import employees from the active directory by following the steps below:

  1. Navigate to Company Management > Employee > List > Import > Active Directory.

  2. Click on the On-Prem tab and then click Create a new token.

  3. In the Configuration section, click Generate. This will generate a token that will be used in the Active Directory agent. Copy the generated token as you'll have to paste it later. If you don't have the Active Directory, you can download it from this page.

  4. Now, go to the Active Directory Agent and paste the token you generated in step 3.

  5. Under the Active Agents tab, look for any active agents. This section would be empty before setting up a new connection.

  6. Once you log in to the AD Agent by entering the generated token, on the Home screen, click Import Users from AD. Based on your configurations, a list of users that will be imported will appear.

  7. You can take the following actions from the Home page:

    1. Import from AD: You can import the employees from Active Directory by clicking this button.

    2. Export to RH: Click this button to sync the employees imported from Active

      Directory to Right Hand.

    3. Attribute Configuration: Click this button to open the Attribute Configuration screen from where you can map Right-Hand fields with the Active Directory fields.

    4. Configure AD Connection: Clicking this button will open the AD Agent configuration screen where connection settings can be defined.

    5. Sync History: Click this button to view the Sync history.

    6. Update Sync Settings: You can set the frequency on how often you would want to sync the data with the server.

    7. Logout: This will log you out from the Active Directory agent and close it.

  8. The imported employees will appear in the Right-Hand portal under Company Management > Employee > Connectors.

Configure Active Directory

If you're a first-time user, the following steps will help you configure the Active Directory. However, you can refer to the same procedure if you wish to change the settings or configurations in the future.

  1. You will have to log in to the AD using the password generated in Right-Hand portal. Navigate to Company Management > Employee > List > Import > Active Directory > On-Prem > Create a new token > click Generate and copy the token.

  2. In the Agent Configurations page that appears, configure your settings accordingly.

  3. Click Test Connection. If the connection is successful, click Save. Then, you will have to map the Right-Hand fields with the fields from your AD On-prem setup.

  4. In the Attribute Configurations page, select the relevant fields from each drop-down to match them with the Right-Hand field.

  5. Click Save. Once the Agent Configurations and Attribute Configurations are set, the AD Agent will sync the users and the employees will be displayed on the Home.

10. Once the AD Agent is configured and connected, you can also check the status of user import in the Right-Hand by clicking on the Sync history in the Company Management > Employees > Connectors section.

11. Clicking on View Details will display the list of users who were added or removed during the sync.

Active Directory Windows Service (For Auto Sync)

The Active Directory Windows Service (for auto sync) service is an add-on layer for an Active Directory agent to work as a windows service. You can perform the following steps to install the AD service:

  1. Company Management > Employee List > Import > Active Directory > On-Prem > click Show Configuration.

  2. Click on the second link to download the Active Directory service.

  3. To navigate to this folder, open file explorer and type %APPDATA% on the search bar and find Right-Hand AD Agent folder.

  4. Copy the path from the top search bar. This path will be used to install Active Directory services.

  5. Open Powershell with administrative rights by typing Powershell on the windows search bar.

  6. Navigate to the folder where AD service was downloaded.

  7. Run the following command by replacing it with your ad agent installed path, copied in step 4.

    .\Right-hand+AD+Service-v1.0.exe install "YOUR_INSTALLED_PATH"

  8. Active Directory service is now installed. New service will appear inside the windows service list.

  9. Right-click on RHS ADS Service and click on the start button. The status of the service will change to Running.

  10. Users will be imported and auto-synced to Right-Hand portal based on your sync configuration in AD Agent.

  11. Details of every sync can be seen in the Ad Agent > Sync History tab.


Did this answer your question?