Class WorkflowRun

constructor

• new WorkflowRun(o: WorkflowRun | WorkflowRunCfg): WorkflowRun

  WorkflowRun constructor

  Parameters

  • o: WorkflowRun | WorkflowRunCfg

  Returns WorkflowRun

context

current_step

Optionalerror

Optionalid

Optionalsession_id

started_at

Optionalstarted_by

status

Optionalstatus_updated_at

Optionalstep_start

Optionalsteps

trigger_id

Optionalwait_info

current_step_name

• get current_step_name(): any

  Returns any

toJson

• get toJson(): any

  Returns any

createTrace

• createTrace(step_name: string, user?: User): Promise<void>

  Parameters

  • step_name: string
  • Optionaluser: User

  Returns Promise<void>

delete

• delete(): Promise<void>

  Returns Promise<void>

get_next_step

• get_next_step(step: WorkflowStep, user?: User): WorkflowStep | null

  Parameters

  • step: WorkflowStep
  • Optionaluser: User

  Returns WorkflowStep | null

markAsError

• markAsError(e: Error, step: WorkflowStep, user?: User): Promise<void>

  Parameters

  • e: Error
  • step: WorkflowStep
  • Optionaluser: User

  Returns Promise<void>

popReturnDirectives

• popReturnDirectives(nextUpdate?: Row): Promise<any>

  Parameters

  • OptionalnextUpdate: Row

  Returns Promise<any>

provide_form_input

• provide_form_input(form_values: any, response_variable?: string): Promise<void>

  Parameters

  • form_values: any
  • Optionalresponse_variable: string

  Returns Promise<void>

run

• run(
      __namedParameters: {
          api_call?: boolean;
          interactive?: boolean;
          noNotifications?: boolean;
          req?: any;
          trace?: boolean;
          user?: User;
      },
  ): Promise<any>

  Parameters

  • __namedParameters: {
        api_call?: boolean;
        interactive?: boolean;
        noNotifications?: boolean;
        req?: any;
        trace?: boolean;
        user?: User;
    }

  Returns Promise<any>

set_current_step

• set_current_step(stepName: string): void

  Parameters

  • stepName: string

  Returns void

update

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

  Parameters

  • row: Row

  Returns Promise<void>

user_allowed_to_fill_form

• user_allowed_to_fill_form(user: User): boolean

  Parameters

  • user: User

  Returns boolean

userFormFields

• userFormFields(
      step0?: WorkflowStep,
      user?: User,
  ): Promise<{ fields: FieldLike[]; validator?: (r: Row) => any }>

  Parameters

  • Optionalstep0: WorkflowStep
  • Optionaluser: User

  Returns Promise<{ fields: FieldLike[]; validator?: (r: Row) => any }>

Staticcount

• count(where?: Where): Promise<number>

  Parameters

  • Optionalwhere: Where

  Returns Promise<number>

Staticcreate

• create(run_in: WorkflowRunCfg): Promise<WorkflowRun>

  Parameters

  • run_in: WorkflowRunCfg

  Returns Promise<WorkflowRun>

Staticfind

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

  Parameters

  • where: Where
  • Optionalselectopts: SelectOptions

  Returns Promise<WorkflowRun[]>

StaticfindOne

• findOne(where: Where, selectopts?: SelectOptions): Promise<WorkflowRun>

  Parameters

  • where: Where
  • Optionalselectopts: SelectOptions

  Returns Promise<WorkflowRun>

StaticgetResumableWorkflows

• getResumableWorkflows(): Promise<WorkflowRun[]>

  Returns Promise<WorkflowRun[]>

Staticprune

• prune(): Promise<void>

  Returns Promise<void>

StaticrunResumableWorkflows

• runResumableWorkflows(): Promise<void>

  Returns Promise<void>