...
Name | Data Type | Required | Description | Comment |
---|---|---|---|---|
name | String | Yes | Category name. | |
collapse | Boolean | No | Do you collapse this category by default? |
Data Model
WorkflowInfo
Name | Data Type | Required | Description | Comment |
---|---|---|---|---|
id | String | Yes | Unique UUID of the workflow | |
name | String | Yes | Name of the workflow | |
version | String | No | version of the workflow | |
description | String | No | description of the workflow | |
scene | Enum | Yes | the scene of the workflow designer. Valid value as follow: resource - open a VNF's workflow service - open a Service's workflow | different scene may has different activities extend. |
data | String | Yes | The workflow content | for new workflow, the data field maybe empty. |
...
Name | Data Type | Required | Description | Comment |
---|---|---|---|---|
class | String | Yes | The implement class of the bpmn service task | |
inputsInput[] | Map<String, Input> | No | The input parameter definitions of the service task. These parameters will dispaly on UI for designer to fullfill. | |
mappingInputs | MappingInput[] | No | The mapping input parameter definitions of the service task. These parameters will tranform to the actual input parameters of the service task which will be executed on the workflow engine. | Only define the relationshipe between the actual input parameter and the UI dispalyed input parameter of the bpmn task. |
ScriptTask
Name | Data Type | Required | Description | Comment |
---|---|---|---|---|
format | String | Yes | The default script format, For example: javascript groovy | |
script | String | Yes | The default script content. |
...
Name | Data Type | Required | Description | Comment | |||||
---|---|---|---|---|---|---|---|---|---|
url | String | No | The URL of the REST API exposed through the API router. | Choose between the 'url' field and ('name', 'version') filed. | |||||
name | String | No | The microservcie name of the REST API. Only for the condition of access the REST API via MircoServiceBus. | ||||||
version | String | No | The microservcie version of the REST API. Only for the condition of access the REST API via MircoServiceBus. | In the condition of access the REST API via MircoServiceBus, The workflow engine can query the URL of the REST API exposed through the MircoServiceBus by name and version. | |||||
path | String | Yes | The path of the REST API relative to the API router exposed path. | ||||||
method | Enum | Yes | The method of the rest api to be called while the activity be executed on the workflow engine. Valid value as follow: get, post, put, delete | ||||||
headers | Map<Strting, String> | Yes | The header paramters of the rest api associated to the rest task. Map key is the header paramter name, such as 'Accept'.Map value is the header paramter name, such as ''application/json. | ||||||
inputsInput[] | Map<String, Input> | No | The input parameter definitions of the rest task. These parameters will dispaly on UI for designer to fullfill. | mappingInputs | MappingInput[] | No | The mapping input parameter definitions of the rest task. These parameters will tranform to the actual input parameters of the rest task which will be executed on the workflow engine. | Only define the relationshipe between the actual input parameter and the UI dispalyed input parameter of the bpmn task. |
Input
Name | Data Type | Required | Description | Comment | ||||
---|---|---|---|---|---|---|---|---|
name | String | Yes | Input paramter name | |||||
dataTypetype | Enum | Yes | data type of the input paramter. Valid value as follow: string, integer, float, boolean, enum | required | boolean | Yes | Should the input paramter be necessary? true - necessary false - not necessary | |
default | any | No | the default value of the input paramter. | |||||
enumValuerequired | String[]boolean | NoYes | Should the enum value of the paramter. only need when the dataType of the paramter is 'enum'. |
MappingInput
Define the relationshipe between the actual input parameter and the UI dispalyed input parameter of the bpmn task.
input paramter be necessary? true - necessary false - not necessary | ||||||||||||
constraints | ||||||||||||
show | boolean | No | Is it displayed in the UI? | |||||||||
Name | Data Type | Required | Description | Comment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
name | String | Yes | The actual parameter name of the bpmn task. | valueType | Enum | Yes | Type of the 'Value' field, Valid Value as follow: fixed - fixed value, suck as 'abc', 123 reference - name of the UI displayed parameter referenced | value | any | No | fixed value or UI displayed parameter name referenced. such as: "abc" –fixed 123 --fixed true –fixed [Name] - UI displayed parameter name |