Configuring TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties

Max Data Size

Specifies the maximum size of data that the programs can hold internally. The valid range is from 1 to 2GB (which is the max value of java integer). 

An integer indication the maximum data size in bytes, ranging from 1 to 2147483647 (2GB).

The configured default is 2147483647.

Scope Of State

It is used to define the scope of State object, which is an OTD node. The valid options for this parameter are: 

• Resource Adapter Level: The State has the same life cycle as the resource adapter.

• Connection Level: The State has the same life cycle as the connection.

• OTD Level: The State has the same life cycle as the OTD object.

  This scope represents the life cycle of the State.

Select Resource Adapter Level, Connection Level, or OTD Level.

The configured default is Resource Adapter Level.

Connection Type

Specifies how the adapter establishes the TCP/IP connection: 

• Client: The adapter connects to an external server (host/port) to establish the connection. The adapter is in active mode.

• Server: The adapter waits/listens on certain port for an incoming connection request from an external client. Once the request is received, the adapter accepts the request and establishes the connection. The adapter is in passive mode.

Select Client or Server.

Unless you specifically require Server mode, leave this value as the default, Client.

ServerSoTimeout

Sets or Gets the value of the SO_TIMEOUT for the ServerSocket, in milliseconds. Used for ServerSocket.accept().

When this option is set to a non-zero timeout, calling accept() for ServerSocket will block for only this amount of time. If the timeout expires, a java.net.SocketTimeoutException (or java.net.InterruptedIOException) is raised, though the ServerSocket remains valid.

Enable this option prior to entering the blocking operation. This parameter is only used when the Connection Type is set as Server.

The SO_TIMEOUT value in milliseconds. The timeout must be greater than 0 (zero). A timeout of zero is interpreted as an infinite timeout.

The configured default is 60000 (60 seconds).

Keep Alive

Specifies whether the client’s SO_KEEPALIVE option is enabled or disabled. When the option is set for a TCP socket and no data has been exchanged across the socket in either direction for 2 hours (the actual value is implementation dependent), TCP automatically sends a KEEPALIVE probe to the peer (the actual value is implementation dependent). This probe is a TCP segment to which the peer must respond. One of three responses is expected:

1. The peer responds with the expected ACK. The application is not notified (since everything is OK). TCP will send another probe following another 2 hours of inactivity.

2. The peer responds with an RST, which tells the local TCP that the peer host has crashed and rebooted. The socket is closed.

3. There is no response from the peer. The socket is closed. The purpose of this option is to detect if the peer host has crashed. This is used for the accepted client Socket.

Select True or False.

True indicates that the SO_KEEPALIVE option is enabled.

Receive Buffer Size

Sets or Gets the value of the SO_RCVBUF option for the current socket, that is the buffer size used by the operating system for input on this socket. It provides an estimate of the size of the underlying buffers used by the platform for incoming network I/O.

When used in set, this is a suggestion to the kernel from the application regarding the size of buffers to use for the data to be received over the socket. When used in get, this must return the actual size of the buffer used by the platform when receiving data on this socket.

A number indicating the receive buffer size. 

The configured default is 8192.

Send Buffer Size

Sets or Gets the value of the SO_SNDBUF option for the current socket, that is the buffer size used by the operating system for output on this socket. It provides an estimate of the size of the underlying buffers used by the platform for outgoing network I/O.

When used in set, this is a suggestion to the kernel from the application regarding the size of buffers to use for the data to be sent over the socket. When used in get, this must return the actual size of the buffer used by the platform when sending out data on this socket.

A number indicating the send buffer size. 

The configured default is 8192.

SoLinger

Specifies whether the adapter performs a linger-on-close timeout. This option disables/enables immediate return from a close() of a TCP Socket. This parameter is used in conjunction with SoLinger Timeout.

• True with SoLinger Timeout set to a non-zero integer timeout: This means that a close() will block, pending the transmission and acknowledgement of all data written to the peer, at which point the socket is closed gracefully. Upon reaching the linger timeout, the socket is closed forcefully with a TCP RST.

• True with SoLinger Timeout set to a timeout of zero: Indicates that a forceful close is done immediately. If the specified value exceeds 65,535 it will be reduced to 65,535. See the SoLinger Timeout property.

Select True or False.

True enables the SO_Linger option.

SoLinger Timeout

Specifies the server’s SoLinger time in seconds. SoLinger Timeout is used in conjunction with SoLinger (see the SoLinger property) to configure the “linger-on-close” timeout. This option disables or enables immediate return from a close() of a TCP Socket.

When SoLinger is set to true (enabled), the SoLinger Timeout value indicates the following:

• A non-zero integer means that calling close() will block pending the transmission and acknowledgement of all data written to the peer, at which point the socket is closed gracefully. Upon reaching the linger timeout, the socket is closed forcefully, with a TCP RST. If the specified timeout value exceeds 65,535 it will be reduced to 65,535.

• A zero integer indicates that a forceful close is done immediately.

The configured default is 30 seconds.

SoTimeout

Sets or Gets the value of the SO_TIMEOUT in milliseconds. When this option is set to a non-zero timeout, calling read() on the InputStream associated with this socket will block for only this configured length of time.

If the timeout expires, a java.io.InterruptedIOException (or java.net.SocketTimeoutException) is raised, but the Socket remains valid. Enable this option prior to entering the blocking operation.

The SoTimeout value in milliseconds. The timeout must be greater than zero (0). A timeout of zero is interpreted as an infinite timeout. 

The configured default is 10000 (10 seconds).

TcpNoDelay

Specifies whether the server’s TCP_NODELAY option (that is, Nagle’s algorithm) is enabled or disabled. Written data to the network is not buffered pending acknowledgement of previously written data.

• True: Indicates that the server allows data packets that are less than the maximum transmission unit (MTU) size to be sent out immediately over the network. A setting of True may improve performance for higher-speed networks.

• False: Indicates that the server does not allow data packets that are less than the MTU size be sent out immediately over the network.

Select True or False.

The configured default is False.

Socket Factory Implemen-tation Class Name

Specifies the name of the Java class that implements the socket factory. This class is used to create the socket. If you have provided your own socket implementation, enter the name of the Java class that contains this implementation here. The factory implementation class must implement the following interface: 

com.stc.connector.tcpip.model.factory.TCPIPSocketFactory 

A Java class name. 

The default value is 

com.stc.connector.tcpip.model.factory.TCPIPSocketFactoryImpl

Time To Wait Before Attempting Connection

Specifies the length of time (in milliseconds) the adapter waits before attempting to connect to the external system. 

An integer indicating the length of time (in milliseconds) that the adapter waits before attempting to connect. 

The configured default is 0.

Always Create New Connection

Specifies whether the adapter always attempts to create a new connection when a connection establishment request is received. 

• True indicates that the adapter always attempts to create a new connection without attempting to match an existing connection.

• False indicates that the adapter attempts to match an existing connection (managed by the container).

Select True or False.

The configured default is False.

Auto Reconnect Upon Matching Failure

Specifies whether to attempt to re-connect automatically when the adapter gets a matching connection from a container, even though this connection is not valid due to various reasons, for example, the external side of the connection is closed/reset due to the external application’s logic. 

• True indicates that the adapter discards the invalid matching connection and automatically attempts to reconnect using a new connection.

• False indicates that the adapter does not automatically attempt to reconnect using a new connection: instead, the adapter defers the reconnect control to the user Business Rules. The user must detect this type of failure and act appropriately.

Select True or False.

The configured default is True.

Max Connection Retry

Specifies the maximum number of times the adapter attempts to connect to a specific external TCP/IP destination (host/port) before giving up. 

An integer indicating the number of times the adapter will attempt to connect. 

The configured default is 3.

Retry Connection Interval

Specifies the length of time (in milliseconds) the adapter waits between attempts to connect to a specific external TCP/IP destination (host/port). 

An integer indicating the length of time (in milliseconds) that the adapter waits between attempts to connect. 

The configured default is 30000 (or 30 seconds).

Max Binding Retry

Specifies the maximum number of times the adapter will attempt to bind to the specified TCP/IP port on the localhost before giving up. 

An integer indicating the number of times the adapter will attempt to bind to the specified TCP/IP port on the localhost. 

The configured default is 3.

Retry Binding Interval

Specifies the amount of time (in milliseconds) that the adapter waits between attempts to bind to the specified TCP/IP port on the localhost. 

An integer indicating the length of times, in milliseconds, between attempts to bind to the specified TCP/IP port. 

The configured default is 30000 (30 seconds).

Acknowledgment Level

Specifies what type of acknowledgments are provided by the JCD. The valid levels are: 

• Immediate

• Deferred

• Queued

Select Immediate or Deferred or Queued

The configured default is Immediate.

LLP Type

Specifies the LLP (Lower Layer Protocol) type. The valid types are: MLLPV2.0 (Minimal Lower Layer Protocol V2.0)

MLLPV2.0 is the configured default value.

Start Block Character

Specifies the Start Block Character (the first envelope marker character in the HL7 envelope) as a decimal ASCII number.

A decimal within the range of 1 to 127. Unless there is a conflict, the value should be ASCII VT (decimal 11).

The default value is 11.

End Data Character

Specifies the End Data Character (the second to the last envelope marker character in the HL7 envelope) as a decimal ASCII number. The allowed range is 1 to 127.

A decimal within the range of 1 to 127. Unless there is a conflict, the value should be ASCII FS (decimal 28).

The default value is 28.

End Block Character

Specifies the End Block Character (the last envelope marker character in the HL7 envelope) as a decimal ASCII number.

A decimal within the range of 1 to 127. To be strictly compliant with the HL7 Standard, this parameter MUST be set to a Carriage Return (decimal 13).

The default value is 13.

Max Number of Retries

The maximum number of times the adapter will try sending the message upon receiving the MLLP v2.0 Negative Commit Acknowledgement from the peer before giving up. 

This parameter is used by HL7 adapter in outbound mode. 

An integer indicating the number of times the adapter will try sending the message upon receiving the MLLP v2.0 Negative Commit Acknowledgement from the peer.  

The configured default value is 5.

Sequence Number Enabled

Specifies whether Sequence Number Protocol is enabled or disabled. HL7 sequence numbering is used to help prevent duplication of data.

The configured default is False.

Interaction ID

The identification of the unique information interchange. The attribute values are derived from the HL7 MDF interaction names. For example, POLB_IN100100 and COMT_IN300652. 

Processing Code

Defines whether the message being sent is part of the following values: 

• P — Production

• T — Training

• D — Debugging System

The configured default is D.

Processing Mode Code

Defines whether the message being sent is: 

• T — Current Processing

• A — Archive Mode

• T — Initial Load Mode

• R — Restore from Archive Mode

The configured default is T.

Version Code

This attribute is matched by the receiving system to its own version to be sure the message will be interpreted correctly. 

The configured default is V3PR1.

Validate Transmission Wrapper

Indicates whether to validate Transmission Wrapper of data message (for inbound case) and Transmission Wrapper of ACK (for outbound case). 

This parameter will be used in Collaboration Code. 

The configured default is False.

Time To Wait For A Response

Specifies the amount of time (in milliseconds) that the adapter waits for a response from the external system before taking recourse action (see Action on No Response in the Table 87). Any data from the external system is considered a response.

This property corresponds to the initial read/receive operation timeout. Once a response is received, the subsequent read/receive operation uses the SoTimeout specified timeout (see So Timeout in the Table 78).

An integer indicating the length of time in milliseconds that the adapter waits for a response from the external system. A value of 0 (zero) is interpreted as an infinite timeout.

The configured default is 30000 (30 seconds).

Max Empty Read Retry

Specifies the maximum number of times the adapter attempts to read data from the external system after the read/receive operation returns nothing. This applies to the read or receive operation after a response starts to arrive. 

Empty Read means that a timeout occurs on the read/receive operation, which takes the SoTimeout parameter in the TCPIP Server Base Settings section as the applied timeout setting (see So Timeout in the Table 78).

The corresponding recourse action is specified by the Action on Max Failed Read Retry in the Table 87.

An integer indicating the maximum number or retries. 

The configured default is 5.

Max No Response

Specifies the maximum number of response timeouts the adapter allows, while waiting for data from the external system, before taking recourse action. 

This parameter will be used in collaboration code. 

An integer indicating the appropriate number of timeouts that may occur before taking recourse action. 

The default value is 30.

Max NAK Receive Retry

Specifies the maximum number of negative acknowledgments the adapter receives before taking recourse action (see Action on Max Nak Received in the Table 87).

This parameter is used for outbound Collaboration code. 

An integer indicating the appropriate maximum number of NAKs received before taking recourse action. 

The default value is 5.

Max NAK Send Retry

Specifies the maximum number of negative acknowledgments the adapter sends before taking recourse action (see Action on Max Nak Sent in the Table 87.

An integer that indicates the appropriate maximum number of NAKs sent by the adapter before recourse action is taken. 

The default value is 30.

Max Canned NAK Send Retry

Specifies the maximum number of canned negative acknowledgments that the adapter sends before taking recourse action (see Action on Max Nak Sent in the Table 87).

The appropriate maximum number of canned NAK to send before taking recourse action. 0 indicates that the adapter will not attempt to create or send a canned NAK.

The default value is 3.

Enable Journaling

Specifies whether message journaling is enabled. 

This parameter is used for outbound Collaboration code. 

Select True or False.

True indicates that journaling is enabled.

The default value is True.

Action on No Response

Specifies the action the adapter will take if no ACK is received from the external system in the allotted time. The amount of time is determined by the Time To Wait For A Response parameter (see Time To Wait For A Response in the Table 86). The options are:

• Exit: The adapter terminates its connection with the external system and shuts down.

• Resend: The adapter attempts to resend the message to the external system. The Resend option is only allowed when sequence numbering is in effect.

• Reset: The adapter closes its connection with the external system and goes through the connection scenario.

  This parameter is used for outbound Collaboration code.

Select Exit, Resend, or Reset.

The configured default is Reset.

Action on Max No Response

Specifies the action the adapter takes when it attempts to send an Event to the external system the maximum allowed number of times, and does not receive any response (HL7 Application Acknowledgement) from the external system. The maximum number times the adapter sends an Event without receiving a response is determined by the Max No Response parameter (see Max No Response in the Table 86). The options are:

• Exit: The adapter terminates its connection with the external system and shuts down.

• Reset: The adapter closes its connection with the external system and goes through the connection scenario.

  This parameter is used for outbound Collaboration code.

Select Exit or Reset.

The default value is Reset.

Action on Max Failed Read Retry

Specifies the action the adapter takes after it has reached the empty read limit set by the Max Empty Read Retry parameter. The recourse options are:

• Exit: The adapter terminates its connection with the external system and shuts down.

• Reset: The adapter closes its connection with the external system and goes through the connection scenario.

  This parameter is used for outbound Collaboration code.

Select Exit or Reset.

The configured default is Reset.

Action on Nak Received

Specifies the action the adapter takes when it receives an HL7 Application NAK from the external system. The options are: 

• Resend: The adapter attempts to resend the message to the external system.

• Reset: The adapter closes its connection with the external system and goes through the connection scenario.

• Skip Message: The adapter remains connected, but writes the message to an error queue.

  ---

  Note –

  Do not set both the “Action On NAK Received” and “Action On Max NAK Received” parameters to “Skip Message.”

  ---

  This parameter is used for outbound Collaboration code.

Select Resend, Reset, or Skip Message.

The configured default is Resend.

Action on Max Nak Received

Specifies the action the adapter takes when the maximum number of HL7 Application NAKs have been received from the external system, as set by the Max NAK Receive Retry parameter (see Max NAK Receive Retry in the Table 86). The options are:

• Exit: The adapter terminates its connection with the external system and shuts down.

• Reset: The adapter closes its connection with the external system and goes through the connection scenario.

• Skip Message: The adapter remains connected, but writes the message to an error queue.

  ---

  Note –

  Do not set both “Action On NAK Received” and “Action On Max NAK Received” parameters to “Skip Message.”

  ---

  This parameter is used for outbound Collaboration code.

Select Exit, Reset, or Skip Message.

The configured default is Skip Message.

Action on Max Nak Sent

Specifies the action the adapter takes when it has sent the maximum allowed number of NAKs to the external system, as set by the Max NAK Send Retry parameter (see Max NAK Receive Retry in the Table 86). The options are:

• Exit: The adapter terminates its connection with the external system and shuts down.

• Reset: The adapter closes its connection with the external system and goes through the connection scenario.

• This parameter is used for outbound Collaboration code.

Select Exit or Reset.

The default value is Exit.