Using the User Mapping Tool

The User Mapping Tool uses an API that allows it to look up Adobe Identity Management System (IMS) users by email and return their IMS IDs. This API requires the user to create a Client ID for their organization, a Client Secret, and an Access or Bearer Token.

Setting up the User Mapping Tool

Follow the steps below to set this up:

  1. Navigate to Adobe Developer Console using your Adobe ID.
  2. Create a new project or open an existing project.
  3. Add an API - Click Add to Project and select API
  4. Choose User Management API. You might need to get permissions to have this option.
  5. Create a JWT credential.
  6. Generate a key pair, or Upload a public key (rsa is no good). There is a button, Generate a public/private keypair, which will do this for you. Make sure you save both the public and private keys.
  7. Navigate to the User Management API.
  8. Generate an access token (or or bearer token) by pasting your private key content into the text box and clicking Generate Token.
  9. Save all this information such as Client ID, Client Secret, Technical Account ID, Technical Account Email, Org ID, and Access Token safely.

Accessing the User Interface for User Mapping Tool

The User Mapping Tool is integrated into the Content Transfer Tool. You can download the Content Transfer Tool from Software Distribution Portal. For more details on the latest version, refer to the Current Release Notes.

  1. Select the Adobe Experience Manager and navigate to tools -> Operations -> Content Migration.

    image

  2. Click on User Mapping card.

    image

  3. Click on Create User Mapping Config.

    NOTE

    If you skip this step, users and groups mapping will be skipped during the Extraction phase.

    image

    Populate the fields in User Management API Configuration, as described below.

    image

    • Org ID: Enter the Adobe Identity Management System (IMS) Org ID for the organization the users are being migrated.

      NOTE

      To get the Org ID, log into the Admin Console and choose your organization (in the top right area) if you belong to more than one. The Org ID will be in the URL of that page, in the format like xx@AdobeOrg, where xx is the IMS Org ID. Alternately, you can find the Org ID in the Adobe Developer Console page where you generate the Access Token.

    • Client ID: Enter the Client ID that you saved from the Setup step.

    • Access Token: Enter the Access Token that you saved from the Setup step.

      NOTE

      The Access Token expires every 24 hours and a new one needs to be created. To create a new token, go back into Adobe Developer Console, choose your project, click on User Management API and paste the same private key into the box.

  4. After populating the fields, click on Test Configuration to test the connection to the User Management API service. If the connection is successful, you will be able to click on Save to save the configuration.

    image

  5. After saving the configuration, select the configuration and click on Start User Mapping.

    image

  6. Click on Start from the the dialog box to start the User Mapping process.

    image

    It displays the Status as RUNNING.

    image

  7. Once User Mapping is complete, click on Results to view the summary.

    image

    IMPORTANT
    • Once User Mapping is complete, you can navigate back to Content Migration page using the breadcrumb. The User Mapping card displays the status and timestamp. Click on Content Transfer to create a migration Set to run extraction. Refer to Running the Content Transfer Tool for more details.

Resuming the User Mapping Process

If the User Mapping process is stopped due to any of the following reasons:

  • The user selected Stop User Mapping

  • the access token expired during the process or,

  • some other reason

    NOTE

    The progress is saved from where the process stopped.

Follow the steps below to resume the User Mapping process:

  1. Click on View Log to review the User Mapping log to check the saved progress.

    image

  2. Click on the Start User Mapping button again to resume from where it left off.

    NOTE

    Ensure before restarting that the access token is still valid or has been refreshed.

    image

  3. Click on Start from the the dialog box to resume the User Mapping process.

    image

    Once the User Mapping process completes, you will view the Status as FINISHED for that specific configuration.

    image

On this page