Configuring Java CAPS Environment Components for Communications Adapters

Configuring TCP/IP HL7 Adapter Environment Explorer Properties

The TCP/IP HL7 Adapter configuration parameters accessed from the Environment Explorer tree apply to both the inbound and outbound Adapters. The TCP/IP Adapter’s Environment properties are organized into the following sections:

HL7 Inbound Adapter - TCPIP Inbound Settings

The HL7 Inbound Adapter - TCPIP Inbound Settings present the java Socket and ServerSocket options. For more information, please refer JDK javadoc.

This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 8 Environment - HL7 Inbound Adapter - TCPIP Inbound Settings

Name 

Description 

Required Value 

Host

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

The host name or IP address to used to establish a TCPIP connection. 

ServerPort

Specifies 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.

An integer between 0 and 65535, indicating the port number of the TCP/IP destination.

The configured default is 8888.

Backlog

Specifies the maximum length of the queue when creating the ServerSocket. The maximum queue length for the incoming connection indications (request to connect) is set to the Backlog parameter. 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. 

An integer indicating the maximum length of the queue when creating the ServerSocket. 

The configured default is 50.

HL7 Inbound Adapter - MDB Pool Settings

The HL7 Inbound Adapter - MDB Pool Settings are specific to the MDB bean pool of Sun Java System Application Server or Sun Runtime Server only. The parameter settings in this section will go into sun-ejb-jar.xml.

This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 9 Environment - HL7 Inbound Adapter - TCPIP Inbound Settings

Name 

Description 

Required Value 

Steady Pool Size

Specifies the minimum number of MDB beans to be maintained. 

When the value is set to a number greater than 0 (zero), the container not only pre-populates the MDB bean pool with the specified number, but also attempts to ensure that there is always this many MDB beans in the free pool. This ensures that there are enough MDB beans in the ready-to-serve state to process user requests. 

This parameter 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, suppose an idle stateless session container has a fully-populated pool with a steady-pool-size of 10. If 20 concurrent requests arrive for the MDB bean 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 dies down to 10 or fewer concurrent requests, the additional 10 instances are discarded. 

An integer indication the minimum number of MDB beans to be maintained. 

The configured default is 10.

Max Pool Size

Specifies the maximum number of MDB beans in the pool. 

An integer indication the maximum number of MDB beans in the pool. A value of 0 (zero) indicates that the pool is unbounded.

The configured default is 60.

Pool Idle Timeout in Seconds

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

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

The maximum amount of time (in seconds) that an MDB bean instance can remain idle in the pool. 

The configured default is 600 (10 minutes).

HL7 Inbound Adapter - Sequence Number Protocol

The HL7 Inbound Adapter - Sequence Number Protocol provides configuration settings used to help prevent duplication of data.

This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 10 Environment - HL7 Inbound Adapter - Sequence Number Protocol

Name 

Description 

Required Value 

Sequence Number File Location

Specifies the location of the sequence number file (a local directory). This is required when the Sequence Number Protocol is enabled. The sequence number file is a non-volatile directory that stores the sequence number files that are used to persist the HL7 sequence number. This unique base file name is automatically generated according to Project/Collaboration information. 

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


<Project name> + <deployment name> + 
<external application node name>  +  
<Collaboration name> + .seqno

For example: 


 prjHL7Inbound_dpIn_eaHL7Inbound_
jcdHL7inbound1.seqno

The path and directory where the sequence number file is located. 

The default setting is: 

/temp/hl7inbound/seq

HL7 Outbound Adapter - TCPIP Outbound Settings

Presents the java Socket options. For more information, please refer JDK javadoc.

This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 11 Environment - HL7 Outbound Adapter - TCPIP Outbound Settings

Name 

Description 

Required Value 

Host

Specifies the host name or IP address used to establish a TCPIP connection. This parameter is only used when the Connection Type is set to Client. 

The host name or IP address used to establish a TCPIP connection. 

The configured default is localhost.

ServerPort

Specifies 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.

An integer between 0 and 65535, indicating the port number of the TCP/IP destination.

The configured default is 7777.

Backlog

Specifies the maximum length of the queue when creating the ServerSocket. The maximum queue length for the incoming connection indications (request to connect) is set to the Backlog parameter. 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. 

An integer indicating the maximum length of the queue when creating the ServerSocket. 

The configured default is 50.

HL7 Outbound Adapter - Connection Pool Settings

The HL7 Outbound Adapter - Connection Pool Settings are specific to the RA connection pool of Sun Java System Application Server (Sun One Application Server) or Sun Runtime Server only. The parameter settings in this section will go into sun-ra.xml.

This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 12 Environment - HL7 Outbound Adapter - Connection Pool Settings

Name 

Description 

Required Value 

Steady Pool Size

Specifies the minimum number of RA connections to be maintained. 

When the value is set to a number greater than 0 (zero), the container not only pre-populates the RA connection pool with the specified number, but also attempts to ensure that there is always this many RA connections in the free pool. This ensures that there are enough RA connections in the ready-to-serve state to process user requests. 

This parameter 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, suppose an idle stateless session container has a fully-populated pool with a steady-pool-size of 10. If 20 concurrent requests arrive for the RA 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 dies down to 10 or fewer concurrent requests, the additional 10 instances are discarded. 

An integer indication the minimum number of RA connections to be maintained. 

The configured default is 1.

Max Pool Size

Specifies the maximum number of RA connections in the pool. 

An integer indication the maximum number of RA connections in the pool. A value of 0 (zero) indicates that the pool is unbounded.

The configured default is 32.

Pool Idle Timeout in Seconds

Specifies the maximum amount of time (in seconds) that an RA connections instance can remain idle in the pool. When an RA connection has exceeded the configured Pool Idle Timeout, a timer thread removes the unused RA connection. This property defines the interval at which this thread runs. 

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

The maximum amount of time (in seconds) that an RA connections instance can remain idle in the pool. 

The configured default is 300 (5 minutes).

HL7 Outbound Adapter - Sequence Number Protocol

The HL7 Outbound Adapter - Sequence Number Protocol provides configuration settings used to help prevent duplication of data.

This section of the TCP/IP HL7 Adapter Environment properties contains the top-level parameters displayed in the following table.

Table 13 Environment - HL7 Outbound Adapter - Sequence Number Protocol

Name 

Description 

Required Value 

Sequence Number File Location

Specifies the location of the sequence number file (a local directory). This is required when the Sequence Number Protocol is enabled. The sequence number file is a non-volatile directory that stores the sequence number files that are used to persist the HL7 sequence number. This unique base file name is automatically generated according to Project/Collaboration information. 

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


<Project name> + <deployment name> + <collab name> 
+ <externalapplication node name> + .seqno

For example: 


prjHL7Outbound_dpOut_jcolHL7Outbound_
eaHL7Outbound.seqno

The path and directory where the sequence number file is located. 

The default setting is: 


/temp/hl7outbound/seq