Skip to main content

Active Directory field mapping

If you have installed linqi on an on-premise environment and use Active Directory as a source for persons and groups, it is possible to customise the fields that are available in placeholders.
For example, you can offer the telephone number, department or the SAM account name as placeholders.

To customise the placeholders, proceed as follows:

  • Connect to the server on which linqi is installed
  • Navigate to the linqi installation path (e.g. C:\inetpub\wwwroot\linqi)
  • Open the ConfigFiles folder
  • Open the UserAdPlaceholderMapping.json file with an editor (e.g. Notepad)

In this file you will find the available fields from the Active Directory in JSON format. A single entry looks like this:

{
    "Key": "GivenNameOfUser",
    "DisplayName": {
        "de": "Vorname",
        "en": "Firstname",
        "fr": "Prénom",
        "es": "Nombre"
    },
    "AdField": "givenName",
    "isSelectable": true
}

The various properties have the following meaning:

  • Key: This is the key of the placeholder. It is used by linqi to identify the placeholders.
    This key must be unique and should not be changed. If you change the key later, existing placeholders in processes may be broken. DisplayName: Here you can define the display name of the placeholder for the different languages. These are used to display the name to the user when inserting a placeholder.
    You can freely choose this name.
  • AdField: Here you must use the internal name of the AD field which is used as the value for the placeholder. For example, givenName was selected in the example above. This means that the placeholders are resolved to the first name during execution. A list of fields can be found here. You can find the internal name there by clicking on an entry under Ldap-display-name. isSelectable: If this value is set to true, people can insert this placeholder in processes. If you set this value to false, people will no longer be able to insert this placeholder, but existing placeholders will continue to work. This allows you to delete a placeholder without breaking old processes.

After you have inserted a new entry, you must save the file. Make sure that the JSON is valid, i.e. that there is a comma separation between the entries. You must then restart the service (e.g. the linqi application pool in IIS). As soon as this has been done, the new field can be selected in the People placeholders.