EnsLib.RecordMap.Service.Base
abstract class EnsLib.RecordMap.Service.Base extends Ens.BusinessService
Base class for Business Services which process streams containing data mapped to RecordMaps and/or batches of RecordMaps.Property Inventory
Method Inventory
Parameters
parameter SETTINGS = RecordMap:Basic:selector?context={Ens.ContextSearch/RecordMaps},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 RecordMap as %String (MAXLEN = 220) [ Required ];
Name of the RecordMap to use for processing the incoming data.
Property methods: RecordMapDisplayToLogical(), RecordMapGet(), RecordMapIsValid(), RecordMapLogicalToDisplay(), RecordMapLogicalToOdbc(), RecordMapNormalize(), RecordMapSet()
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 GetObject(pStream As %IO.DeviceStream, Output pObject As EnsLib.RecordMap.Base, pTimeout As %Numeric = -1, ByRef pLookAhead As %String = "", pLabelFound As %Boolean = 0) as %Status
Wrap the GetObject() method in the RecordMap class.
classmethod OnGetConnections(Output pArray As %String, pItem As Ens.Config.Item)
Add connections from TargetConfigNames
method OnInit() as %Status
Ensure that the RecordMap 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
- %AlertStartTime
- %ConfigName
- %ConfigQueueName
- %LastActionTime
- %LastHandledTime
- %LastReportedError
- %OutsideCreated
- %PreserveSession
- %ProcessInputCalled
- %QuitTask
- %RequestHeader
- %SessionId
- %SuperSession
- %SuperSessionCreatedBeforeSession
- %WaitForNextCallInterval
- %WarnedLatest
- %isShadow
- Adapter
- AlertGracePeriod
- AlertGroups
- AlertOnError
- ArchiveIO
- BusinessPartner
- GenerateSuperSessionID
- IOLogEntry
- InactivityTimeout
- ThrottleDelay
Inherited 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()
- GetDeferredResponseToken()
- GetMsgHdrRequestKey()
- GetProductionSettingValue()
- GetProductionSettings()
- GetPropertyConnections()
- GetSettings()
- GetShadowInstance()
- NewIOLogEntry()
- OnError()
- OnGenerateSuperSession()
- OnKeepalive()
- OnMonitor()
- OnProcessInput()
- OnProductionStart()
- OnProductionStop()
- OnTearDown()
- PopulateSuperSession()
- QueueName()
- SaveIOLogEntry()
- SendAlert()
- SendDeferredResponse()
- SendRequestAsync()
- SendRequestSync()