test

Sun GlassFish ESB Healthcare Pack Installation Guide

Sun GlassFish ESB Healthcare Pack Installation

This topic provides instructions to help you successfully install the healthcare components of GlassFish ESB using a graphical user interface (GUI). The Healthcare Pack includes the following components:

To access all the GlassFish ESB documentation in PDF and HTML format, go to the GlassFish ESB page on docs.sun.com (http://docs.sun.com/app/docs/prod/gf.entsvc.bus#hic).

What You Need to Know

What You Need to Do

Additional Information

The following provide reference information, plus information and instructions for using the HL7 Binding Component, Sun Master Index, the BPEL Service Engine, and the PIX/PDQ projects. These are the key components of the PIX/PDQ projects.

Installation Overview

The Sun GlassFish ESB Healthcare Pack is installed on top of an existing GlassFish ESB v2.2 environment. The installer automates several configuration tasks for the PIX/PDQ solution, such as creating database tables, creating the connection pools and JDBC resources, defining security, and so on.

The Healthcare Pack Installer allows you to customize your installation. You can install the full healthcare solution, just Sun Master Index, just the HL7 Binding Component (BC), or both Sun Master Index and the HL7 BC. In order to use the PIX/PDQ solution in the healthcare pack, both Sun Master Index and the HL7 BC need to be included in the installation.

Installation Process

When you install the complete Healthcare Pack, the installation wizard performs several tasks automatically, including the following:

You can configure the installer not to perform these tasks or to only perform a subset of these tasks. If you opt to have the installer build and deploy the PIX/PDQ projects, several JBI components are started when you start the GlassFish server. These components include the BPEL Service Engine, HL7 Binding Component, HTTP Binding Component, and JMS Binding Component.

Important Installation Notes

By default, the Healthcare Pack Installer checks whether any of the artifacts listed above exists, and makes modifications to the MySQL installation or to the runtime environment based on whether they are found. If the artifacts already exist, the installer updates your environment as follows:

Before You Install

Before beginning the installation, make sure you have GlassFish ESB already installed and that you know the location and port numbers for the installation. Running the installer creates the Master Index database and Audit database for you in a MySQL environment. This means you need to have MySQL installed and running before performing the installation unless you opt to skip the MySQL configuration.

Software Requirements:

You should stop NetBeans and any Binding Components running on the domain before running the installer.

Cluster Requirements If you are installing the Platinum Pack into a clustered environment, perform the following steps in the order given before you begin:

Installing the Healthcare Pack With Default Configuration (Quick Start)

The following procedure describes how to install Healthcare Pack quickly and with minimal configuration. This type of installation allows you get quickly up and running with the PIX/PDQ projects, and is good for test environments.

Before installing the Healthcare Pack, review the information under Installation Overview, which explains what is installed. When installing the Healthcare Pack on UNIX systems, such as Solaris machines, you need to set the DISPLAY variable to install in GUI mode. For more information, see Installing the Healthcare Pack With Custom Configuration.

ProcedureTo Perform a Default Installation

Before You Begin

If you are performing a complete installation and you want the installer to create the database automatically, you must have a running installation of MySQL 5.1. To perform the installation with no configuration, the database needs to use port 3306. These instructions also assume that your GlassFish ESB environment is using the default port numbers. If your GlassFish ESB installation is configured with custom port numbers, follow the instructions under Installing the Healthcare Pack With Custom Configuration.

Before you can install any components of this pack, GlassFish ESB v2.2 must be installed.

  1. Exit from all programs prior to beginning the installation.

  2. Locate the Healthcare Pack Installer file on your installation media.

    The file is named healthcarepack-v2.2-installer.jar.

  3. To start the installation, either double-click the healthcarepack-v2.2-installer.jar file or run the following command:

    java -jar healthcarepack-v2.2-installer.jar

    The Healthcare Pack Installer wizard appears.

    Figure shows the Welcome window of the Installer.

  4. On the installer Welcome window, click Next.

    The License Agreement window appears.

    Figure shows the License Agreement window of the Installer.

  5. Accept the License Agreement and then click Next.

    The MySQL Location window appears.

    Figure shows the Root Connection page of the MySQL Location window.

  6. On the Root Connection tab of the MySQL Location window, enter the root password. Click Test Connection to verify the values.

    Tip –

    If you do not want to create the MySQL database, deselect Configure MySQL. If you already have an existing MySQL schema named midm or arrdb, they will be overwritten unless you deselect Configure MySQL.

  7. Click Next.

    The GlassFish Location window appears.

    Figure shows the GlassFish Location window of the Installer.

  8. On the GlassFish Location window, accept or modify the default values.

    Note –

    The default admin password is adminadmin and the default master password is changeit. If you need to change the master password, run the following command:

    asadmin change-master-password new-password

    Substitute the actual password for new-password.

  9. Click Next.

    The GlassFish Configuration window appears.

    Figure shows the GlassFish Configuration window of the Installer.

  10. Click Next to accept the default values.

    The NetBeans Location window appears.

    Figure shows the NetBeans Location window of the Installer.
    Note –

    When installing on Mac OS, the path to select is GlassFishESB_Home/netbeans.app/Contents/Resources/netbeans.

  11. Accept or modify the default values, and then click Next.

    The Preview Summary window appears.

    Figure shows the Preview Summary window of the Installer.

  12. Click Install.

    Note –

    Unless you deselect the options at the bottom of the page, the PIX/PDQ projects will all be built and deployed following installation. By default, the GlassFish server is shut down after the installation is complete. If you select Stop GlassFish Server After Installation, be sure to restart the server when the installation is done.

  13. When the installation is complete, click Finish.

    Figure shows the Summary of Installation window of the Installer.

Installing the Healthcare Pack With Custom Configuration

The following procedures describe how to install the complete Healthcare Pack with full configuration. This includes configuring the databases and database users, connection pools, JMS topic, application variables and configurations, and security for the PIX/PDQ consoles. Before installing the Healthcare Pack, review the information under Installation Overview, which explains what is installed.

When installing the Healthcare Pack on UNIX systems, such as Solaris machines, you need to set the DISPLAY variable to install in GUI mode. How you do this depends on how you connect to your system.

If you receive the error message “No X11 DISPLAY variable was set, but this program performed an operation which requires it” and you use the SSH command to connect to your system from another UNIX machine, you need to set the DISPLAY variable.

If you use X Windows software, such as Exceed, the DISPLAY variable is set for you automatically. Do not use telnet if you install on a Windows system.

Follow these steps in the order given to perform a custom installation of the Healthcare Pack:

ProcedureTo Begin the Installation

Before You Begin

If you are performing a complete installation and you want the installer to create the database automatically, you must have a running installation of MySQL 5.1. Before you can install any components of this pack, GlassFish ESB v2.2 must be installed.

  1. Exit from all programs prior to beginning the installation.

    You can cancel the installation at any time during the process.

  2. Locate the Healthcare Pack Installer file on your installation media.

    The file is named healthcarepack-v2.2-installer.jar.

  3. To start the installation, either double-click the healthcarepack-v2.2-installer.jar file or run the following command from the command line:

    java -jar healthcarepack-v2.2-installer.jar

    The Healthcare Pack Installer wizard appears.

    Figure shows the Welcome window of the Installer.

  4. On the installer Welcome window, click Next.

    The License Agreement window appears.

    Figure shows the License Agreement window of the Installer.

  5. Accept the License Agreement and then click Next.

  6. Continue to To Configure MySQL.

ProcedureTo Configure MySQL

You can configure the installer to automatically create the database tables for the healthcare projects. You can also configure the user passwords and schema names for the databases, and view the scripts that will be run.

Tip –

If you do not want to create the MySQL database, deselect Configure MySQL. If you already have an existing MySQL schema named midm or arrdb, they will be overwritten unless you deselect Configure MySQL.

  1. Complete the steps under To Begin the Installation.

  2. On the MySQL Location window, either deselect Configure MySQL, or perform the following steps.

    If Configure MySQL is not selected, the required databases for the PIX/PDQ are not automatically created.

    Figure shows the Root Connection tab of the MySQL Location window.

  3. On the Root Connection tab, verify or update the Server Host, Root User, and Server Port fields, and enter the root password for MySQL.

    The default MySQL port number is 3306.

  4. Click Test Connection to make sure the information is valid and MySQL is running.

  5. Click the User-Schema tab.

    The User-Schema page defines one user, mdm, for the Master Index and PIX/PDQ database, and another user, arr, for the Audit database. The default passwords are the same as the user names.

    Figure shows the User Schema tab of the MySQL Location window.

  6. Accept the default user passwords and schema for each database, or do any of the following:

    • In the User field, select mdm, and then modify the Password and Schema name for the Master Index and PIX/PDQ database.

    • In the User field, select arr, and then modify the Password and Schema name for the Audit database.

      Note –

      Make a note of any changes you make here, because you will need to update the JDBC connection pool information accordingly.

  7. To view the database scripts that will be run to create the required databases, do the following:

    1. Click the Database Scripts tab.

      Figure shows the Database Scripts tab of the MySQL Location window.

    2. Select a script from any of the three boxes, and then click View next to that box.

      The script appears in read-only view.

      Note –

      The MDM/MPI scripts create the core master index tables. The PIX/PDQ scripts create tables specific to the PIX/PDQ solution. The ATNA Audit scripts create the Audit database.

  8. Click Next.

    A warning dialog appears to verify that your MySQL root user has the required privileges.

    Figure shows the database root user warning dialog box.

  9. Do one of the following:

    • If the root user has the required privileges, click Continue.

    • If the root user does not have the required privileges, click Copy to Clipboard, open a SQL Editor, connect to MySQL, and then paste the script into the editor. Press Enter. Back in the Installer, click Continue.

  10. Continue to To Specify the GlassFish Location.

ProcedureTo Specify the GlassFish Location

This task ensures that the Healthcare Pack is installed to the correct domain.

  1. Complete the steps under To Configure MySQL.

  2. On the GlassFish Location window, deselect Install JBI Runtime Component if you do not want to install the GlassFish components. Otherwise, perform the following steps.

    Figure shows the GlassFish Location window of the Installer.

  3. Accept or modify the location for the GlassFish server.

  4. Select either Remote Domain or Local Domain, depending on your server configuration.

  5. Accept the default connection and login properties for the domain, or update the values if you have customized the administrator login information.

    Note –

    The default admin password is adminadmin and the default master password is changeit. If you need to change the master password, run the following command:

    asadmin change-master-password new-password

    Substitute the actual password for new-password.

  6. Click Next.

  7. Continue to To Configure Runtime Components.

ProcedureTo Configure Runtime Components

The Installer creates several runtime components for you, included connection pools, JDBC and JMS resources, application variables and configurations, and user profiles for console security. The following instructions explain how to configure each of these.

  1. Complete the steps under To Specify the GlassFish Location.

  2. On the GlassFish Configuration window, deselect Configure GlassFish JBI Components if you do not want the runtime components to be automatically created by the installer. Otherwise, complete the following steps.

    Figure shows the JDBC Connection Pools tab of the GlassFish Configuration window.

  3. To configure the automatically created connection pools, do the following:

    Note –

    This step is optional. If you accepted the default values on the MySQL Location window, you should skip this step. Only change the values on this page if you modified the MySQL information or if you are using a different database.

    1. Click the JDBC Connections Pools tab.

    2. Select any of the predefined connection pools to customize the pool.

    3. Modify any of the open fields.

      For more information on the predefined connection pools and the fields on this tab, see JDBC Connection Pool Fields.

    4. Click Apply.

    5. Repeat the above steps to configure a different connection pool.

  4. To view the automatically created JDBC resources, click the JDBC Resources tab.

    These correspond to the predefined connection pools above and cannot be modified.

    Figure shows the JDBC Resources tab of the GlassFish Configuration window.

  5. To configure the username and password for the Master Index outbound topic, do the following:

    1. Click the JMS Properties tab.

      Figure shows the JMS Properties tab of the GlassFish Configuration window.

    2. Modify the User and Password fields.

      The default values are admin and admin.

    3. Click Apply.

    4. In the bottom of the window, you can view the topics and queues that are created for the PIX/PDQ system.

  6. To modify the values for the predefined application variables, do the following:

    1. Click the Variables tab.

      Figure shows the Variables tab of the GlassFish Configuration window.

    2. In the Description field, select the variable to modify.

      For more information about the predefined variables, see Predefined Application Variables.

    3. Modify the Value field and click Apply.

    4. Repeat the above steps for each variable to modify.

  7. To modify the values for the predefined application configurations, do the following:

    1. Click the Configurations tab.

      Figure shows the Configurations tab of the GlassFish Configuration window.

    2. In the Description field, select the configuration to modify.

      For more information about the predefined configurations, see Predefined Application Configurations.

    3. Modify the Value field and click Apply.

    4. Repeat the above steps for each configuration to modify.

  8. To modify the passwords for the data management and monitoring tools, do the following:

    1. Click the File Users tab.

      Figure shows the File Users tab of the GlassFish Configuration window.

    2. Select a username in the Name field.

    3. Update the password.

      The default passwords are the same as the usernames.

    4. Click Apply.

    5. Repeat the above steps for each password to modify.

  9. Click Next.

  10. Continue to To Specify the NetBeans Location.

ProcedureTo Specify the NetBeans Location

This step ensures that the Healthcare Pack is installed to the correct instance of NetBeans.

  1. Complete the steps under To Configure Runtime Components.

  2. On the NetBeans Location window, deselect Install JBI Runtime Component if you do not want to install the GlassFish components. Otherwise, perform the following steps.

    Figure shows the NetBeans Location window of the Installer.

  3. Accept or modify the location for the NetBeans home directory.

    Note –

    When installing on Mac OS, the path to select is GlassFishESB_Home/netbeans.app/Contents/Resources/netbeans.

  4. Accept or modify the location where the PIX/PDQ projects will be installed.

  5. Click Next.

  6. Continue to To Complete the Installation.

ProcedureTo Complete the Installation

In the final installation step, you can specify whether projects are built and deployed, and whether the GlassFish server is shut down following the installation.

  1. Complete the steps under To Specify the NetBeans Location.

  2. On the Preview Summary review your installation selections. If you have any changes, use the Back button to navigate back through the wizard.

    Figure shows the Installation Summary window of the Installer.

  3. If you want the PIX/PDQ projects to be automatically built following installation, select Build Projects.

  4. If you want the PIX/PDQ projects to be automatically built and deployed following installation, select both Build Projects and Deploy Built Artifacts.

  5. If you do not want the installer to stop the GlassFish server after installation, deselect Stop GlassFish Server After Installation.

    Note –

    If you deselect this option, be sure to restart the server once installation is complete.

  6. Click Install.

  7. When the installation is complete, the Summary of Installation window appears, and displays a message letting you know whether or not the installation was successful.

    Figure shows the Summary of Installation window of the Installer.

Installer Field Descriptions

The following topics describe fields on the GlassFish Configuration window of the Installer:

JDBC Connection Pool Fields

The fields on the JDBC Connection Pool tab of the GlassFish Configuration window configure the connection pools that are automatically created by the installer. If you configured the installer to automatically create the Healthcare Pack databases, the information you specify in the JDBC Connection Pool fields should match the information you specified in To Configure MySQL. If you did not change the fields for the MySQL database, you can accept the default values on this page. If you are not using the installer to create the database and are using a different database instead, the field values on this page should match the information for the database you are using.

Field 

Description 

Connection Pools 

Select from one of the predefined connection pools to modify its configuration. The following pools are predefined: 

  • cpPatientXA: The connection pool for the Master Index database.

  • cpPatientSequenceXA: The connection pool for the Master Index sequence table.

  • MyArrdbPool: The connection pool for the Audit database.

Database Host 

The name of the server on which the database is located. 

Database Port 

The port number on which the database is listening. For MySQL, the default port number is 3306. 

Schema Name 

The name of the database schema where the database tables are created.  

User 

The login ID of the database user. 

Password 

The login password of the database user.  

Predefined Application Variables

The following table lists and describes the application variables that are predefined for the PIX/PDQ system. The port numbers and variables are based on the default GlassFish ESB port numbers. If you customized your port numbers, you need to modify the corresponding variable values.

Variable Name 

Variable Description 

Variable Value 

GFDefaultHttpPort 

ATNA Audit Service HTTP Port 

The port number your domain is listening on for HTTP requests. The default value is 8080. 

jmsURL 

PIX Update Notification JMS URL 

The URL to the Java MQ server you are using. The default value is mq://localhost:7676. 

sunpixmgr-v2–url 

HL7 v2 Listening URL 

The URL used to connect to the HL7 v2 external system. The default value is hl7://localhost:3600 

sunpixmgr-application 

PIX Update Sender HL7 v2 Application 

The HL7 v2 sending application. The default value is SUGA. 

sunpixmgr-facility 

PIX Update Sender HL7 v2 Facility 

The HL7 v2 sending facility. This value further identifies the sending application. The default value is SUNVAN. 

sunpixmgr-device 

PIX Update Sender Hl7 v3 Device 

The HL7 v3 sending device. The default value is 2.1.12^654. 

sunpixmgr-organization 

PIX Update Sender HL7 v3 Organization 

The HL7 v3 sending organization. There is no default value since this is not a required property for HL7 v3. 

Predefined Application Configurations

The following table lists and describes the application configurations that are predefined for the PIX/PDQ system. The application configurations are only used with the HL7 v3 projects. If you are using HL7 v2, you do not need to modify these values.

Configuration Name 

Configuration Description 

Configuration Value 

sunpixmgr-soap11 

HL7 v3 SOAP 1.1 PIX URL 

The default value is http://localhost:${HttpDefaultPort}/ PIXManager/PIXPort11. 

sunpdqsup-soap11 

HL7 v3 SOAP 1.1 PDQ URL 

The default value is http://localhost:${HttpDefaultPort}/ PDQSupplier/PDQPort11. 

sunpixmgr-soap12 

HL7 v3 SOAP 1.2 PIX URL 

The default value is http://localhost:${HttpDefaultPort}/ PIXManager/PIXPort12. 

sunpdqsup-soap12 

HL7 v3 SOAP 1.2 PDQ URL 

The default value is http://localhost:${HttpDefaultPort}/ PDQSupplier/PDQPort12. 

Installing Sun Master Index Only

The following procedure describes how to install just Sun Master Index using the Healthcare Pack Installer. Before installing the Sun Master Index, review the information under Installation Overview, which explains what is installed. Sun Master Index uses a database to store information about patients and to track a patient's history. You do not need to have the database platform installed to install Master Index, but you do need to install the database in order to work with Master Index. Master Index support the following database platforms:

Note –

When installing Sun Master Index on UNIX systems, such as Solaris machines, you need to set the DISPLAY variable to install in GUI mode. For more information, see Installing the Healthcare Pack With Custom Configuration.

ProcedureTo Install Sun Master Index

Before You Begin

Before you can install Master Index, GlassFish ESB v2.2 must be installed.

  1. Exit from all programs prior to beginning the installation.

    You can cancel the installation at any time during the process.

  2. Locate the Healthcare Pack Installer file on your installation media.

    The file is named healthcarepack-v2.2-installer.jar.

  3. To start the installation, either double-click the healthcarepack-v2.2-installer.jar file or run the following command from the command line:

    java -jar healthcarepack-v2.2-installer.jar

    The Healthcare Pack Installer wizard appears.

    Figure shows the Welcome window of the Installer.

  4. On the installer Welcome window, click Customize.

    The Customize Installation dialog box appears.

    Figure shows the Customize Installation dialog box.

  5. Deselect PIX/PDQ and then select Master Index. Click OK.

  6. On the installer Welcome window, click Next.

    The License Agreement window appears.

    Figure shows the License Agreement window of the Installer.

  7. Accept the License Agreement and then click Next.

    The NetBeans Location window appears.

    Figure shows the NetBeans Location window of the Installer.
    Note –

    When installing on Mac OS, the path to select is GlassFishESB_Home/netbeans.app/Contents/Resources/netbeans. There are no GlassFish components to install for Master Index, so you do not need to provide the GlassFish server home directory for this installation.

  8. Accept or modify the location for the NetBeans home directory, and then click Next.

    The Preview Summary window appears.

  9. Review your installation selections. If you have any changes, use the Back and Next buttons to navigate back through the wizard.

    Figure shows the Preview Summary window of the Installer.

  10. If you do not want the installer to stop the GlassFish server after installation, deselect Stop GlassFish Server After Installation.

    Note –

    If you deselect this option, be sure to restart the server once installation is complete.

  11. When you are ready, click Install.

  12. When the installation is complete, the Summary of Installation window appears, and displays a message letting you know whether or not the installation was successful.

    Figure shows the Summary of Installation window of the Installer.

Installing the HL7 Binding Component Only

The following procedure describes how to install just the HL7 Binding Component using the Healthcare Pack Installer. Before installing the HL7 BC, review the information under Installing the Healthcare Pack With Custom Configuration, which explains what is installed.

Note –

When installing HL7 on UNIX systems, such as Solaris machines, you need to set the DISPLAY variable to install in GUI mode. For more information, see Installing the Healthcare Pack With Custom Configuration.

ProcedureTo Install the HL7 Binding Component

Before You Begin

Before you can install the HL7 BC, GlassFish ESB v2.2 must be installed.

  1. Exit from all programs prior to beginning the installation.

    You can cancel the installation at any time during the process.

  2. Locate the Healthcare Pack Installer file on your installation media.

    The file is named healthcarepack-v2.2-installer.jar.

  3. To start the installation, double–click the healthcarepack-v2.2-installer.jar file or run the following command from a command line:

    java -jar healthcarepack-v2.2-installer.jar

    The Healthcare Pack Installer wizard appears.

    Figure shows the Welcome window of the Installer.

  4. On the installer Welcome window, click Customize.

    The Customize Installation dialog box appears.

    Figure shows the Customize Installation dialog box.

  5. Deselect PIX/PDQ and then select HL7 Binding Component. Click OK.

  6. On the installer Welcome window, click Next.

    The License Agreement window appears.

    Figure shows the License Agreement window of the Installer.

  7. Accept the License Agreement and then click Next.

    The GlassFish Location window appears.

    Figure shows the GlassFish Location window of the Installer.

  8. Accept the default values for the following properties, or modify them as needed:

    • The path to the GlassFish server.

    • Whether you are installing to a remote or local domain.

    • The connection and login properties for the administrator user.

      Note –

      The default admin password is adminadmin and the default master password is changeit. If you need to change the master password, run the following command:

      asadmin change-master-password new-password

      Substitute the actual password for new-password.

  9. Click Next.

    The NetBeans Location window appears.

    Figure shows the NetBeans Location window of the Installer.

  10. Accept or modify the location for the NetBeans home directory.

    Note –

    When installing on Mac OS, the path to select is GlassFishESB_Home/netbeans.app/Contents/Resources/netbeans.

  11. Click Next.

    The Preview Summary window appears.

    Figure shows the Preview Summary window of the Installer.

  12. Review your installation selections. If you have any changes, use the Back and Next buttons to navigate back through the wizard.

  13. If you do not want the installer to stop the GlassFish server after installation, deselect Stop GlassFish Server After Installation.

    Note –

    If you deselect this option, be sure to restart the server once installation is complete.

  14. When you are ready, click Install.

    The Installation Processing window appears, and displays the progress of the installation.

  15. When the installation is complete, the Summary of Installation window appears, and displays a message letting you know whether or not the installation was successful.

    Figure shows the Preview Summary window of the Installer.

Starting GlassFish ESB

To start NetBeans and the GlassFish server after the initial installation, navigate to the GlassFish ESB install directory or to the directory where the component is installed that you want to start. Run the appropriate command as describe in the table below.

Component 

From GlassFish ESB Installation Directory 

NetBeans IDE 

Windows GUI: Double-click the NetBeans desktop icon, select NetBeans from the Start menu, or run install-directory\start_netbeans.bat.

Mac OSX GUI: Select the NetBeans icon in the Dock or double-click NetBeans.app in the GlassFish ESB home directory.

UNIX: Run the executable file in install-directory/netbeans/bin.

GlassFish Server 

Windows GUI: Double-click install-directory\start_glassfish_domain_name.bat

Mac OSX GUI: Double-click install-directory\start_glassfish_domain_name

UNIX: Run asadmin start-domain from install-directory/glassfish/bin

Note –

You can also start the GlassFish server from the Services tab on the NetBeans IDE.