Run the Identity Migration Tool interactively

Run the migration tool interactively to make selections as the tool is running. If you prefer, you can run the tool using command-line arguments.

1. On the machine where you unzipped the Identity Migration Tool, open a command prompt and navigate to the directory where the unzipped files are located.

2. To run the tool, type IdentityMigrationTool and then press Enter.

3. When prompted, specify whether to migrate your views, which includes modifying the PI_INTEGRATOR_VIEW template and view elements.

   • No (N), type N or press Enter to run in preview-only mode; this will not make any modifications to the PI_INTEGRATOR_VIEW template or any view elements. Skip to step 5.

   • Yes (Y), type Y to modify your view element and template as needed.

4. At the "Do you want this tool to attempt to take an XML backup of your InstancePath element?" prompt, specify the backup option:

   • No (N), type N. This will not do anything; you should take a backup manually. If you do not have a backup and the tool modifies your views, you will not be able to fully revert back to your AF database's prior state. You take a manual backup from PI System Explorer with the Include All Referenced Objects and Include Security Strings options checked. (See XML export options.)

   • Yes (Y), type Y or press Enter to have the tool attempt to take an XML backup and terminate if the backup file is not successfully created.

5. At the "If a view's AF Identity list (IDList attribute) value is not blank, do you want the tool to overwrite the existing value" prompt, specify the overwrite option:

   • No (N), type N or press Enter to skip any view whose IDList attribute value is not blank.

   • Yes (Y), type Y to overwrite the existing IDList value.

6. Enter the InstancePath value from %PIHOME64%\Integrators\BA\CAST.UI.WindowsService.exe.config. For example, \\MyAFServer\Configuration\OSIsoft\PI Integrator for Business Analytics\Instance1.

7. The views will now load. Select the views you want to migrate. The tool will only process non-deleted views (views whose IsDeleted attribute value is false,) regardless of the option chosen.

   • (A), type A or press Enter to migrate all views.

   • (B), type B to specify the domain of the view creators whose views you would like to migrate.

   • (C), type C to enter an input view ID file path to migrate a specific set of views.

   When you run the tool, it creates a SetupPIIntegratorSetup_IdentityMigration_FailedViews_TimeStamp.txt file that contains the IDs of the views that failed.

8. At the "If any AF identities on the view's source AF server and database cannot be found for the view creator, do you want the tool to use the service account's AF identities instead if valid?" prompt, specify the option to use:

   • No (N), type N or press Enter if you would like the tool to skip any view whose creator cannot be mapped to AF Identities with read data access on the view's source AF database.

   • Yes (Y), type Y to use the service account's AF identities instead for those views.

9. At the prompt, specify whether to proceed with the migration:

   • No (N), type N.

   • Yes (Y), type Y to run the tool.

10. After running the Identity Migration Tool, the following files will be present in the %/PIHOME%\dat folder.

    • SetupPIIntegratorSetup_IdentityMigration_FailedViews_.txt: list of view IDs to which we were unable to add AF identities. This file can be used as input to the tool for a later run.

    • SetupPIIntegratorSetup_IdentityMigration_Report_.csv: results in CSV format.

    • SetupPIIntegratorSetup_IdentityMigration_Report_.html: results in HTML Format, which can be viewed in a web browser.

    • SetupPIIntegratorSetup_IdentityMigration_Logs.txt: view migration logs.

    • *SetupPIIntegratorSetup_IdentityMigration_InstancePathBackup_.xml: backup of the InstancePath's AF elements, attributes and templates; this file is not present if the tool is run in preview mode.