The TCP/IP HL7 V3 Server Inbound adapter configuration properties, accessed from the Connectivity Map, are organized into the following sections:
TCPIP Inbound Settings - Server Port Binding — TCP/IP HL7 V3 Inbound Adapter.
TCPIP Inbound Settings - Client Connection Establishment — TCP/IP HL7 V3 Inbound Adapter.
TCPIP Inbound Settings - Inbound Connection Management — TCP/IP HL7 V3 Inbound Adapter.
TCPIP Inbound Schedules - Listener Schedule — TCP/IP HL7 V3 Inbound Adapter.
TCPIP Inbound Schedules - Service Schedule — TCP/IP HL7 V3 Inbound Adapter.
Where to Go Next
General Inbound Settings — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The General Inbound Settings section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
Table 88 Connectivity Map - General Inbound Settings
Where to Go Next
TCPIP Inbound Settings — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The TCPIP Inbound Settings section presents the java Socket and ServerSocket options. This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
Table 89 Connectivity Map - TCPIP Inbound Settings
Where to Go Next
TCPIP Inbound Settings - Server Port Binding — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The TCPIP Inbound Settings - Server Port Binding section defines the parameters used for controlling the server port binding. This section is only used when the Connection Type is set as Server.
This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
This section is only used when the Connection Type is set as Server.
Name |
Description |
Required Value |
---|---|---|
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. |
|
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). |
Where to Go Next
TCPIP Inbound Settings - Client Connection Establishment — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The TCPIP Inbound Settings - Client Connection Establishment section defines some configuration parameters used for controlling the connection establishment. This section is only used when the Connection Type is set as Client.
This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
This section is only used when the Connection Type is set as Client.
Name |
Description |
Required Value |
---|---|---|
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). |
Where to Go Next
TCPIP Inbound Settings - Inbound Connection Management — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The TCPIP Inbound Settings - Inbound Connection Management section defines the parameters used for inbound Server Connection Management. For example, the connection pool and the life cycle of the accepted connection.
This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
Table 92 Connectivity Map - TCPIP Inbound Settings - Inbound Connection Management
Name |
Description |
Required Value |
---|---|---|
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. |
|
Specifies the scope of the accepted connection which is used by the adapter. The two options are:
|
Select Resource Adapter Level or Collaboration Level. The configured default value is Resource Adapter Level. |
|
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. |
|
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. |
Where to Go Next
TCPIP Inbound Schedules - Listener Schedule — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
This section configures the scheduler used by the inbound TCP/IP Server. The server waits for a new client connection establishment request. These parameters are used to configure the listener/monitor that listens on the specified port.
Two J2EE schedulers are available:
Timer Service: available for J2EE. This scheduler is configured using the At Fixed Rate, Delay, and Period properties.
Work Manager: available for J2EE (JCA 1.5 and above). This scheduler is configured using the Delay and Period properties.
Both schedulers provide the functionality required by the inbound TCP/IP Server.
This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
Table 93 Connectivity Map - TCPIP Inbound Schedules - Listener Schedule
Name |
Description |
Required Value |
---|---|---|
Specifies the scheduler type for this inbound communication. There are two options:
|
Select Timer Service or Work Manager. If your container doesn’t support JCA Work Manager, select Timer Service. |
|
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. |
|
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. |
|
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. |
|
Specific to the Timer Service configuration only. Specifies whether a Fixed-Rate execution or Fixed-Delay execution is used.
|
Select True or False. True indicates that a fixed-rate execution is used. False indicates that a fixed-delay execution is used. |
Where to Go Next
TCPIP Inbound Schedules - Service Schedule — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
This section configures the scheduler used by the TCP/IP Server that executes the business tasks (Collaboration Rules) over the existing connection. This scheduler affects the actual Business Rules defined by the user.
Two J2EE schedulers are available (see the Table 68).
Timer Service: Available for J2EE. This scheduler is configured using the At Fixed Rate, Delay, Period, and Schedule Type properties.
Work Manager: Available for J2EE (JCA 1.5 and above). This scheduler is configured using the Delay, Period, and Schedule Type properties.
Both schedulers provide the functionality required by the inbound TCP/IP Server.
This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
Table 94 Connectivity Map - TCPIP Inbound Schedules - Service Schedule
Name |
Description |
Required Value |
---|---|---|
Specifies the scheduler type for this inbound communication. There are two options:
|
Select Timer Service or Work Manager. I f your container doesn’t support JCA Work Manager, select Timer Service. |
|
Applies to both the Timer Service or the Work Manager. Specifies whether the task is scheduled to occur once or be repeated.
|
Select OneTime or Repeated. |
|
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. |
|
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. |
|
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.
|
Select True or False. True indicates that a fixed-rate execution is used. False indicates that a fixed-delay execution is used. |
Where to Go Next
HL7 Acknowledgment — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
Specifies how the acknowledgments are handled in Java Collaboration Definition (JCD). This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
Table 95 Connectivity Map - HL7 Acknowledgment
Name |
Description |
Required Value |
---|---|---|
Specifies what type of acknowledgments are provided by the JCD. They are:
|
The configured default is Immediate. |
Provides Lower Layer Protocol (LLP) configuration settings.
This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
Table 96 Connectivity Map - Lower Layer Protocol
Name |
Description |
Required Value |
---|---|---|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
Where to Go Next
Sequence Number Protocol — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
Provides sequence number protocol configuration settings. HL7 sequence numbering is used to help prevent duplication of data.
This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
Table 97 Connectivity Map - Sequence Number Protocol
Name |
Description |
Required Value |
---|---|---|
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. |
Where to Go Next
HL7v3 Transmission Wrapper — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
Provides HL7v3 Transmission Wrapper configuration settings. The HL7 Transmission Wrapper includes information needed by a sending application or message handling service to package and route the V3 Composite Message to the designated receiving application(s) and/or message handling service(s). The Transmission Wrapper is a cluster of classes, routed at Message, identifies the sender and receiver of the message and the particular kind of message being communicated.
This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
Table 98 Connectivity Map - HL7v3 Transmission Wrapper
Name |
Description |
Required Value |
---|---|---|
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. | ||
Defines whether the message being received is part of the following:
|
The configured default is D |
|
Defines whether the message is being received is of the following:
|
The Configured default is T. |
|
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. |
|
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. |
Where to Go Next
Communication Control — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The Communication Control section controls data transferring (sending/receiving) over the TCP/IP connection.
This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters displayed in this table:
Table 99 Connectivity Map - Communication Control
Name |
Description |
Required Value |
---|---|---|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
Where to Go Next
HL7 Recourse Action — TCP/IP HL7 V3 Inbound Adapter.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The HL7 Recourse Action section determines the actions the adapter takes when operations occur outside the configured constraints.
This section of the TCP/IP HL7 V3 inbound adapter Connectivity Map properties contains the top-level parameters as displayed in the table.
Table 100 Connectivity Map - HL7 Recourse Action
Name |
Description |
Required Value |
---|---|---|
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:
|
Select Exit, or Resend, or Reset. The configured default is Reset. |
|
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:
|
Select Exit or Reset. The default value is Reset. |
|
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:
|
Select Exit or Reset. The configured default is Reset. |
|
Specifies the action taken by the adapter when it receives an HL7 Application NAK from the external system. The options are:
|
Select Resend, or Reset, or Skip Message. The configured default is Resend. |
|
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:
|
Select Exit, or Reset, or Skip Message. The configured default is Skip Message. |
|
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:
|
Select Exit or Reset. The default value is Exit. |