Assistant.addStep(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Adds a step to an assistant. Steps define each page of the assistant. Use Assistant.isNotOrdered to control if the steps must be completed sequentially or in no specific order. If you want to create help text for the step, you can use AssistantStep.helpText on the object returned.
Returns	serverWidget.AssistantStep object
Supported Script Types	SuiteScript 2.x Suitelet Script Type
Governance	None
Module	N/ui/serverWidget Module
Since	2015.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
options.id	string	required	The internal ID for this step (for example, 'entercontacts').	2015.2
options.label	string	required	The label for this step (for example, 'Enter Contacts'). By default, the step appears vertically in the left panel of the assistant.	2015.2

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/ui/serverWidget Module Script Samples.

          //Add additional code 
...
var assistant = serverWidget.createAssistant({
    title : 'Simple Assistant'
});
assistant.addStep({
    id : 'idname',
    label : 'Sample label'
});
...
//Add additional code 

        

Related Topics

serverWidget.Assistant

N/ui/serverWidget Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices