Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Core

OptimaJet.Workflow

Classes

Extension which provides API for HTML5 Workflow Designer

OptimaJet.Workflow.Core

Classes

The class for implementation custom activities
A class that contains default persistence providers identifiers of the Workflow Engine.

Enums

Represents the base template which is used to edit the activity.
Policy for saving parameters to annotations.

OptimaJet.Workflow.Core.Builder

Classes

Represents a scheme build step
Represents the result of a build step execution
Base workflow builder, which convert not parsed process scheme SchemeDefinition<T> to the object model of a scheme of a process ProcessDefinition

Interfaces

Interface of a workflow builder, which convert not parsed process scheme SchemeDefinition<T> to the object model of a scheme of a process ProcessDefinition

Enums

Determines the order of the build steps

OptimaJet.Workflow.Core.Cache

Classes

Interfaces

Interface of a cache for parced processes ProcessDefinition

OptimaJet.Workflow.Core.CodeActions

Classes

Provides compillation of code actions
Provides invoke of code actions by name
Contain parts which can be used to compose common patterns and names which can be used for search in match.If add new group don't forget about name.If change names don't forget about name include pattern.

Interfaces

External compiller interface. System purpose only.

Enums

Structs

Code for compile by IExternalCompiler. System purpose only.

OptimaJet.Workflow.Core.Designer

Classes

Designer request for Extension actions IDesignerAction.
Designer response.
Represents the state of a process that is displayed in the designer. Attention! Don't use this class in your code. It can be changed in future versions.
The generator of the state of a process that is displayed in the designer. Attention! Don't use this class in your code. It can be changed in future versions.
Represents the state of a process that is displayed in the designer. Attention! Don't use this class in your code. It can be changed in future versions.

Interfaces

Extension action for the designer.

Enums

All Operations for DesignApi
Elements from Request

OptimaJet.Workflow.Core.Entities

Classes

Interfaces

OptimaJet.Workflow.Core.Execution

Classes

Represent execution request which contains conditions and actions
Represents a parameter mapping for an inline activity.

OptimaJet.Workflow.Core.Fault

Classes

Represents an exception raised when a workflow activity references an action that is not found in its scheme definition.
Represents an exception raised when a workflow scheme contains an activity with the specified name.
Represents an exception thrown when an activity-related item cannot be found in a workflow scheme.
Represents an exception that is thrown when a workflow scheme already contains an actor with the same name.
Represents an exception thrown when an actor cannot be found in a workflow scheme.
Provides common error messages used for argument validation failures.
Represents an exception raised when a workflow scheme already contains a code action with the same name and type.
Represents an error indicating that a requested column does not exist.
Represents an error that occurs when a command with the same name already exists in a scheme.
Represents an exception thrown when a command cannot be found in a workflow scheme.
Represents an exception thrown when a command is not valid for the current workflow operation.
Represents an exception that is thrown when a command is not valid for the current workflow state.
Represents an exception thrown when a command parameter with the same name already exists.
Represents an exception thrown when a command parameter cannot be found in a workflow scheme command.
Represents an exception that indicates a configuration-related error in the Workflow Engine.
Represents an exception that indicates runtime status cannot be set to the requested state.
Represents an exception thrown when a status cannot be set to the requested value.
Represents an exception that indicates scheme tags cannot be updated.
Represents an exception thrown when the initial activity cannot be found.
Represents an exception thrown when a workflow command cannot be executed because the command input is invalid for the current runtime state.
Signals that a JSON parameter value is invalid or cannot be parsed for the current operation.
The exception that is thrown when a parameter value is invalid.
Represents an exception thrown when a workflow parameter with the same name is already present in a scheme.
The exception thrown when a requested parameter is not found in a workflow scheme.
Represents an exception raised for persistence-provider query failures and carries flags that describe whether such failures can be retried or recovered.
Represents an exception thrown when an attempt is made to create or register a process that already exists.
Represents an exception that occurs during workflow process execution.
Represents an exception thrown when a requested process cannot be found.
Represents an exception raised when a workflow process scheme cannot be built.
Represents an exception raised when building a process scheme from an inline template fails.
Represents an exception thrown when a process does not belong to the current tenant.
Represents an exception thrown when a runtime waits too long for another runtime to complete its restore operation.
Indicates that the runtime reached an unexpected internal state.
Represents a missing workflow scheme for a specific lookup location.
Represents an exception that is thrown when a workflow scheme is not valid.
Represents an exception thrown when the current workflow runtime lock changed while a self-restore operation is being performed.
Represents an exception raised when the workflow runtime is in a shutdown state and cannot process operations.
Represents an exception that is thrown when a workflow status referenced by the runtime is not defined.
Represents an exception that is thrown when a timer with the same name already exists in a workflow scheme.
Represents an exception thrown when a timer manager operation in the workflow runtime fails.
Represents an exception that is thrown when a timer cannot be found in a workflow scheme.
Represents an exception that is raised when a workflow scheme already contains a transition with the specified name.
Represents an exception that is thrown when a workflow scheme transition already contains a condition with the specified name.
Represents an exception that is thrown when a transition condition cannot be found for the specified transition.
Represents an exception thrown when a transition cannot be found in a workflow scheme.
Represents an exception that is thrown when a transition restriction for a specific actor already exists in a workflow scheme.
Represents an exception that is thrown when a transition restriction cannot be found for a given actor in a workflow scheme.
Represents an exception thrown when a type string cannot be parsed into a valid Type.
Represents an error raised when an activity has a different type than the one expected by an operation.
The exception thrown when the parameter type declared in a workflow scheme cannot be parsed as a Type.
Represents an exception that is thrown when subprocess markup in a workflow definition is invalid.

Enums

Represents locations where a workflow scheme lookup can be attempted.

OptimaJet.Workflow.Core.Generator

Interfaces

Interface of a workflow generator, which generates not parsed process scheme SchemeDefinition<T>

OptimaJet.Workflow.Core.Helpers

Classes

OptimaJet.Workflow.Core.License

Classes

Interfaces

OptimaJet.Workflow.Core.Logging.Events

Enums

OptimaJet.Workflow.Core.Logging

Classes

Interfaces

OptimaJet.Workflow.Core.Model

Classes

Represent a reference on action in a process scheme
Represent an activity in a process scheme
Exceptions handler for activity
Timeout for set Due date
Represent an actor in a process scheme
Represent an annotation than can be attached to ActivityDefinition or TransitionDefinition
Represent a base object in a process scheme
Represent a code action in a process scheme
Represents a parameter for code action
Represent a command in a process scheme
Represent a transition's condition in a process scheme
Represent settings used by Workflow Designer
A name-value pair for a ParameterType.Dropdown parameter
Dynamic parameter, properties can be accessed two ways de["propertyName"] or (de as dynamic).propertyName Property names are case sensitive
Converts an object to and from JSON.
Response with pagination
Represent a parameter in a process scheme
Represents a named reference on a parameter in a process scheme
Represent a parameter in a process scheme with value
Represent a collection of process's parameters
Immutable batch of parameters to persist with flag management. Centralizes filtering, serialization, and flag update logic from providers to Core.
Represents object model of a scheme of a process
Represent a instance of a specific process
Extension methods for process tenant-bound global parameter operations.
Represent a transition's restiction in a process scheme
Represent a not parsed process scheme
Immutable DTO representing a serialized parameter ready for persistence.
Represent a timer in a process scheme
Represent a transition in a process scheme
Represent a localization record in a process scheme
Represent a transition's trigger in a process scheme

Interfaces

The interface that a class should implement for quick conversion to DynamicParameter
Defines the properties available for inline activity
Defines the properties available for ordinary activity

Enums

Activity type
Type of a code action which determine a area of use of a code action
Conditions and restrictions concatenation type
Type of condition for triggering of transition
Type of localized resource
Specifies the method of storing parameters
Type of a code action parameter
Type of transition's restriction
Desired persistence operation for a parameter.
Type of a timer
Classifier of the direction of the transition
Type of transition in terms of subprocesses
Type of impact that lead to the triggering of a transition

OptimaJet.Workflow.Core.Model.ApprovalMap

Classes

Simplified representation of ActivityDefinition. Use like data transfer object
Simplified representation of TransitionDefinition. Use like data transfer object

OptimaJet.Workflow.Core.Model.Builder

Classes

Provides methods to build and manipulate a workflow process definition

Interfaces

Represents a builder for configuring an activity.
Represents a builder for configuring exception handling for an activity.
Represents a builder for configuring an activity implementation.
Represents a builder for configuring an actor.
Represents a base builder for configuring an activity.
A builder interface for configuring a CodeActionDefinition.
Represents a builder for configuring a command.
Represents a builder for configuring a command parameter.
Represents a builder for configuring an activity timeout.
Represents a builder for configuring an idle timeout.
Represents a builder for configuring an inline activity.
Represents a builder for configuring a parameter definition.
Represents a builder for configuring a process definition.
Represents a builder for configuring a timer definition.
Represents a builder for configuring a transition definition.
Represents a builder for configuring a transition command.
Represents a builder for configuring a transition condition.
Represents a builder for configuring transition conditions.
Represents a builder for configuring a transition expression.
Represents a builder for configuring a parallel finalize transition.
Represents a builder for configuring a parallel start transition.

OptimaJet.Workflow.Core.Parser

Classes

Base workflow parser, which parses not parsed process scheme SchemeDefinition<T> to the object model of a scheme of a process ProcessDefinition
Base workflow parser, which parses not parsed process scheme serialized to XML to the object model of a scheme of a process ProcessDefinition

Interfaces

Interface of a workflow parser, which parses not parsed process scheme SchemeDefinition<T> to the object model of a scheme of a process ProcessDefinition

OptimaJet.Workflow.Core.Persistence

Classes

Options for creating an instance of relational persistence provider
Represent a stage of a life cycle of a process
Scheme persistence in file system.
Sort settings
Provides tenant-bound global parameter operations.
Identifies a tenant-scoped global parameter.
Identifies a tenant-scoped group of global parameters.

Interfaces

Interface of a form data provider, which provide storing forms
Interface of a persistence provider, which provide storing of process's instance specific parameters and global parameters
Provides save and load of workflow runtime parameters. as timers etc
Interface of a persistence provider, which provide storing of schemes

Enums

OptimaJet.Workflow.Core.Plugins.BasicsPlugin.ActorProviders

Interfaces

Allows to thread-safely control collections of actors grouped by schemes.

OptimaJet.Workflow.Core.Plugins

Classes

Set of methods for convert plugin actions to workflow actions

Delegates

OptimaJet.Workflow.Core.Plugins.BasicsPlugin

Classes

OptimaJet.Workflow.Core.Plugins.LoopsPlugin.Other

Classes

OptimaJet.Workflow.Core.PredefinedActions

Classes

Contains all predefined actions

OptimaJet.Workflow.Core.Runtime

Classes

Base class for all aggregating providers
Represent information about an activity which was planned to execute, contains ProcessInstance object
Object that represents information which is required for mass creation of processes
Auxiliary parameters that configure bulk operations.
The result of command execution
Represent a command parameter for use in an application
Represents parameters for creation of an instance of a process
Represents an empty designer autocomplete provider.
Represents an empty designer parameter format provider.
Empty action provider for system purpose
Empty external parameters provider
Empty rule provider for system purpose
Represents parameters for getting initial commands of a process scheme
Represents parameters for getting state information by Scheme code
Represent information about an activity which was set as a current acivity of process, contains ProcessInstance object
Represents a record of transition of process from one Activity to another
Represent information about changed status of a process
Timer of a process
Represents parameters for resume the process
The result of resume execution
Provides data for the RuntimeStart event.
Represent information about changed scheme of a process
Represents parameters for creation of an instance of a process
Represent information about case when we try to update a subprocess's scheme but there are no starting transition in a new sccheme of a root process
Represent a timer information
Represent a timer to register in persistence store
Represents a workflow command for use in an application
Represents information about an error occurred due to execution of a workflow process
Provides main API to operations with workflow processes
Runtime API for bulk operations
Workflow Runtime API extension for GetActors methods
Workflow Runtime API extension for GetActors methods
Extension methods for tenant-bound global parameter operations.
Represent a state of a process for use in an application

Interfaces

Interface for parameter format provider (only for the Designer)
Manages the lifecycle and registration of timers within a workflow runtime.
Interface of a action provider, which provide execution of actions specified in activities ActivityDefinition.Implementation and ActivityDefinition.PreExecutionImplementation and execution of conditions ConditionDefinition.Action
Interface of a rule provider, which provide rule checking and getting of a list of users which satisfies a rule TransitionDefinition.Restrictions

Enums

Describes the way of handling CancellationToken after activity execution.
Specifies the filtering strategy for action and condition name queries in workflow providers.

Delegates

OptimaJet.Workflow.Core.Runtime.Bulk

Classes

Provides event data for the BulkAggregateTask<TId, TResult>.OnTaskFinalized event.
Represents the result of a bulk task execution. For tasks that have not finished, BulkTaskResult<TResult>.Empty is used.
Placeholder type used by bulk APIs that do not return a command-specific value.

Interfaces

Provides an API for executing WorkflowRuntime operations in bulk mode.

Enums

Describes the lifecycle state of a bulk task.

OptimaJet.Workflow.Core.Runtime.Calendars

Classes

Represents a work calendar.
Provides extension methods for configuring Calendar instances and calculating intervals using workflow calendar rules.
Represents a day of a month.
Represents the workday settings for a specific calendar date.
Represents workday settings for a calendar year.

Interfaces

Represents a calendar that defines workdays and working-time boundaries.

Enums

Represents the months of the calendar year.

OptimaJet.Workflow.Core.Runtime.CodeAutocomplete

Classes

Represents a node in the autocomplete tree used by code completion.
Represents a request for retrieving code autocomplete suggestions.
Represents one variable entry in the code autocomplete metadata model.
Aggregates, stores, and routes autocomplete requests to ICodeAutocompleter implementations.
Provides the default ICodeAutocompleter implementation.
Searches and caches available runtime types for code autocomplete.

Interfaces

Provides access to code autocomplete providers and methods for registering, initializing, and querying completion data.
Provides an abstraction for components that can provide code completion suggestions.
Provides access to discover and cache runtime types used by code autocomplete.

Enums

Defines the kind of element represented by an autocomplete suggestion item.

OptimaJet.Workflow.Core.Runtime.ProcessRestoring

Classes

Represents a decision that controls how a process is restored.

Interfaces

Provides a customization point for process recovery after runtime restart.

Enums

Specifies the strategy used when restoring a process instance.

OptimaJet.Workflow.Core.Runtime.ServiceRunners

Classes

Provides multi-server process restoring behavior by delegating restore execution to RestorerBase.
Provides a service runner implementation for multi-server workflow runtime execution.
Provides shared logic for creating asynchronous restore operations for workflow process instances.
Provides single-server process restoring behavior by delegating restore execution to RestorerBase.
Provides a service runner implementation for single-server workflow runtime execution.

Interfaces

Defines how a workflow runtime starts and configures its service loop.

OptimaJet.Workflow.Core.Runtime.Settings

Classes

Default settings source implementation for MultiServerSettings.
Represents the default implementation of IServerSettingsSource<T>. It loads and persists settings of type T from runtime global storage.
Default settings source implementation for SingleServerSettings.
Provides an in-memory implementation of IServerSettingsSource<T> for settings of type T.
Represents configuration settings for multi-server runtime behavior.
Provides configuration settings for single-server runtime operation.

Interfaces

Provides server settings operations for MultiServerSettings.
Represents an asynchronous source that provides and persists workflow server settings.
Provides server settings operations for SingleServerSettings.

OptimaJet.Workflow.Core.Runtime.Timers

Classes

Provides timer processing for workflow runtime instances.

Enums

Defines timer categories used by the workflow runtime.

OptimaJet.Workflow.Core.Subprocess

Classes

Algorithms for subprocesses branches
Specifies the current process and the method of searching in the Process Instances tree

Enums

Specifies which kind of nodes will be included in search
Specifies starting point of search something in the Process Instance Tree

OptimaJet.Workflow.Core.TestTrace

Classes

OptimaJet.Workflow.Core.Utils

Classes

Delegates

OptimaJet.Workflow.Core.Utils.OneOf

Classes

Interfaces

Structs

OptimaJet.Workflow.Plugins.Activity

Classes

OptimaJet.Workflow.Plugins

Classes

Interfaces

Describes a plugin for the Workflow Engine.

Enums

Delegates

OptimaJet.Workflow.Plugins.ApprovalsPlugin

Classes

Enums

OptimaJet.Workflow.Plugins.ApproversProvider

Classes

Represent a structure to store sightings as workflow parameter

OptimaJet.Workflow.Plugins.BasicsPlugin

Enums

OptimaJet.Workflow.Plugins.CustomWorkflowProviders

Classes

Interfaces

Delegates

OptimaJet.Workflow.Plugins.LoopsPlugin

Classes

Enums