Configuring Java CAPS Project Components for Communication Adapters

HL7 Recourse Action — TCP/IP HL7 V2 Inbound Adapter

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 V2 inbound adapter Connectivity Map properties contains the top-level parameters displayed in the table.

Table 76 Connectivity Map - HL7 Recourse Action

Name 

Description 

Required Value 

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, Resend, or Reset.

The configured default is Reset.

Action on Max No Response

Specifies the action the adapter takes when it attempts to send a message 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 a message 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, 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, 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.