Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Class Designer

OptimaJet.Workflow.Designer

Extension which provides API for HTML5 Workflow Designer

Namespace: OptimaJet.Workflow

public static class Designer

Inheritance

  • System.Object

Properties

Name
Type
ProcessHistoryPageSize #
Int32

Methods

public static string DesignerAPI(this WorkflowRuntime runtime, NameValueCollection form, out bool hasError, Stream fileStream = null, bool setIsObsoleteForOperationSave = true) #
API for HTML5 Workflow Designer. Contains following operations: - bool exists(schemecode, schemeid, processid) Checks existence of the scheme of the process with specific code, id or id of the process - JSON load(schemecode, schemeid, processid) Returns the scheme of the process in JSON format by specific code, id or id of the process - JSON save(schemecode, data) Saves the scheme with specified code. Ruturns updated scheme. - JSON uploadscheme(filestream) Converts scheme uploaded as XML file to JSON. - XML downloadscheme(data) Converts scheme from JSON object to XML. - object compile(data) Method for test compile of code actions - JSON getemptytype(typename) returns serialized empty type - array getautocompletesuggestions (category, value) returns a list of autocomplete suggestions - JSON uploadschemebpmn(filestream) Converts BPMN scheme uploaded as XML file to JSON. - XML downloadschemebpmn(data) Converts BPMN scheme from JSON object to XML. Type of the operation determined by "operation" parameter from request parameters

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The instance of the runtime
form
NameValueCollection
Parameters from request. Allowed parameters is: "operation", "schemecode", "schemeid", "processid", "data"
hasError
Boolean
If true the result contains info about an exception
fileStream
Stream
Stream which represent uploaded file
setIsObsoleteForOperationSave
Boolean
If true and operation is "save" IsObsolete property will be set to all shemes of processes with specified code

Returns

Type
Description
String
Operation execution result
public static Task<(string result, bool hasError)> DesignerAPIAsync(this WorkflowRuntime runtime, NameValueCollection form, Stream fileStream = null, bool setIsObsoleteForOperationSave = true) #
API for HTML5 Workflow Designer. Contains following operations: - bool exists(schemecode, schemeid, processid) Checks existence of the scheme of the process with specific code, id or id of the process - JSON load(schemecode, schemeid, processid) Returns the scheme of the process in JSON format by specific code, id or id of the process - JSON save(schemecode, data) Saves the scheme with specified code. Ruturns updated scheme. - JSON uploadscheme(filestream) Converts scheme uploaded as XML file to JSON. - XML downloadscheme(data) Converts scheme from JSON object to XML. - object compile(data) Method for test compile of code actions - JSON getemptytype(typename) returns serialized empty type - array getautocompletesuggestions (category, value) returns a list of autocomplete suggestions - JSON uploadschemebpmn(filestream) Converts BPMN scheme uploaded as XML file to JSON. - XML downloadschemebpmn(data) Converts BPMN scheme from JSON object to XML. Type of the operation determined by "operation" parameter from request parameters

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The instance of the runtime
form
NameValueCollection
Parameters from request. Allowed parameters is: "operation", "schemecode", "schemeid", "processid", "data". Look at RequestElements
fileStream
Stream
Stream which represent uploaded file
setIsObsoleteForOperationSave
Boolean
If true and operation is "save" IsObsolete property will be set to all shemes of processes with specified code

Returns

Type
Description
Task<Boolean>
Operation execution result
public static void RegisterTypesFromAssembly(Assembly assembly, Func<Type, bool> filter = null) #

Parameters

Name
Type
Description
assembly
Assembly
filter
Func<Boolean>