Performing Bulk Import of the LDAP Users into the AgileApps Platform

From AgileApps Support Wiki

Overview

You can import the existing users present in an LDAP server into the AgileApps platform, without mandating each user to access and login to the AgileApps system. You can assign tasks or records to the users which can be picked up and worked upon when they login to the AgileApps platform.

Who can perform this operation?

Any user who has the User Management and Import and Export Data administrative permissions can perform the required operations to import the LDAP users through a data import. For more information on permissions, see Administrative Permissions.

Before you begin

Ensure to configure the required tenant capabilities for the tenant using the ISV login. For more information on capabilities, see Manage Tenant Capabilities.

Steps to Import LDAP Users into AgileApps

To import the LDAP users to the AgileApps platform, you have to perform the following:
1. Install the application package.

  • Perform the following steps to install the application package:
    1. Download the application package ldapuserimport10.11.zip.
    2. Navigate to Configuration > Administration > Account Management > Packages.
    3. Click Install from File.
    4. Select the application package zip file ldapuserimport10.11.zip and click Next.
    5. In the Install Package screen, For ROLES in the package section, select Merge roles.
      Note: This section may not be visible if you are installing the package for the first time.
    6. Share the resource, LDAPUserImporter object and LDAPUserImporter custom class to any existing application, for example - ServiceDesk application, by navigating to Configuration > Customization > Resource Sharing.

2. Import the CSV file into the object available in the installed application.

  • Perform the following steps to import the CSV file into the Object:
    1. Download the sample CSV file LDAPUsers.csv.
    2. Insert the LDAP users' basic information into the CSV file as follows:
      a) First Name
      b) Last Name
      c) Email Address (present in LDAP server)
      d) Username (present in LDAP server)
      e) Access Profile Id (same as the LDAP configuration in AgileApps)
      f) Team Id (same as the LDAP configuration in AgileApps)
      g) Applications Access (support for multiple applications with their associated roles)
      Syntax: App_1_Id:App_1_Role_1_Id,App_1_Role_2_Id,App_1_Role_3_Id_::_App_2_Id:App_2_Role_1_Id,App_2_Role_2_Id,App_2_Role_3_Id
      Example: 27df9a485b1141b1bae84089c5fe47d1:a19362ffe33b4635a0bcd761d4c54b07,ca008895bc65498f929799d8ce680b99_::_1:dfff7507ad7d4347816552a44dad455c,49a47b32804c4932a252c7c36c95999e
      h) Record ID (any unique number)
      i) Owner ID (3 - the System user, however, you can also mention any valid user id present in AgileApps)
    3. Navigate to Configuration > Administration > Data Management > Import Data.
    4. On the Import Data screen, select LDAPUserImporter in the Choose the Target Object drop-down list.
    5. In the Upload CSV File tab, select Choose File and then select the LDAPUsers.csv file. Set the Encoding Type as UTF-8 and click Next.
    6. In the Map Columns tab, map the corresponding columns from the CSV file to the object fields and click Next.
    7. In the Confirmation screen, verify your mapping and click Ok.
    8. In the Set Attributes tab, let the fields be as is.
    9. Click Start Import.
      Note: Once the user creation is successful, the records from the LDAPUserImporter object are deleted.

Thumbsup.gif

Tip: Logs
You can view the log messages for the user creation or failures in the Debug Log screen, by navigating to Configuration > Customization > Developer Resources > Debug Log.

Result

All the LDAP users mentioned in the CSV file are created in the AgileApps platform. You can now select these users from the User Lookups to assign any tasks or records.

However, the synchronization of users' information with the LDAP server happens only when the respective user logs into AgileApps with his or her valid credentials.