Sun Adapter for TCP/IP HL7 User's Guide

TCP/IP HL7 Inbound Adapter Environment Properties

The TCP/IP HL7 Adapter configuration parameters accessed from the Environment tree apply to both the inbound and outbound Adapters, and are the same for HL7 v2 and HL7 v3 Adapters.

The inbound TCP/IP HL7 Adapter’s Environment properties are divided into the following sections:

HL7 Inbound Adapter - TCPIP Inbound Settings

The following table lists and describes the TCP/IP HL7 inbound adapter properties that appear on the TCPIP Inbound Settings page of the Properties Editor accessed from the Environment. These properties configure the Java socket and server socket options. For more information, see the Javadocs provided with Java SDK.

Table 51 Environment - HL7 Inbound Adapter - TCPIP Inbound Settings

Name 

Description 

Host

The host name or IP address used to establish a TCP/IP connection. This property is only used when the Connection Type is set to Client.

ServerPort

The port number of the TCP/IP destination. This is dependent on the value set for Connection Type. If Connection Type is set to Server, it indicates the port number on the local host; if Connection Type is set to Client, it indicates the port number of the external host.

Enter an integer between 0 and 65535. 

Backlog

An integer indicating the maximum length of the queue for incoming connection requests when creating the server socket. When a connection indication arrives and the queue is full, the connection is refused. 

This parameter is only used when Connection Type is set to Server.

HL7 Inbound Adapter - MDB Pool Settings

The following table lists and describes the properties that appear on the MDB Pool Setting page of the Properties Editor accessed from the Environment. These properties are specific to the message–driven bean (MDB) pool of the GlassFish Server or Sun Runtime Server. These properties settings are packaged into sun-ejb-jar.xml.

Table 52 Environment - HL7 Inbound Adapter - TCPIP Inbound Settings

Name 

Description 

Steady Pool Size

An integer indicating the minimum number of message–driven beans to maintain. When the value is set to a number greater than 0 (zero), the container pre-populates the MDB pool with the specified number and tries to ensure that there are always this number of beans in the free pool. This ensures that there are enough MDB beans in the ready-to-serve state to process user requests. 

This property does not necessarily guarantee that no more than steady-pool-size instances exist at a given time. It only governs the number of instances that are pooled over a long period of time. For example, if an idle stateless session container has a fully-populated pool with a steady-pool-size of 10 and 20 concurrent requests arrive for the MDB component, the container creates 10 additional instances to satisfy the burst of requests. The advantage of this is that it prevents the container from blocking any of the incoming requests. However, if the activity is reduced to 10 or fewer concurrent requests, the additional 10 instances are discarded. 

Max Pool Size

An integer indicating the maximum number of message–driven beans in the pool. A value of 0 (zero) indicates that the pool is unbounded.

Pool Idle Timeout in Seconds

The maximum amount of time (in seconds) that an MDB instance can remain idle in the pool. When an MDB has exceeded the configured timeout, a timer thread removes the unused MDB. This property defines the interval at which this thread runs. 

A value greater than 0 indicates that the container removes or destroys any MDB instance that is idle at this specified duration. A value of 0 (zero) specifies that idle MDB instances can remain in the pool indefinitely. 

HL7 Inbound Adapter - Sequence Number Protocol

The following table lists and describes the property that appears on the Sequence Number Protocol page of the Properties Editor accessed from the Environment. Sequence numbering helps prevent duplication of data.

Table 53 Environment - HL7 Inbound Adapter - Sequence Number Protocol

Name 

Description 

Sequence Number File Location

The location of the sequence number file (a local directory). This is required when the Sequence Number Protocol is enabled. The sequence number folder is a nonvolatile directory that stores the sequence number files used to persist the HL7 sequence number. The unique base file name is automatically generated according to project or Collaboration information. 

For the inbound Adapter the file names are created as follows: 

ProjectName + DeploymentName + ExternalApplicationName + CollaborationName + .seqno

For example, prjHL7Inbound_dpIn_eaHL7Inbound_ jcdHL7inbound1.seqno

The default setting is /temp/hl7inbound/seq.

HL7 Inbound Adapter - Database Settings

The following table lists and describes the property that appears on the Database Settings page of the Properties Editor accessed from the Environment. These properties are used for storing HL7 messages as part of MLLP v2 support.

Table 54 Environment - HL7 Inbound Adapter - Database Settings

Name 

Description 

JNDI Name of the JDBC Datasource

The JNDI name of the JDBC data source as defined in the application server. This data source is used by MLLP v2 protocol to persist the HL7 messages before sending a commit acknowledgment. 

For more information, see MLLP V2 and the Sample Projects.