Workflow Management

Target release

Casablanca

Epic

Document status

DRAFT

Document owner

@Srinivasa Vellanki

Designer

Developers

QA

Goals

  • Enable Designers(Service Designer, VNF Owner or TechOps) to be able to Manage Workflows

Background and strategic fit

ONAP Workflow Designer High Level Overview



Assumptions

.

Requirements

Title

User Story

Importance

Notes

Title

User Story

Importance

Notes

1

Create a Workflow

As a Designer I want to be able to create a Workflow

Specify

  1. Name

  2. Description

  3. Input and Output Parameters (basic data-types)

  4. Workflow

Must Have



2

Search Workflow

As a Designer I want to be able to search Workflows based on Name.

Must Have 

 

3

List Workflows 

As a Designer I want to be able to see list of workflows, filter them along with and similar to other SDC entities like VF and Service in Catalog and Home 

Must Have 

 

4

View Workflow

As a Designer I want to be able to view Workflow details like Name, Inputs, Outputs and the workflow

Must Have 

 

5

Edit Workflow Definition

As a Designer I want to be able to create a new major version of the workflow and modify Name of the workflow, Input and Output Parameters (basic data-types) and the workflow.

Nice to Have 

 

6

Edit Workflow Implementation

As a Designer I want to be able to create a new minor version of the workflow and modify the workflow.

Workflow Definition cannot be edited as part of Workflow minor version

  1. Name

  2. Description

  3. Inputs and Outputs

Must Have 

 

7

Copy(Save As) Workflow

As a Designer I want to be able to copy a workflow and save with a different Name. i.e., create a new workflow based on the data from an existing workflow

Nice to Have 

 

8

Certify Workflow 

As a Designer I want to be able to certify a workflow for completeness.

  1. No broken ends

  2. Validate all the mandatory inputs to the Activities are supplied from the Workflow.

Must Have 

 

9

Distribute Workflow

As a User (role configurable) I want to be able to distribute a workflow

Must Have 

 

10

Search Workflow API 

API to search workflows 

Must Have 

 

11

Get Workflow API 

API to fetch workflow details like

  1. Name

  2. Description

  3. Inputs and Outputs

  4. Workflow Artifact Reference

Must Have 

 

12

 Sub-Flows

As a Designer I should be able to use a workflow as a sub-process

Nice to Have 

 

User interaction and design

Questions

Below is a list of questions to be addressed as a result of this requirements document:

Question

Outcome

Question

Outcome

Do we need to support categorization of workflows?

 

 

Not Doing