Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Class BasicPlugin

OptimaJet.Workflow.Plugins.BasicPlugin

Namespace: OptimaJet.Workflow.Plugins

public class BasicPlugin : WorkflowPluginWithRuleProvider<ActionsBasicPlugin, ActionsAsyncBasicPlugin, ConditionsBasicPlugin, ConditionsAsyncBasicPlugin, RulesBasicPlugin, RulesAsyncBasicPlugin>, ICustomMixProvider, ICustomWorkflowActionProvider, IWorkflowActionProvider, IDisableProvider, ICustomDesignerParameterFormatProvider, IDesignerParameterFormatProvider, ICustomActivityProvider, ICustomConditionProvider, IWorkflowPlugin, ICustomWorkflowRuleProvider, IWorkflowRuleProvider

Inheritance

  • System.Object
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowActionProvider{OptimaJet.Workflow.Plugins.BasicsPlugin.ActionsBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ActionsAsyncBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ConditionsBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ConditionsAsyncBasicPlugin}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowActionAndDesignerParameterFormatProvider{OptimaJet.Workflow.Plugins.BasicsPlugin.ActionsBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ActionsAsyncBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ConditionsBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ConditionsAsyncBasicPlugin}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.CustomMixProvider{OptimaJet.Workflow.Plugins.BasicsPlugin.ActionsBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ActionsAsyncBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ConditionsBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ConditionsAsyncBasicPlugin}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowPlugin{OptimaJet.Workflow.Plugins.BasicsPlugin.ActionsBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ActionsAsyncBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ConditionsBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ConditionsAsyncBasicPlugin}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowPluginWithRuleProvider{OptimaJet.Workflow.Plugins.BasicsPlugin.ActionsBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ActionsAsyncBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ConditionsBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.ConditionsAsyncBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.RulesBasicPlugin,OptimaJet.Workflow.Plugins.BasicsPlugin.RulesAsyncBasicPlugin}

Implemented Interfaces

Constructors

public BasicPlugin() #
public BasicPlugin(Dictionary<string, string> pluginSettings) #

Parameters

Name
Type
Description
pluginSettings
Dictionary<String>

Properties

Name
Type
Name #
String
The plugin name.
UsersInRoleAsync #
UsersInRoleAsyncDelegate
Setting_Mailserver #
String
Setting_MailserverPort #
Int32
Setting_MailserverFrom #
String
Setting_MailserverLogin #
String
Setting_MailserverPassword #
String
Setting_MailserverSsl #
Boolean
Setting_DontCompileExpressions #
Boolean
Use this setting for compatibility only
GetApproverIdentityId #
GetApproverIdentityId
Gets the identity ID of the approver specified by the parameter.

Methods

protected virtual void InitialActions() #
protected virtual void InitialActionsAsync() #
protected virtual void ActionAsyncSetActivity(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
protected virtual Task ActionAsyncExecuteCommand(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 Task ActionAsyncSetState(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 ActionSetParameterAsync(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 ActionSendEmailAsync(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 ActionCreateProcessAsync(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 ActionHttpRequestAsync(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 ActionFillApproversUsersAsync(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 ActionFillApproversRolesAsync(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 ActionRemoveParameterAsync(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 ActionDeleteSubprocessesAsync(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 ActionClearApproversAsync(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 Task StoreResponse(HttpResponseMessage res, ProcessInstance processInstance, Dictionary<string, string> parameters) #

Parameters

Name
Type
Description
res
HttpResponseMessage
processInstance
ProcessInstance
parameters
Dictionary<String>

Returns

Type
Description
Task
protected virtual Task StoreResponse(string data, ProcessInstance processInstance, Dictionary<string, string> parameters) #

Parameters

Name
Type
Description
data
String
processInstance
ProcessInstance
parameters
Dictionary<String>

Returns

Type
Description
Task
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 void InitialExclude() #
protected virtual void InitialSettings() #
public void WithActor(string actor, List<string> schemes = null) #
Adds an actor to the collection of predefined actors in all schemes specified in the collection. It is supposed to be used before plugin initialization.

Parameters

Name
Type
Description
actor
String
Actor name.
schemes
List<String>
Collection of scheme codes for adding an actor.
public void WithActors(List<string> actors, List<string> schemes = null) #
Adds an actors collection to the collection of predefined actors in all schemes specified in the collection. It is supposed to be used before plugin initialization.

Parameters

Name
Type
Description
actors
List<String>
Collection of actors names.
schemes
List<String>
Collection of scheme codes for adding an actor.
public static Approvers GetApprovers(ProcessInstance processInstance, string name) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
name
String

Returns

Type
Description
Approvers
protected virtual Task OnProcessStatusChangedAsync(object handler, ProcessStatusChangedEventArgs e, CancellationToken token) #

Parameters

Name
Type
Description
handler
Object
e
ProcessStatusChangedEventArgs
token
CancellationToken

Returns

Type
Description
Task
protected virtual Task<IEnumerable<string>> RuleGetApprovers(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task<String>
public virtual List<string> GetAutocompleteSuggestions(SuggestionCategory category, string value, string schemeCode) #

Parameters

Name
Type
Description
category
SuggestionCategory
value
String
schemeCode
String

Returns

Type
Description
List<String>
public override List<ActivityBase> GetCustomActivities() #
Returns custom activities

Returns

Type
Description
List<ActivityBase>
protected virtual void InitialConditions() #
protected virtual void InitialConditionsAsync() #
public virtual Task<bool> ConditionCheckParameterAsync(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<Boolean>
public virtual Task<bool> ConditionCheckApproversExistAsync(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<Boolean>
public virtual Task<bool> ConditionCheckAllSubprocessesCompletedAsync(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<Boolean>
public virtual Task<bool> ConditionIsProcessFinishAsync(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<Boolean>
public virtual Task<bool> ConditionIsApprovedByRolesAsync(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<Boolean>
public virtual Task<bool> ConditionIsApprovedByUsersAsync(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<Boolean>
public virtual Task<bool> ConditionCheckHttpRequestAsync(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<Boolean>
public virtual Task<bool> ConditionIsApproveCompleteAsync(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<Boolean>
protected virtual void InitialActionsDescriptions() #
protected virtual void InitialActionsAsyncDescriptions() #
protected virtual void InitialActionsAsyncTemplates() #
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> FormatSetActivity() #

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

Type
Description
List<CodeActionParameterDefinition>
protected virtual void InitialRulesCheck() #
protected virtual void InitialRulesCheckAsync() #
protected virtual void InitialRulesGetIdentities() #
protected virtual void InitialRulesGetIdentitiesAsync() #
public virtual Task<bool> ApproverCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string identityId, string ruleName, string parameter, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
identityId
String
ruleName
String
parameter
String
token
CancellationToken

Returns

Type
Description
Task<Boolean>
public virtual Task<bool> PredefinedCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string identityId, string ruleName, string parameter, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
identityId
String
ruleName
String
parameter
String
token
CancellationToken

Returns

Type
Description
Task<Boolean>
public virtual Task<bool> CheckRoleCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string identityId, string ruleName, string parameter, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
identityId
String
ruleName
String
parameter
String
token
CancellationToken

Returns

Type
Description
Task<Boolean>
public virtual Task<IEnumerable<string>> ApproverCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string ruleName, string parameter, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
ruleName
String
parameter
String
token
CancellationToken

Returns

Type
Description
Task<String>
public virtual Task<IEnumerable<string>> PredefinedCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string ruleName, string parameter, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
ruleName
String
parameter
String
token
CancellationToken

Returns

Type
Description
Task<String>
public virtual Task<IEnumerable<string>> CheckRoleCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string ruleName, string parameter, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
ruleName
String
parameter
String
token
CancellationToken

Returns

Type
Description
Task<String>

Fields

public readonly IActorProvider PredefinedActorProvider #
Allows to thread-safely control collections of predefined actors.
public Dictionary<string, string> RequestHeaders #
public ApproversInStageAsyncDelegate ApproversInStageAsync #
public CheckPredefinedActorAsyncDelegate CheckPredefinedActorAsync #
public GetPredefinedIdentitiesAsyncDelegate GetPredefinedIdentitiesAsync #
public UpdateDocumentStateDelegate UpdateDocumentStateAsync #