Skip to main content


abstract class EnsLib.RecordMap.Service.BatchStandard extends EnsLib.RecordMap.Service.Base

Base class for Business Services which process streams containing batches of data mapped to a RecordMap Batch.

Property Inventory

Method Inventory


parameter SETTINGS = FatalErrors,SkipRecordParsingErrors,BatchHandling,BatchClass;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property BatchClass as %String (MAXLEN = 220);
Name of Batch class to be used for input
Property methods: BatchClassDisplayToLogical(), BatchClassGet(), BatchClassIsValid(), BatchClassLogicalToDisplay(), BatchClassLogicalToOdbc(), BatchClassNormalize(), BatchClassSet()
property BatchHandling as %String (DISPLAYLIST = ",Whole Batch,Single-Session Batch,Multi-Session Batch,Individual", VALUELIST = ",Whole,1Session,Batch,Indiv") [ InitialExpression = "1Session" , Required ];
How to treat received batch documents:
- Whole Batch : Accumulate and send the whole batch as one composite document
- Single-Session Batch : Forward all Records in the batch as part of a single session, including the Batch object
- Multi-Session Batch : Forward each Record in the batch in its own session, followed by the Batch object
- Individual : Forward each Record in the batch in its own session; do not forward the Batch object
Property methods: BatchHandlingDisplayToLogical(), BatchHandlingGet(), BatchHandlingIsValid(), BatchHandlingLogicalToDisplay(), BatchHandlingLogicalToOdbc(), BatchHandlingNormalize(), BatchHandlingSet()
property FatalErrors as %String (VALUELIST = ",Any,ParseOnly") [ InitialExpression = "Any" ];
Errors saving any record will be treated as Fatal. If "ParseOnly" is selected, errors when saving individual Records will not be treated as fatal, and parsing of the message will continue.
Property methods: FatalErrorsDisplayToLogical(), FatalErrorsGet(), FatalErrorsIsValid(), FatalErrorsLogicalToDisplay(), FatalErrorsLogicalToOdbc(), FatalErrorsNormalize(), FatalErrorsSet()
property SkipRecordParsingErrors as %Boolean [ InitialExpression = 0 ];
By default errors parsing data into a record such as ErrQuoteCharMismatch will be treated as fatal and end the processing of the message.
These parsing errors are those detected before the record is saved.
If this setting is enabled, errors when parsing the data into a record before saving is attempted will not be treated as fatal, no attempt will be made to try to save the record and parsing of the message will continue.
Note the record data may become out of alignment.
If this setting is enabled and AlertOnError is enabled, an alert will be sent when such an error is encountered.
Property methods: SkipRecordParsingErrorsDisplayToLogical(), SkipRecordParsingErrorsGet(), SkipRecordParsingErrorsIsValid(), SkipRecordParsingErrorsLogicalToDisplay(), SkipRecordParsingErrorsNormalize(), SkipRecordParsingErrorsSet()


method GetBatchObject(pIOStream As %IO.DeviceStream, Output pBatch As EnsLib.RecordMap.Batch, pTimeout As %Numeric = -1, ByRef pLookAhead As %String = "") as %Status
Parse a Batch object based on the specified Batch class and RecordMap
method OnInit() as %Status
Ensure that the Batch object exists and extends EnsLib.RecordMap.Batch.
method SendBatch(pBatch As EnsLib.RecordMap.Batch, pAsync As %Boolean = 1, Output pResponses As %ListOfObjects) as %Status
Method to send the Batch object as per the specified BatchHandling behaviour.
method SendRecord(pRecord As EnsLib.RecordMap.Base) as %Status
Method to send individual Records as needed for the specified BatchHandling behaviour.

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab