This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

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

EnsLib.RecordMap.Service.ComplexBatchStandard

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

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

Property Inventory

Method Inventory

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;
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 ComplexMap as %String (MAXLEN = 220) [ Required ];
Name of the Complex RecordMap to use for processing the incoming data.
Property methods: ComplexMapDisplayToLogical(), ComplexMapGet(), ComplexMapIsValid(), ComplexMapLogicalToDisplay(), ComplexMapLogicalToOdbc(), ComplexMapNormalize(), ComplexMapSet()
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 methods: SynchronousSendDisplayToLogical(), SynchronousSendGet(), SynchronousSendIsValid(), SynchronousSendLogicalToDisplay(), SynchronousSendNormalize(), SynchronousSendSet()
property TargetConfigNames as %String);
A comma-separated list of Configuration Items which should receive the parsed objects.
Property methods: TargetConfigNamesDisplayToLogical(), TargetConfigNamesGet(), TargetConfigNamesIsValid(), TargetConfigNamesLogicalToDisplay(), TargetConfigNamesLogicalToOdbc(), TargetConfigNamesNormalize(), TargetConfigNamesSet()

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.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new window