EnsLib.RecordMap.Operation.ComplexBatchFileOperation

class EnsLib.RecordMap.Operation.ComplexBatchFileOperation extends EnsLib.RecordMap.Operation.ComplexBatchStandard

Business Operation to write ComplexBatch data out to files on disk. Note that this operation uses a temporary file while writing out the ComplexBatch, and transmits the temporary file when output is complete.

Property Inventory

Method Inventory

Parameters

parameter ADAPTER = EnsLib.File.OutboundAdapter;
Inherited description: The type of adapter used to communicate with external systems
parameter SETTINGS = Filename:Basic;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

property Filename as %String (MAXLEN = 1000, MINLEN = 1) [ InitialExpression = "%Q" , Required ];
Name of file to output the ComplexBatch to. May include timestamp specifiers. If present, the %f specifier will be replaced with the value of the ComplexBatch object's %Source property stripped of characters illegal in filenames.
See the documentation for the CreateTimestamp() method in Ens.Util.File for more detailed timestamping options.
Property methods: FilenameDisplayToLogical(), FilenameGet(), FilenameIsValid(), FilenameLogicalToDisplay(), FilenameLogicalToOdbc(), FilenameNormalize(), FilenameSet()

Methods

method GetCharEncoding() as %String [ Language = objectscript ]
Return the expected character encoding to use for the output. The Batch operation uses a temp file to store data prior to writing out the end of the batch, and we need to know what encoding we should use to match the final output encoding. For this operation, the encoding is a setting of the adapter.
method ProcessTempStream(pTempStream As %IO.FileStream, pBatch As EnsLib.RecordMap.ComplexBatch) as %Status [ Language = objectscript ]
Let the adapter take responsibility for writing out the temporary file.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

Feedback