Skip to main content
Version: 6.0

Case Manager Server: Windows Services

Case Manager Windows Services Diagram

A Windows Service is an application that runs in the background and often starts up with Windows. Windows Services can be accessed from Windows’s Task Manager or the Services settings, from where the service can be stopped or started. As mentioned in the previous section, Case Manager requires the Firebird database engine (version 3.0) to be installed on the server as a Windows Service, to enable access to the Case Manager database. Case Manager itself also has three Windows Services running on the server:

  • Instance Directory Service (service name “Case Manager Instance Director”) hosts the connection details for Case Manager databases. A client/workstation application can detect the Instance Directory on the local network and request up-to-date server connection details.
  • Case Manager Time Server (service name: “CmTimeServer”) tracks the agents’ actions and time spent on cases in the main Case Manager application. An agent requires a connection to the time server in order to log in.
  • Case Manager Queue Server (service name: “CmQueueServer”) hosts the queue functionality of Case Manager.

The installation programs for these Case Manager services can be found in the CaseManagerServerApps folder. The Instance Directory Service is installed by running the setup.exe, and the Time Server and Queue Server are installed by running their respective install.bat files "As Administrator" (an option availble, by right-clicking on the file). The install.bat process will ask you to select the instance for which you wish to install the server.

Monitoring the services​

After installation, you can monitor that these services are all running from the Task Manager in Windows. Alternatively, you can open the Services from the Windows Start Menu (or Settings/Control Panel). You will also have the option to start and stop these running services by right-clicking on the listed service name (as mentioned above). Note that the service name for the Time Server and Queue Server is appended by a $ sign and the name of the instance.

Event Logs & Troubleshooting​

The Case Manager services write to the Windows Event Log information (such as errors, warnings, and general notifications) that may help to troubleshoot problematic services. These events can be viewed by making use of the Event Viewer in Windows. Here, the Case Manager logs (named CaseManager), can be found in the Applications and Services Logs section. As a side note and tip for troubleshooting: should the Time or Queue service fail to start up and the logs do not provide sufficient information to solve the problem, you can also try to run the service as a console application from where you may view the error message causing the problem. This can be done by running the run.bat file (as Administrator) located in the CaseManagerTimeServer or CaseManagerQueueServer folders in the CaseManagerServerApps.