Class WorkflowStep

constructor

• new WorkflowStep(o: WorkflowStep | WorkflowStepCfg): WorkflowStep

  WorkflowStep constructor

  Parameters

  • o: WorkflowStep | WorkflowStepCfg

  Returns WorkflowStep

action_name

configuration

Optionalid

initial_step

name

Optionalnext_step

Optionalonly_if

trigger_id

mmname

• get mmname(): string

  Returns string

mmnext

• get mmnext(): string | undefined

  Returns string | undefined

toJson

• get toJson(): any

  Returns any

delete

• delete(connect_prev_next?: boolean): Promise<void>

  Parameters

  • connect_prev_next: boolean = false

  Returns Promise<void>

run

• run(
      context: any,
      user: AbstractUser,
      req?: any,
      workflowRun?: any,
  ): Promise<any>

  Parameters

  • context: any
  • user: AbstractUser
  • Optionalreq: any
  • OptionalworkflowRun: any

  Returns Promise<any>

update

• update(row: Row): Promise<void>

  Parameters

  • row: Row

  Returns Promise<void>

StaticactionSummary

• actionSummary(
      step: WorkflowStep,
      opts?: { req?: any; trigger?: Trigger },
  ): string[] | undefined

  Parameters

  • step: WorkflowStep
  • opts: { req?: any; trigger?: Trigger } = {}

  Returns string[] | undefined

StaticbuiltInActionConfigFields

• builtInActionConfigFields(
      opts?: any,
  ): 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: (
                  s: string,
                  _: any,
                  field?: { required: boolean },
              ) => string | undefined;
          }
          | {
              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: { options: string[] }
              | 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: (
                  s: string,
                  _: any,
                  field?: { required: boolean },
              ) => string | undefined;
          }
          | {
              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: (
                  s: string,
                  _: any,
                  field?: { required: boolean },
              ) => string | undefined;
          }
          | {
              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?: 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;
          }
      )[],
  >

  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: (
                  s: string,
                  _: any,
                  field?: { required: boolean },
              ) => string | undefined;
          }
          | {
              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: { options: string[] }
              | 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: (
                  s: string,
                  _: any,
                  field?: { required: boolean },
              ) => string | undefined;
          }
          | {
              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: (
                  s: string,
                  _: any,
                  field?: { required: boolean },
              ) => string | undefined;
          }
          | {
              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?: 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;
          }
      )[],
  >

StaticbuiltInActionExplainers

• builtInActionExplainers(opts?: any): any

  Parameters

  • opts: any = {}

  Returns any

Staticcreate

• create(step_in: WorkflowStepCfg): Promise<WorkflowStep>

  Parameters

  • step_in: WorkflowStepCfg

  Returns Promise<WorkflowStep>

StaticdeleteForTrigger

• deleteForTrigger(trigger_id: number): Promise<void>

  Parameters

  • trigger_id: number

  Returns Promise<void>

Staticfind

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

  Parameters

  • where: Where
  • Optionalselectopts: SelectOptions

  Returns Promise<WorkflowStep[]>

StaticfindOne

• findOne(where: Where): Promise<WorkflowStep>

  Parameters

  • where: Where

  Returns Promise<WorkflowStep>

Staticgenerate_diagram

• generate_diagram(steps: WorkflowStep[], options?: {}): string

  Parameters

  • steps: WorkflowStep[]
  • options: {} = {}

  Returns string

StaticgetDiagramLoopLinkBacks

• getDiagramLoopLinkBacks(steps: WorkflowStep[]): Record<string, string>

  Parameters

  • steps: WorkflowStep[]

  Returns Record<string, string>

Staticmmescape

• mmescape(s: string): string

  Parameters

  • s: string

  Returns string