Class Reference
EnsLib.Workflow.Operation
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [EnsLib] >  [Workflow] >  [Operation]
Private  Storage

class EnsLib.Workflow.Operation extends Ens.BusinessOperation

This Business Operation manages the delegation of workflow tasks to the Workflow Engine.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 1 2


Summary

This is a Business Operation class.

RequestResponse
EnsLib.Workflow.TaskRequest EnsLib.Workflow.TaskResponse

Properties
%AlertStartTime %ConfigName %ConfigQueueName %LastActionTime
%LastHandledTime %LastReportedError %QuitTask %RequestHeader
%SessionId %SuperSession %WarnedLatest %isShadow
Adapter AlertGroups AlertOnError AlertRetryGracePeriod
ArchiveIO AutoCreateRole BusinessPartner DeferResponse
FailureTimeout IOLogEntry InactivityTimeout NoFailWhileDisconnected
QueueCountAlert QueueWaitAlert ReplyCodeActions Retry
RetryCount RetryInterval SendSuperSession SuspendMessage
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 DeferResponse EnumerateSettingsClose
EnumerateSettingsExecute EnumerateSettingsFetch GenerateSuperSession GetDeferredResponseToken
GetMessageList GetMsgHdrRequestKey GetProductionSettingValue GetProductionSettings
GetPropertyConnections GetSettings GetShadowInstance IncludeSuperSession
NewIOLogEntry OnError OnFailureTimeout OnGenerateSuperSession
OnGetConnections OnGetReplyAction OnInit OnKeepalive
OnMessage OnMonitor OnProductionStart OnProductionStop
OnTearDown QueueName SaveIOLogEntry SendAlert
SendDeferredResponse SendRequestAsync SendRequestSync TaskHandler


Parameters

• parameter INVOCATION = "Queue";
2 modes: Queue, InProc
• parameter SETTINGS = "AutoCreateRole:Basic";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property AutoCreateRole as %Boolean [ InitialExpression = 0 ];
If true, then this operation, when it starts, will automatically create a corresponding Workflow Role definition if one does not currently exist.

Methods

• method OnInit() as %Status
This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
• method TaskHandler(pTask As EnsLib.Workflow.TaskRequest, Output pResponse As EnsLib.Workflow.TaskResponse) as %Status
Take a Task and give it to the Workflow Engine for distribution. The role is assumed to be the same as the configuration name of this operation.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.