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 onbound TCP/IP HL7 Adapter’s Environment properties are divided into the following sections:

HL7 Outbound Adapter - TCPIP Outbound 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 configure the Java socket and server socket options. For more information, see the Javadocs provided with Java SDK.

Table 55 Environment - HL7 Outbound Adapter - TCPIP Outbound 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. The default value is localhost.

ServerPort

An integer between 0 and 65535, indicating 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.

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.

Connection Mode

An indicator of how the Adapter connects to the external system. Select one of the following options: 

  • Automatic – The Adapter connects to the external system during initialization based on the connection settings (host and port number) defined in the environment. This enables dynamic connections

  • Manual – The connection settings are provided in the Java Collaboration through method calls, so the connection is done manually.

HL7 Outbound Adapter - Connection Pool Settings

The following table lists and describes the properties that appear on the Connection Pool Setting page of the Properties Editor accessed from the Environment. These properties are specific to the resource adapter pool of the GlassFish Server or Sun Runtime Server. These properties settings are packaged into sun-ra.xml.

Table 56 Environment - HL7 Outbound Adapter - Connection Pool Settings

Name 

Description 

Steady Pool Size

An integer indicating the minimum number of resource adapter connections to be maintained. When the value is set to a number greater than 0 (zero), the container pre-populates the RA connection pool with the specified number and tries to ensure that there are always this many connections in the free pool. This ensures that there are enough connections 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 resource adapter connection 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 resource adapter connections 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 a resource adapter connection instance can remain idle in the pool. When a connection has exceeded the configured timeout, a timer thread removes the unused connection. This property defines the interval at which this thread runs. 

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

HL7 Outbound 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 57 Environment - HL7 Outbound 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 outbound Adapter the file names are created as follows: 

ProjectName + DeploymentName + CollaborationName + ExternalApplicationName + .seqno

For example, prjHL7Outbound_dpOut_jcolHL7Outbound_ eaHL7Outbound.seqno

The default setting is /temp/hl7outbound/seq.