Setup File
You can create a setup file to control Docsplitter behavior. It can be invoked with these command line parameters:
-s | Points directly to a setup file. Settings in the [CommandLine Option] section are ignored. See TIB_fsp-instream_<n.n>_.tpa.pdf. |
-TPA |
Points to a trading partner automation CSV file that contains a pointer to a setup file. All sections in the setup file are processed. See TIB_fspinstream_<n.n>_.tpa.pdf. If there is a conflict between the command line and the settings in the setup file selected by TPA, the last setting processed will prevail. By moving the -TPA to the end of the command line, you are assured of having its settings honored when there is a conflict: |
The setup file can include any or all of these sections.
This section is processed only when you use the -TPA command line option |
|
---|---|
[CommandLine Option] |
Effect on output |
ValidEdiOutputPathName=file
|
Name of the output file containing valid EDI. Example (asterisk stands for the EDI filename):
|
InValidEdiOutputPathName=file |
Name of the output file containing invalid EDI. Example (asterisk stands for the EDI filename):
|
LogLevel=n |
Logging level for Docsplitter report file. 0 = debug 1 = no debug Example:
|
ReportFormat=x |
Report format x = xml d = Delimited xp = Generic XML Example:
|
ReportFilePathName=file |
Report file path and filename. Directory must already exist. Example (asterisk stands for the EDI filename):
|
PerformDataSwapping=setting |
Controls whether swapping will take place (For details, refer Displaying Tree Information during Splitting). Setting can be: v Swap data in valid file This is equivalent to Docsplitter’s -wv, wi, and -wb command line parameters. Example:
|
ValidSwapAuditFile=file |
Specifies the valid swap audit file. Do not use wildcards in the filename. This is equivalent to Docsplitter’s -av command line parameter. Example:
|
InvalidSwapAuditFile=file |
Specifies the invalid swap audit file. Do not use wildcards in the filename. This is equivalent to Docsplitter’s -a1 command line parameter. Example:
|
SwapSetupFile=file |
Specifies the DataSwapper.ini file. This is equivalent to Docsplitter’s -z command line parameter. Example:
|
ContentsOfReport |
Type of data in the report. V valid B both This is equivalent to Docsplitter’s -c command line parameter. |
This section is processed when you use either -s or -TPA command line options |
|
---|---|
[Options] |
Effect on output |
AddST02ToFilename =n
|
Do you want to add the first ST02 (Transaction Set Control Number) value encountered in the file to the output filename? This is useful if you wish to identify good/bad files by their associated ST02. 0 = no (default) 1 = yes Example 1:
Example 2:
Where |
AddCRLFToDocumentEnd=n |
Do you want to add the CR/LF after the segment terminator? 0 = no 1 = yes (default) Example 1:
|
CalcValidBPR02=n CalcInValidBPR02=n |
(820s and 835s only). Do you want to recalculate the value in the BPR02 after splitting? These two options let you recalculate the valid file and/or the invalid file. 0 = no 1 = yes (default) If you split your 835s below the ST, you should consider recalculating the valid file’s BPR02 to create a valid 835. If you split at the ST or above, you should consider not recalculating the invalid file’s BPR02. |
ConcatenateValidOutputFiles=n ConcatenateInValidOutputFiles=n |
Do you want multiple valid and/or invalid files to be concatenated? 0 = no (default) 1 = yes |
FilesPerRun=n |
This option lets you reduce resource use on the Docsplitter machine. Docsplitter knows how many files its split will generate before it actually does the split. FilesPerRun determines how many of them will be open at once while it actually generates the files. A maximum of n valid and invalid files can be opened at once. After that, they are processed and closed and then the next n valid and invalid files are processed. If you're doing large numbers of files per split, bigger numbers will be a little faster, but use more resources. FilesPerRun also lets you limit the number of open files per pass if your system will only let you open a relatively small number of files (which can happen on Unix). The end result will be the same regardless of the number you specify. If FilesPerRun is omitted, 100 is assumed. This affects content-based splitting and split-point grouping. It does not affect standard error-based splitting, which generates just one valid and one invalid file. |
OutputEDIWithCRLF=n |
Do you want a CR/LF to follow each segment terminator? 0 = no (wrap the output data) 1 = yes (default) See Input and Output on page Input and Output. |
CalcValidSE01 CalcInValidSE01 |
Do you want Docsplitter to recalculate the SE01 in the valid or invalid output file? 0 = no 1 = yes (default: recalculate) |
CalcValidGE01 CalcInValidGE01 |
Do you want Docsplitter to recalculate the GE01 in the valid or invalid output file? 0 = no 1 = yes (default: recalculate) |
CalcValidIEA01 CalcInValidIEA01 |
Do you want Docsplitter to recalculate the IEA01 in the valid or invalid output file? 0 = no 1 = yes (default: recalculate) |
CalcValidHL CalcInValidHL |
Do you want Docsplitter to recalculate the HL element values in the valid or invalid output file? 0 = no 1 = yes (default: recalculate) |
CalcValidTS2 CalcInValidTS2 |
Do you want Docsplitter to recalculate the TS2 element values in the valid or invalid output file? 0 = no 1 = yes (default: recalculate) |
CalcValidTS3 CalcInValidTS3 |
Do you want Docsplitter to recalculate the TS3 element values in the valid or invalid output file? 0 = no 1 = yes (default: recalculate) |
RemoveZeroByteEDIFiles=n
|
Do you want to remove all empty files created by Docsplitter: 0 = no (default; leave empty files) 1 = yes |
SaveDTLRecords=n |
Do you want to include information about errors (from the detail file’s DTL records) in the XML or delimited report? If this flag is on, Docsplitter's report file will contain error messages as well as values encountered. 0 = no (saves memory) 1 = yes (default) |
SaveGENRecords=n |
(TIBCO Foresight® Transaction Insight® internal use only) |
SaveSVALURecords=n |
Do you want to include EDI data (from the detail file’s SVALU records) in the XML or delimited report? 0 = no (saves significant memory) 1 = yes (default) |
SeparateAtSplitPoint=n |
If this option appears in the setup file, Docsplitter uses split-point grouping, which sets a maximum number of split units per file. For details, refer Debugging your Content-Based Splitting n is the maximum number of units per file. This option cannot be used with [Content Splitting Map]. |
UseDocSplitterPlus =n
|
High-Performance Parsing should be used for HIPAA EDI documents ONLY. When set to 1 (yes), this option specifies the use of High-Performance Parsing, which improves processing time on large files. Reporting information is not available with High-Performance Parsing. An empty report file is generated. 0 = no, use standard parsing (default) 1 = yes This option cannot be used with the command line parameter –e997. If –e997is specified, DocSplitter reverts to standard parsing. |
This section is processed when you use either -s or -TPA command line options |
|
---|---|
[Debugging] |
Displays debugging information while running from the command line. |
Do you want to redirect output to the file specified with the -b command line parameter? 0 = no (default) 1 = yes |
|
TreeFinal=n |
Do you want to display splitting details in a hierarchical format? 0 = no (default) 1 = yes Do not set this to 1 when executing Docsplitter in a workflow run by Automator. For details, refer Split-Point Grouping Examples |
Content=n |
Do you want to display EDI values used for content-based splitting? 0 = no (default) 1 = yes For details, refer Split-Point Grouping Examples |
VariableSplitPoints=n |
Do you want to display which data is splitting to each file for your variable split points? 0 = no (default) 1 = yes |
ProcessNode=n |
Do you want to display loop levels as they are processed? 0 = no (default) 1 = yes |
ProcessRecord=n
|
Do you want to display detailed file record IDs as they are processed? 0 = no (default) 1 = yes |
ProgressStatus=n
|
Do you want to display checkpoint messages as they are processed? 0 = no (default) 1 = yes |
ControlNumberStatus=n |
Displays the control numbers of ISA, GS and ST segments after n segments have been processed. Example: ControlNumberStatus=5000 means that after segment 5000, any control numbers encountered in ISA, GS and ST segments will be displayed. |
This section is processed when you use either -s or -TPA command line options |
|
---|---|
[Split Point] |
Sets customized split points. For details, refer Changing the Split Point |
All=ISA All=ISA/GS trans#=splitpoint trans#=splitpoint |
For details, refer Sample Setup File Docsplitter finds the most specific match in the list, and splits other transactions at the location designated with ALL. The order in which these entries appear does not matter. Split points are listed on page Delimited report files. |
ProcessBelowSplitPoint=n |
Do you want to rebalance any of these in the split files: CalcValidSE01 CalcInValidSE01 CalcValidGE01 CalcInValidGE01 CalcValidIEA01 CalcInValidIEA01 CalcValidHL CalcInValidHL CalcValidBPR02 0 = no 1 = yes (default) – This causes Docsplitter to check the individual Calc settings. There is no corresponding command-line parameter. |
Xml=rootelement|splitpath |
Specifies the split point for XML data. See XMLatForesight.pdf. For an example, see DocSplitter_XML.ini in the DemoData directory of Instream. |
This section is processed when you use either -s or -TPA command line options |
|
[Summary Point] |
Specifies the split summary element for XML data. See XMLatForesight.pdf |
XML |
An element where Docsplitter is to put the number of splits in each output file. For an example, run V_DS_XML_split_PO in the Scripts directory of Instream and look at the TOTAL element at the bottom of the valid output file. This one uses an element called TOTAL and shows that the file contains 9 splits:
It uses DocSplitter_XML.ini, which contains this: Summary Point]
|
This section is processed when you use either -s or -TPA command line options |
||
---|---|---|
[Content Splitting Options] |
Determine which data is split when using content-based splitting. See page How Docsplitter uses the 997 or 999. |
[Content Splitting Options] |
AutoCreateCBSSplitFiles=n |
Do you want Docsplitter to automatically create split files when ZCBS records are found? 0 = no – use the Content Splitting Map to decide how to split. 1 = yes This eliminates the need to specify particular values. For details, refer How Docsplitter uses the 997 or 999 This option cannot be used with [Content Splitting Map]. |
|
MergeValidOutput=n |
When using content-based splitting, do you want all valid EDI data to go to one file? 0 = no – use content-based splitting on valid data too. 1 = yes |
|
MergeInValidOutput=n |
When using content-based splitting, do you want all invalid EDI data to go to one file? 0 = no – use content-based splitting on invalid data too. 1 = yes |
|
ValidationSplitting=n |
When using content-based splitting, do you want to split valid from invalid data also? 0 = no – just split based on content. 1 = yes |
|
This section is processed when you use either -s or -TPA command line options |
||
[Content Splitting Map] |
Determine which data is split when using content-based splitting, and names its output file. See page How Docsplitter uses the 997 or 999. |
|
filename-end=|content|content| filename-end.ext=|content| Examples:
|
Which content causes a split and what file name ending shall it split to? In the examples: Content containing Content containing Content containing Notice the vertical bars and trailing spaces. The content must be the fixed length defined by the DefineCustomRec business rule that wrote the ZCBS record in the detail results file. If in doubt, find any ZCBS record in a detail file produced by that guideline, and count the data plus trailing spaces. |
This section is processed when you use either -s or -TPA command line options |
|
---|---|
[AK3_Allow] |
Specify which error codes in the AK304 are considered warnings when doing 997-based splitting (see Customizing Docsplitter’s 997 or 999 Splitting) |
code=0 this code is considered a warning code=0 this code is considered a warning or AK3=0 all AK3 codes are considered warnings Example: |
In this example, code 6 in the AK3 is considered a warning. |
This section is processed when you use either -s or -TPA command line options |
|
---|---|
[AK5_Allow] |
Specify which error codes in the AK502-AK506 are considered warnings when doing 997-based splitting. |
code=0 code=0 . . . |
Similar to the AK3_Allow section. |
This section is processed when you use either -s or -TPA command line options |
|
[AK9_Allow] |
Specify which error codes in the AK905-AK909 are considered warnings when doing 997-based splitting. |
code=0 code=0 . . . |
Similar to the AK3_Allow section. |
This section is processed when you use either -s or -TPA command line options |
|
---|---|
[TA1_Allow] |
Specify which error codes in the TA105 are considered warnings when doing 997-based splitting. For details, refer List of Possible Split Points |
code=0 (this code is considered a warning) code=0 (this code is considered a warning too) or TA1=0 (all TA1 codes are considered warnings) .. Example:
|
In this example, codes 010 and 011 in the TA1 are considered warnings. |
[Options] OutputEDIWithCRLF=0 [Debugging] TreeFinal=1 Content=1 VariableSplitPoints=1 [Split Point] All=ISA/GS 835=ISA/GS/ST 837=ISA/GS/ST [Content Splitting Options] MergeValidOutput=0 MergeInValidOutput=0 ValidationSplitting=1 [Content Splitting Map] HOSPITALA=RIVERSIDE01 HOSPITALB=UNIVERISTY02 HOSPITALC=GRANT03 HOSPITALD=DOCTORS04 HOSPITALE=MEMORIAL05 [AK3_Allow] 6=0 [AK5_Allow] AK5=0 [TA1_Allow] 011=0
In this example, 835s and 837s will split at the ST and other transactions will split at the GS.