The Active Directory service

A Windows Service that performs all of the work for Active Directory synchronization

The Active Directory service runs as a Windows Service and is usually installed on a “server” style machine that does not get powered down.

HelpMaster Services

Before the service can be started, you will need to specify the “Log On As” user account.  Typically, this account is a dedicated “HelpMaster service account” that has been created to run all of the HelpMaster services (Email Manager, Priority Manager, Automation, Active Directory etc).  For further inforamation about this account, see HelpMaster Service Account

The Active Directory service is the working element of the Active Directory module - it is the application that executes all of the Active Directory profiles that you have defined.    Once it has been installed and configured, it requires no further maintenance or configuration.

The Active Directory service works by regularly polling the HelpMaster database every minute.  The service will look for active/enabled Active Directory profiles that have been configured to run at that time.  If such a profile exists, the business logic in that profile will be executed.

The Active Directory service will log events in both the Windows Event Log, as well as the HelpMaster Active Directory Log.

Using the Active Directory functionality without running the service

It is possible to perform a manual Active Directory synchronization.  This process does not rely on the service being configured or running.  In order to do this, refer to Manually performing an Active Directory Synchronization

Configuration

Before the Active Directory service can be started, it needs to be configured correctly.  Use the “Active Directory Service Setup” screen to specify these settings.

This screen can be accessed via the Desktop Edition > Automation > Active Directory Service Setup screen.

Service Name

This is the name of the Active Directory Manager service as displayed in the list of available Windows Services.  Click on the button Windows Services Viewer to display all of the services installed on the selected machine.  This name here is provided for identification purposes only.

Display Name

This is the name of the Active Directory Manager service as displayed in the list of available Windows Services.  Click on the button Windows Services Viewer to display all of the services installed on the selected machine.  This name here is provided for identification purposes only.

Service Path

This is the path where the Active Directory Manager service is installed.  Click on the button Windows Services Viewer to display all of the services installed on the selected machine.  This name here is provided for identification purposes only.

Service Database

This setting refers to the HelpMaster database that the service will work against.

Test a Windows account

The Active Directory service needs a Windows domain account to run as.  This account should have sufficient network security permissions to to the following resources:

  1. Access the HelpMaster SQL Sever database,
  2. Access the HelpMaster Working Folders .  Requires Modify privileges,
  3. Access the Windows .Net framework system files,
  4. If any of your HelpMaster Active Directory profiles have the Delete clients checkbox enabled (i.e. you want to delete clients), you will need to use a Windows account that has domain administration privileges in order to query Active Directory Tombstone objects.  See Deleting existing HelpMaster clients for further details about this.

After you have entered the Service account user name and password, click on the Test User button to perform a system check of the security credentials required.  If the user account that was specified passes all of these tests, it can then be set as the service account from the Windows Services console.

If the security test fails, you will need to do one of the following

  1. Use another account that has more network security privileges
  2. Modify the existing account so that it has the necessary security privileges to the area that the test failed.

Last service run

Indicates when the Active Directory service last ran.  Click on the refresh button to get the latest date/time.

Last date a profile was completed

Shows the last time an Active Directory profile was successfully completed.

Last run on machine

Displays the machine name of the server that last successfully ran the Active Directory service.

Service version (last run)

Displays the version of the service that last ran successfully on the server hosting the service.

Event Logging Options (tab)

Diagnostic Logging

When the Turn on Verbose Logging for the next … service runs check box is enabled, the Active Directory Manager will write a comprehensive event log for every action that it performs.  This may be useful for diagnosing configuration problems, or simply for testing and viewing what the Active Directory Manager is doing.  Due to the fact that verbose logging can very quickly fill your event log with much information, this feature will automatically turn itself off after the selected number of intervals that the service runs.  To turn it on again, simply enable the check box again and select the number of service runs.

Starting the Active Directory Service

Once all of the configuration settings have been set, you will need to start the Active Directory Manager service to start processing your Active Directory users. In order to start the Active Directory Manager Service, do the following.

  1. Click Start menu,
  2. Select Settings > Control Panel > Administrative Tools > Services to display the Windows Services screen
  3. Right-click on the HelpMaster Active Directory Service service and select Start from the popup menu
  4. If all of the settings have been configured correctly, the Active Directory service should start successfully.  To verify this you can check the system event message in the Applications section of the Windows Event Log,
  5. All Active Directory service activity will also appear in the log files of your Active Directory Management console.

Note : As soon as the Active Directory Manager Service start successfully, it will start working upon your HelpMaster database and any Active Directory Manager profiles that are marked as enabled.

Stopping the Active Directory Manager Service

Stopping or pausing the service is similar to starting it.  Click the Stop button to stop the Active Directory Manager service.

See also

HelpMaster Service Account