GenerateACK

General

The General tab contains the following fields.

Field	Literal Value/Module Property/Process Property?	Description
Name	No	The name to be displayed as the label for the activity in the process.

The Description tab is used to provide a short description for the activity.

The Input tab contains the following fields.

Field	Datatype	Description
hl7Message	string	The incoming HL7 message for generating an ACK or NAK message.
defaultMSHwhenHeaderInvalid	string	If the MSH segment of the input HL7 message is invalid, use this field to specify a valid MSH segment for the input HL7 message. If you do not provide a valid MSH segment, the following is used as a default value: MSH\|^~\\&\|\|\|\|\|\|\|ACK\|\|P\|2.3\|\| \|\| Note: This field takes effect only if the MSH segment of the input HL7 message is invalid.
msaTextMsg	string	The text in the MSA segment of the input HL7 message. The default value for this field is null (""). Override the default by specifying text here.
msaAckCode	string	The acknowledgment (ACK) code in the MSA segment of the input HL7 message. The default value for this field is AE. Override the default by specifying an ACK code here. The following acknowledgment codes can be used: AA, AE, AR, A, E, R, accept, error, reject, CA, CE, and C. Note: When msaAckCode is set to AA, A, or "accept," output item ackIsNak will output as false.

Output Item	Datatype	Description
ackContent	string	The generated acknowledgment message.
ackIsNak	boolean	Indicates whether the generated acknowledgment is a NAK or an ACK message. If the value is true the generated acknowledgment is a NAK message. If the value is false the generated acknowledgment is an ACK message. The following ACK codes in the output MSAsegment can be used: AA, A, CA, and accept.

Output Item

Datatype

Description

ackContent

string

The generated acknowledgment message.

ackIsNak

boolean

Indicates whether the generated acknowledgment is a NAK or an ACK message.

If the value is true the generated acknowledgment is a NAK message.

If the value is false the generated acknowledgment is an ACK message.

The following ACK codes in the output MSAsegment can be used: AA, A, CA, and accept.

The Fault tab lists exceptions that are thrown by this activity.

Error Schema Element	Datatype	Description
msg	string	Error message description.
msgCode	string	The error code. It represents TIBCO ActiveMatrix BusinessWorks™ Plug-in for HL7 with FHIR and TIBCO Foresight® Translator and TIBCO Foresight® Instream® errors. See Error Codes for details.