This topic describes how to create user maps and apply user matching.
About user maps and user matching
Use user maps and user matching allow you to synchronize user fields. User maps describe how a user is identified in all your data sources. These maps define users that have different user names across multiple Data sources. User maps allow you to map these two users together so that Micro Focus Connect knows that hey are the same user.
User matching finds a user representation across two products and indicates that a user in System 1 is the same one in System 2.
The following are some common Micro Focus Connect user representations:
- Jira DisplayName
- Octane email, full_name or name
- ALM/QC loginname
- Azure DevOps DisplayName
If both products use the same user representation, you do not need to use user maps. If, however, the user representation is inconsistent, you must define user maps.
You can define user maps:
In the Micro Focus Connect dashboard. For details, see Define user maps in the dashboard.
By importing an XML file with the user information. For details, see Import user maps.
Through batch utilities, automating the user map creation and updates. For details, see Batch utility scripts.
You can manually construct the maps through the Micro Focus Connect user interface. For example, when mapping between ALM Octane and Jira, you can map the Jira assignee field to the ALM Octane owner field. For details, see User maps and user matching.
Each user map defines one user's identity across your different data sources.
To define a user map:
- On the top banner, select the User Maps tab.
- Click Add User Map. A User Map entry is added to the grid. In this User Map, you specify a single user's various identities across the different data sources.
Double-click the User Map placeholder text, and rename the User Map. The user map name is only used internally.
- Add rows to the user map.
- On each row, select a data source, and enter the user's name as it's defined in the data source.
- Repeat the above steps to create Data maps for all the users in your data sources.
- Click Save.
You can import user maps through a structured XML file.
To create a template of the XML file, you export users directly from the endpoint system and import them into the Micro Focus Connect database using the Batch utility scripts. For details, see Automatic user mapping. Alternatively, define a User map in the Micro Focus Connect and export it.
To import User maps:
- Create one or two User maps in the UI. For details, see Define user maps in the dashboard.
Export the User maps:
- In the top banner, click the gear button, and select Export.
- In the Export Connect Data dialog box, select the Users tab.
- Select the User Maps you want to export, and click Export.
Open the exported file.
The following example shows a typical user map record:
<UserMap> <name>User Map2</name> <User> <type>DataSource</type> <value>Jira DataSource</value> <name>Example Jira TeamDev</name> </User> <User> <type>DataSource</type> <value>Octane DataSource</value> <name>example.octteamdev@localhost</name> </User> </UserMap>
Repeat the above structure in the XML file to define a User map for each user.
The user map name. An internal label identifying the user for whom you are creating the user map. The name should be unique.
The user's name as found in the Data Source
You are allowed to specify multiple names for the same user within the same Data Source.
Caution: Do not change any of the data outside of the <UserMaps> block. This information is necessary to allow Micro Focus Connect to re-import the file.
- After completing all the user maps, save the file with an .xml extension.
Import the XML file:
- In the top banner, click the gear button, and select Import.
- Select your modified XML file.
- Click Import.
Enable user maps
After you create user maps, you need to associate them with user fields inside your connections.
To enable user maps:
- Select the Connections tab.
- Click the gear alongside a Connection and select Edit.
- In the Update Connection dialog box, click Next to navigate to the Types and Fields tab.
- Select a type and click (Edit).
- For each user field in the list, select the Enable User Map column.
Micro Focus Connect allows you to configure fallback users to use during synchronization, in cases where there is no user mapping.
For example, consider a case where a Jira Story is synchronized with ALM Octane and the Jira Story has Jane Doe as the Author. If there is no matching user in ALM Octane and no relevant user mapping, then Micro Focus Connect will create a user story in ALM Octane with the Author set to the fallback user.
This can also be useful if you do not want to create a full set of user accounts in the products being synchronized.
Fallback users can be configured to be specific or general. For example, you can designate fallback user Bob for a specific project mapping, type, and field. Alternatively, you can designate fallback user Bob for all project mappings, type mappings, and field mappings.
To set the fallback users:
In the Connection wizard, navigate to the User Configuration tab.
To set a fallback user for all type and field mappings, in the upper pane, expand the dropdown in the Target Fallback User or Master Fallback User columns and select a user.
To set a fallback user for specific types and fields:
In the bottom pane, click +Fallback User. The Create Fallback User dialog opens.
Select the side: Target or Master.
Choose a project, type, field, and user and click OK.
Repeat as required for each target or master.
Note: Micro Focus Connect uses the fallback user that is the most specific. If you specify a user for a particular type, it overrides your general designation in the upper pane.