Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsLib.RecordMap.Service.ComplexBatchStandard
Private  Storage   

EnsLib.RecordMap.Service.ComplexBatchStandard


abstract class EnsLib.RecordMap.Service.ComplexBatchStandard extends
Ens.BusinessService

Base class for Business Services which process streams containing ComplexBatch data.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 4 6


Summary


This is a Business Service class.

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError
%OutsideCreated %PreserveSession %ProcessInputCalled
%QuitTask %RequestHeader %SessionId
%SuperSession %SuperSessionCreatedBeforeSession %WaitForNextCallInterval
%WarnedLatest %isShadow Adapter
AlertGracePeriod AlertGroups AlertOnError
ArchiveIO BusinessPartner ComplexMap
GenerateSuperSessionID IOLogEntry InactivityTimeout
SynchronousSend TargetConfigNames ThrottleDelay

Methods
%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 GetBatch
GetDeferredResponseToken GetProductionSettingValue GetProductionSettings GetPropertyConnections
GetSettings GetShadowInstance NewIOLogEntry OnBatchComplete
OnError OnGenerateSuperSession OnGetConnections OnInit
OnKeepalive OnMonitor OnProcessInput OnProductionStart
OnProductionStop OnTearDown PopulateSuperSession QueueName
SaveIOLogEntry SendAlert SendDeferredResponse SendRequest
SendRequestAsync SendRequestSync

Subclasses
EnsLib.RecordMap.Service.ComplexBatchFileService

Parameters


• parameter SETTINGS = "ComplexMap:Basic:selector?context={/Classes?super=EnsLib.RecordMap.ComplexMap&hideAbstract=1},TargetConfigNames:Basic:selector?multiSelect=1&context={Ens.ContextSearch/ProductionItems?targets=1&productionName=@productionId},SynchronousSend";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties


• property ComplexMap as %String(MAXLEN=220) [ Required ];
Name of the Complex RecordMap to use for processing the incoming data.
• property SynchronousSend as %Boolean [ InitialExpression = 0 ];
Control whether requests should be sent synchronously or asynchronously to the items listed in TargetConfigNames. The default is false.
• property TargetConfigNames as %String(MAXLEN="");
A comma-separated list of Configuration Items which should receive the parsed objects.

Methods


• method GetBatch(pStream As %IO.DeviceStream, Output pBatch As EnsLib.RecordMap.ComplexBatch, pTimeout As %Numeric = -1, ByRef pLookAhead As %String = "") as %Status
Wrap the GetBatch() method in the ComplexMap class.
• method OnBatchComplete(pBatch As EnsLib.RecordMap.ComplexBatch) as %Status
Callback which is invoked immediately after successful parsing of a batch. Users may wish to override this method to allow for extra validation and or initial processing. Note that this callback is invoked before the Batch is first saved to disk.
• classmethod OnGetConnections(Output pArray As %String, pItem As Ens.Config.Item)
Add connections from TargetConfigNames
• method OnInit() as %Status
Ensure that the ComplexMap and the target class exist and are based on the RecordMap framework.
• method SendRequest(pRequest As %Persistent, pAsync As %Boolean = 1, Output pResponses As %ListOfObjects) as %Status
Send the generated object to the requested targets.