ResponseGenerator

Response documents (also called acknowledgments) are used to give feedback to the sender of a transaction on the status of the acceptance of the transaction by its recipient. See Types of Response Documents for details.

Additionally, custom reports can be generated for internal use. See Response Generator Custom Reports for details.

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.
Input Mode	No	Specifies where the input data is stored. There are two options: File and Memory. Memory is normally the most efficient way of connecting, but large documents should be stored as files.
Output Mode	No	Specifies where the output data is stored. There are two options: File and Memory. Memory is normally the most efficient way of connecting, but large documents should be stored as files.
Generate 277	Yes	Check this checkbox to generate a 277 CA/U Acknowledgment. A 277 CA/U Acknowledgment is generated when responding to HIPAA 837 transactions. See Types of Response Documents for details.
Generate 824	Yes	Check this checkbox to generate an 824 Application Advice. An 824 Application Advice is generated when responding to X12 EDI transactions. See Types of Response Documents for details.
Generate 997	Yes	Check this checkbox to generate a 997 Functional Acknowledgment. A 997 Functional Acknowledgment is generated when responding to X12 EDI transactions. See Types of Response Documents for details.
Generate 999	Yes	Check this checkbox to generate a 999 Functional Acknowledgment. A 999 Functional Acknowledgment is generated when responding to X12 EDI transactions. See Types of Response Documents for details.
Generate TA1	Yes	Check this checkbox to generate a TA1 Interchange Acknowledgment. A TA1 Interchange Acknowledgment is generated when responding to X12 EDI transactions. See Types of Response Documents for details.
Generate Control	Yes	Check this checkbox to generate a CONTRL document. A CONTRL document is generated when responding to EDIFACT validation (except Inbound CONTRL). See Types of Response Documents for details.
Generate Custom Report	Yes	Check this checkbox to generate a custom report. See Response Generator Custom Reports for details.
Custom Report Template	Yes	Full path and name to a Custom Report Template. (Active only if Generate Custom Report is selected.) Refer to Response Generator Technical Manual PDF document for information about Custom Report Templates.
Parameters	Yes	You can specify parameters listed in the Response Generator Technical Manual PDF document in this field. For example: `-ge-y` indicates that group enveloping is to be included in the response documents. The Response Generator function can overwrite files if they already exist. `-dav string`indicates that the string, for example, 005010 , is set as the application version for the outbound GS. `-fver_pass` indicates that the ISA and GS version numbers for the source document will not be changed.

Description

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

Input

The Input tab contains the following fields.

Field	Datatype	Description
instream_result	string	Specifies the file path and name of the Instream detail file for which the response will be generated. (Required) Note: This file is not changed by ResponseGenerator.
output_directory	string	Specifies directory path for the output files. (Required) Note: This field only appears when File mode is selected as the output mode in the Configuration panel. You need to specify the output directory for the output files.
profile	string	(Optional) Specifies which APF file to use. The APF file contains configuration information for the Instream activity. Each time you validate, an APF file is read to determine what is to be checked and what is written to output files. The default APF is $fsdeflt.apf and is located in the TIBCO_FORESIGHT_HOME / Instream-Translator /bin directory. Note: This field will not be displayed when the CallBack shared resource is enabled, because the APF file will be extracted from the CallBack code.
tpa_file	string	Path to a Trading Partner Automation CSV file that contains a pointer to a setup file. All sections in the setup file are processed. See the Trading Partner Automation PDF document. If there is a conflict between the command line and the settings in the setup file selected by TPA, the last setting processed prevails.
parameters	string	Specifies the response generator parameters to be used. (Optional)

Output

The Output tab contains the following fields.

Field	Datatype	Description
return_code	string	Specifies the ResponseGenerator return code. For example, 100 means ResponseGenerator ran successfully, 110 means ResponseGenerator failed, and so on. Return codes are listed in Appendix A of Response Generator Technical Manual PDF document.
rg_277<_filename>	string	Provides the content (memory output) or specifies the full path and name (file output) of the 227 CA/U Acknowledgment.
rg_824<_filename>	string	Provides the content (memory output) or specifies the full path and name (file output) of the 824 Application Advice.
rg_997<_filename>	string	Provides the content (memory output) or specifies the full path and name (file output) of the 997 Functional Acknowledgment.
rg_999<_filename>	string	Provides the content (memory output) or specifies the full path and name (file output) of the 999 Implementation Acknowledgement.
rg_TA1<_filename>	string	Provides the content (memory output) or specifies the full path and name (file output) of the TA1 Interchange Acknowledgment.
rg_CONTRL_DOC<_filename>	string	Provides the content (memory output) or specifies the full path and name (file output) of the CONTRL document.
rg_custom_report<_filename>	string	Provides the content (memory output) or specifies the full path and name (file output) of the custom report document.

Fault

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 EDI and TIBCO Foresight errors. See Error Codes for details.