N/workflow Module

Use the N/workflow module to initiate new workflow instances or trigger existing workflow instances.

                                   

In This Help Topic

N/workflow Module Members

Member Type

Name

Return Type / Value Type

Supported Script Types

Description

Method

workflow.initiate(options)

number

Server scripts

Initiates a workflow on-demand. This method is the programmatic equivalent of the Initiate Workflow Action action in SuiteFlow.

Returns the internal ID of the workflow instance used to track the workflow against the record.

workflow.trigger(options)

number

Server scripts

Triggers a workflow on a record. The actions and transitions of the workflow are evaluated for the record in the workflow instance, based on the current state for the workflow instance.

Returns the internal ID of the workflow instance used to track the workflow against the record.

Related Topics

General Notices