Table of Contents

Interface WorkflowStep

A workflow step (code-sequence) to run before/after specific events.

WorkflowStep

you are here (click to zoom) - discover the stack

The workflow step contains

  1. a command for which it will trigger
    1. see the Commands List
    2. There is also a special command called refresh which isn't a normal command used on a button, but an internal command called when refreshing the page through reload or ajax. This too can be handled and cancelled
  2. a phase (before/after) - possible phase values: before, after, all
  3. a code what is to be done

See also: CMS Command Workflows for Commands and Toolbars

History

  1. Introduced in 2sxc 11.12
  2. Enhanced so it also works on inline toolbars in v12.10
Package: Api.Js.SxcJs

Properties

code

The code which is run, must be a promise-factory. So it's a function that will return a promise. Required. See Function Signature WorkflowStepCode

WorkflowStep

you are here (click to zoom) - discover the stack

The workflow step contains

  1. a command for which it will trigger
    1. see the Commands List
    2. There is also a special command called refresh which isn't a normal command used on a button, but an internal command called when refreshing the page through reload or ajax. This too can be handled and cancelled
  2. a phase (before/after) - possible phase values: before, after, all
  3. a code what is to be done

See also: CMS Command Workflows for Commands and Toolbars

History

  1. Introduced in 2sxc 11.12
  2. Enhanced so it also works on inline toolbars in v12.10
Declaration
code: (args: WorkflowStepCodeArguments) => WorkflowStepCodeArguments
Property Value
Type Description
(args: WorkflowStepCodeArguments) => WorkflowStepCodeArguments

command

The action this step is for, can be 'any', 'edit', etc. Will be 'all' by default

WorkflowStep

you are here (click to zoom) - discover the stack

The workflow step contains

  1. a command for which it will trigger
    1. see the Commands List
    2. There is also a special command called refresh which isn't a normal command used on a button, but an internal command called when refreshing the page through reload or ajax. This too can be handled and cancelled
  2. a phase (before/after) - possible phase values: before, after, all
  3. a code what is to be done

See also: CMS Command Workflows for Commands and Toolbars

History

  1. Introduced in 2sxc 11.12
  2. Enhanced so it also works on inline toolbars in v12.10
Declaration
command: string
Property Value
Type Description
string

name

The name of this step, in case it needs to be replaced or somehow controlled Will be empty by default

WorkflowStep

you are here (click to zoom) - discover the stack

The workflow step contains

  1. a command for which it will trigger
    1. see the Commands List
    2. There is also a special command called refresh which isn't a normal command used on a button, but an internal command called when refreshing the page through reload or ajax. This too can be handled and cancelled
  2. a phase (before/after) - possible phase values: before, after, all
  3. a code what is to be done

See also: CMS Command Workflows for Commands and Toolbars

History

  1. Introduced in 2sxc 11.12
  2. Enhanced so it also works on inline toolbars in v12.10
Declaration
name?: string
Property Value
Type Description
string

phase

Action-phase being run, like 'all', 'before', 'after' will be 'before' by default

WorkflowStep

you are here (click to zoom) - discover the stack

The workflow step contains

  1. a command for which it will trigger
    1. see the Commands List
    2. There is also a special command called refresh which isn't a normal command used on a button, but an internal command called when refreshing the page through reload or ajax. This too can be handled and cancelled
  2. a phase (before/after) - possible phase values: before, after, all
  3. a code what is to be done

See also: CMS Command Workflows for Commands and Toolbars

History

  1. Introduced in 2sxc 11.12
  2. Enhanced so it also works on inline toolbars in v12.10
Declaration
phase?: WorkflowPhases
Property Value
Type Description
WorkflowPhases

priority

Execution priority, higher comes first Will be 1 by default.

WorkflowStep

you are here (click to zoom) - discover the stack

The workflow step contains

  1. a command for which it will trigger
    1. see the Commands List
    2. There is also a special command called refresh which isn't a normal command used on a button, but an internal command called when refreshing the page through reload or ajax. This too can be handled and cancelled
  2. a phase (before/after) - possible phase values: before, after, all
  3. a code what is to be done

See also: CMS Command Workflows for Commands and Toolbars

History

  1. Introduced in 2sxc 11.12
  2. Enhanced so it also works on inline toolbars in v12.10
Declaration
priority?: number
Property Value
Type Description
number
Edit this page