Client Field Matching

Select the HelpMaster Client fields to AD user matching pattern

When the HelpMaster Active Directory (AD) service scans the AD for new or matching users, it needs some way to check whether an AD user already exists in the HelpMaster database as a client. This is done by comparing certain fields of the client record in the HelpMaster database with the corresponding fields in AD. Use this screen to instruct the HelpMaster AD service which fields to compare when checking for existing clients.

AD Field Matching

The HelpMaster Active Directory service process

Each time the HelpMaster AD service runs, it will iterate through each of the AD users in the selected LDAP paths, then compare each AD user with all HelpMaster clients using the matching pattern you select from this screen.

  • When a 100% match is found between an AD user and a HelpMaster client, an association between these records will be established rather than creating a new HelpMaster client. This association is then used to keep the client/user in synch with the AD record if the Update existing Clients action is selected. This association records the Windows SID of the AD user in the corresponding HelpMaster client’s database table/column tblClient.WindowsSID

  • If a match is not found, then the HelpMaster AD service assumes that the AD user does not exist in the HelpMaster database, and will therefore create a new HelpMaster client if the Create new Clients action is selected.

As a general rule, use a matching pattern that contains the highest number of fields that you know exist in both your AD data as well as your HelpMaster database. Using a pattern with more fields to match will ensure that the correct HelpMaster client is matched with the corresponding AD user.

Warnings for matching patterns that match on the HelpMaster Client ID and the Active Directory User ID

3 of the matching patterns match clients using the HelpMaster Client ID to the AD User ID. Care should be taken using these options when you are creating a profile to link existing HelpMaster clients. Remember that the AD User ID may be different to existing HelpMaster client IDs, even though they are they same person. The HelpMaster client ID may have been automatically generated at a previous time using a client ID generation algorithm that does not match up with the way the clients’ AD user ID is stored.

For example, the following table shows the same person, but with a different HelpMaster client ID / AD user name. When such a difference occurs, it is highly recommended not to use any matching pattern that considers the AD user ID. If such a pattern was used, the example record would be seen as different, and a new client for SmithJ would be created in the HelpMaster database.

Field HelpMaster Active Directory Comments
Client ID / User ID JohnS SmithJ « note the difference here!
First Name John John
Last Name Smith Smith

Different profiles, different pattern matching

Note that it is possible to create multiple HelpMaster AD profiles that have different client pattern matching options. This may be useful if you need to use one or more of the client matching patterns, or if your AD data contains differing amounts of data for different user fields. If using multiple profiles that each have the Create option checked, please be aware that when a profile cannot establish a match, it will create a new client. To prevent specific AD accounts from being created as clients in HelpMaster, use the LDAP Query Filter.

What if the wrong client is matched?

If at any time the wrong HelpMaster client(s) is associated with the wrong AD user, you can manually disassociate the HelpMaster client.

See Also

Working with HelpMaster clients and Active Directory

Creating new clients

Working with the Active Directory module

Auto generation of Client ID