How to run the Identity Migration Tool
- Last UpdatedJun 25, 2025
- 2 minute read
Before running the Identity Migration Tool:
-
PI Asset Framework (AF) Client including PI System Explorer must be installed on the machine where you are running the Identity Migration Tool.
-
An entry in the known servers table must be added in PI System Explorer for the AF server hosting the PI Integrator for Business Analytics configuration. (See Add a PI AF server to the connection list.) In addition, there needs to be an entry for each source AF server your PI Integrator for Business Analytics instance uses to publish data for views. You must be able to connect to each of these servers via PI System Explorer using the same machine that will run the Identity Migration Tool.
-
Create a mapping to the Administrators AF identity on the AF server hosting the PI Integrator for Business Analytics configuration.
-
The user running the Identity Migration Tool needs read access permissions on the AF Server for Security Identities, Security Mappings, Databases and AF security objects for all source AF servers your PI Integrator for Business Analytics instance uses to publish data for views. The built-in World AF Identity encompasses the required access.
-
The user running the Identity Migration Tool needs permissions to create and write files to the %PIHOME%\dat folder. Local administrator privileges encompass the required access.
-
The Identity Migration Tool is zipped and packaged with the PI Integrator.
-
Copy the downloaded zip file to a machine in the same domain as your PI Integrator for Business Analytics users.
-
Unzip the copied zip file to a local directory.
-
Run the Identity Migration Tool using one of the following options: Run the Identity Migration Tool interactively or Run the Identity Migration Tool using command-line arguments.