NetSuite Changelog
SuiteScriptSuiteScriptNew FeatureBest Practices

Assistant Object Members for Suitelets in NetSuite

The Assistant Object Members enable developers to streamline Suitelet UI creation with sophisticated multi-step assistants.

·2 min read·1 views·View Oracle Docs

The Assistant Object allows developers to create sophisticated multi-step assistants within NetSuite using the N/ui/serverWidget module. By leveraging Suitelets, you can build custom pages that maintain a consistent NetSuite appearance.

It's important to note that direct access to the NetSuite UI via the Document Object Model (DOM) isn’t supported; all interactions should occur through SuiteScript APIs.

Key Features of Assistant Object Members

When using the serverWidget.Assistant object, various methods allow you to manipulate the interface, including:

Member TypeNameReturn Type/Value TypeSupported Script TypesDescription
MethodAssistant.addField(options)serverWidget.FieldSuiteletsAdds a field to the assistant.
MethodAssistant.addFieldGroup(options)serverWidget.FieldGroupSuiteletsAdds a group of fields to the assistant.
MethodAssistant.addStep(options)serverWidget.AssistantStepSuiteletsAdds a step to the assistant.
MethodAssistant.getField(options)serverWidget.FieldSuiteletsRetrieves a field object.
MethodAssistant.getSteps()serverWidget.AssistantStepSuiteletsReturns all steps in the assistant.

Important Considerations

  • Field and object names should be prefixed with custpage to prevent conflicts in the naming convention when adding UI objects to existing pages.
  • The methods and properties of the Assistant Object support Suitelets, ensuring seamless integration within the NetSuite environment.

Conclusion

The serverWidget.Assistant allows developers to enhance the user experience with multi-step processes that are both intuitive and visually consistent. By effectively utilizing assistant members, you can streamline data entry tasks and guide users through complex workflows in your NetSuite applications.

Key Takeaways

  • The Assistant Object permits the creation of multi-step wizards in Suitelets.
  • All UI interactions must be conducted through SuiteScript APIs, avoiding DOM access.
  • Unique object identifiers should be prefixed to mitigate naming conflicts in UI components.

Frequently Asked Questions (4)

Do I need to enable a specific feature flag to use Assistant Object members in Suitelets?
The article does not mention any need to enable a specific feature flag. Assistant Object members are used through the N/ui/serverWidget module in Suitelets.
What script types support the `serverWidget.Assistant` object methods?
The methods of the `serverWidget.Assistant` object are supported by Suitelets.
What naming convention should I use to avoid conflicts when adding fields in Suitelets?
Field and object names should be prefixed with `custpage` to prevent conflicts with existing naming conventions in NetSuite pages.
How can I retrieve all steps of an Assistant in a Suitelet?
You can retrieve all steps in an assistant using the `Assistant.getSteps()` method within the `serverWidget.Assistant` object.
Source: Assistant Object Members — Oracle NetSuite Help Center. This article was generated from official Oracle documentation and enriched with additional context and best practices.

Was this article helpful?

More in SuiteScript

View all SuiteScript articles →