Automatically create user maps

Synchronizing data sources involves also synchronizing the users defined in the data sources. The same user may be defined differently in each data source.

To cope with this, you can define user maps.

If you have a small number of users in each system, you may be able to defined the user maps manually.

For a large amount of users, you can use utilities that automate the user mapping process.

Process outline

Automatically creating user maps involves the following high-level steps. The steps are described in detail in the sections below.

  1. Extract user data tables from the data sources.

    The extraction utility supports the following data sources: ALM Octane, ALM/QC, Jira, Azure DevOps, Rally, VersionOne, Service Now.

    If you connect to your data sources via proxy servers, define the proxy details in property bag files.

  2. In the extracted user data tables, identify key and identifier columns for each data source.
  3. Repeat the user data extraction, this time specifying only the key and identifier columns from each data source.

    You specify the key and identifier columns in the property bag files.

  4. Run the mfcUserMaps utility to create and import user maps from the user data tables.

Back to top

Extract user data tables from the data sources

You use the mfcDataSourceUsers utility to extract user data tables from the data sources.

The utility extracts all the user information in the data sources.

To extract the user data: Right click the mfcDataSourceUsers.bat file and run as administrator.

The files are saved in: <Micro Focus Connect directory>/UserMaps.

Specify proxy servers

If you connect to your data sources via proxy servers, specify the proxy details in property bag files.

To specify proxies in property bag files:

  1. Create a text file using the following naming convention: {datasourcename}.property.bag.txt

    {datasourcename} needs to match exactly one of the data source names as defined in Micro Focus Connect.

  2. In the file, define the following parameters:

    http(s).proxySet=true

    http(s).proxyHost=proxysocks.localhost.net

    http(s).proxyPort=80

    http(s).nonProxyHosts=localhost

    http(s).proxyUser=username

    http(s).proxyPassword=password

  3. Save the property bag file in: <Micro Focus Connect directory>/UserMaps
  4. Run the mfcDataSourceUsers utility. See above.

Back to top

Specify Key and Identifier columns for each data source

The data sources include user information which is not necessary for the user mapping.

For the user mapping, you need to identify two fields in each data source: a key and an identifier.

  • The key is a user field that has a common value for a given user across all data sources.
  • The identifier is the field that contains the label (example: name or email address) by which the user is known in the data source. For example, in ALM Octane, users can be identified by their email addresses, full name or log in name. In Jira, users are identified by their display name.

In some cases, the key and identifier in a data source may be the same field.

To instruct the utility to extract only the key and identifier fields, create a property bag for each data source that specifies the relevant columns.

To specify key and identifier columns for data sources:

  1. Create a property bag file for each data source. For details, refer to the previous section.
  2. In the file, list the following parameter:

    columns=key,identifier

    key and identifier must exactly match names from the headers. A header name may be repeated twice.

  3. Extract the user keys and identifiers from the data sources: Right click the mfcDataSourceUsers.bat file and run as administrator.

    The user data files are saved in: <Micro Focus Connect directory>/UserMaps.

Back to top

Create and import user maps

The mfcUsersMaps utility does the following:

  1. Identifies matching users in the data files, based on their identical key values.
  2. Creates a user map for each user with its various identities.
  3. Imports the user maps to Micro Focus Connect.

To create and import user maps:

  1. Open the mfcUserMaps.bat file, and edit the following line:

    "%JRE_PATH%\java.exe" -jar "%UTILITIES_PATH%\mfcUserMaps.jar" "%CONNECT_PATH%" "C:\temp" "|" {"incremental" | “removeall” | “pairs”} "%UTILITIES_PATH%\Jira" "%UTILITIES_PATH%\Oct1"

    The following table explains the command's arguments:

    Argument Details
    "C:\temp" The location of an audit file produced by the script. The file contains all the user maps spanning all the data sources. The file is named usermaps.audit.{datetime}.txt
    {"incremental" | “pairs” | “removeall”}

    "incremental", "removeall" and "pairs" are all optional and mutually exclusive.

    • Incremental. Takes any set of datasource maps, with any subset of users, and import them in the context of the existing user map in the database.
    • Pairs. Takes a pair of user map files. Each member of the pair is the equivalent to a connection running across the two data sources.

      It only imports those users who have a matching key in both usermap files. Doing so, it guarantees that there will be no ‘orphan’ user maps in the connect database, with a user representation from one product but not the other.

    • Removeall. Empties the database of all usermaps.

    If no argument is provided, the script removes all the existing user maps and replaces them with the newly generated user maps.

    "%UTILITIES_PATH%\Jira"

    The paths and file names of the user data files. The data files are generated by the mfcDataSourceUsers utility.

    • List all the data files that you want to include in the user maps.
    • The file names must match precisely the data source names as defined in Micro Focus Connect.
  2. You can import the audit file to tools like Excel and Access to review the user maps and audit the correctness of entries. As necessary, you can make adjustments to the respective systems (or LDAP or Active Directory) and extract the user data again.
  3. Right click mfcUserMaps.bat and run as administrator.

Back to top