Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The HL7 data agent is used to collect and monitor HL7 messages coming from WSO2 ESB. The following sections explain how to configure the HL7 data agent in the ESB and monitor HL7 messages in BAM:

Table of Contents
maxLevel3
minLevel3

...

HL7 data agent (message publisher) comes by default with the HL7 transport that you installed earlier. To enable the data agent in the ESB and configure it to connect to BAM, set the following parameters in within the <axisconfig name="AxisJava2.0"> element in the <ESB_HOME>/repository/conf/axis2/axis2.xml file:

ConfigurationXML Code
Enable HL7 data agent<parameter name="transport.hl7.PublisherEnable">true</parameter>
Set the BAM server URL to which the data agent in the ESB connects to

<parameter name="transport.hl7.PublisherServerUrl">tcp://xx.xxx.x.xx:7611</parameter>

Provide the IP address of your BAM server.

Set the BAM server credentials

<parameter name="transport.hl7.PublisherServerUsername">admin</parameter>

<parameter name="transport.hl7.PublisherServerPassword">admin</parameter>

Set secure authentication. This is optional.

<parameter name=" transport.hl7.PublisherSecureServerUrl">tcpssl://xx.xxx.x.xx:76117711</parameter>

Provide the IP address of the BAM server.

Enable message status validation (Success or failure)

<parameter name="transport.hl7.ValidateMessage">true</parameter>

Enable this parameter with the ones above to get the message status.

...

Code Block
hl7.tbox
     |--streamDefn <folder>
           |--hl7_data_publisher_def <file>
           |--streams.properties <file>
     |--dashboard
           |--dashboard.properties <file>
           |--jaggery <folder>

The contents of the toolbox are described below:

...

Monitoring HL7 messages using BAM

Use either BAM message console or Cassandra explorer to monitor the HL7 messages as follows.

Anchor
Monitoring using BAM message console
Monitoring using BAM message console
Monitoring using BAM message console

After deploying the toolbox, you can access the HL7 message console in BAM through which you can monitor HL7 messages coming from the ESB.

...

Enter the connection details to Cassandra cluster and click Login.
Image Removed

  • Connection URL : Connection URL of the Cassandra cluster with IP and port. e.g., localhost:9160. This field is mandatory.
  • Username/Password : Credentials of the cluster

The message search page opens.
Image Removed
The fields of the message search page are described below:

FieldDescription

Message type

Stream name to perform the search on. For HL7 messages, select bam_hl7_data_publisher_store. This field is mandatory.

Status

Message status (success/failure/all)

Max Rows

Maximum number of search results to be displayed
Start time/End TimeTime interval to search messages

...

  • The Expand Message icon to view message content
  • An activity ID (value is equal to to Message control ID) to view all events that belong to the activity   

...

For instructions on how to monitor HL7 messages using the BAM message console, see Message Console.

Anchor
Monitoring using Cassandra explorer
Monitoring using Cassandra explorer
Monitoring using Cassandra explorer

Follow the below steps to monitor HL7 messages using Cassandra explorer.

  1. To see details of the HL7 messages in BAM, select Explore Cluster under Cassandra Explorer menu of the Tools menu in the management console.
  2. Connect to the Cassandra cluster.

    • Connection Url* : Connection URL of the Cassandra cluster with IP and port. e.g., localhost:9160. This field is mandatory.
    • Username/Password : Credentials of the cluster
    • Maximum Result Count : Maximum number of results retrieved from the Cassandra cluster
  3. Browse keyspace bam_hl7_data_publisher_store -> event_ks. For example,

...