Class EnsLib.Background.Service

class EnsLib.Background.Service extends Ens.BusinessService

Internal business service for queuing background work requests

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	1	2

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	Target
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	GetProductionSettingValue	GetProductionSettings	GetPropertyConnections
GetSettings	GetShadowInstance	NewIOLogEntry	OnError
OnGenerateSuperSession	OnGetConnections	OnInit	OnKeepalive
OnMonitor	OnProcessInput	OnProductionStart	OnProductionStop
OnTearDown	PopulateSuperSession	QueueName	SaveIOLogEntry
SendAlert	SendBackgroundRequest	SendDeferredResponse	SendRequestAsync
SendRequestSync

Parameters

• parameter SETTINGS = "Target";

Exposed if this item is added to the production via portal/production definition to make it visible

Properties

• property Target as Ens.DataType.ConfigName;

This is the target if the request does not specify a value for property BackgroundProcessor

Methods

• method OnProcessInput(pInput As Ens.Background.Request, pOutput As %RegisteredObject) as %Status

Override this method to process incoming data. Do not call SendRequestSync/Async() from outside this method (e.g. in a SOAP Service or a CSP page).

• classmethod SendBackgroundRequest(pRequest As Ens.Background.Request, ByRef pResponse As Ens.Response, Output pSessionId As %String) as %Status

Send the background request.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search