Migrate User Authentication Data from Historian to Common UAA Service

About this task

Starting Historian 8.0 version, you can use the common User Authentication and Authorization (UAA) service.
Note: You can either choose the common UAA deployed by any other products such as, Operations Hub, Plant Apps; or the common UAA deployed by Historian.
To use the common User Authentication and Authorization service, the UAA data should be migrated from Historian to existing common UAA service of other products such as Operations Hub, Plant Apps.

To enable this migration of data the uaa_config_tool is introduced.

Note: While migrating uaa details, we are setting default password as user123 for all the users. You should change it using uaa config tool once migration is done. While setting up new password, it may ask you to enter port number. Please enter 443 as the port number and proceed.

It includes the following tasks:

  1. Back up Historian UAA data.
  2. Migrate the data to an existing common UAA service.


  1. Open Command Prompt.
  2. Mount the ISO and navigate to the Utilities folder where the uaa_config_tool.exe file is located. It is also located under GE Digital folder once you install Web-based Clients. Example: <C:\Program Files\GE Digital\Historian Config>
    Important: You should back up the data before upgrading to 8.0 (Web-based Clients)
  3. Enter the following command to take a back up of the data:

    C:\ uaa_config_tool.exe backup_data -d <destination folder>

    <destination folder> is the location where you want to save the back up files.

    Note: You may be prompted to enter the password twice for Historian Database and UAA. Enter the password as GEIP123User
    Back up is generated and the data is saved in the destination folder.
  4. Copy the backup files to the machine where web-based clients are installed.
  5. Enter the following command to migrate the data:
    uaa_config_tool.exe migrate_data -h <host-addr> -m <portnum> -u <username> -s <secret> -l <location path of backup files>

    Example: uaa_config_tool.exe migrate_data -h vmhistwin2016 -m 443 -u admin -s Gei321itc -l c:\myuaabackupfiles

    Note: While migrating uaa details, it may ask for port number at migrating historian database, user should enter 8432 and press ENTER.
    <host-addr> Address of the host or destination where you want to migrate the data.
    <portnum>Port number of the destination.
    <secret> Client Secret
    <location path of backup files>Source location where the data is backed up.


  • The data is migrated to the destination that is, common UAA service.
  • The umtlog file is generated containing the details about backup and migration for users and groups.
  • The User_migration_report is generated which contains the migration status of the user data.
Note: Creation and migration of users and groups can fail of the user or group already exists in the destination.

What to do next

If user migration fails, you can change the username in the backup file and repeat Step 5.