Configuring TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties

Max Data Size

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

A number indicating the maximum amount of data. The valid range is from 1 to 2147483647 (bytes).

The configured default is 2147483647.

Scope Of State

Defines the scope of State object, which is an OTD node. The 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 one of the following: 

• Resource Adapter Level

• Connection Level

• OTD Level

The configured default is Resource Adapter Level.

Dedicated Session Mode

Specifies whether the server Dedicated Session Mode is enabled or disabled. When the server Dedicated Session Mode is enabled, the current client’s request exclusively holds the server port to which it connects. The next client’s request to the same port is blocked or rejected until the previous request concludes and releases the connection. 

Select True or False.

True indicates that Dedicated Session Mode is enabled.

The configured default is False.

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

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

ServerSO Timeout

Sets or gets the value of the SO_TIMEOUT for ServerSocket, in milliseconds. Used for ServerSocket.accept(). When this option is set to a non-zero timeout, calling accept() for this ServerSocket will block for the configured length of time. If the timeout expires, a java.net.SocketTimeoutException (or java.net.InterruptedIOException) is thrown, but 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 number indicating the Server SO Timeout is in milliseconds.

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

The configured default is 60000 (60 seconds).

Server Socket Factory Implementation Class Name

Specifies the name of the Java class that implements the server socket factory. This class is used to create the server socket. If you have provided your own server 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 valid Java class name; the default is: 

com.stc.connector.tcpip.model.
factory.TCPIPSocketFactoryIm
pl

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, 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 server SO_KEEPALIVE option is enabled.

For some properties, the server socket itself does not have direct properties settings associated with it. Instead, the properties map to the accepted client socket.

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 for 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 for 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. See the SoLinger Timeout the property.

Select True or False.

True enables the SO_Linger option.

SoLinger Timeout

Specifies the server’s SoLinger time-out in seconds. SoLinger Timeout is used in conjunction with SoLinger (see the SoLingerproperty value to configure the “linger-on-close” timeout.

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

• A non-zero integer means that callingclose() 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.

An integer between -1 and 65535. The default is -1 seconds, which indicates that the SoLinger option is disabled (set as false).

The configured default is 30 (30 seconds).

Zero (0) indicates that SoLinger immediately performs a forceful close. An integer of 1 to 65535 indicates the number of seconds for the time-out.

SoTimeout

Sets or gets the value of the SoTimeout in milliseconds. Used for the accepted client socket. With this option set to a non-zero timeout, calling read() on the InputStream associated with this socket will block for only the configured length of time. If the timeout expires, a java.io.InterruptedIOException (or java.net.SocketTimeoutException) is thrown, but the Socket remains valid.

Enable this option prior to entering the blocking operation. 

The SoTimeout value in milliseconds. The configured default is 10000 (10 seconds).

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

TcpNoDelay

Specifies whether the server’s TcpNoDelay option (that is, Nagle’s algorithm) is enabled or disabled.

• True: Indicates that the server allows data packets that are less than the maximum transfer 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.

  This is used for the accepted client socket.

Select True or False.

The configured default is False.

Max Binding Retry

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

An integer indicating the number of bind attempts. 

The configured default is 3.

Retry Binding Interval

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

An integer indicating the length of time in milliseconds that the adapter waits between attempts. 

The configured default is 30000 (30 seconds).

Time to Wait Before Attempting Connection

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

A number indicating the amount of time (in milliseconds) to wait before attempting to connect to an external system. 

The configured default is 30000 (30 seconds).

Max Connection Pool Size

Specifies the maximum number of concurrent connections allowed for the specific listener/monitor which is listening on, or monitoring a specified TCP/IP port. This represents the capability or availability of this server’s services. Each connect-request from a client gains one concurrent connection. This parameter also represents the maximum number of clients who can concurrently connect to this server’s services, and get served by the specific listener/monitor at the same time. 

A number indicating the maximum number of concurrent connections available from a listener/monitor for a specific TCP/IP port. 0 indicates that there is no limit.

The configured default is 50.

Scope Of Connection

Specifies the scope of the accepted connection which is used by the adapter. The two options are: 

• Resource Adapter Level: The resource adapter will close the connection upon closure request (by way of ClosureCommandMessage), so the connection may “keep alive” during multiple executions of the Collaboration.

  Collaboration Level: The connection is closed once the Collaboration has been executed, so the connection has the same life cycle as the Collaboration.

Select Resource Adapter Level or Collaboration Level.

The configured default value is Resource Adapter Level.

Close Notification

Specifies the close notification value. When the server receives a notification with content that matches this parameter’s value, the server safely closes the connection and cancels any corresponding schedules. 

A String indicating the trigger value that notifies the server to close the connection. 

The configured default is QUIT.

Idle Timeout

Specifies the length of time (in milliseconds) for inactivity of the requestor (client). The adapter attempts to detect activity on client side (the other side of the connection). If no client activity (no i/o request comes over the connection from the client) for a specified time period, then the connection is closed from the server side to release the resource. The value is in milliseconds. If you want to disable this IdleTimeout checking, just specify 0 for this parameter. 

An integer that indicates the length of time in milliseconds. A value of 0 disables IdleTimeout.

The configured default is 60000.

Scheduler

Specifies the scheduler type for this inbound communication. There are two options: 

• Timer Service: The task is scheduled through the J2EE Timer Service. Timer Service is supported by J2EE.

• Work Manager: The task is scheduled through the J2EE Work Manager. Work Manager is supported by J2EE (JCA 1.5 and above).

Select Timer Service or Work Manager.

If your container doesn’t support JCA Work Manager, select Timer Service.

Schedule Type

This property configuration, though visible from the Properties Editor, is disabled. The only available schedule type is Repeated, indicating that the task is scheduled for repeated execution at regular intervals defined by the Period property in this section (see the Period property).

This field is not enabled. 

Delay

Applies to both the Timer Service or the Work Manager. Specifies, in milliseconds, the length of delay time before the task is executed.

An integer indicating the length of time before the task is executed, in milliseconds. 

Period

Applies to both the Timer Service or the Work Manager. Specifies the regular interval, in milliseconds, between successive task executions.

An integer indicating the length of time between successive task executions, in milliseconds. 

At Fixed Rate

Specific to the Timer Service configuration only. Specifies whether a Fixed-Rate execution or Fixed-Delay execution is used.

• Fixed-Rate: A fixed-rate execution means that each execution is scheduled relative to the scheduled time of the initial execution. If an execution is delayed for any reason (such as garbage collection or other background activity), two or more executions will occur in rapid succession to “catch up.” In the long run, the frequency of execution will be exactly the reciprocal of the specified period, assuming the system clock underlying Object.wait(long) is accurate.

• Fixed-Delay: A fixed-delay execution means that each execution is scheduled relative to the actual time of the previous execution. If an execution is delayed for any reason (such as garbage collection or other background activity), subsequent executions will be delayed as well. As a result, the frequency of execution will generally be slightly lower than the reciprocal of the specified period, assuming the system clock underlying Object.wait(long) is accurate.

Select True or False.

True indicates that a fixed-rate execution is used. False indicates that a fixed-delay execution is used.

Scheduler

Specifies the scheduler type for this inbound communication. There are two options: 

• Timer Service: The task is scheduled through the J2EE Timer Service. Timer Service is supported by J2EE.

• Work Manager: The task is scheduled through the J2EE Work Manager. Work Manager is supported by J2EE (JCA 1.5 and above).

Select Timer Service or Work Manager. I

f your container doesn’t support JCA Work Manager, select Timer Service. 

Schedule Type

Applies to both the Timer Service or the Work Manager. Specifies whether the task is scheduled to occur once or be repeated.

• OneTime: The task will be scheduled for one-time execution.

• Repeated: The task will be scheduled for repeated execution at regular intervals defined by Period property.

Select OneTime or Repeated.

Delay

Applies to both the Timer Service or the Work Manager. Specifies, in milliseconds, the length of delay time before the task is executed.

An integer indicating the length of time, in milliseconds, before the task is executed. 

The configured default is 0.

Period

Applies to both the Timer Service or the Work Manager. Specifies the regular interval, in milliseconds, between successive task executions. This is used for the Repeated schedule type (see the Schedule Type property in the Table 68)

An integer indicating the length of time, in milliseconds, between successive task executions. 

The configured default is 1.

At Fixed Rate

Specific to the Timer Service configuration only. Specifies whether a Fixed-Rate execution or Fixed-Delay execution is used. This is used for the “Repeated” schedule type by the “Timer Service” scheduler.

• Fixed-Rate: A fixed-rate execution means that each execution is scheduled relative to the scheduled time of the initial execution. If an execution is delayed for any reason (such as garbage collection or other background activity), two or more executions will occur in rapid succession to “catch up.” In the long run, the frequency of execution will be exactly the reciprocal of the specified period, assuming the system clock underlying Object.wait(long) is accurate.

• Fixed-Delay: A fixed-delay execution means that each execution is scheduled relative to the actual time of the previous execution. If an execution is delayed for any reason (such as garbage collection or other background activity), subsequent executions will be delayed as well. As a result, the frequency of execution will generally be slightly lower than the reciprocal of the specified period, assuming the system clock underlying Object.wait(long) is accurate.

Select True or False.

True indicates that a fixed-rate execution is used. False indicates that a fixed-delay execution is used.

Acknowledgment Type

Specifies what type of acknowledgments are provided by the JCD. They are: 

• Immediate

• Deferred

• Queued

The configured default is Immediate.

LLP Type

Specifies the LLP (Lower Layer Protocol) type. The valid type is: 

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

True indicates that sequence numbering is enabled.

Select True or False.

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_INI00100 and COMT_IN300652.

Processing Code

Defines whether the message being received is part of the following: 

• P — Production

• T — Training

• D — Debugging System

The configured default is D

Processing Mode Code

Defines whether the message is being received is of the following: 

• T — Current Processing

• A — Archive Mode

• I — Initial 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 interrupted correctly. 

The Configured default is v3.0.

Validate Transmission Wrapper

Includes 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 76). 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 following read/receive operation uses the SoTimeout specified timeout (see So Timeout in Table 64). Value 0 is interpreted as an infinite timeout.

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

The configured default is 30000.

Max Empty Read Retry

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

A number 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 (see Action on Max No Response in the Table 76).

This parameter is used for the inbound Collaboration code. 

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

The configured default 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 76).

This parameter is used for the inbound Collaboration code. 

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

The default value is 30.

Max NAK Send Retry

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

This parameter is used for the inbound Collaboration code. 

An integer indicating 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 76).

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 configured default is 0.

Enable Journaling

Specifies whether message journaling is enabled. 

This parameter is used for inbound Collaboration code. 

Select True or False.

True indicates that journaling is enabled.

The configured default is True.

Action on No Response

Specifies the action taken by the adapter when 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 75). 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 inbound Collaboration code.

Select Exit, or 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 number of times, and does not receive any response (HL7 Application Acknowledgement) from the external system. The maximum number of 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 75). 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 inbound 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. This parameter is used by inbound adapters only. 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 inbound Collaboration code.

Select Exit or Reset.

The configured default is Reset.

Action on Nak Received

Specifies the action taken by the adapter 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 inbound Collaboration code.

Select Resend, or 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 75). 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.

  This parameter is used for inbound Collaboration code.

  ---

  Note –

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

  ---

Select Exit, or Reset, or Skip Message.

The configured default is Skip Message.

Action on Max Nak Sent

Specifies the action taken by the adapter 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 Send Retry in the Table 75). 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 inbound Collaboration code.

Select Exit or Reset.

The default value is Exit.