Class 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.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	4	5

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	GenerateSuperSessionID
IOLogEntry	InactivityTimeout	RecordMap
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	GetDeferredResponseToken
GetMsgHdrRequestKey	GetObject	GetProductionSettingValue	GetProductionSettings
GetPropertyConnections	GetSettings	GetShadowInstance	NewIOLogEntry
OnError	OnGenerateSuperSession	OnGetConnections	OnInit
OnKeepalive	OnMonitor	OnProcessInput	OnProductionStart
OnProductionStop	OnTearDown	PopulateSuperSession	QueueName
SaveIOLogEntry	SendAlert	SendDeferredResponse	SendRequest
SendRequestAsync	SendRequestSync

Subclasses
EnsLib.RecordMap.Service.BatchStandard	EnsLib.RecordMap.Service.Standard

Parameters

• parameter SETTINGS = "RecordMap:Basic:selector?context={Ens.ContextSearch/RecordMaps},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 RecordMap as %String(MAXLEN=220) [ Required ];

Name of the 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 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.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search