Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Class ApprovalPlugin

OptimaJet.Workflow.Plugins.ApprovalPlugin

Namespace: OptimaJet.Workflow.Plugins

public class ApprovalPlugin : WorkflowPlugin<ActionsApprovalPlugin, ActionsAsyncApprovalPlugin, ConditionsApprovalPlugin, ConditionsAsyncApprovalPlugin>, ICustomMixProvider, ICustomWorkflowActionProvider, IWorkflowActionProvider, IDisableProvider, ICustomDesignerParameterFormatProvider, IDesignerParameterFormatProvider, ICustomActivityProvider, ICustomConditionProvider, IWorkflowPlugin

Inheritance

  • System.Object
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowActionProvider{OptimaJet.Workflow.Plugins.ApprovalsPlugin.ActionsApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ActionsAsyncApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ConditionsApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ConditionsAsyncApprovalPlugin}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowActionAndDesignerParameterFormatProvider{OptimaJet.Workflow.Plugins.ApprovalsPlugin.ActionsApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ActionsAsyncApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ConditionsApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ConditionsAsyncApprovalPlugin}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.CustomMixProvider{OptimaJet.Workflow.Plugins.ApprovalsPlugin.ActionsApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ActionsAsyncApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ConditionsApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ConditionsAsyncApprovalPlugin}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowPlugin{OptimaJet.Workflow.Plugins.ApprovalsPlugin.ActionsApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ActionsAsyncApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ConditionsApprovalPlugin,OptimaJet.Workflow.Plugins.ApprovalsPlugin.ConditionsAsyncApprovalPlugin}

Implemented Interfaces

Constructors

public ApprovalPlugin() #

Properties

Name
Type
AllowedActorsFilter #
Func<Boolean>
The filter for allowed actors. When applied, only actors that meet the specified criteria will be included. Restricted actors remain unaffected by this filter.
DisableApprovalHistory #
Boolean
Disables Approval History, preventing the creation of records in the approval history table.
DisableInbox #
Boolean
Disables the inbox, preventing access to the list of users and available commands for the current approval stage.
Name #
String
The plugin name.

Methods

protected virtual void InitialActions() #
protected virtual void InitialActionsAsync() #
public virtual Task ActionGetApprovalHistoryAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task
public virtual Task ActionGetInboxAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task
public virtual Task ActionGetOutboxAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task
public virtual Task ActionFillApprovalHistoryAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task
protected virtual void InitialExclude() #
public override void OnPluginAdd(WorkflowRuntime runtime, List<string> schemes = null) #
Called when a plugin is added to a runtime.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The instance of the runtime.
schemes
List<String>
The list of schemes for which the plugin is being added.
public Task OnPluginRemoveAsync(WorkflowRuntime runtime) #

Parameters

Name
Type
Description
runtime
WorkflowRuntime

Returns

Type
Description
Task
protected virtual Task OnProcessActivityChangedAsync(WorkflowRuntime runtime, ProcessInstance processInstance, CancellationToken token) #

Parameters

Name
Type
Description
runtime
WorkflowRuntime
processInstance
ProcessInstance
token
CancellationToken

Returns

Type
Description
Task
protected virtual Task<long> GetNextOrderForApprovalHistoryAsync(ProcessInstance processInstance, WorkflowRuntime runtime = null) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime

Returns

Type
Description
Task<Int64>
protected virtual void InitialConditions() #
protected virtual void InitialConditionsAsync() #
protected virtual void InitialActionsDescriptions() #
protected virtual void InitialActionsAsyncDescriptions() #
protected virtual void InitialConditionsDescriptions() #
protected virtual void InitialConditionsAsyncDescriptions() #
protected virtual void InitialFormatsActions() #
protected virtual void InitialFormatsActionsAsync() #
protected virtual void InitialFormatsConditions() #
protected virtual void InitialFormatsConditionsAsync() #
public virtual List<CodeActionParameterDefinition> FormatFillApprovalHistory() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatGetApprovalHistory() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatGetInbox() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatGetOutbox() #

Returns

Type
Description
List<CodeActionParameterDefinition>

Fields

public Func<List<string>, List<string>> GetUserNamesByIds #
public bool InboxActorsWithOnlyRejectCommands #
public bool InboxCheckConditions #
When this setting is enabled, transition conditions will be checked during inbox filling, and only transitions for which the conditions are met will be included in the inbox.
public bool AutoApprovalHistory #
public string NameParameterForComment #