Downloads & Data

Download tools and source code; access data sources and services

ClearWaterWatcher.zip

793 KB

Download Now

This download is provided under the Open Government Licence.

ClearWaterWatcher Software

By Connecting for Health | 2012

ClearWaterWatcher is a windows service to automate the use of the ClearWater tool.

Prerequisites

Operating System – Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2.

.NET Framework 3.5 required.

To check if .NET Framework 3.5 is installed, confirm that the following folder is present on the computer:

C:\WINDOWS\Microsoft.NET\Framework\v3.5.xxxx

To download and install .NET Framework 3.5 go to:

http://www.microsoft.com/download/en/details.aspx?id=21

ClearWater must be installed and ClearWaterCmd must be configured using its configuration file.

If you plan to use email notifications from ClearWaterWatcher you must have both a SMTP host ClearWaterWatcher can connect to and an email account on the SMTP host that ClearWaterWatcher can use to send emails.

For example NHSMail provides a SMTP host (accessible from the N3 network) defined as:

Host name: send.nhs.net
Port: 587
Encryption: TLS/SSL

Note – The email account you use will have an associated password that must be configured for ClearWaterWatcher. If this password is changed, then ClearWaterWatcher must be reconfigured. You may therefore find it useful to have a dedicated email account created for ClearWaterWatcher on the SMTP host which has its password policy set to “never require change”.

Note – If you plan to use email notifications make sure any antivirus software is not using port blocking rules to stop applications and windows services from sending emails. If it is you will need to configure the antivirus software to allow the ClearWaterWatcher windows service to send emails on the SMTP port you have configured.

A data feed source, such as DTS, must be available that will automatically deliver feed files to a named folder.

Deployment Package

ClearWaterWatcher has been developed using Microsoft Visual C# 2010 Express, the free development tool from Microsoft. This tool however does not support the creation of normal windows deployment packages (InstallShield or Setup Project), therefore the deployment package consists of a ZIP file called:

ClearWaterWatcher.zip

Installation

Unzip the contents of the deployment package (ClearWaterWatcher.zip) to a suitable folder on the computer (InstallLocation).

The content of the zip file is shown in table 1.

 

Table 1 - Zip contents.

Table 1 – Zip contents.

You need to manually install ClearWaterWatcher as a Windows Service.

You can install it on a server or on a desktop computer.

You will need administrative privileges to be able to install ClearWaterWatcher as a Windows Service.

Open a command prompt on the computer and change directory (CD) to the folder ClearWaterWatcher\Bin.

Figure 1 - Command prompt.

Figure 1 – Command prompt.

Run the command:

InstallUtil ClearWaterWatcher.exe

Figure 2 - InstallUtil.

Figure 2 – InstallUtil.

You will see a series of progress messages from the command, ending with the message “The transacted install has completed.”

Figure 3 - Installation messages.

Figure 3 – Installation messages.

ClearWaterWatcher is now installed as a Windows Service.

To check that it is installed open the Windows Services Manager:

Go to Start > Control Panel

Figure 4 - Control panel.

Figure 4 – Control panel.

Open Administrative Tools.

Figure 5 - Administrative tools.

Figure 5 – Administrative tools.

Open Services.

Figure 6 - Services.

Figure 6 – Services.

You should see ClearWaterWatcher installed and not started.

CAUTION –  Do not start the ClearWaterWatcher service until you have configured it.

Configuration

The application uses the configuration file:

InstallLocation\ClearWaterWatcher\Bin\ClearWaterWatcher.exe.config

This is a .NET application configuration file in XML format, and is shown in figure 7.

Figure 7 - Configuration file.

Figure 7 – Configuration file.

You can change the configuration settings in this file by directly editing the file.

The configuration file contains the following configuration items shown in table 2.

Table 2 - Configuration items.

Table 2 – Configuration items.

As a windows service ClearWaterWatcher is installed with a default service configuration.

To view or change this service configuration run Windows Service Manager and then double click ClearWaterWatcher to open the properties dialog.

Figure 8 - Service properties.

Figure 8 – Service properties.

ClearWaterWatcher is installed with a startup type of Manual. This means that you will need to manually start the service from the Windows Service Manager. Every time the computer is rebooted you will need to manually start the service.

You can change the startup type to Automatic which will then automatically start the service every time the computer is rebooted.

Figure 9 - Service log on.

Figure 9 – Service log on.

ClearWaterWatcher is installed with log on as Local system account. This is the windows account the service will use to run. For a detailed description of local system account see:

http://msdn.microsoft.com/en-us/library/windows/desktop/ms684190(v=vs.85).aspx

You can change the account used if required.

The log on account must have the following privileges:

  • Be able to read and write to the InputPath folder
  • Be able to read and write to the SuccessPath folder
  • Be able to read and write to the FailurePath folder
  • Be able to read and execute ClearWaterCmd
  • Be able to read and write to all folders and files ClearWaterCmd uses

If ClearWaterCmd is configured to connect to SQL Server using integrated security, then the log on account must be added as a login account to SQL Server.

Remove

To remove ClearWaterWatcher you need to manually uninstall ClearWaterWatcher as a Windows Service.

You will need administrative privileges to be able to uninstall ClearWaterWatcher as a Windows Service.

Open a command prompt on the computer and change directory (CD) to the folder:

ClearWaterWatcher\Bin

Figure 10 - Command prompt.

Figure 10 – Command prompt.

Run the command:

InstallUtil /u ClearWaterWatcher.exe

Figure 11 - InstallUtil /u.

Figure 11 – InstallUtil /u.

You will see a series of progress messages from the command, ending with the message “The uninstall has completed.”

Figure 12 - Removal messages.

Figure 12 – Removal messages.

ClearWaterWatcher is now uninstalled as a Windows Service.