This project has moved. For the latest updates, please go here.

Setting up a development instance of the Client Registry in 20 minutes

This tutorial will guide you through the installation of the client registry on a test server.

Warning: This tutorial should not be used if you are deploying the Client Registry to a publicly accessible location as it uses the PostgreSQL superuser account.

Install the Client Registry w/Postgres Bundled Version

Time to Complete: ~10 minutes

The CR reference implementation is distributed as two different installers. In this tutorial we will be using the package which has PostgreSQL 9.2.4 bundled. This will save us an extra step of building a PostgreSQL server.

After downloading the bundle run the setup application. The first step of installation is setup of the PostgreSQL server. To perform this step, check the box labeled Install PostgreSQL 9.2.4 and enter an administrative user account and password (for the postgresql instance).

screenshot

After this step, there are some pretty standard configuration options presented, depending on your requirements you can customize the installation, however this tutorial will assume default options are used.

After installation has completed, you will be asked to configure the Client Registry, pressing finish will launch the Client Registry Configuration Tool.

screenshot

Configure The Instance

Time to Complete: ~5minutes

The configuration tool provided with the Client Registry software allows system administrators to quickly configure the application and deploy the necessary databases without hand-editing the configuration files. When first launched, the configuration tool will ask you for database credentials and a configuration option.

The "Easy Configuration" option will be used for this tutorial as it quickly sets up the necessary interfaces. Enter your database credentials in the fields, and press the New... button beside the Database Name option.

screenshot

In the Create Database window, enter a superuser account (in our case "postgres" that was created during the install) and the password. Enter a database name for the client registry databases as well as an owner (in our case "postgres" will also be the owner).

screenshot

After the database is created, you can select it from the Database Name drop down and press Continue. The configuration tool will deploy the necessary features to your machine. If your machine reports "Not Responding" don't panic, sometimes ADO.NET database access on the configuration tool can lock up the UI thread.

After configuration is complete, you will be presented with the configuration tool an a list of all configured features.

After clicking Start the service will start on your computer. You should now be able to navigate to the administrative SOAP interface at http://127.0.0.1:9999/admin .

Final Configuration

Time to Complete: ~5 minutes

The core configuration for the client registry is now complete. To enable additional interfaces configure them using the tool. In this tutorial we'll enable the PIXv3 interface (the minimum interfaces for testing a PIX consumer).

To enable PIXv3, select the Everest option under Messaging (The client registry uses Everest for all HL7v3 messaging). Enable the configuration panel (click on the Enable Configuration for Everest) and check the option "Enable configuration for IHE PIX Version 3". Change the URL scheme from https:// to http:// (as https requires certificates). Also enable debugging on the endpoint.

Click Configure Options and check the "MARC-HI Everest Framework Listeners" option. Clicking Ok will apply the configuration and restart the service.

You should now be able to navigate to http://127.0.0.1:8080/PIXManager and load the default WCF assistance page.

Last edited Jun 24, 2015 at 4:36 PM by jf03cg, version 3