Note

 

This documentation supports the 20.19.01 version of Remedyforce.

To view the latest or an earlier version, select the version from the Product version menu.

Importing users with the Customer Portal license from an LDAP server

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.

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

Note

The Customer Portal Manager Custom license has been discontinued and might not be available in your Salesforce organization.

Before you begin

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

  • 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.
  • 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).
    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 users with the Customer Portal license from an LDAP server

Important

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.

  1. 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 file.

  2. In Pentaho Spoon, select File > Open, navigate to the folder where you downloaded the Pentaho package, and open the TransferLDAPInfo.kjb (job) file.
  3. In the Delete client user import records step (transformation), provide your Salesforce organization access details.

     Click here to see the detailed steps.
    1. Right-click the Delete client user import records step and select Open referenced object > Transformation.
    2. Double-click the Select all client user import records step.
    3. In the window that opens, enter your Salesforce organization user name and password.
    4. (Optional) To verify the connection, click Test connection.
    5. To save your changes and close the window, click OK.
    6. Double-click the Delete records from Client User Import table step and repeat step 3c to step 3e.
    7. To save your updates to the Delete client user import records step file, click Save.
  4. Navigate to the TransferLDAPInfo.kjb (job) file.
  5. In the Update Client User Import table 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.
    StepActionDetails
    a.Open the Update Client User Import table with LDAP user information transformation.Right-click the Update Client User Import table with LDAP user information step, and select Open referenced object > Transformation.
    b.Provide LDAP server access details.

    On the TransferLDAPInfo tab, perform the following actions:

      1. Double-click the LDAP input step.
      2. In the LDAP Input window, enter the host, user name, and password of the LDAP server from which you are importing users.
      3. (Optional) To verify the connection, click Test connection and then click OK.
      4. (Optional) To fetch more fields from the LDAP server, on the Fields tab, click Get fields.
      5. To save your changes and close the LDAP Input window, click OK.
    c.(Optional) Assign customized LDAP attribute values to objects of your Salesforce organization based on conditions applied on the LDAP attributes.Perform the following actions:
      1. Double-click the Dynamic account and profile assignment step.
      2. 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.
      3. Click OK.
    d.Provide the Salesforce organization access details.Perform the following steps:
      1. Double-click the Salesforce Upsert step.
      2. In the Salesforce Upsert window, 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.
    e.(Optional) Update the predefined mapping between the LDAP fields and the Salesforce User object.Perform the following actions:
      1. Double-click the Salesforce Upsert [For User] step.
      2. In the Salesforce Upsert window, click Edit Mapping.
        The Certain referenced fields were not found! error message is displayed because of a known issue with the Pentaho Data Integration tool.
      3. To open the Enter Mapping window, click OK.
      4. Update mappings for other fields based on your requirements.
        For more information about mapping, see Overview of how users are imported from LDAP servers.
      5. To save your settings and close the Enter Mapping window, click OK.
      6. In the Salesforce Upsert window, in the Module field column in the Fields area, replace UserRole with UserRoleid and Profile with Profileid.
      7. To save your changes and close the Salesforce Upsert window, click OK.
  6. To save the KTR and KJB files, click .
  7. In the TransferLDAPInfo.kjb file, click Run this job .
  8. Perform one of the following actions based on the Pentaho version that you are using:

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

    Transformation status is depicted by using the following icons:

    • — Complete
    •   — Running
    • — Unsuccessful
    Data is imported into the Client User Import table in your Salesforce organization. Consider the following points about the imported records:
    • If clients who 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.
  9. (Optional) To view logs, in the Execution results section, click the Logging tab.
    All errors are displayed in red.

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:

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 run; 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 run 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.

SortSorts the users that are imported from the LDAP server.
Find Unique RowsChecks 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.

Related topics

Overview of how users are imported from LDAP servers

Scheduling jobs to import data

Troubleshooting common issues when importing data

Was this page helpful? Yes No Submitting... Thank you

Comments