Instream

The Instream activity allows the plug-in to validate the input EDI data, split validation results, and use validation detail results to generate responses.

Support Protocols

The following list shows the protocols supported by the Instream activity:

X12
HIPAA
EDIFACT
Flat File

Features

The following list shows the features provided by the Instream activity:

Validation
- creates two files or an output stream: detail results and summary results
- supports the CallBack function.
See Instream Validation Technical Manual PDF document for more information about the validation function.
Document Splitter
- uses validation results to separate the valid EDI from the invalid
- generates a list of files containing valid data, a list of files containing invalid data, and a Document Splitter report containing the status of each claim or other data being split based on the split point grouping specified in the Document Splitter profile.
You can create your own profile to split the EDI into multiple documents. See Document Splitter Technical Manual PDF document or details about the Document Splitter function.
Response Generator
- uses validation results to create responses, such as 277 Acknowledgement, 824 Application Advice, 997/999 Functional Acknowledgement, TA1 Interchange Acknowledgement, and CONTRL document.
See Response Generator Technical Manual PDF document for details about the Response Generator function.
DataSwapper
- replaces the value in a specified data element with another value in the EDI
- inserts a new segment into the EDI
- deletes a segment from the EDI
- creates a report of the data that was changed.
See DataSwapper PDF document for details about the DataSwapper function.

Examples

Refer to the associated examples: To Be Provided.

General

The General tab contains the following fields.

For more details on Instream, refer to the Instream Validation Technical Manual PDF document.

Field	Literal Value/Module Property/Process Property?	Description
Name	No	The name to be displayed as the label for the activity in the process.
Operation Type		Specify an operation type: Instream only Instream and ResponseGenerator Instream and DocumentSplitter Instream, ResponseGenerator and DocumentSplitter Instream and DataSwapper
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.
Stop Validation on IC Error	No	Check this checkbox to indicate that validation should be stopped if an error occors in the Interchange.
Document Level Validation	No	Note: This functionality is not applicable when the CallBack shared resource is enabled, and it is applicable only for X12 protocol. Check this checkbox to validate the EDI data that has no enveloping (EDI does not have ISA or GS enveloping). When the incoming EDI data contains ISA or GS enveloping, the enveloping will be ignored if you check this checkbox. If selected, you must also enter Document Level Validation Separators on the Input > Functions tab, using the "document_only_parameters" field. See Electronic Data Interchange for details about EDI enveloping.
CallBack	No	Select this checkbox to use a Java Class for callback (optional). See Instream CallBack for more complete information on Enabling Callbacks.
Class Name	No	Specify a Java Class. This field is enabled when CallBack is checked. Create a new Java Class. Browse to an existing Java Class using the Type selection dialog. See ValidateHL7 Callback for more complete information on Enabling Callbacks.

Description

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

DocumentSplitter

The DocumentSplitter tab contains the following fields.

For more details on Document Splitter, refer to the DocumenSplitter PDF document.

Field	Datatype	Description
Document Splitter	No	Check this checkbox to enable the Document Splitter function.
DS Report Type	No	This drop-down list allows you to specify what report types are generated. The following are the three options available: Both Valid Only Invalid Only No Report
Report Format	No	This drop-down list allows you to specify the format of the generated report. The following are the there two options available: XML CSV
Ignore Output File Name	No	DocSplitter outputs multiple files, resulting in large amounts of data. Select this checkbox to ignore output file names and reduce the volume of unnecessary data. (Default = Checked)

ResponseGenerator

The ResponseGenerator tab contains the following fields.

For more details on Response Generator, refer to the Response Generator Technical Manual PDF document.

Output Item	Datatype	Description
Generate Response	No	Check this checkbox to enable the Response Generator function.
Generate 277	No	Check this checkbox to generate a 277 CA/U Acknowledgement. A 277 CA/U Acknowledgement is generated when responding to HIPAA 837 transactions. See Response Documents (Acknowledgements) for details.
Generate 824	No	Check this checkbox to generate an 824 Application Advice. An 824 Application Advice is generated when responding to X12 EDI transactions. See Response Documents (Acknowledgements) for details.
Generate 997	No	Check this checkbox to generate a 997 Functional Acknowledgement. A 997 Functional Acknowledgement is generated when responding to X12 EDI transactions. See Response Documents (Acknowledgements) for details.
Generate 999	No	Check this checkbox to generate a 999 Functional Acknowledgement. A 999 Functional Acknowledgement is generated when responding to X12 EDI transactions. See Response Documents (Acknowledgements) for details.
Generate TA1	No	Check this checkbox to generate a TA1 Interchange Acknowledgement. A TA1 Interchange Acknowledgement is generated when responding to X12 EDI transactions. See Response Documents (Acknowledgements) for details.
Generate Control	No	Check this checkbox to generate a CONTRL document. A CONTRL document is generated when responding to EDIFACT validation (except Inbound CONTRL). See Response Documents (Acknowledgements) for details.
Generate Custom Report	No	Check this checkbox to generate a Custom Report. A Custom Report can be generated for certain transaction types using a Custom Report Template. See Response Generator Custom Reports for details.
Custom Report Template	No	Specifies the path to the Custom Report template.
Response 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.

DataSwapper

The DataSwapper tab contains the following fields.

For more details on DataSwapper, refer to the DataSwapper PDF document

Field	Datatype	Description
Setup File	Yes	Specifies the path to the DataSwapper setup file. Refer to the DataSwapper PDF document for information on how to create a DataSwapper setup file.
Insert After Segment	No	Check this checkbox to place inserted segments after the segment containing a GenerateFSUID or InsertSegment business rule. If left unchecked, the insertion will be before the segment that contains the business rule.

Input

The Input tab contains the following fields.

For more details on Instream, refer to the Instream Validation Technical Manual PDF document.

Field	Datatype	Description
instreamInput
input	string	This field only appears when File mode is selected as the input mode in the Configuration panel. You need to specify the full path and name of the input file in this field.
msg_content	string	This field only appears when Memory mode is selected as the input mode in the Configuration panel. You need to specify the content of the input file.
guideline_name	string	The name of the guideline used for validation, or used as the input for Document Splitter. Note: This field will not be displayed when the CallBack shared resource is enabled, because the guideline will be extracted from the CallBack code.
output_directory	string	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.
instream_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.
document_only_parameters		If the Document Level Validation checkbox is selected on the General tab, Separators (Segment Terminator, Element Separator, and Component Element Separator, in this order) must be specified in this field in one of the following formats: character, for example: ~*: integer, for example: 29, 30, 31 hex, for example: 0x1E, 0x1F, 0x1D
documentSplitter
ds_profile	string	(Optional) This field only appears when the Document Splitter checkbox is checked in the DocumentSplitter tab. You need to specify the full path and name to a Document Splitter INI file in this field. Note: The parameters set in the Document Splitter INI file take precedence over those set in the Input tab and the DocumentSplitter tab.
tpa_file		Specifies the path to the trading partner automation file.
parameters
output_directory	string	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.
responseGenerator
profile
tpa_file		Specifies the path to the trading partner automation file.
parameters
output_directory	string	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.
dataSwapper
profile
output_directory	string	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.

Output

The result and the summary report are listed in the Output tab. For details about the output items, see the Instream Validation Technical Manual.

The Output tab contains information grouped by function. For convenince, the tables describing the contents of these fields are broken into functional groups (instream, responseGenerator, documentsplitter, and dataSwapper) and presented in the order they are displayed on the GUI.

Note:

In File output mode, when you run a process with the Instream activity twice using the same input file and output location, an error is thrown indicating that the output files already exist. Make sure that you move all output files to an appropriate location after every validation to avoid this error.

instream Output Items

Output Field	Mode Selected	Output Item	Datatype	Description
instream
instream_result	File output	validation_resultFile	string	Specifies the full path and name of the validation detail results file (in the Flat File format), which contains general messages and statistics, and describes errors and warnings found during validation.
	Memory output	validation_result_in _flatfile	string	Specifies the message of the validation detail results in the Flat File format.
instream_summary	File output	validation_summaryFile	string	Specifies the full path and name of the validation summary file (in the Flat File format), which contains a summary of the validation, including validation start time, end time, number of errors, warnings, and other messages.
	Memory output	validation_summary_in _flatfile	string	Specifies the message of the validation summary results in the Flat File format.
?	?	validation_summary	N/A	This node displays the validation summary file in the XML tree format. Note: When the Document Splitter or Response Generator functions are enabled, the summary in XML format will be not supported (this node will disappear).
total_of_error	N/A	total_of_error	integer	Records the total errors with a severity level larger than level 2 (Error Count, Fatal Count, User1 Count, and User2 Count). The number of errors for each severity is recorded in the SVRTY record in the summary file. See Instream Validation Technical Manual PDF document for details.
return_code	N/A	return_code	integer	Specifies the return code. For example, 100 means the validation ran successfully, 133 means the database directory cannot be found, and so on. Return codes are listed in Appendix A of Instream Validation Technical Manual PDF document.
MessageCountBySeverity	N/A		integer
MessageCountByType	N/A		integer

Response Generator Output Items

Mode Selected	Output Item	Datatype	Description
File output	rg_277_filename	string	Specifies the full path and name of the 227 CA/U Acknowledgement.
File output	rg_824_filename	string	Specifies the full path and name of the 824 Application Advice.
File output	rg_997_filename	string	Specifies the full path and name of the 997 Functional Acknowledgement.
File output	rg_999_filename	string	Specifies the full path and name of the 999 Implementation Acknowledgement.
File output	rg_TA1_filename	string	Specifies the full path and name of the TA1 Interchange Acknowledgement.
File output	rg_CONTRL_DOC_ filename	string	Specifies the full path and name of the CONTRL document.
?	custom_report	string	Provides the content of the Custom Report.
Memory output	rg_277	string	Provides the content of the 277 CA/U Acknowledgement.
Memory output	rg_824	string	Provides the content of the 824 Application Advice.
Memory output	rg_997	string	Provides the content of the 997 Functional Acknowledgement.
Memory output	rg_999	string	Provides the content of the 999 Implementation Acknowledgement.
Memory output	rg_TA1	string	Provides the content of the TA1 Interchange Acknowledgement.
Memory output	rg_CONTRL_DOC	string	Provides the content of the CONTRL document.
?	custom_report	string	Provides the content of the Custom Report.

documentSplitter Output Items

Mode Selected	Output Item	Datatype	Description
File output	ds_report_filename	string	Specifies the full path and name of the Document Splitter report, which contains the status of each claim or other data being split, as well as other information.
File output	ds_rpt_valid_results	N/A	Contains a list of valid files (ds_rpt_valid_filename). The ds_rpt_valid_filename output specifies the full path and name of the valid EDI file. Note: When splitting the EDI based on the split point grouping specified in the Document Splitter profile, multiple valid files will be generated if the input data contains multiple segments.
File output	ds_rpt_invalid_results	N/A	Contains a list of invalid files (ds_rpt_invalid_filename). The ds_rpt_invalid_filename output specifies the full path and name of the invalid EDI file. Note: When splitting the EDI based on the split point grouping specified in the Document Splitter profile, multiple invalid files will be generated if the input data contains multiple segments.
Memory output	ds_report_content	string	Specifies the content of the Document Splitter report.
Memory output	ds_rpt_valid_results	N/A	Contains a list of ds_rpt_valid_content. The ds_rpt_valid_content output specifies the content of the valid EDI data. Note: When splitting the EDI based on the split point grouping specified in the Document Splitter profile, multiple valid files will be generated if the input data contains multiple segments
Memory output	ds_rpt_invalid_results	N/A	Contains a list of ds_rpt_invalid_content. The ds_rpt_invalid_content output specifies the content of the invalid EDI data. Note: When splitting the EDI based on the split point grouping specified in the Document Splitter profile, multiple invalid files will be generated if the input data contains multiple segments

dataSwapper Output Items

Output Item	Datatype	Description
report	string	An audit report showing what data was swapped.
output	string	A changed EDI file containing the swapped data.

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.