Migrating Data for Enabling Single Sign-On for IBM PEM Community Manager

Prerequisite for Data Migration

Before performing the data migration task, DevOps user should follow the instructions:
  • Make sure all existing users are active.
  • The PCM servers will be unavailable during the migration period. Inform the DBA to take a back-up of PCM database.
  • The database back-up should be taken every time before you migrate the data for SSO as the migration process includes manual steps and the data cannot be recovered in case of an error.

Running the SSO Migration Utility

When you call the SSO migration utility, the data is either exported or migrated based on the configured migration action. To complete the data migration, at first call the utility with the Export action and then with the Migrate action.

To migrate users data in PCM, you need to follow the below steps:
  1. Export the existing data in PCM. To export, follow the steps:
    1. Configure the SSO migration properties in application.yml and set the data.action property to EXPORT. For more information on setting the properties, refer to Configuring the properties of application.yml file.
    2. Run the SSO migration utility. For more information on how to run the utility, refer to Deploy the SSO Migration Utility for IBM PEM Community Manager.
    3. Export action will export the following:
    Users CSV file, refer to the table for details:
    CSV column Description
    Email Contains the User Email ID.
    User ID Contains the User ID.
    User External ID For users that are migrated, this column contains the unique ID of the user in the external system. The column will be empty for non-migrated user.
    First Name Contains the first name of the user.
    Last Name Contains the last name of the user.
    ID Contains the User ID, this column is non editable.
    Migration Status Contains the migration status of the user.
    Description Contains the description for migration status of the user. This column will be empty for export.
    Note: Only active and non-superadmin (role) users are eligible for migration. Export action will export only the active and non-superadmin (role) users in the CSV file.
  2. Update the CSV data with external system details. To update, follow the steps:
    1. Each row in both CSV files should be validated and updated.
    2. By referring the user details in the external system, update the following:
      User CSV Column Description
      Email Update the email address of the user as per the external system.
      User ID Update the User ID as per the external system.
      User External ID Update the unique ID of the user as per the external system.
      First Name Update the first name of the user as per the external system.
      Last Name Update the last name of the user as per the external system.
  3. Migrate the data in PCM. To migrate, follow the steps:
    1. The migrate action will take user CSV file as input to migrate the user’s data.
    2. Configure the SSO migration properties in application.yml and set the data.action property to MIGRATE and file name properties. For more information on setting the properties, refer to Configuring the properties of application.yml file.
    3. Run the SSO migration utility. For more information on how to run the utility, refer to Deploy the SSO Migration Utility for IBM PEM Community Manager.
    4. Once the migration is complete, User CSV file will be exported with the migration status and description for each row.

Once the migration is complete, the DevOps user should inform all the users that the maintenance activity is completed, and users can now use their SSO credentials to access PCM.