Interface FlowModel

The detail definition of Flow (returned by interface).

See

FlowInputModel

interface FlowModel {
    actionCalls?: ActionCallNode[];
    active: boolean;
    assignments?: AssignmentNode[];
    breaks?: BreakNode[];
    catalogue?: string;
    constants?: Constant[];
    decisions?: DecisionNode[];
    description?: string;
    enableStat?: boolean;
    event?: string;
    eventCriteria?: string;
    fastCreates?: FastCreateNode[];
    fastDeletes?: FastDeleteNode[];
    fastLookups?: FastLookupNode[];
    fastUpdates?: FastUpdateNode[];
    formulas?: Formula[];
    id: string;
    innerFlows?: (FlowInputModel & {
        active: true;
        private: true;
        version: string;
    })[];
    label: string;
    loops?: LoopNode[];
    name: string;
    processType: "Inner Flow" | "Autolaunched Flow" | "Event Trigger" | "Timer Trigger";
    recordCreates?: RecordCreateNode[];
    recordDeletes?: RecordDeleteNode[];
    recordLookups?: RecordLookupNode[];
    recordUpdates?: RecordUpdateNode[];
    startConnectPoint?: string;
    startElement: string;
    startX?: number;
    startY?: number;
    status: string;
    structs?: Struct[];
    subFlows?: SubFlowNode[];
    timerCriteria?: TimerCriteria;
    variables?: Variable[];
    version: string;
    waits?: WaitNode[];
}

Hierarchy (view full)

Properties

actionCalls? active assignments? breaks? catalogue? constants? decisions? description? enableStat? event? eventCriteria? fastCreates? fastDeletes? fastLookups? fastUpdates? formulas? id innerFlows? label loops? name processType recordCreates? recordDeletes? recordLookups? recordUpdates? startConnectPoint? startElement startX? startY? status structs? subFlows? timerCriteria? variables? version waits?

Properties

Optional actionCalls

actionCalls?: ActionCallNode[]

The nodes of action calls.

active

active: boolean

Check if the flow is active.

Optional assignments

assignments?: AssignmentNode[]

Optional breaks

breaks?: BreakNode[]

The break nodes.

Optional catalogue

catalogue?: string

Optional constants

constants?: Constant[]

The constants.

Optional decisions

decisions?: DecisionNode[]

The decisions nodes.

Optional description

description?: string

Optional enableStat

enableStat?: boolean

Enable flow runtime statistics.

Optional event

event?: string

The binding event, when processType is 'Event Trigger'.

Optional eventCriteria

eventCriteria?: string

The binding event criteria, when processType is 'Event Trigger'.

Optional fastCreates

fastCreates?: FastCreateNode[]

The nodes to create records via object variable.

Optional fastDeletes

fastDeletes?: FastDeleteNode[]

The nodes to remove records via object variable.

Optional fastLookups

fastLookups?: FastLookupNode[]

The nodes to lookup records via object variable.

Optional fastUpdates

fastUpdates?: FastUpdateNode[]

The nodes to update records via object variable.

Optional formulas

formulas?: Formula[]

The formulas.

id

id: string

The ID of the flow.

Optional innerFlows

innerFlows?: (FlowInputModel & {
    active: true;
    private: true;
    version: string;
})[]

The inner flows, can be referenced by sub flow nodes.

label

label: string

Optional loops

loops?: LoopNode[]

The loop nodes.

name

name: string

processType

processType: "Inner Flow" | "Autolaunched Flow" | "Event Trigger" | "Timer Trigger"

The process type.

Optional recordCreates

recordCreates?: RecordCreateNode[]

The nodes to create records.

Optional recordDeletes

recordDeletes?: RecordDeleteNode[]

The nodes to remove records.

Optional recordLookups

recordLookups?: RecordLookupNode[]

The nodes to lookup records.

Optional recordUpdates

recordUpdates?: RecordUpdateNode[]

The nodes to update records.

Optional startConnectPoint

startConnectPoint?: string

startElement

startElement: string

The name of the start element.

Optional startX

startX?: number

Optional startY

startY?: number

status

status: string

The compiled status.

Optional structs

structs?: Struct[]

The structs.

Optional subFlows

subFlows?: SubFlowNode[]

The nodes of subflows.

Optional timerCriteria

timerCriteria?: TimerCriteria

The binding event, when processType is 'Timer Trigger'.

Optional variables

variables?: Variable[]

The variables.

version

version: string

The version of the flow.

Optional waits

waits?: WaitNode[]

The wait nodes.

Settings

Member Visibility

Theme

On This Page

actionCallsactiveassignmentsbreakscatalogueconstantsdecisionsdescriptionenableStateventeventCriteriafastCreatesfastDeletesfastLookupsfastUpdatesformulasidinnerFlowslabelloopsnameprocessTyperecordCreatesrecordDeletesrecordLookupsrecordUpdatesstartConnectPointstartElementstartXstartYstatusstructssubFlowstimerCriteriavariablesversionwaits