Home > Class Reference > ENSLIB namespace > EnsLib.RecordMap.Service.BatchStandard


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.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 3 4


This is a Business Service class.

%AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError
%OutsideCreated %PreserveSession %ProcessInputCalled
%QuitTask %RequestHeader %SessionId
%SuperSession %SuperSessionCreatedBeforeSession %WaitForNextCallInterval
%WarnedLatest %isShadow Adapter
AlertGracePeriod AlertGroups AlertOnError
ArchiveIO BatchClass BatchHandling
BusinessPartner FatalErrors GenerateSuperSessionID
IOLogEntry InactivityTimeout RecordMap
SynchronousSend TargetConfigNames ThrottleDelay
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnClose %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %SuperSessionSet %ValidateObject AdapterName
AssignOneSetting CloseIOLogEntry EnumerateSettingsClose EnumerateSettingsExecute
EnumerateSettingsFetch ForceSessionId GenerateSuperSession GetBatchObject
GetDeferredResponseToken GetObject GetProductionSettingValue GetProductionSettings
GetPropertyConnections GetSettings GetShadowInstance NewIOLogEntry
OnError OnGenerateSuperSession OnGetConnections OnInit
OnKeepalive OnMonitor OnProcessInput OnProductionStart
OnProductionStop OnTearDown PopulateSuperSession QueueName
SaveIOLogEntry SendAlert SendBatch SendDeferredResponse
SendRecord SendRequest SendRequestAsync SendRequestSync


parameter SETTINGS = "FatalErrors,BatchHandling,BatchClass";
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 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 FatalErrors as %String(VALUELIST=",Any,ParseOnly") [ InitialExpression = "Any" ];
Errors which 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.


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.