Run the Identity Migration Tool using command-line arguments
- Last UpdatedJun 25, 2025
- 2 minute read
-
On the machine where you unzipped the Identity Migration Tool, open a command prompt as administrator and navigate to the local directory where the unzipped files are located.
-
To view help text for the command-line arguments for the tool, enter: IdentityMigrationTool /?
-
To run the Identity Migration Tool, enter: IdentityMigrationTool /I:InstancePath [/D:ServiceAccountSAM] [/M [/N]] [/O] [/S:SAMDomain /U:UPNDomain] [/V:pathToInputViewIDsFile].
where:
-
/I:InstancePath - The InstancePath value from the %PIHOME64 \Integrators\BA\CAST.UI.WindowsService.exe.config file.
-
/D:ServiceAccountSAM - (optional) If specified, the tool will default to the service account UPN's AF identities. Identities can not be determined or do not map to any AF identities that have read data access on the view's source AF database. If not specified, the tool will skip those views. Specify ServiceAccountSAM in SAM format (domain\user.)
-
/M - (optional) If specified, the tool will modify the PI_INTEGRATOR_VIEW element template and/or view elements. If not specified, the tool will run in preview-only mode and will not make any modifications.
-
/N - (optional) If specified with or without /M, the tool will not attempt to take an XML backup of the element listed in the /I:InstancePath value and its children. If not specified but /M is specified, the tool will attempt to take this backup and will terminate if it is unable to confirm that the backup file was created successfully.
-
/O - (optional) If specified, the tool will process views regardless of whether their IDList attribute value is blank. If not specified, the tool will skip views whose IDList attribute value is not blank.
-
/S:SAMDomain /U:UPNDomain - (optional, cannot be specified if /V is specified) If specified, the tool will process only views whose creators' SAM account domain matches the specified SAM domain. If the /U:UPNDomain option is specified, the tool will use the UPNDomain value as the User Principal Name (UPN) domain when creating Windows Identities for those view creators; or, if the /U:UPNDomain is not present, the tool will set the UPNDomain value equal to the SAMDomain value instead.
-
/V:PathToInputViewIDsFile - (optional, cannot be specified if /S is specified) If specified, the tool will read input view IDs from the specified file path and will only process views whose view IDs are present in the file.
-
-
After running the Identity Migration Tool, the following files will be present in the same folder where you ran the tool:
-
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; *not present if the tool is run in preview mode.
-