Client matching pattern

Client matching pattern

When the HelpMaster Active Directory service monitors Active Directory for new users, it needs some way to check whether a new Active Directory 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 Active Directory. Use this screen to instruct the Active Directory service which fields to compare when checking.

The HelpMaster Active Directory service process

Each time the HelpMaster Active Directory service runs, it will iterate through each Active Directory record that is not already associated with a HelpMaster client record, and then compare that Active Directory record with HelpMaster clients using the matching pattern you select in this screen.

  • When a 100% match is found between an Active Directory user and a HelpMaster client using the pattern match selected, an association between these records will be established for all time. This association is then used to keep the client/user in synch with the Active Directory record. This association is represented by recording the Windows SID of the Active Directory user against the corresponding HelpMaster client in the HelpMaster database table/column tblClient.WindowsSID

  • If a match is not found, then the HelpMaster Active Directory service assumes that the Active Directory user does not exist in the HelpMaster database, and will therefore create a new HelpMaster client if the “Create new client” checkbox is selected on the Action screen of the Active Directory profile.

As a general rule, use a matching pattern that contains the highest number of fields that you know exist in both your Active Directory data as well as your HelpMaster database. Using a pattern with more fields to match will ensure that right HelpMaster client is matched with the right Active Directory 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 Active Directory User ID. Care should be taken using these options when you are creating a profile to link existing HelpMaster clients. Remember that the Active Directory 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' Active Directory user ID is stored.

For example, the following table shows the same person, but with a different HelpMaster client ID / Active Directory user name. When such a difference occurs, it is highly recommended not to use any matching pattern that considers the Active Directory 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.

HelpMaster Active Directory
Client ID / User ID JohnS SmithJ << note the difference here!
First Name John John
Last Name Smith Smith
Email john@company.com john@company.com

Different profiles, different pattern matching

Note that it is possible to create multiple HelpMaster Active Directory profiles that have different client pattern matching options set. This may be useful if you need to use one or more of the client matching patterns, or if your Active Directory 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.

What if the wrong client is matched?

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

See Also

Working with HelpMaster clients and Active Directory

Creating new clients

Working with the Active Directory module

Auto generation of Client ID