Class Designer
OptimaJet.Workflow.Designer
Provides WorkflowRuntime extension methods that process Workflow Designer requests.
Namespace: OptimaJet.Workflow
public static class DesignerProperties
public static int ProcessHistoryPageSize { get; } #Gets the default number of process history entries loaded per page for Workflow Designer responses.
Methods
public static string DesignerAPI(this WorkflowRuntime runtime, NameValueCollection form, out bool hasError, Stream fileStream = null, bool setIsObsoleteForOperationSave = true) #Executes a Workflow Designer API operation synchronously.
Parameters
Name
Type
Description
hasErrorBooleansetIsObsoleteForOperationSaveBooleantrue to mark the saved process scheme and process schemes that inline it as obsolete after a successful Operations.save operation; false to skip this obsolescence update.
Returns
Type
Description
StringThe serialized operation response.
Remarks
The operation is selected from form by using the RequestElements.operation entry. The following built-in operations are supported:
- Operations.exists checks whether the process scheme selected by RequestElements.schemecode, RequestElements.schemeid, or RequestElements.processid exists.
- Operations.load returns the selected process scheme for editing, or creates an empty scheme named by RequestElements.newschemecode when no existing scheme is selected.
- Operations.save saves the process scheme supplied through RequestElements.data under RequestElements.schemecode and returns the saved scheme prepared for continued editing.
- Operations.uploadscheme reads an XML process scheme from
fileStreamand returns it as a Designer process definition without saving it. - Operations.downloadscheme converts the process definition supplied through RequestElements.data to XML.
- Operations.getpluginsnames returns the names of enabled plugins registered in the runtime.
- Operations.getcustomactivities returns the enabled custom activities registered in the runtime.
- Operations.getprocesslogs returns process log entries selected by RequestElements.processid and the log query supplied through RequestElements.data.
- Operations.getprocesshistorypage returns a page of process history selected by RequestElements.processidforrequest, RequestElements.pagingindex, and RequestElements.pagingsize.
- Operations.getlogenabledstate returns whether logging is enabled for the process selected by RequestElements.processid.
- Operations.getuseridentities returns user names and their workflow participant identities, filtered and paged by RequestElements.name, RequestElements.pagingindex, and RequestElements.pagingsize.
- Operations.changelogenabled toggles logging for the process selected by RequestElements.processid and returns the new state.
- Operations.insertscheme inserts the XML scheme supplied through
insertedschemeinto the process definition in RequestElements.data, positioning it withposxandposy, and returns the combined definition. - Operations.compile tests compilation of the code action supplied through RequestElements.data and returns the compilation result.
- Operations.perform tests compilation of RequestElements.expression using the result type selected by RequestElements.expressiontype.
- Operations.getemptytype creates and serializes an empty instance of the .NET type named in RequestElements.data.
- Operations.getautocompletesuggestions returns Designer suggestions selected by RequestElements.category, RequestElements.value, and RequestElements.schemecode.
- Operations.getcodeactionparameter returns the Designer parameter definitions for the action, condition, or rule selected by RequestElements.type, RequestElements.name, and RequestElements.schemecode.
- Operations.deleteglobalcodeaction deletes the global code actions whose names are supplied as a JSON array through
namesand returns the deletion result. - Operations.getcodeautocomplete returns code-completion suggestions for the request supplied through RequestElements.data.
- Operations.getworkflowengineinstanceinfo returns licensing information for the current Workflow Engine instance.
- Operations.getcalendars returns the keys of calendars registered in the runtime.
- Operations.getworkflowengineinfo returns the Workflow Engine version together with the type, version, and enabled state of each registered plugin.
RequestElements.TenantId scopes scheme operations that support tenants. An operation name not defined by Operations can be handled by an IDesignerAction registered through WorkflowRuntime.RegisterDesignerAction(string, IDesignerAction).
public static Task<(string result, bool hasError)> DesignerAPIAsync(this WorkflowRuntime runtime, NameValueCollection form, Stream fileStream = null, bool setIsObsoleteForOperationSave = true) #Executes a Workflow Designer API operation asynchronously.
Parameters
Name
Type
Description
setIsObsoleteForOperationSaveBooleantrue to mark the saved process scheme and process schemes that inline it as obsolete after a successful Operations.save operation; false to skip this obsolescence update.
Returns
Type
Description
Task<String, Boolean>A Task<TResult> whose result contains the serialized operation response and a value that is true when the response represents an error.
Remarks
The operation is selected from form by using the RequestElements.operation entry. The following built-in operations are supported:
- Operations.exists checks whether the process scheme selected by RequestElements.schemecode, RequestElements.schemeid, or RequestElements.processid exists.
- Operations.load returns the selected process scheme for editing, or creates an empty scheme named by RequestElements.newschemecode when no existing scheme is selected.
- Operations.save saves the process scheme supplied through RequestElements.data under RequestElements.schemecode and returns the saved scheme prepared for continued editing.
- Operations.uploadscheme reads an XML process scheme from
fileStreamand returns it as a Designer process definition without saving it. - Operations.downloadscheme converts the process definition supplied through RequestElements.data to XML.
- Operations.getpluginsnames returns the names of enabled plugins registered in the runtime.
- Operations.getcustomactivities returns the enabled custom activities registered in the runtime.
- Operations.getprocesslogs returns process log entries selected by RequestElements.processid and the log query supplied through RequestElements.data.
- Operations.getprocesshistorypage returns a page of process history selected by RequestElements.processidforrequest, RequestElements.pagingindex, and RequestElements.pagingsize.
- Operations.getlogenabledstate returns whether logging is enabled for the process selected by RequestElements.processid.
- Operations.getuseridentities returns user names and their workflow participant identities, filtered and paged by RequestElements.name, RequestElements.pagingindex, and RequestElements.pagingsize.
- Operations.changelogenabled toggles logging for the process selected by RequestElements.processid and returns the new state.
- Operations.insertscheme inserts the XML scheme supplied through
insertedschemeinto the process definition in RequestElements.data, positioning it withposxandposy, and returns the combined definition. - Operations.compile tests compilation of the code action supplied through RequestElements.data and returns the compilation result.
- Operations.perform tests compilation of RequestElements.expression using the result type selected by RequestElements.expressiontype.
- Operations.getemptytype creates and serializes an empty instance of the .NET type named in RequestElements.data.
- Operations.getautocompletesuggestions returns Designer suggestions selected by RequestElements.category, RequestElements.value, and RequestElements.schemecode.
- Operations.getcodeactionparameter returns the Designer parameter definitions for the action, condition, or rule selected by RequestElements.type, RequestElements.name, and RequestElements.schemecode.
- Operations.deleteglobalcodeaction deletes the global code actions whose names are supplied as a JSON array through
namesand returns the deletion result. - Operations.getcodeautocomplete returns code-completion suggestions for the request supplied through RequestElements.data.
- Operations.getworkflowengineinstanceinfo returns licensing information for the current Workflow Engine instance.
- Operations.getcalendars returns the keys of calendars registered in the runtime.
- Operations.getworkflowengineinfo returns the Workflow Engine version together with the type, version, and enabled state of each registered plugin.
RequestElements.TenantId scopes scheme operations that support tenants. An operation name not defined by Operations can be handled by an IDesignerAction registered through WorkflowRuntime.RegisterDesignerAction(string, IDesignerAction).