Best Practices for Generating, Configuring and Importing User Mapping (4323862)

User mapping is often a core problem for SharePoint Migrations.  The job of creating user mappings, configuring, and importing them into Content Matrix can be time consuming and difficult, depending on the size and complexity of the migration project. To address this need we have created a new command line utility called UserMappingsCLI that can help with the following tasks:

• Fetch all users from On-premises Active Directory and Azure Active Directory, and store them in csv files.
• Automatically generate user mappings file using the exported list of source and target users.

We have also added new PowerShell Cmdlets to import the user mapping into Content Matrix.

Instructions for generating and importing user mappings for SharePoint on-premises to SharePoint Online migration use case.

(A readme file with examples for additional use cases is included in the package)

To configure the UserMappingsCLI tool

1. Download and extract the attached zip file to a machine that has Content Matrix 9.0 or above installed.
2. The package contains the following files and folders:
   1. Folder UserMappingsCLI_yyyy.mm.dd.n contains the command line executable UserMappingsCLI.exe, its dependencies and a Logs folder.
   2. Folder sample-transformers contains a set of sample PowerShell scripts. Transformers are PowerShell scripts that can be used to alter the mappings. For example, format-mapping.ps1 inserts a windows claims prefix to the source user name, and a SPO claims prefix to the target user name.
   3. readme.html
3. Open the Windows Command Prompt as Administrator and navigate to the folder containing the executable, for instance C:\Quest\Tools\UserMappingsCLI\UserMappingsCLI_2019.11.7.3\.

To export users

• To export all users from on-premises Active Directory domain:

 UserMappingsCLI.exe --action=export --source-type=ad --export-type=csv --export="C:\temp\Source-Domain-Users.csv"

• To export users from Azure Active Directory:

 UserMappingsCLI.exe --action=export --source-type=aad --export-type=csv --export="C:\temp\Target-M365Tenant-Azure-Users.csv"

            Would you like to save your Azure credentials?. Please answer 'yes' or 'no'.

To generate user mappings file using the exported list of users

• Edit the PowerShell transformer (C:\Quest\Tools\UserMappingsCLI\sample-transformers\format-mapping.ps1) and replace the domain name with your domain name. Also, replace the claims prefix if needed - please see the note below for more information about claims prefix.

• Run the following command to generate user mappings.  Note the arguments have been broken into separate lines for legibility.

UserMappingsCLI.exe
--action=generate
--source-type=csv
--source="C:\temp\Source-Domain-Users.csv"
--target-type=csv
--target="C:\temp\Target-M365Tenant-Azure-Users.csv"
--transformer-type=powershell
--transformer="C:\Quest\Tools\UserMappingsCLI\sample-transformers\format-mapping.ps1"
--storage-type=csv
--storage="C:\Quest\Tools\UserMappingsCLI\user-mappings.csv"

  It will then generate user mappings (user-mappings.csv) in the following format:

Click To See Full Image.

Note :

It is important to use the correct claims encoding prefix in the user mappings. The claims prefix depends on the authentication provider used by SharePoint Web Applications. Some examples of standard claims prefixes are given below. For more information about claims encoding format click here 

If you are not sure which claims format to use, you can launch the Content Matrix global users mappings and inspect the claims prefix used in SharePoint.

To import user mappings into Content Matrix SharePoint Edition

Applies to: Content Matrix 9.0 and above

1. Install only SharePoint Edition of Content Matrix. Uninstall any other editions of Content Matrix (ex: Public Folder Edition) you may have.
2. Close Content Matrix.
3. Open a Windows PowerShell console as Administrator.
4. Configure the user mapping cmdlets:
   1. Import the commands: Add-PSSnapin Metalogix.SharePoint.Commands
   2. Make sure the Cmdlets are available: Get-Command -Module Metalogix.SharePoint.Commands -Name *user*
      1. You should see the following Cmdlets in the output (Content Matrix 9.0 or above):
             Clear-GlobalUserMappings       # Clears any existing user mappings
             Load-GlobalUserMappings        # Clears and loads new mappings
             Print-GlobalUserMappings        # Prints existing mappings
5. Import the mappings using this command by supplying the user mappings file:
       Load-GlobalUserMappings -CsvFile C:\Quest\Tools\UserMappingsCL\user-mappings.csv
6. Launch Content Matrix