logo banner

In Metalogix Content Matrix Console - SharePoint Edition, user mappings can be configured before a migration takes place. This can be helpful in situations where a user exists at the source but does not at the target, such as when the user has been deactivated in Active Directory at the source because they are no longer with the company, and there is therefore no reason to have the inactive account at the target.

Instead of creating an account for this user at the target to associate the migrated data with, the user mapping would map the inactive account to one that exists at the target. Basic metadata would then be migrated over, and would be associated with the user that the mapping points to.

To configure global user mappings before a migration, select Settings > Configure global mappings from the ribbon menu. This will open the Specify Global Mappings dialog.

Another method for configuring user mappings is to start a copy operation, and go to the Mapping Options section of the copy options. Select the Edit Global Mappings... button to open the Specify Global Mappings dialog.

On this Page

Configure Global User Mappings

  1. In the ribbon menu go to Settings > Configure global mappings. This will open the Specify Global Mappings... dialog.

  2. This dialog box contains four main windows. The left hand window holds a set of tabs that allows users to switch between User and Domain mappings. The top left-hand and right-hand windows display the source and target users that the mapping will be based off of. The fourth window, on the bottom of the dialog, displays any user mappings that are currently set.

    Above the top left, and right-hand user display windows there are also options to set filters on the users, as well as a Views option to toggle between the display names and the login names of the users.

    The two user display windows (the top left-hand and right-hand windows) do not list the source and target users in their respective windows by default. This is because the Global Mappings are for all environments that the SharePoint Edition is connected to. Because this can be for multiple environments the Source need to be set for both the source side and target side user windows. To set the Source click the drop down arrow beside the Source option box (above the top left-hand window). This will open a drop down list of all of the available servers and connections to select from. Once a server has been selected all the users on that server will populate in the window below. Select the desired source server from the available list, then select the desired target server on the right-hand side, in the same way.

  3. Mappings can be performed by selecting a user on the left (the source), and a user on the right (the target), and then clicking the Map button on the far right. Note that Content Matrix maps groups by their corresponding SID values rather than the names seen in this window. If mapping is being done manually outside of Content Matrix by XML, SIDs for groups will need to be used in place of user names. SID placeholders can be seen in the example below:

    <Mappings>
    <Mapping Source="[SID]" Target="[SID]" />
    <Mapping Source="Metalogix\User2" Target="Metalogix\User254" />
    </Mappings>

    Completed mappings will appear in the bottom window. Any number of users on the source can be mapped into a single user on the target. Once a user has been mapped from the source side, they will no longer be listed on the source side list of users. The source side user will only be listed in the bottom window as a part of a mapping. This is to prevent multiple mapping from the same account. Users on the target side will remain in the list of users, as multiple users can be mapped to a single target user account.

    For example, let's say there is a user on the source side (Domain1\User1) who is not on the target side. The global user mapping would allow for that user to be mapped to a different user (Domain2\User23) on the target (one who does exist). Once mapped, any data on the source side that would be migrated over would replace the user information for Domain1\User1, with the Domain2\User23.

    This concept also applies for mapping multiple users on the source side into a single account on the target side. For example, if there are three user on the source, Domain1\User1, Domain1\User2, and Domain1\User3, all three of these users can be selected on the source side (at the same time) and mapped to the Domain2\User23 user account.

    Any mappings can be removed by selecting them from the bottom window, and clicking the Unmap button on the right-hand side. Similarly, clicking the Clear button will remove any mappings that currently exist in the bottom window.

  4. Once all the desired options are set, click OK to finish.

Mapping Users that don't Exist on the Target Side

In Content Matrix Console - SharePoint Edition it is also possible to map source side users to users that don't exist on the target side yet, or to users that cannot be accessed through the server drop down list. The method to use for these types of cases is to create a new user in the Specify Global Mappings dialog.

  1. In the ribbon menu and select Settings > Configure global mappings. This will open the Specify Global Mappings dialog.

  2. To create a new user account on the target side (to map to), click the Source button on the right-hand side. This will open the Create user mapping dialog.

  3. The Login Name is the most important field in this dialog as this is the main field that is used to create/add a new user (since it should automatically retrieve any necessary values from the target side authenticator). The other three fields, Display Name, Email, and Notes, come into play if the Login Name does not authenticate for any reason. In this case these other fields will be used by the entering their values to fill out the user data. While the Display Name and Email fields are helpful, the Notes field does not necessarily need to be filled out. The OK button will not be selectable until there is a value in the Login Name attribute.

    After the four Create user mapping fields have been filled with the appropriate/desired data, click OK.

  4. The new user will be created on the target side, and will have a slightly different color as compared to the other listed users. Any mappings can now be set to this user.

Any users created in this way can also be deleted in the Specify Global Mappings dialog by selecting them on the target side list of users, and clicking the Delete button on the right.

Import Mappings from an XML file

SharePoint Edition also has the ability to import any desired user mappings from an XML file. Importing user mappings from an XML file involves creating an XML file with the desired mappings, then importing that file into the product.

  1. Create a file, with any name, that contains any desired user mappings. The file must be an XML file, and must contain a root level node named Mappings, and have one child node for every mapping that you want imported. Each child node must contain two attributes: Source and Target. The Source is the Login Name of the source side user, and the Target attribute is the Login Name of the target user that is being mapped to.

    The XML file should follow the below format:

    <Mappings>
    <Mapping Source="Metalogix\User1" Target="Metalogix\User87" />
    <Mapping Source="Metalogix\User2" Target="Metalogix\User254" />
    </Mappings>

  2. After this XML file has been created, it can then be imported into the SharePoint Edition. In the Specify Global Mappings dialog, click the Import mappings from XML button at the bottom.

  3. This will open the Select xml file to import dialog. By default this dialog will open to the Metalogix AppData folder for the product, displaying files with .xml extensions (for Microsoft Vista based systems this folder is located at: C:\Users\[USER]\AppData\Roaming\Metalogix\Content Matrix Console - SharePoint Edition).

    Select the user mapping XML file, and click Open.

  4. Any retrievable user mappings will be added to the bottom window, according to the contents of the file.

Any user mappings added in this way can now be used during a migration.

There are multiple types of mappings that can be included in the XML file. the different types are: User mappings, Domain mappings, URL mappings, and GUID mappings. All of these mappings types can exist within the same XML file, however, each type of mapping must have it's own child node. The format for these child nodes is:

When these nodes are included within the XML file, the mappings will be sorted and will only appear in the appropriate tabs (user mappings in the User Mappings tab, domain mappings in the Domain Mappings tab, URL mappings in the Url Mappings tab, and GUID mappings in the GUID Mappings tab).

Note: The Import mappings from XML feature is also fully backward compatible with the previous version of Content Matrix Console - SharePoint Edition's UserMappings.XML file. So any user mappings set in the previous (old framework) version of the SharePoint Edition's UserMappings.XML file can be imported into the User Mappings.

Domain Mapping

Content Matrix Console - SharePoint Edition has the ability to map users across domains, in addition to it's ability to map users. These two abilities can be used together to map all users across a domain, and then to map some specific users into other user accounts.

  1. In the ribbon menu and select Settings > Configure global mappings. This will open the Specify Global Mappings dialog.

  2. In the Specify Global Mappings dialog select the Domain Mappings option from the window on the far left. This will switch the view over to the domain mappings, and any mappings that are set will be displayed. The list of mappings can be filtered.

  3. To add a new mapping click the New button on the far right. This will open the Create Domain Mapping dialog.

    Then enter the source side domain name and the target side domain name. Click OK when ready to continue.

  4. The domain mapping will now be added to the list, and will be applied during a migration. To remove a domain mapping, select one from the list, and click the Unmap button on the far right. To clear all domain mappings, click the Clear button.

  5. Click OK when finished. This will close the Specify Global Mappings dialog. One of two things can then be done: 1) start a migration using the specified mappings, or 2) continue with a migration using the specified mappings.

Any Domain Mappings that are set will also override the user mappings. For example, if "Domain1\User1" is mapped to "Domain1\User23," and a Domain Mapping has been set up to map "Domain1" to "Domain2," then the result after migration would be for "Domain1\User1" would have mapped over to "Domain2\User23." All other users would be mapped to their same user account, but would be mapped from "Domain1" to "Domain2." So if "Domain1\User2" had no User Mappings set, it would become "Domain2\User2" after the migration.