Creating and Using Workflow Fields
Workflow Custom Fields and Workflow State Custom Fields cannot be successfully used in client-side actions and conditions.
Workflow fields apply to a single workflow definition. The field stores a unique value for each record on which an instance of the workflow runs. You can use a workflow field in conditions and actions like the Set Field Value action.
You can store the value of the field in the database for access by multiple workflow instances for the record type, or only use it temporarily for a single workflow instance.
To create a workflow field, create a workflow field on the workflow definition page. NetSuite populates the field value when the workflow instance runs.
You can also use workflow fields to accomplish the following tasks:
-
Track records created by a workflow. Track records created with the Create Record action. Select the workflow field in the Store Result In dropdown list on the Create Record action and then use the Subscribe To Record action to track changes to the created record.
The List/Record type of the workflow field must match the List/Record type of the record you create with the Create Record action to appear in the Store Result In dropdown list.
-
Store a return value from a Workflow Action script. Use the Store Result In dropdown list of a Custom workflow action to store the value returned from a Workflow Action script. See Storing a Return Value from a Custom Action Script in a Workflow Field.
To create a workflow field:
-
If you have not already done so, open the workflow definition page for the workflow in which you want to create the workflow field.
-
In the context panel, click the Workflow tab, click the Fields view, and then click New Workflow Field.
Note:To edit a workflow field after you create it, hover over the field name on the Fields view in the context panel and click the Edit icon.
-
On the Workflow Field window, enter the following properties:
Property
Description
Label
Name or description for the field. NetSuite displays this label in the context panel and in the Store Result In dropdown list on Custom and Subscribe To Record actions.
ID
Optional script ID for the field. This value must be lowercase. It cannot include spaces or exceed 30 characters.
Use script IDs if you plan to use the SuiteBundler feature to bundle the workflow and install it in another NetSuite account. Script IDs reduce the risk of naming conflicts.
NetSuite prepends
custworkflowto this value when you save the workflow definition.Owner
Owner of the workflow field.
Description
Optional text description of the field.
Type
Type of custom field. See Field Type Descriptions for Custom Fields.
List/Record
List or record that corresponds to the list or record type selected for the Type property.
You must enter a value for this property if you select a List/Record or Multiple Select value for the Type property. See Creating a Custom Field.
Store Value
Stores the field value in the NetSuite database when the workflow instance runs. Use this option to store the value for future instances of the workflow.
If you do not check the Store Value box, the field value is only accessible in the current workflow instance. When the field value is not stored, the database treats the value as a string and the value is not accessible to other workflow instances.
Workflow
Instances of the workflow to which this field applies. You cannot edit this field.
-
Continue setting the properties on the Display, Validation & Defaulting, and Translation subtabs. The Sourcing & Filtering subtab is not available for workflow fields. To source a workflow field, you must use the Set Field Value Action action.
Note:For additional information about workflow field properties, see Creating a Custom Field.
-
Click Save. The workflow field appears on the Fields subtab of the workflow definition page and the Fields view on the Workflow tab on the context panel.
You can now use the field name in a condition or workflow action.