Instream

Use the Instream activity to validate EDI for many different file formats, including (but not limited to) HIPAA (health care) data, other X12 formats, EDIFACT, flat files, and XML.

The Instream activity allows the plug-in to validate the input EDI data, split validation results, swap elements in data, 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:

  1. Validation
    • creates two files or an output stream: detail results and summary results
    • supports the Instream CallBack function.

    See Instream Validation Technical Manual PDF document for more information about the validation function.

  2. DocumentSplitter
    • 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 report containing the status of each claim or other data being split based on the split point grouping specified in the DocumentSplitter profile.

    You can create your own profile to split the EDI into multiple documents. See Document Splitter Technical Manual PDF document for details about the Document Splitter function.

  3. ResponseGenerator
    • uses validation results to create responses, such as 277 Acknowledgment, 824 Application Advice, 997/999 Functional Acknowledgment, TA1 Interchange Acknowledgment, and CONTRL document.

    See Response Generator Technical Manual PDF document for details about the Response Generator function.

  4. 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: EDI Plug-in Example Processes.

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 occurs 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 Instream 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 DocumentSplitter.

Field Literal Value/Module Property/Process Property? Description
Report Type No Refer to DocumentSplitter, General - Report Type Field.
Report Format No Refer to DocumentSplitter, General - Report Format Field.
Ignore Output File Name No Refer to DocumentSplitter, General - Ignore Output File Name Field.

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 Literal Value/Module Property/Process Property? Description
Generate 277 No Refer to ResponseGenerator, General - Generate 277 Field.
Generate 824 No Refer to ResponseGenerator, General - Generate 824 Field.
Generate 997 No Refer to ResponseGenerator, General - Generate 997 Field.
Generate 999 No Refer to ResponseGenerator, General - Generate 999 Field.
Generate TA1 No Refer to ResponseGenerator, General - Generate TA1 Field.
Generate Control No Refer to ResponseGenerator, General - Generate Control Field.
Generate Custom Report No Refer to ResponseGenerator, General - Generate Custom Report Field.
Custom Report Template No Refer to ResponseGenerator, General - Custom Report Template Field.
Parameters Yes Refer to ResponseGenerator, General - Response Parameters Field.

DataSwapper

The DataSwapper tab contains the following fields.

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

Field Literal Value/Module Property/Process Property? 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 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
instream
input string Specifies the full path and name 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 appears only when File mode is selected as the output mode in the General tab. 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 string 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
profile string Refer to DocumentSplitter, Input - profile Field.
tpa_file string Refer to DocumentSplitter, Input - tpa_file Field.
parameters string Refer to DocumentSplitter, Input - parameters Field.
output_directory string Refer to DocumentSplitter, Input - output_directory Field.
responseGenerator
profile Refer to ResponseGenerator, Input - profile Field.
tpa_file Refer to ResponseGenerator, Input - tpa_file Field.
parameters Refer to ResponseGenerator, Input - parameters Field.
output_directory string Refer to ResponseGenerator, Input - output_directory Field.
dataSwapper
profile Specifies the path to the DataSwapper setup file.
Note: Refer to the DataSwapper PDF document for information on how to create a DataSwapper setup file.
output_directory string Output directory for the output files.
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.

Output

The result and the summary report are listed in the Output tab.

The Output tab contains information grouped by function 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.
total_of_errors N/A total_of_errors 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 Instream 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
rg_277_filename File output string Specifies the full path and name of the 227 CA/U Acknowledgment.
rg_277 Memory output string Provides the content of the 277 CA/U Acknowledgment.
rg_824_filename File output string Specifies the full path and name of the 824 Application Advice.
rg_824 Memory output Provides the content of the 824 Application Advice.
rg_997_filename File output string Specifies the full path and name of the 997 Functional Acknowledgment.
rg_997 Memory output Provides the content of the 997 Functional Acknowledgment.
rg_999_filename File output string Specifies the full path and name of the 999 Implementation Acknowledgment.
rg_999 Memory output Provides the content of the 999 Implementation Acknowledgment.
rg_TA1_filename File output string Specifies the full path and name of the TA1 Interchange Acknowledgment.
rg_TA1 Memory output Provides the content of the TA1 Interchange Acknowledgment.
rg_CONTRL_DOC_ filename File output string Specifies the full path and name of the CONTRL document.
rg_CONTRL_DOC Memory output Provides the content of the CONTRL document.
rg_custom_report_ filename File output string Specifies the full path and name of the custom report.
rg_custom_report Memory output Provides the content of the custom report.
documentSplitter
ds_report_filename File output string Specifies the full path and name of the DocumentSplitter report, which contains the status of each claim or other data being split, as well as other information.
ds_rpt_valid_results File output string 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 DocumentSplitter profile, multiple valid files will be generated if the input data contains multiple segments.
ds_rpt_invalid_results File output string 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 DocumentSplitter profile, multiple invalid files will be generated if the input data contains multiple segments.
ds_report_content Memory output string Specifies the content of the DocumentSplitter report.
ds_rpt_valid_results Memory output string 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 DocumentSplitter profile, multiple valid files will be generated if the input data contains multiple segments

ds_rpt_invalid_results Memory output string 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 DocumentSplitter profile, multiple invalid files will be generated if the input data contains multiple segments

dataSwapper
report N/A string An audit report showing what data was swapped.
output N/A 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.

Contents
Search Results