Class WorkflowStep

constructor

• new WorkflowStep(o): WorkflowStep

• WorkflowStep constructor

  Parameters

  • o: WorkflowStep | WorkflowStepCfg

  Returns WorkflowStep

action_name

configuration

Optional id

initial_step

name

Optional next_step

Optional only_if

trigger_id

mmname

• get mmname(): string

• Returns string

mmnext

• get mmnext(): undefined | string

• Returns undefined | string

toJson

• get toJson(): any

• Returns any

delete

• delete(connect_prev_next?): Promise<void>

• Parameters

  • connect_prev_next: boolean = false

  Returns Promise<void>

run

• run(context, user): Promise<any>

• Parameters

  • context: any

  • user: User

  Returns Promise<any>

update

• update(row): Promise<void>

• Parameters

  • row: Row

  Returns Promise<void>

Static builtInActionConfigFields

• builtInActionConfigFields(opts?): Promise<(FieldRepeat | {
      attributes?: undefined;
      class: string;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes?: undefined;
      class?: undefined;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes: {
          options: string[];
      };
      class?: undefined;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required: boolean;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes: {
          options: string[];
      };
      class?: undefined;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required: boolean;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel?: undefined;
      type: string;
      validator?: undefined;
  } | {
      attributes?: undefined;
      class: string;
      default: string;
      fieldview: string;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes?: undefined;
      class: string;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator: any;
  } | {
      attributes?: undefined;
      class?: undefined;
      default?: undefined;
      fieldview: string;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes?: undefined;
      class?: undefined;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg: boolean;
          wf_action_name: string;
      };
      sublabel?: undefined;
      type: string;
      validator?: undefined;
  } | {
      attributes?: undefined;
      class: string;
      default: string;
      fieldview?: undefined;
      label: string;
      name: string;
      required: boolean;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes: undefined | {
          options: string[];
      };
      class: string;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required: boolean;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator: any;
  } | {
      attributes?: undefined;
      class: string;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required: boolean;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator: any;
  })[]>

• Parameters

  • opts: any = {}

  Returns Promise<(FieldRepeat | {
      attributes?: undefined;
      class: string;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes?: undefined;
      class?: undefined;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes: {
          options: string[];
      };
      class?: undefined;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required: boolean;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes: {
          options: string[];
      };
      class?: undefined;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required: boolean;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel?: undefined;
      type: string;
      validator?: undefined;
  } | {
      attributes?: undefined;
      class: string;
      default: string;
      fieldview: string;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes?: undefined;
      class: string;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator: any;
  } | {
      attributes?: undefined;
      class?: undefined;
      default?: undefined;
      fieldview: string;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes?: undefined;
      class?: undefined;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required?: undefined;
      showIf: {
          immediately_bg: boolean;
          wf_action_name: string;
      };
      sublabel?: undefined;
      type: string;
      validator?: undefined;
  } | {
      attributes?: undefined;
      class: string;
      default: string;
      fieldview?: undefined;
      label: string;
      name: string;
      required: boolean;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator?: undefined;
  } | {
      attributes: undefined | {
          options: string[];
      };
      class: string;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required: boolean;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator: any;
  } | {
      attributes?: undefined;
      class: string;
      default?: undefined;
      fieldview?: undefined;
      label: string;
      name: string;
      required: boolean;
      showIf: {
          immediately_bg?: undefined;
          wf_action_name: string;
      };
      sublabel: string;
      type: string;
      validator: any;
  })[]>

Static builtInActionExplainers

• builtInActionExplainers(opts?): any

• Parameters

  • opts: any = {}

  Returns any

Static create

• create(step_in): Promise<void>

• Parameters

  • step_in: WorkflowStepCfg

  Returns Promise<void>

Static deleteForTrigger

• deleteForTrigger(trigger_id): Promise<void>

• Parameters

  • trigger_id: number

  Returns Promise<void>

Static find

• find(where, selectopts?): Promise<WorkflowStep[]>

• Parameters

  • where: Where

  • Optional selectopts: SelectOptions

  Returns Promise<WorkflowStep[]>

Static findOne

• findOne(where): Promise<WorkflowStep>

• Parameters

  • where: Where

  Returns Promise<WorkflowStep>

Static generate_diagram

• generate_diagram(steps, options?): string

• Parameters

  • steps: WorkflowStep[]

  • options: {} = {}

  Returns string

Static getDiagramLoopLinkBacks

• getDiagramLoopLinkBacks(steps): Record<string, string>

• Parameters

  • steps: WorkflowStep[]

  Returns Record<string, string>

Static mmescape

• mmescape(s): string

• Parameters

  • s: string

  Returns string