Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameData TypeRequiredDescriptionComment
id
String
Yes
Unique UUID of the workflow

name
String
YesName of the workflow
version
String
Noversion of the workflow
description
String
Nodescription of the workflow
sceneEnumYes

the scene of the workflow designer. Valid value as follow:

vnf - open a VNF's workflow

service - open a Service's workflow

different scene may has different activities extend.
data
Object
YesThe workflow contentfor new workflow, the data field maybe empty.

...

Sample:

Code Block
languagexml
titleA New Workflow (Empty):
{
    "id":"activity-id",
    "name":"Upgrade Image",
    "version":"1.0",
    "description":"Upgrade Image",
    "scene":"vnf",
    "data":{

    }
}

...

Name

Data Type

Required

Description

Comment

classStringYesThe implement class of the bpmn service task

inputs

Map<String, Input>

No

The input parameter definitions of the task.

key - Input parameter name

value - Input parameter definition

These parameters will dispaly on UI for designer to fullfill.

Sample:

Code Block
languagexml
collapsetrue
[
    {
        "id":"extend-activity-id",
        "name":"Stop Traffic",
        "description":"Stop Traffic",
        "type":"serviceTask",
        "icon":{
            "name":"stop-traffic",
            "width":56,
            "height":56
        },
        "activity":{
            "class":"org.onap.activity.ext.StopTrafficServiceTask",
            "inputs":{
                "param1":{
                    "type":"string",
                    "default":"value1",
                    "required":true,
                    "constraints":[

                    ],
                    "displayName":"aaa",
                    "show":true
                },
                "param2":{
                    "type":"string",
                    "default":"value2",
                    "required":false,
                    "constraints":[

                    ]
                }
            }
        }
    }
]

...

Name

Data Type

Required

Description

Comment

scriptFormat

String

Yes

The script format, For example: javascript, groovy


script

String

Yes

The script content.


Sample:

Code Block
languagexml
collapsetrue
[
    {
        "id":"extend-activity-id-stop-vnf",
        "name":"Stop VNF",
        "description":"Stop VNF",
        "type":"scriptTask",
        "icon":{
            "name":"stop-vnf",
            "width":56,
            "height":56
        },
        "activity":{
            "scriptFormat":"Groovy",
            "script":"test groovy script"
        }
    }
]

...