Importing Salesforce Platform license users with assigned permission sets from an LDAP server

You can import users into your Salesforce organization by using the Pentaho Data Integration tool. The Pentaho package for importing Salesforce Platform license users with assigned permission sets from an LDAP server is available on the BMC Communities website.

By using the LDAP Pentaho package, you can import users who are assigned the Salesforce Platform license and ServiceDesk Client permission set by default. The BMC Helix Remedyforce package license is also assigned to the new imported users. For information about how users are imported into your Salesforce organization, see Overview-of-how-users-are-imported-from-LDAP-servers.

The following topics provide information about importing Salesforce Platform license users with assigned permission sets from an LDAP server into your Salesforce organization:

Note

For information about the LDAP versions that BMC Helix Remedyforce supports, see Supported-browsers-mobile-devices-and-integrations.

Before you begin

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

Install Java Runtime Environment (JRE).
Download the Pentaho Data Integration tool.
If the Require TLS 1.1 or higher for HTTPS connections Salesforce critical update is enabled in your organization, you must use version 6.1 or later of the Pentaho Data Integration tool.

Register at the BMC Communities website.
If you have enabled the setting to access your Salesforce organization from limited IP addresses, ensure that you have the security token to log on to your Salesforce organization.
For more information about the security token, see Salesforce Help.
Download the Pentaho package from the BMC Communities website (https://communities.bmc.com/docs/DOC-32288).
For information about the KJB (job) and KTR (transformation) files that are included in the Pentaho package, see KJB and KTR files for importing users from an LDAP server.

To import Salesforce Platform license users with assigned permission sets from an LDAP server

You cannot assign a permission set to an existing user by using this Pentaho package. Instead, you can use the KTR file provided in the InsertPermissions folder. For more information, see To assign permission sets to existing users by using a KTR file.

Important

Consider the following points when providing the access details for your Salesforce organization:

If you have enabled the setting to access your Salesforce organization from limited IP addresses, you must append the security token to your Salesforce organization password.
For example, if the password for your Salesforce organization is mypassword and your security token is XXXXXXXXX, specify mypasswordXXXXXXXXX in the Password fields.
BMC recommends that you do not change the default API version in the Salesforce Webservice URL.

To launch the Pentaho Data Integration tool, perform the following actions:
1. Navigate to the location where you downloaded and unzipped the Pentaho Data Integration tool.
2. Navigate to the data-integration folder and double-click the Spoon.bat.
In Pentaho Spoon, select File > Open, navigate to the folder where you downloaded the Pentaho packages, and open the TransferLDAPInfo.kjb file.
On the TransferLDAPInfo tab, in the Transfer Lookup Excel Export step (transformation), provide your Salesforce organization access details.
Click here to see the detailed steps.
1. Right-click the Transfer LookUp Excel Export step, and select Open referenced object > Transformation.
2. On the LookUp Excel Export tab, double-click one of the following steps:
  Salesforce Input [From User]
  Salesforce Input[For Profile]
  Salesforce Input[From Account]
  Salesforce Input[From UserRole]
  Salesforce Input[For User Account Link]
  Salesforce Input[From Permission Set]
3. In the Salesforce Input window, enter your Salesforce organization user name and password.
4. (Optional) To verify the connection, click Test connection and then click OK.
5. To save your changes and close the Salesforce Input window, click OK.
6. Repeat step 3b to step 3e for the other steps listed in step 3b.
7. To save the KTR file, click Save.
On the TransferLDAPInfo tab, right-click the Assign Account to users step, and select Open referenced object > Transformation.
1. On the TransferAccountsToUsers tab, double-click the Salesforce Insert [For User Account Link] step.
2. Enter your Salesforce organization user name and password.
3. (Optional) To verify the connection, click Test connection and then click OK.
4. To save your changes and close the window, click OK.
5. Double-click the Salesforce Update step and repeat step 4b to step 4d.
6. To save the KTR file, click Save.
On the TransferLDAPInfo tab, right-click the Assign Permission sets to the new users step, and select Open referenced object > Transformation.
1. On the AssignPermissionSets tab, double-click the Salesforce Insert step.
2. Enter your Salesforce user name and password.
3. (Optional) To verify the connection, click Test connection and then click OK.
4. To save your changes and close the window, click OK.
5. To save the KTR file, click Save.
On the TransferLDAPInfo tab, right-click the Assign Remedyforce License to the new user step, and select Open referenced object > Transformation.
1. On the AssignRemedyforceLicense tab, double-click the Salesforce Update step.
2. Enter your Salesforce user name and password.
3. (Optional) To verify the connection, click Test connection and then click OK.
4. To save your changes and close the window, click OK.
5. To save the KTR file, click Save.
On the TransferLDAPInfo tab, in the Update Salesforce with LDAP user information step (transformation), provide your LDAP server and Salesforce organization access details and, if required, customize the Pentaho package.

Click here to see the detailed steps.
On the TransferLDAPInfo tab, in the Update manager information step, provide your Salesforce organization and LDAP server access details:
Click here to see the detailed steps.
1. Right-click the Update manager information step and select Open referenced object > Transformation.
2. To provide the Salesforce organization access details, perform the following actions:
  Double-click the Salesforce Update step.
  Enter your Salesforce organization user name and password.
  (Optional) To verify the connection, click Test connection and then click OK.
  To save your changes and close the window, click OK.
3. To provide LDAP server access details, perform the following actions:
  Double-click the LDAP Input step.
  In the Host section, ensure that the correct LDAP host connectivity configuration has been entered.
  In the authentication section, enter the user name and password of the LDAP server from which you are importing users.
  (Optional) To verify the connection, click Test connection and then click OK.
  To save your changes and close the window, click OK.
4. To save the KTR file, click Save.
To save the KJB file, click Save.
In the KJB file, click Run this job.
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.
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.

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

To assign permission sets to existing users by using a KTR file

To assign permission sets to existing users by using the KTR file provided in the InsertPermissions folder, you need the AssigneeId of users and the IDs of the permission sets that you want to assign to the users. You can change the permission set that you want to assign to the imported users.

From the InsertPermissions folder, double-click the PermissionSetAssignment.csv file, and enter the user IDs (AssigneeIds) and the permission set IDs.
To launch the Pentaho Data Integration tool, perform the following actions:
1. Navigate to the location where you downloaded and unzipped the Pentaho Data Integration tool.
2. Navigate to the data-integration folder and double-click the Spoon.bat.
In Pentaho Spoon, select File > Open and navigate to the folder where you downloaded the Pentaho packages.
To assign permission sets to existing users, from the InsertPermissions folder, open the InsertPermissionSets.ktr file.
In the InsertPermissionSets.ktr file, double-click the Salesforce Insert step, and enter your Salesforce organization user name and password.
To save your changes and close the window, click OK.
To save the KTR file, click Save.
To run the KTR file, click Run this job.

To schedule jobs to import data

On the BMC Communities website, the Pentaho packages for importing data from external data sources into BMC Remedyforce page contain a Scheduling Files folder. This folder contains a sample batch file that you can use as a base to create your batch files for scheduling data import. For more information about scheduling a job, see http://wiki.Pentaho.com/display/EAI/Kitchen+User+Documentation.

Navigate to the folder where you have extracted the Pentaho package for which you want to schedule import jobs.
Open the Scheduling Files folder and create a copy of the sample batch file, such as SchedulingComputerSystem.bat.
Open the batch file that you created in step 2, perform the following actions, and save the file:
1. Update the path of the Kitchen.bat file based on your version of the Pentaho Data Integration tool:KETTLE_HOME="<path>\<PentahoFolder>\data-integration"
2. Update the path of the Kitchen.bat file and the KJB file:<path>\<PentahoFolder>\data-integration\kitchen.bat /file:"<JobFile>\<JobFileName>.kjb"/level:Detailed
In these steps, the following definitions apply:
- <path> is the location where you have extracted the Pentaho installer ZIP file.
- <PentahoFolder> is the extracted root folder for your version of the Pentaho Data Integration tool.
  For example, for version 6.1 of the Pentaho Data Integration Tool, the extracted root folder is pdi-ce-6.1.0.1-196.
- <JobFile> is the location where you have extracted the job files.
- <JobFileName> is the KJB file that you want to run at the scheduled interval.
- The level option specifies the level of logging for the job. The values that you can specify for the level option are Minimal, Basic, Detailed, Debugging, and Row Level. The log files are saved in the same folder where KJB files are saved.
See an example of the updated batch file.

The following figure shows an example of the updated SchedulingComputerSystem.bat file.
Go to Start > Control Panel > Administrative Tools > TaskScheduler.
In the Task Scheduler window, in the Actions area, click Create Basic Task.
In the Create Basic Task Wizard, type the name and description of the task, and click Next.
Select the appropriate option for starting the task, and click Next.
For example, you can select Daily or When the computer starts as the option for starting the task.
Configure the additional options for starting the task, and click Next.
The additional options are displayed based on the option that you selected in step 7. For example, if you select the Daily option for starting the task, you must configure the start date and frequency at which you want to run the batch file.
Select the Start a program radio button, and click Next.
Click Browse to locate the batch file that you have created to schedule the job, and click Next.
Select the Open the Properties dialog for this task when I click Finish check box, and click Finish.

KJB and KTR files for importing users from an LDAP server

In Pentaho, metadata is stored in XML format in the file system as KTR (transformations) or KJB files (jobs). 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:

The following table provides information about the steps that are included in the TransferLDAPInfo.ktr file (Update Salesforce 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 User table. For more information about mapping, see Overview-of-how-users-are-imported-from-LDAP-servers.

Troubleshooting

The following table describes the troubleshooting tips that you can use to resolve common issues that you might face when importing data.