mynt

module function · N/workflow

trigger()

workflow.trigger(options)

Triggers a workflow on a record.

Implementation
Not started
Design
Open for proposals suggest how it should read
Proposals
A suitescript api
Signature
workflow.trigger(options)
Returns
number
Governance
20 units
Script types
Server scripts
Version
SuiteScript 2.x, documented for 2.1; since NetSuite 2015.2
call shapefrom Oracle's parameter table
1workflow.trigger({2    actionId:   /* string | number, optional */,3    recordId:   /* string, required */,4    recordType: /* string, required */,5    stateId:    /* string | number, optional */,6    workflowId: /* string | number, required */7});
Oracle reference for this method
ParameterTypeRequiredDescription
options.actionIdstring | numberoptionalThe internal ID of a button that appears on the record in the workflow. Use this parameter to trigger the workflow as if the specified button were clicked.
options.recordIdstringrequiredThe record ID of the workflow base record.
options.recordTypestringrequiredThe record type ID of the workflow base record. Use values from the record.Type enum. This is the Record Type field on the Workflow Definition Page .
options.stateIdstring | numberoptionalThe internal ID (number) or script ID (string) of the workflow state that contains the action.
options.workflowIdstring | numberrequiredThe internal ID (number) or script ID (string) for the workflow definition. This is the ID field on the Workflow Definition Page .
B mynt syntax

No Mynt syntax yet.

Nothing in the language compiles to workflow.trigger(options) today. How should it read?

C community proposals

Competing syntax for trigger, from GitHub Discussions. Select two or more to compare them side by side.

All discussions

Loading proposals from GitHub…

D suggest an alternative

Write the Mynt you wish you could write.

A good proposal shows the syntax, the SuiteScript it should become, and argues for it: why it is clearer, how it fits the rest of the language, what it makes harder.

  • Clarity. Does it say what happens, without ceremony?
  • Consistency. Does it read like load, save and Ref[field]?
  • Expressiveness. Does it cover the cases people actually write?
  • Honesty. Does it hide a NetSuite cost, such as governance, that a reader should see?

N/workflow · workflow.trigger(options)

Suggest syntax for trigger