DocumentSplitter

Use the DocumentSplitter activity to split validated data into valid and invalid data.

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

Docsplitter Output

Use of the DocumentSplitter activity results in the following output:
  • A file containing the valid data
  • A file containing the invalid data
  • An XML or delimited report containing the status of each claim or other data being split, plus additional information.
Note the following about DocumentSplitter output:
  • When using content-based splitting or split-point grouping, DocumentSplitter will create multiple split files.
  • For EDI, output includes a CR/LF after the segment terminator unless:
    • The segment terminator in the input file is a LF
    • You include the following section in a setup file
      [Options]
      OutputEDIWithCRLF=0
  • DocumentSplitter fixes the output file's segment counts by default.

Split Points

Documents can be split at various point in the data. Basic split points are as follows:

Data Type Split Points
HIPAA Vary
X12 non-HIPAA ST

ISA,GS

EDIFACT UNH

UNB, UNG

Flat File Top of layout
XML Any repeating complex element

For a complete listing of where documents can split, see Appendix B: Split Points in the Document Splitter Technical Manual PDF.

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.
Report Type No This drop-down list allows you to specify what report types are generated.
  • Valid data
  • Invalid data
  • Both (Default)
  • No report
Report Format No This drop-down list allows you to specify the format of the generated report.
  • XML

This report contains the status of each claim or other data being split, plus other information.

Ignore Output File Name No DocumentSplitter 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)

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
input string Specifies the file path and name of the input data file.
instream_result string Specifies the file path and name of the Instream detail file to be split. (Required)
Note: This file is not changed by DocumentSplitter.
output_directory string Specifies directory path for the output (split) files. (Required)
profile string Full path and name to a Document Splitter INI file.
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 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 Yes You can specify parameters listed in the Document Splitter Technical Manual PDF document in this field. For example:
  • -wb Swap data in both valid and invalid output file(s) according to the rules in the validation guideline.

Output

The Output tab contains the following fields.

Field Datatype Description
report 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.
files string output_data – Body of report.
boolean is_valid_document? – Document is valid (1) or document is not valid (0).
string content_name – Specifies the name of the contents if content-based splitting is used.

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.