This chapter is about how to use workflow configuration.
About:
The workflow config plugin is used in the context of camunda integration. In general, the use case is to start an instance of a camunda bpmn deployment.
In relation to an omn object or with defined parameters and values
Configuration:
-
Display pattern - The name of the started workflow instance, the placeholder will be evaluated in relation to the selected object(s)
-
Description - The description text can be used for backend purposes and in the case of existing "request on startup"-parameters, it is shown in the modal
-
Object type - define for which model class of omn the function is available
-
Workflow name - define on the base of which bpmn deployment an instance will be created (by name, always the last deployment will be used)
-
Workflow ID - define on the base of which bpmn deployment an instance will be created by id it will execute the same version every time
-
Parameters - define the provided parameters for the started instance
Key - name of the parameter type - datatype of the parameter FILE contains an object reference to the selected file LANGUAGE contains an object reference to an omn configured language Object type - only available in case of type FILE, define the type of allowed subclass Default value - define a default value that is assigned to a started instance, can be an entry of possible values column Possible values - only available in case of STRING, to provide a predefined set of values Placeholder - possible to enter evaluated expressions In the case of type FILE it can be used for "current selected object" In the case of type STRING it can be used for "current user" Allow multiple value - to define if a parameter can contain more than one entry, separated by "," in camunda Fallback - A value that is used, if no value was passed Read - Define if the value is shown in the startup modal during function execution Write - Define if the value is editable in the startup modal during function execution Request on startup - Define if the value is linked to the startup modal during function execution
-
Allow multiselection - define if the function is executable in case of multi-select, or not and if yes, which case
We support multiple cases of multiselection behavior - 0:1 means, start one process without any selection - 1:1 means, start one process for a single selection - n:1 means, start one for multiple selected objects - n:n equals means, start a single instance for each selected object, all with same additional parameter setting - n:n individual means, start a single instance for each selected object, all with possible individual additional parameter setting - n:m means, to be able to start for example 1 process for every 2 objects that are in selection (special usage for e.g. composings)