Downloads & Data

Download tools and source code; access data sources and services

ClearWater28_03_2012.zip

7.96 MB

Download Now

This download is provided under the Open Government Licence.

ClearWater Software

By Connecting for Health | 2012

ClearWater is a set of software tools to assist organisations in importing urgent care dashboard data into a Microsoft SQL Server database.

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

Access to Microsoft SQL Server 7.0 or later is required.

Deployment Package

ClearWater 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:

ClearWater.zip

Installation

Unzip the contents of the deployment package (ClearWater.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.

Configuration

SQL Server

Within SQL Server manually create a new database for ClearWater to use. You can choose any name for the database. In the rest of this article a database name of ClearWater is used.

Figure 1 shows an example of creating the database in Microsoft SQL Server 2008 Express.

Figure 1 - Create database.

Figure 1 – Create database.

This database will contain patient identifiable data therefore it needs to be setup with appropriate SQL Server logins and server roles, and appropriate database users and roles to restrict access.

Within the database open the SQL script:

InstallLocation\ClearWater\SQL Scripts\SQLServerClearWater.sql

Execute the script. This will create the staging tables within the database.

Warning – the SQL script SQLServerClearWater.sql drops any existing staging tables within the database before creating them. When a table is dropped all its data is also deleted. Therefore executing SQLServerClearWater.sql will delete any existing data in the staging tables.

Figure 2 shows an example of running the script in Microsoft SQL Server 2008 Express.

Figure 2 - Create database tables and views.

Figure 2 - Create database tables and views.Figure 2 - Create database tables and views.Figure 2 - Create database tables and views.

Figure 2 - Create database tables and views.

Figure 2 – Create database tables and views.

ClearWaterWin

The ClearWaterWin application is found at:

InstallLocation\ClearWater\Bin\ClearWaterWin.exe

To run it you can either:

  • Place a Shortcut to it on the desktop
  • Add it to the Programs Menu
  • Run it directly from its location by browsing in My Computer or Windows Explorer

The application uses the configuration file:

InstallLocation\ClearWater\Bin\ClearWaterWin.exe.config

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

Figure 3 - Configuration file.

Figure 3 – Configuration file.

You can change the configuration settings in this file by either directly editing the file or by using the ClearWaterWin application (except for ValidateEnvelope). It is recommended you normally use the latter method.

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

Table 2 - Configuration items.

Table 2 – Configuration items.

Note – ClearWaterWin does not need to be installed on the same computer as SQL Server. It just requires access to SQL Server, it can therefore be used from a desktop computer rather than a server if desired.

 ClearWaterCmd

The ClearWaterCmd application is found at:

InstallLocation\ClearWater\Bin\ClearWaterCmd.exe

To run it you can either start a windows command interpreter and invoke the application from the command line (figure 4), or call the application from a batch file.

Figure 4 - Run ClearWaterCmd.

Figure 4 - Run ClearWaterCmd.

Figure 4 - Run ClearWaterCmd.

Figure 4 - Run ClearWaterCmd.

Figure 4 – Run ClearWaterCmd.

The application uses the configuration file:

InstallLocation\ClearWater\Bin\ClearWaterCmd.exe.config

The configuration file has the same format and contains the same configuration items as the configuration file for ClearWaterWin.

Note – as for ClearWaterWin, ClearWaterCmd does not need to be installed on the same computer as SQL Server. It just requires access to SQL Server, it can therefore be used from a desktop computer rather than a server if desired.