Importing users with the Customer Portal license from an LDAP server

The following topics provide information about importing users with the Customer Portal license from an LDAP server into your Salesforce organization:

You can import users into your Salesforce organization by using the Pentaho Data Integration tool. The Pentaho package for importing users with the Customer Portal license from an LDAP server is available on the BMC Communities website. For information about how users are imported into your Salesforce organization, see Overview of how users are imported from LDAP servers.

KJB and KTR files in the Pentaho package

The Pentaho package includes the TransferLDAPInfo.kjb file (job file) for importing users from an LDAP server. The job (KJB) file contains a series of transformations that run in a sequence. Each transformation maps to a KTR file that is available, along with the KJB file, in the Pentaho package. The following table provides information about the KTR files and the corresponding transformations that the KJB file contains:

KTR file	Step or transformation in the KJB file	Description
None	Check if delta timestamp file exists	Checks if any time stamp file exists. The Pentaho package utilizes a time stamp file to determine which records were added or modified since the last time the job was run. This step is used for incremental import. If a time stamp file does not exist, the Create the initial timestamp file step is executed; otherwise, the Delete client user import records step.
CreateInitialTimeStampedFileForLDAP.ktr	Create the initial time stamp file	Creates the time stamp file to record the time of import. This step is executed only if you are importing for the first time or you have deleted the existing time stamp file.
DeleteClientUserImportRecords.ktr	Delete client user import records	Deletes records in the Client User Import table.
TransferLDAPInfo.ktr	Update client user import table with LDAP user information	Transfers data from LDAP server to the Salesforce organization.
StoreLDAPTimestamp.ktr	Store the current timestamp	If the data import is successful, the time of import is saved.

The following table provides information about the steps that are included in the TransferLDAPInfo.ktr file (Update client user import table with LDAP user information transformation). The Pentaho package runs these steps to import users from the LDAP server into your Salesforce organization. You can view these steps only when you open the KTR file in the Pentaho Data Integration tool. The KTR file also contains mapping of the fields in the LDAP server to the fields in the Client User Import table. For more information about mapping, see Overview of how users are imported from LDAP servers.

Step	Description
Delta timestamp	Reads the saved time stamp.
Create time based LDAP filter string	Creates a time-based LDAP filter string that is used to fetch the new records added since you last ran the job successfully.
LDAP input	Uses the LDAP filter string to fetch the defined attributes of the records from the LDAP server.
Dynamic account and profile assignment	Enables assigning account and profile information to the records that are imported based on any of the LDAP attribute.
Sort	Sorts the users that are imported from the LDAP server.
Find Unique Rows	Checks that the imported users are unique so that duplicate records are not created in your Salesforce organization.
Salesforce upsert	Accepts the destination of the data and the credentials for the Salesforce organization where you want to save the imported data.
Success Rows	Stores the rows that are imported successfully.
Failure Rows	Stores the rows that are not imported with error code, error description, and error fields.

Before you begin

Before you can import users from an LDAP server, you must perform the following tasks:

Register at the BMC Communities website.
Ensure that you specify the default settings for clients in the Import Defaults column on the User Settings page (Remedyforce Administration > Manage Users > User Settings).
These default settings are applied to all client records that are imported to the Client User Imports object. For more information see Configuring user settings.
Download the Pentaho package from the BMC Communities website (https://communities.bmc.com/docs/DOC-17004).
BMC recommends that you download the job files in the folder in which you have unzipped the Pentaho Data Integration tool.

To import users with the Customer Portal license from an LDAP server

To launch the Pentaho Data Integration tool, in the \<PentahoInstallerFolder>\data-integration folder, double-click the Spoon.bat file.
In Pentaho Spoon, select File > Open, navigate to the folder where you downloaded the Pentaho package, and open the TransferLDAPInfo.kjb (job) file.
To open the DeleteClientUserImportRecords.ktr (transformation) file, right-click the Delete client user import records step, and select Open referenced object > Transformation.
To provide your Salesforce organization access details, perform the following actions:
1. Double-click the Select all client user import records step.
2. In the Salesforce Input window, enter your Salesforce organization user name and password.
3. (Optional) To verify the connection, click Test connection.
4. Click OK.
5. Double-click the Delete records from Client User Import table step.
6. In the Salesforce Delete window, enter your Salesforce organization user name and password.
7. (Optional) To verify the connection, click Test connection.
8. Click OK.
To provide the LDAP server access details, perform the following actions:
1. Navigate to the TransferLDAPInfo.kjb (job) file.
2. Right-click the Update Client User Import table with LDAP user information step and select Open referenced object > Transformation.
3. In the TransferLDAPInfo.ktr (transformation) file, double-click the LDAP input step.
4. In the LDAP Input window, enter the host, user name, and password of the LDAP server from which you are importing users.
5. (Optional) To verify the connection, click Test connection.
6. Click OK.
7. (Optional) To fetch more fields from the LDAP server, in the Fields tab, click Get Fields.
8. (Optional) To assign customized LDAP attribute values to objects of your Salesforce organization based on conditions applied on the LDAP attributes, double-click the the Dynamic account and profile assignment step.
9. In the Script Values / Mod window, customize the account and profile assignment by referring to the commented examples that are provided.
  For example, you can assign account and profiles based on the LDAP attribute, such as userPrinicpalName.
10. Click OK.
11. To provide your Salesforce organization access details, double-click the Salesforce Upsert step, and enter your Salesforce organization user name and password.
  Note
  
  Starting from January 1, 2016, Salesforce is retiring www.salesforce.com as an API endpoint. To avoid connectivity issues (HTTP Status 404 error), update your Pentaho transformations that connect to https://www.salesforce.com/services/Soap/u/<API version> to https://login.salesforce.com/services/Soap/u/35.0 before the retirement date.
  If you are running the Pentaho package in a Sandbox environment, modify the Salesforce Webservice URL from https://test.salesforce.com/services/Soap/u/<API version> to https://test.salesforce.com/services/Soap/u/35.0 in the updated Pentaho transformation. For more information, see Salesforce API Endpoint Retirement.
12. (Optional) To update predefined mapping between the LDAP fields and the Salesforce client user import object, click Edit Mapping.
  For more information about mapping, see Overview of how users are imported from LDAP servers.
13. (Optional) To verify the connection between the Pentaho Data Integration tool and the Salesforce organization, click Test connection.
14. Click OK.
(Optional) If you have enabled the setting to access your Salesforce organization from limited IP addresses, to enable communication between Salesforce and the Pentaho Data Integration tool, perform the following actions:
1. In Salesforce, navigate to Setup > Reset My Security Token.
  Note
  
  If you have enabled the improved Setup user interface in your Salesforce organization, navigate to My Settings > Personal > Reset My Security Token. For more information, see http://help.salesforce.com/apex/HTViewHelpDoc?id=admin_setup_improved.htm&language=en_US.
2. Click Reset Security Token.
  An email message is sent to your email address stored in Salesforce.
3. In the Password field of the Salesforce Upsert step, append the security token to the password.
  For example, if your password is mypassword and your security token is XXXXXXXXX, then you must enter mypasswordXXXXXXXXX in the Password field.
  
  You must also append the security token to the password in all steps in which you have entered the user name and password of your Salesforce organization.
To save the KTR and KJB files, click .
In the TransferLDAPInfo.kjb file, click .
Perform one of the following actions based on the Pentaho version that you are using:
Pentaho version Action
6.1 In the Run Options window, click Run.
5.4 In the Execute a job window, click Launch.
Data is imported into the Client User Import table in your Salesforce organization. If clients that are imported do not exist in your Salesforce organization, new clients are created. If the imported records do not have account and profile information, the default account and profile specified in the Remedyforce Administration > Manage Users > User Settings page in BMC Remedyforce are added to the records. If imported records contain account or profile information that does not exist in your Salesforce organization, they are imported in the Failure Rows step.

Transformation status is depicted by using the following icons:
- — Complete
- — Running
- — Unsuccessful
(Optional) To view logs, in the Execution results section, click the Logging tab.
All errors are displayed in red.

Importing users with the Customer Portal license from an LDAP server

KJB and KTR files in the Pentaho package

Before you begin

To import users with the Customer Portal license from an LDAP server

Related topics

Comments

Pentaho version	Action
6.1	In the Run Options window, click Run.
5.4	In the Execute a job window, click Launch.