Class WorkflowRuntimeConfigurationExtension

Inheritance

↳ object

    ↳ WorkflowRuntimeConfigurationExtension

Inherited Members

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

MemberwiseClone()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Core.Runtime

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public static class WorkflowRuntimeConfigurationExtension

Methods

SetCancellationTokenHandling(WorkflowRuntime, CancellationTokenHandling)

Sets cancellation token handling type

Declaration

public static WorkflowRuntime SetCancellationTokenHandling(this WorkflowRuntime runtime, CancellationTokenHandling value)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
CancellationTokenHandling	value	Cancellation token handling type

Returns

Type	Description
WorkflowRuntime

WithDefaultBuildSteps(IWorkflowBuilder, WorkflowRuntime)

Configures the builder with default build steps

Declaration

public static IWorkflowBuilder WithDefaultBuildSteps(this IWorkflowBuilder builder, WorkflowRuntime runtime)

Parameters

Type	Name	Description
IWorkflowBuilder	builder	The instance of the builder
WorkflowRuntime	runtime

Returns

Type	Description
IWorkflowBuilder	Configured instance of builder

WithBuilder(WorkflowRuntime, IWorkflowBuilder)

Configures the runtime with specified builder IWorkflowBuilder

Declaration

public static WorkflowRuntime WithBuilder(this WorkflowRuntime runtime, IWorkflowBuilder builder)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
IWorkflowBuilder	builder	The instance of the builder <xref href="OptimaJet.Workflow.Core.Builder.IWorkflowBuilder" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

WithDefaultBuilder<TSchemeMedium>(WorkflowRuntime)

Configures the runtime with default (scheme in xml) builder IWorkflowBuilder

Declaration

[Obsolete("Use runtime.WithBuilder configuration method")]
public static WorkflowRuntime WithDefaultBuilder<TSchemeMedium>(this WorkflowRuntime runtime) where TSchemeMedium : class

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

WithPersistenceProvider(WorkflowRuntime, IPersistenceProvider)

Configures the runtime with specified persistence provider IPersistenceProvider

Declaration

public static WorkflowRuntime WithPersistenceProvider(this WorkflowRuntime runtime, IPersistenceProvider persistenceProvider)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
IPersistenceProvider	persistenceProvider	The instance of the persistence provider <xref href="OptimaJet.Workflow.Core.Persistence.IPersistenceProvider" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

AttachDeterminingParametersGetter(WorkflowRuntime, EventHandler<NeedDeterminingParametersEventArgs>)

Subscribe a event handler on OnNeedDeterminingParameters event to obtain parameters for creating a scheme of a process where a scheme was changed NeedDeterminingParametersEventArgs

Declaration

public static WorkflowRuntime AttachDeterminingParametersGetter(this WorkflowRuntime runtime, EventHandler<NeedDeterminingParametersEventArgs> determiningParametersGetter)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
EventHandler<NeedDeterminingParametersEventArgs>	determiningParametersGetter	Event handler <xref href="OptimaJet.Workflow.Core.Runtime.NeedDeterminingParametersEventArgs" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

SwitchAutoUpdateSchemeBeforeGetAvailableCommandsOn(WorkflowRuntime)

Set !:WorkflowRuntime.IsAutoUpdateSchemeBeforeGetAvailableCommands to true

Declaration

public static WorkflowRuntime SwitchAutoUpdateSchemeBeforeGetAvailableCommandsOn(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

SwitchAutoUpdateSchemeBeforeGetAvailableCommandsOn(WorkflowRuntime, EventHandler<NeedDeterminingParametersEventArgs>)

Set !:WorkflowRuntime.IsAutoUpdateSchemeBeforeGetAvailableCommands to true and add event handler to OnNeedDeterminingParameters event WorkflowRuntime.OnNeedDeterminingParameters

Declaration

public static WorkflowRuntime SwitchAutoUpdateSchemeBeforeGetAvailableCommandsOn(this WorkflowRuntime runtime, EventHandler<NeedDeterminingParametersEventArgs> determiningParametersGetter)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
EventHandler<NeedDeterminingParametersEventArgs>	determiningParametersGetter	Event handler <xref href="OptimaJet.Workflow.Core.Runtime.NeedDeterminingParametersEventArgs" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

SwitchAutoUpdateSchemeBeforeGetAvailableCommandsOff(WorkflowRuntime)

Set !:WorkflowRuntime.IsAutoUpdateSchemeBeforeGetAvailableCommands to false

Declaration

public static WorkflowRuntime SwitchAutoUpdateSchemeBeforeGetAvailableCommandsOff(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

StartAsync(WorkflowRuntime)

Start all workflow runtime services and compile global code actions

Declaration

public static Task<WorkflowRuntime> StartAsync(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime

Returns

Type	Description
Task<WorkflowRuntime>	Configured instance of the workflow runtime

Start(WorkflowRuntime)

Start all workflow runtime services and compile global code actions

Declaration

public static WorkflowRuntime Start(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

StartAsync(WorkflowRuntime, bool)

System use only. The signature of this method can be changed without any notification. Start all workflow runtime services and compile global code actions

Declaration

public static Task<(WorkflowRuntime runtime, Dictionary<string, string> compilerErrors)> StartAsync(this WorkflowRuntime runtime, bool ignoreNotCompiledGlobalActions)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
bool	ignoreNotCompiledGlobalActions	if true all compillation errors in the global codeactions will be ignored

Returns

Type	Description
Task<(WorkflowRuntime runtime, Dictionary<string, string> compilerErrors)>	Configured instance of the workflow runtime

Start(WorkflowRuntime, bool, out Dictionary<string, string>)

System use only. The signature of this method can be changed without any notification. Start all workflow runtime services and compile global code actions

Declaration

public static WorkflowRuntime Start(this WorkflowRuntime runtime, bool ignoreNotCompiledGlobalActions, out Dictionary<string, string> compilerErrors)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
bool	ignoreNotCompiledGlobalActions	if true all compillation errors in the global codeactions will be ignored
Dictionary<string, string>	compilerErrors	compiler errors

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

ColdStartAsync(WorkflowRuntime)

System use only. The signature of this method can be changed without any notification. Start all workflow runtime services except timers.

Declaration

public static Task<WorkflowRuntime> ColdStartAsync(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime

Returns

Type	Description
Task<WorkflowRuntime>	Configured instance of the workflow runtime

ColdStart(WorkflowRuntime)

System use only. The signature of this method can be changed without any notification. Start all workflow runtime services except timers.

Declaration

public static WorkflowRuntime ColdStart(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

ColdStartAsync(WorkflowRuntime, bool)

System use only. The signature of this method can be changed without any notification. Start all workflow runtime services except timers.

Declaration

public static Task<(WorkflowRuntime runtime, Dictionary<string, string> compilerErrors)> ColdStartAsync(this WorkflowRuntime runtime, bool ignoreNotCompiledGlobalActions)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
bool	ignoreNotCompiledGlobalActions

Returns

Type	Description
Task<(WorkflowRuntime runtime, Dictionary<string, string> compilerErrors)>	Configured instance of the workflow runtime

ColdStart(WorkflowRuntime, bool, out Dictionary<string, string>)

System use only. The signature of this method can be changed without any notification. Start all workflow runtime services except timers.

Declaration

public static WorkflowRuntime ColdStart(this WorkflowRuntime runtime, bool ignoreNotCompiledGlobalActions, out Dictionary<string, string> compilerErrors)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
bool	ignoreNotCompiledGlobalActions
Dictionary<string, string>	compilerErrors

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

WithCache(IWorkflowBuilder, IParsedProcessCache)

Configures the workflow builder with specified cache for parced processes IParsedProcessCache

Declaration

public static IWorkflowBuilder WithCache(this IWorkflowBuilder bulder, IParsedProcessCache cache)

Parameters

Type	Name	Description
IWorkflowBuilder	bulder	The instance of the workflow builder
IParsedProcessCache	cache	The instance of the cache for parced processes <xref href="OptimaJet.Workflow.Core.Cache.IParsedProcessCache" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
IWorkflowBuilder	Configured instance of the workflow builder

WithDefaultCache(IWorkflowBuilder)

Configures the workflow builder with default in memory cache for parced processes IParsedProcessCache

Declaration

public static IWorkflowBuilder WithDefaultCache(this IWorkflowBuilder bulder)

Parameters

Type	Name	Description
IWorkflowBuilder	bulder	The instance of the workflow builder

Returns

Type	Description
IWorkflowBuilder	Configured instance of the workflow builder

WithGenerator<TSchemeMedium>(WorkflowBuilder<TSchemeMedium>, IWorkflowGenerator<TSchemeMedium>)

Configures the workflow builder with specified workflow scheme generatorOptimaJet.Workflow.Core.Generator.IWorkflowGenerator%601

Declaration

public static IWorkflowBuilder WithGenerator<TSchemeMedium>(this WorkflowBuilder<TSchemeMedium> bulder, IWorkflowGenerator<TSchemeMedium> generator) where TSchemeMedium : class

Parameters

Type	Name	Description
WorkflowBuilder<<TSchemeMedium>>	bulder	The instance of the workflow builder
IWorkflowGenerator<<TSchemeMedium>>	generator	The instance of the workflow scheme generator <xref href="OptimaJet.Workflow.Core.Generator.IWorkflowGenerator%601" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
IWorkflowBuilder	Configured instance of the workflow builder

WithParser<TSchemeMedium>(WorkflowBuilder<TSchemeMedium>, IWorkflowParser<TSchemeMedium>)

Configures the workflow builder with specified workflow scheme parserOptimaJet.Workflow.Core.Parser.IWorkflowParser%601

Declaration

public static IWorkflowBuilder WithParser<TSchemeMedium>(this WorkflowBuilder<TSchemeMedium> bulder, IWorkflowParser<TSchemeMedium> parser) where TSchemeMedium : class

Parameters

Type	Name	Description
WorkflowBuilder<<TSchemeMedium>>	bulder	The instance of the workflow builder
IWorkflowParser<<TSchemeMedium>>	parser	The instance of the workflow scheme parser <xref href="OptimaJet.Workflow.Core.Parser.IWorkflowParser%601" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
IWorkflowBuilder	Configured instance of the workflow builder

WithShemePersistenceProvider<TSchemeMedium>(WorkflowBuilder<TSchemeMedium>, ISchemePersistenceProvider<TSchemeMedium>)

Configures the workflow builder with specified scheme persistence providerOptimaJet.Workflow.Core.Persistence.ISchemePersistenceProvider%601

Declaration

public static IWorkflowBuilder WithShemePersistenceProvider<TSchemeMedium>(this WorkflowBuilder<TSchemeMedium> builder, ISchemePersistenceProvider<TSchemeMedium> schemePersistenceProvider) where TSchemeMedium : class

Parameters

Type	Name	Description
WorkflowBuilder<<TSchemeMedium>>	builder	The instance of the workflow builder
ISchemePersistenceProvider<<TSchemeMedium>>	schemePersistenceProvider	The instance of the scheme persistence provider <xref href="OptimaJet.Workflow.Core.Persistence.ISchemePersistenceProvider%601" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
IWorkflowBuilder	Configured instance of the workflow builder

WithTimerManager(WorkflowRuntime, ITimerManager)

Configures the runtime with specified timer manager ITimerManager

Declaration

public static WorkflowRuntime WithTimerManager(this WorkflowRuntime runtime, ITimerManager timerManager)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
ITimerManager	timerManager	The instance of the timer manager <xref href="OptimaJet.Workflow.Core.Runtime.ITimerManager" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

WithCalendars(WorkflowRuntime, params ICalendar[])

Configures the runtime with specified work calendars

Declaration

public static WorkflowRuntime WithCalendars(this WorkflowRuntime runtime, params ICalendar[] calendars)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
OptimaJet.Workflow.Core.Runtime.Calendars.ICalendar[]	calendars	Work calendar instances

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

SetDefaultCalendar(WorkflowRuntime, string)

Set default work calendar to runtime

Declaration

public static WorkflowRuntime SetDefaultCalendar(this WorkflowRuntime runtime, string calendarName)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
string	calendarName	The Work calendar name

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

EnableCodeActions(WorkflowRuntime)

Enable code action and expression compilation in runtime

Declaration

public static WorkflowRuntime EnableCodeActions(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

WithExpressionsCompilerOptions(WorkflowRuntime, ExpressionsCompilerOptions)

Configure the behaviour of ExpressionsCompiler

Declaration

public static WorkflowRuntime WithExpressionsCompilerOptions(this WorkflowRuntime runtime, ExpressionsCompilerOptions options)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
ExpressionsCompilerOptions	options	Expressions compiler options

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

CodeActionsDebugOn(WorkflowRuntime)

Switch on compilation debug mode for code actions

Declaration

public static WorkflowRuntime CodeActionsDebugOn(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

DisableCodeActions(WorkflowRuntime)

Disable code action compillation in runtime

Declaration

public static WorkflowRuntime DisableCodeActions(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

RegisterAssemblyForCodeActions(WorkflowRuntime, Assembly, bool, Func<Type, bool>)

Register reference on assembly for compilation of code actions

Declaration

public static WorkflowRuntime RegisterAssemblyForCodeActions(this WorkflowRuntime runtime, Assembly assembly, bool ignoreForDesigner = false, Func<Type, bool> designerTypeFilter = null)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
Assembly	assembly	Assembly for register
bool	ignoreForDesigner	If true then types from the assembly will not be registered in the designer
Func<Type, bool>	designerTypeFilter	Function which filters a types for designer

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

SetParameterSerializerSettings(WorkflowRuntime, JsonSerializerSettings)

Changes a JsonSerializerSettings which are using to serialise parameters in runtime

Declaration

[Obsolete("Use ParametersSerializer.Settings to setup your custom Json serializer settings")]
public static WorkflowRuntime SetParameterSerializerSettings(this WorkflowRuntime runtime, JsonSerializerSettings settings)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
JsonSerializerSettings	settings	JsonSerializerSettings object

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

DeserializeParameter(WorkflowRuntime, string, Type)

Provides access to Workflow Engine .NET Persistence Process Parameters serialization mechanism

Declaration

[Obsolete("Use ParametersSerializer.Deserialize to deserialize a parameter")]
public static object DeserializeParameter(this WorkflowRuntime runtime, string serializedValue, Type parameterType)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
string	serializedValue	Serialized value
Type	parameterType	Parameter type

Returns

Type	Description
object	Deserialized object

SerializeParameter(WorkflowRuntime, object, Type)

Provides access to Workflow Engine .NET Persistence Process Parameters serialization mechanism

Declaration

[Obsolete("Use ParametersSerializer.Serialize to serialize a parameter")]
public static string SerializeParameter(this WorkflowRuntime runtime, object value, Type parameterType)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
object	value	Parameter value
Type	parameterType	Parameter type

Returns

Type	Description
string	Deserialized object

SetExecutionSearchOrder(WorkflowRuntime, ExecutionSearchOrder)

Sets the order of the Action, Condition, or Rule search by name

Declaration

public static WorkflowRuntime SetExecutionSearchOrder(this WorkflowRuntime runtime, ExecutionSearchOrder order)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
ExecutionSearchOrder	order

Returns

Type	Description
WorkflowRuntime

SetIgnoreMissingExecutionItems(WorkflowRuntime, bool)

Declaration

[Obsolete("If you are sure that your schemes do not mention nonexistent Actions, Conditions or Rules, do not use this setting. This setting is only for resolving possible compatibility issues and can be removed.")]
public static WorkflowRuntime SetIgnoreMissingExecutionItems(this WorkflowRuntime runtime, bool value)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
bool	value

Returns

Type	Description
WorkflowRuntime

WithRuleProvider(WorkflowRuntime, IWorkflowRuleProvider, List<string>)

Adds specified rule provider IWorkflowRuleProvider to the runtime

Declaration

public static WorkflowRuntime WithRuleProvider(this WorkflowRuntime runtime, IWorkflowRuleProvider ruleProvider, List<string> schemes = null)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
IWorkflowRuleProvider	ruleProvider	The instance of the rule provider <xref href="OptimaJet.Workflow.Core.Runtime.IWorkflowRuleProvider" data-throw-if-not-resolved="false"></xref>
List<string>	schemes	The list of schemes for which the provider is added

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

ClearRuleProvider(WorkflowRuntime)

Resets Rule provider to default value (EmptyWorkflowRuleProvider)

Declaration

public static WorkflowRuntime ClearRuleProvider(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	Configured instance of the workflow runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

WithActionProvider(WorkflowRuntime, IWorkflowActionProvider, List<string>)

Adds specified action provider IWorkflowActionProvider in the runtime

Declaration

public static WorkflowRuntime WithActionProvider(this WorkflowRuntime runtime, IWorkflowActionProvider workflowActionProvider, List<string> schemes = null)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
IWorkflowActionProvider	workflowActionProvider	The instance of the action provider <xref href="OptimaJet.Workflow.Core.Runtime.IWorkflowActionProvider" data-throw-if-not-resolved="false"></xref>
List<string>	schemes	The list of schemes for which the provider is added

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

ClearActionProvider(WorkflowRuntime)

Resets Action provider to default value (EmptyWorkflowActionProvider)

Declaration

public static WorkflowRuntime ClearActionProvider(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	Configured instance of the workflow runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

WithExternalParametersProvider(WorkflowRuntime, IWorkflowExternalParametersProvider, List<string>)

Adds specified external parameters provider IWorkflowExternalParametersProvider in the runtime

Declaration

public static WorkflowRuntime WithExternalParametersProvider(this WorkflowRuntime runtime, IWorkflowExternalParametersProvider externalParametersProvider, List<string> schemes = null)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
IWorkflowExternalParametersProvider	externalParametersProvider	The instance of the external parameters provider <xref href="OptimaJet.Workflow.Core.Runtime.IWorkflowExternalParametersProvider" data-throw-if-not-resolved="false"></xref>
List<string>	schemes	The list of schemes for which the provider is added

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

ClearExternalParametersProvider(WorkflowRuntime)

Resets external parameters provider to default value (EmptyWorkflowExternalParametersProvider)

Declaration

public static WorkflowRuntime ClearExternalParametersProvider(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	Configured instance of the workflow runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

WithLocalizationProvider(WorkflowRuntime, ILocalizationProvider)

Adds specified ILocalizationProvider in the runtime

Declaration

public static WorkflowRuntime WithLocalizationProvider(this WorkflowRuntime runtime, ILocalizationProvider provider)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
ILocalizationProvider	provider	The instance of the implemented <xref href="OptimaJet.Workflow.Core.Runtime.ILocalizationProvider" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

ClearLocalizationProvider(WorkflowRuntime)

Resets ILocalizationProvider to default value (null)

Declaration

public static WorkflowRuntime ClearLocalizationProvider(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	Configured instance of the workflow runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

WithDesignerAutocompleteProvider(WorkflowRuntime, IDesignerAutocompleteProvider, List<string>)

Adds specified autocomplete provider (only for the Designer) IDesignerAutocompleteProvider in the runtime

Declaration

public static WorkflowRuntime WithDesignerAutocompleteProvider(this WorkflowRuntime runtime, IDesignerAutocompleteProvider autocompleteProvider, List<string> schemes = null)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
IDesignerAutocompleteProvider	autocompleteProvider	The instance of the autocomplete provider <xref href="OptimaJet.Workflow.Core.Runtime.IDesignerAutocompleteProvider" data-throw-if-not-resolved="false"></xref>
List<string>	schemes	The list of schemes for which the provider is added

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

ClearDesignerAutocompleteProvider(WorkflowRuntime)

Resets Designer Autocomplete Provider to default value (null)

Declaration

public static WorkflowRuntime ClearDesignerAutocompleteProvider(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	Configured instance of the workflow runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

WithDesignerParameterFormatProvider(WorkflowRuntime, IDesignerParameterFormatProvider, List<string>)

Adds specified parameter format provider (only for the Designer) IDesignerParameterFormatProvider in the runtime

Declaration

public static WorkflowRuntime WithDesignerParameterFormatProvider(this WorkflowRuntime runtime, IDesignerParameterFormatProvider designerParameterFormatProvider, List<string> schemes = null)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
IDesignerParameterFormatProvider	designerParameterFormatProvider	The instance of the parameter format provider <xref href="OptimaJet.Workflow.Core.Runtime.IDesignerParameterFormatProvider" data-throw-if-not-resolved="false"></xref>
List<string>	schemes	The list of schemes for which the provider is added

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

ClearDesignerParameterFormatProvider(WorkflowRuntime)

Resets Designer Parameter Format Provider to default value (null)

Declaration

public static WorkflowRuntime ClearDesignerParameterFormatProvider(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	Configured instance of the workflow runtime

Returns

Type	Description
WorkflowRuntime	Configured instance of the workflow runtime

WithPlugins(WorkflowRuntime, List<string>, params IWorkflowPlugin[])

Registers plugins in the workflow runtime

Declaration

public static WorkflowRuntime WithPlugins(this WorkflowRuntime runtime, List<string> schemes, params IWorkflowPlugin[] plugins)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	Configured workflow runtime
List<string>	schemes	The list of schemes for which the plugins is added
OptimaJet.Workflow.Plugins.IWorkflowPlugin[]	plugins	>Plugins instances

Returns

Type	Description
WorkflowRuntime	Configured workflow runtime

WithPlugin(WorkflowRuntime, IWorkflowPlugin, List<string>)

Registers plugin in the workflow runtimeS

Declaration

public static WorkflowRuntime WithPlugin(this WorkflowRuntime runtime, IWorkflowPlugin plugin, List<string> schemes = null)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	Configured workflow runtime
IWorkflowPlugin	plugin	Plugin instance
List<string>	schemes	The list of schemes for which the plugin is added

Returns

Type	Description
WorkflowRuntime	Configured workflow runtime

AsSingleServer(WorkflowRuntime)

Use this method when the runtime is running in a single-server environment.

Declaration

public static WorkflowRuntime AsSingleServer(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime

Returns

Type	Description
WorkflowRuntime

AsSingleServer(WorkflowRuntime, SingleServerSettings)

Use this method when the runtime is running in a single-server environment.

Declaration

public static WorkflowRuntime AsSingleServer(this WorkflowRuntime runtime, SingleServerSettings settings)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
SingleServerSettings	settings

Returns

Type	Description
WorkflowRuntime

AsSingleServer(WorkflowRuntime, ISingleServerSettingsSource)

Use this method when the runtime is running in a single-server environment.

Declaration

public static WorkflowRuntime AsSingleServer(this WorkflowRuntime runtime, ISingleServerSettingsSource settingsSource)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
ISingleServerSettingsSource	settingsSource

Returns

Type	Description
WorkflowRuntime

WithProcessRestorer(WorkflowRuntime, IProcessRestorer)

Add the process restore that will run the procees after server failure.

Declaration

public static WorkflowRuntime WithProcessRestorer(this WorkflowRuntime runtime, IProcessRestorer restorer)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
IProcessRestorer	restorer

Returns

Type	Description
WorkflowRuntime

WithServiceRunner(WorkflowRuntime, IWorkflowServiceRunner)

Declaration

public static WorkflowRuntime WithServiceRunner(this WorkflowRuntime runtime, IWorkflowServiceRunner workflowServiceRunner)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
IWorkflowServiceRunner	workflowServiceRunner

Returns

Type	Description
WorkflowRuntime

WithProcessLogger(WorkflowRuntime, IProcessLogProvider)

Declaration

public static WorkflowRuntime WithProcessLogger(this WorkflowRuntime runtime, IProcessLogProvider processLogger)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
IProcessLogProvider	processLogger

Returns

Type	Description
WorkflowRuntime

ClearProcessRestorers(WorkflowRuntime)

Clear process restorers

Declaration

public static WorkflowRuntime ClearProcessRestorers(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime

Returns

Type	Description
WorkflowRuntime

AsMultiServer(WorkflowRuntime, IMultiServerSettingsSource)

Use this method when the runtime is running in a multi-server environment.

Declaration

public static WorkflowRuntime AsMultiServer(this WorkflowRuntime runtime, IMultiServerSettingsSource settingsSource)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
IMultiServerSettingsSource	settingsSource

Returns

Type	Description
WorkflowRuntime

AsMultiServer(WorkflowRuntime)

Use this method when the runtime is running in a multi-server environment.

Declaration

public static WorkflowRuntime AsMultiServer(this WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime

Returns

Type	Description
WorkflowRuntime

WithRuntimeSettings(WorkflowRuntime, WorkflowRuntimeSettings)

Change runtime settings

Declaration

public static WorkflowRuntime WithRuntimeSettings(this WorkflowRuntime runtime, WorkflowRuntimeSettings settings)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
WorkflowRuntimeSettings	settings

Returns

Type	Description
WorkflowRuntime

WithCustomActivities(WorkflowRuntime, List<ActivityBase>)

Registers custom activities in the workflow runtime

Declaration

public static WorkflowRuntime WithCustomActivities(this WorkflowRuntime runtime, List<ActivityBase> activities)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
List<ActivityBase>	activities

Returns

Type	Description
WorkflowRuntime

WithCustomConditions(WorkflowRuntime, List<FormBase>)

Registers custom conditions in the workflow runtime

Declaration

public static WorkflowRuntime WithCustomConditions(this WorkflowRuntime runtime, List<FormBase> conditions)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
List<FormBase>	conditions

Returns

Type	Description
WorkflowRuntime

WithCustomActivity(WorkflowRuntime, ActivityBase)

Registers custom activity in the workflow runtime

Declaration

public static WorkflowRuntime WithCustomActivity(this WorkflowRuntime runtime, ActivityBase activity)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
ActivityBase	activity

Returns

Type	Description
WorkflowRuntime

WithBPMNCustomDownload(WorkflowRuntime, BPMNCustomDownloadDelegate)

Declaration

public static WorkflowRuntime WithBPMNCustomDownload(this WorkflowRuntime runtime, BPMNCustomDownloadDelegate func)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
BPMNCustomDownloadDelegate	func

Returns

Type	Description
WorkflowRuntime

WithBPMNCustomUpload(WorkflowRuntime, BPMNCustomUploadDelegate)

Declaration

public static WorkflowRuntime WithBPMNCustomUpload(this WorkflowRuntime runtime, BPMNCustomUploadDelegate func)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
BPMNCustomUploadDelegate	func

Returns

Type	Description
WorkflowRuntime