Inbound tab

This table shows the Inbound tab's parameters:

Parameter Description
Outbound Only Click this to make the connection send-only. The engine receives only reply messages from the host. Clicking this disables all other configuration entries in this pane.

When this is selected, the engine expects to receive a reply if you have set up the thread to do so. By setting up for replies, the outbound thread sets an awaiting reply flag each time it sends a message out. This happens when Await Replies is selected on the Outbound tab. This tells the engine to expect a reply. Outbound Only ignores any unexpected inbound messages that arrive when the awaiting reply flag is not set.

When this is cleared, this indicates that you are using your outbound thread to receive data messages from the destination system. An example would be a request for a lab order number. A system could be set up to respond back to the outbound thread with this lab order number. This is not common because most interfaces use another inbound thread to communicate data back to the source system.

If you are having problems with losing replies from the destination system, then you can temporarily clear this option. In this way, you can track replies that may have been received after the reply time-out period. After the time-out is met, the awaiting reply flag is turned off and this option discards late arriving replies.

Hold Select this to hold inbound data. When this is cleared, inbound data is released.

When selected, messages can be resent to a running inbound thread. Simultaneously, this option holds the thread from reading messages through its protocol driver. This is required to maintain the correct message order when resending

TPS Inbound Data Click Edit to open the Inbound TPS Editor. Then, click Add to open the TPS Properties dialog box, from where you can select the procedures or Java class and arguments for inbound data messages. This TPS pre-processes inbound data messages before being sent to a translation thread.

If a procedure applies to all messages, then put the procedure in TPS Inbound Data. If the procedure applies to less than all messages, then put the procedure in one or more route details.

When Run in a Sub-thread is selected on the Inbound TPS Editor, a sub-thread is created under the protocol thread. This sub-thread is used only for data type messages, not those of type reply. There must be a TPS defined; there is no sub-thread if a TPS is not defined.

TRx ID Determination Format Click the arrow to select the format from the menu. The format is used to parse the record into fields for later translation. Then, click Edit to open the Trx ID determination dialog box. Use this dialog box to configure transaction ID information:
  • Selecting DICOM, disables Edit. There are no properties to edit. The trxid for the DICOM protocol is AbstractSyntax_CommandCode.

    For example: 1.2.840.10008.5.1.4.31_0020, Patient Root Query/Retrieve Information Model_MOVE_C_MOVE_RQ.

  • For FRL, select Offset and Length. These specify the offset and length to the location of the Trx ID in the record.
  • For HL7, HPRIM, X12, NCPDP, and UN/EDIFACT, it is not necessary to select the version and variant. Edit is not available when any of these are selected.
  • For JSON, it selects the first type field value to identify the Trx ID of the message/transaction. Use field routing to select a key or rely on the default first value that is encountered in the json structure as the Trx ID.
  • Selecting XML disables Edit. There are no properties to edit.
  • Selecting XML (Namespace) disables Edit. There are no properties to edit.
  • Select UPOC to specify a UPoC without going through FRL. Click Edit to open the Format UPoC dialog box. Only one proc can be selected. Specify arguments for inbound data messages. TPS configurations are supported when the format is UPoC.
EDI Batch Click the arrow to select the format from the list. Then, click Edit to open the batch configuration dialog box.

This feature requires an additional license to be functional.

  • For NCPDP Telecom, select the version. If EDI Batch type NCPDP Telecom is specified for an inbound thread, then all inbound messages are treated as batches.
  • For X12, select the version and whether to split to Groups or Transaction Sets.
  • As the inbound NCPDP Formulary and Benefit batch has no parameters, Edit is unavailable.