Flow Creation

Introduction

Each Flow is made up of Stages. Each Stage is further divided into Tasks. In the below example, Flow has three Stages. Stage 1 has two tasks. Stage 2 has three Tasks and Stage 3 has only one Task.

Flow Structure

Task

Task is the basic building block for flow creation. You can group one or more Tasks while creating a Stage.

Content

Each Task must be created with mandatory properties from Task Interface

interface Task {
    name: string
    controllerName:string
    userAction: UserAction
    userInput: UserInput
    resource: string
    _id?: string
    type?: string
    createdDate?: string
}

Task Creation from Client App

Stage

A Stage is created by grouping one or more Tasks. In turn, one or more Stages can be grouped together while creating a Flow.

Content

Each Stage must be created with mandatory properties from Stage Interface

export interface Stage{
    _id?: string,
    tasks: string[],
    detailTasks?:Task[]
    createdDate?: string,
    name: string,
    canSkip: Boolean,
    hostConsentToProceed: Boolean
}

Stage Creation from Client App

Flow

A Flow is created by grouping one or more Stages.

Content

Each Flow must be created with mandatory properties from Flow Interface

export interface Flow{
    _id?: String,
    stages: string[],
    createdDate?: string,
    name: string,
    hostCanAbort: Boolean
}

Flow Creation from Client App