Skip to main content


abstract class EnsLib.EDI.X12.Operation.BatchStandard extends EnsLib.EDI.X12.Operation.Standard

Property Inventory

Method Inventory


parameter SETTINGS = Filename:Basic,AutoBatchParentSegs,AutoBatchCompletionTimeout;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property AutoBatchCompletionTimeout as %Numeric [ InitialExpression = 0 ];
How long to wait before adding the trailing segments to batch output which has been unmodified for a period of time, but does not yet have the trailing segments necessary to make a complete batch document. 0 means never timeout. This is only relevant if AutoBatchParentSegs is turned on.
Property methods: AutoBatchCompletionTimeoutDisplayToLogical(), AutoBatchCompletionTimeoutGet(), AutoBatchCompletionTimeoutIsValid(), AutoBatchCompletionTimeoutLogicalToDisplay(), AutoBatchCompletionTimeoutNormalize(), AutoBatchCompletionTimeoutSet()
property AutoBatchParentSegs as %Boolean [ InitialExpression = 1 ];
When writing a message that has a batch parent, output the batch headers first, and follow up with the batch trailers when triggered by the final batch parent header message or by a file name change.
All child messages of a batch parent message will be written out unless already written previously while AutoBatchParentSegs=true.
Property methods: AutoBatchParentSegsDisplayToLogical(), AutoBatchParentSegsGet(), AutoBatchParentSegsIsValid(), AutoBatchParentSegsLogicalToDisplay(), AutoBatchParentSegsNormalize(), AutoBatchParentSegsSet()
property Filename as %String (MAXLEN = 1000, MINLEN = 1) [ InitialExpression = "%f_%Q" , Required ];
Name of file to output the document(s) to. May include timestamp specifiers. The %f specifier if present will be replaced with the name of the document's original source stream (stripped of characters illegal in filenames).

See the method Ens.Util.File.CreateTimestamp() for documentation of timestamping options.

Property methods: FilenameDisplayToLogical(), FilenameGet(), FilenameIsValid(), FilenameLogicalToDisplay(), FilenameLogicalToOdbc(), FilenameNormalize(), FilenameSet()


method OnInit() as %Status
This user callback method is called just after %OnNew()
method OnKeepalive(pAdapterStatus As %Status) as %Status
Inherited description: This method will be called within KeepaliveInterval of the last return from OnTask() or OnKeepalive(). It is called via the Adapter's OnKeepalive() method, which is called from the Host.OnTask() method; if there is no Adapter there is no keepalive call.
method OnMessage(pRequest As EnsLib.EDI.X12.Document, Output pResponse As EnsLib.EDI.X12.Document) as %Status
This method is for File and FTP Operations: per-message batch output with no reply. TCP and HTTP Operations receive reply messages and only support entire batch output.
method completeUnfinishedBatches()
Add trailers to files that have been unchanged for AutoBatchCompleteionTimeout seconds
method fileExists(pFilename As %String, pStatus As %Status = $$$OK) as %Boolean
Implemented by subclasses
method outputHeaders(pKey As %String, pOldParents As %String, pParents As %String) as %Status

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab