2/28/2014 UI Builder APIs

SuiteCloud (Customization, Scripting, and Web Services) : SuiteScript : SuiteScript API : SuiteScript Functions : UI Builder APIs

UI Builder APIs

UI builder APIs allow developers to programmatically create various componets of a the NetSuite UI
(for example, forms, fields, sublists, tabs, portlets). You can also use the UI builder APIs to create
NetSuite-looking assistant wizards.
For more details on working with UI builder APIs, see also UI Objects Overview.
All APIs listed below are in alphabetical order.
nlapiCreateAssistant(title, hideHeader)
nlapiCreateForm(title, hideNavbar)
nlapiCreateList(title, hideNavbar)
nlapiCreateTemplateRenderer()
nlobjAssistant
nlobjAssistantStep
nlobjButton
nlobjColumn
nlobjField
nlobjFieldGroup
nlobjForm
nlobjList
nlobjPortlet
nlobjSubList
nlobjTab
nlobjTemplateRenderer

nlapiCreateAssistant(title, hideHeader)
Use this function to return a reference to an nlobjAssistant object, which is the basis for building
your own custom assistant. This API is supported in Suitelets.

Parameters
title {string} [required] - The name of the assistant. This name will appear at the top of all
assistant pages.
hideHeader {boolean} [optional] - If not set, defaults to false. If set to true, the header
(navbar/logo) on the assistant is hidden from view.

Returns
nlobjAssistant object

Since
Version 2009.2

Example
This snippet shows how to call nlapiCreateAssistant to return a reference to the nlobjAssistant
object. With the nlobjAssistant object instantiated, you can then define the steps of the
assistant.

var assistant = nlapiCreateAssistant("Small Business Setup Assistant");

assistant.setOrdered(true); // indicate that all steps must be completed sequentially
assistant.addStep('companyinformation', 'Setup Company
Information').setHelpText("Setup your
<b>important</b> company information in the fields below.")
assistant.addStep('entercontacts', 'Enter Contacts').setHelpText("Manually add
contacts
into your account.")

assistant.addStep('importdata', 'Import Data').setHelpText("Finally, import records

into your account via CSV.);
https://system.na1.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteScript/UIBuilderAPIs.html#bridge… 1/4
2/28/2014 UI Builder APIs

Back to UI Builder APIs | Back to SuiteScript Functions

nlapiCreateForm(title, hideNavbar)
Creates an nlobjForm object which can be used to generate an entry form page. This API is available
to Suitelets only.

Parameters
title {string} [required] - The title for the form
hideNavbar {boolean} [optional] - Set to true if the navigation bar should be hidden on the
Suitelet. Setting to true enables “popup page” use cases in which the popup can be created
with the UI Objects API rather than just HTML.
When hideNavbar is set to false, the standard NetSuite navigation appears on the form or
popup. Note that this navigation bar contains links to pages that require users to be logged in
to access.

Returns
An nlobjForm object
Back to UI Builder APIs | Back to SuiteScript Functions

nlapiCreateList(title, hideNavbar)
Creates an nlobjList object used to generate an internal standalone list. This API is available to
Suitelets only.

Parameters
title {string} [required] - The title for the list
hideNavbar {boolean} [optional] - Set to true if the navigation bar should be hidden on the
Suitelet. Setting to true enables “popup page” use cases in which the popup can be created
with the UI Objects API rather than just HTML.
When hideNavbar is set to false, the standard NetSuite navigation appears on the form or
popup. Note that this navigation bar contains links to pages that require users to be logged in
to access.

Returns
An nlobjList object
Back to UI Builder APIs | Back to SuiteScript Functions

nlapiCreateTemplateRenderer()
Use this function to produce HTML and PDF printed forms that utilize advanced PDF/HTML template
capabilities. This API returns an nlobjTemplateRenderer object. This object includes methods that
pass in a template as string to be interpreted by FreeMarker, and render interpreted content in your
choice of two different formats: as HTML output to an nlobjResponse object, or as XML string that
can be passed to nlapiXMLToPDF(xmlstring) to produce a PDF.
This function is available when the Advanced PDF/HTML Templates (Beta) feature is enabled.
Because this feature is a beta version, this API is also considered beta and may be subject to
change. For information about this feature, see Advanced PDF/HTML Templates (Beta).

https://system.na1.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteScript/UIBuilderAPIs.html#bridge… 2/4
2/28/2014 UI Builder APIs

Note: The advanced template API expects your template string to conform to FreeMarker syntax. Refer
to FreeMarker documentation for details. FreeMarker documentation is available from this link, or
go to:
http://freemarker.sourceforge.net/docs/index.html.

Returns
An nlobjTemplateRenderer object

Since
Version 2013.1

Example

function renderRecord(request, response)

{
var salesOrderID = 3;
var salesOrder = nlapiLoadRecord(‘salesorder', salesOrderID);
var renderer = nlapiCreateTemplateRenderer();
renderer.setTemplate(…);
renderer.addRecord(‘record', salesOrder);
response.setContentType(‘HTMLDOC');
renderer.renderToResponse(response);
}

Back to UI Builder APIs | Back to SuiteScript Functions

nlobjAssistant
See nlobjAssistant - defined in the section on UI Objects.
Back to UI Builder APIs | Back to SuiteScript Functions

nlobjAssistantStep
See nlobjAssistantStep - defined in the section on UI Objects.
Back to UI Builder APIs | Back to SuiteScript Functions

nlobjButton
See nlobjButton - defined in the section on UI Objects.
Back to UI Builder APIs | Back to SuiteScript Functions

nlobjColumn
See nlobjColumn - defined in the section on UI Objects.
Back to UI Builder APIs | Back to SuiteScript Functions

nlobjField
See nlobjField - defined in the section on UI Objects.
Back to UI Builder APIs | Back to SuiteScript Functions

nlobjFieldGroup
See nlobjFieldGroup - defined in the section on UI Objects.
Back to UI Builder APIs | Back to SuiteScript Functions

nlobjForm
See nlobjForm - defined in the section on UI Objects.

https://system.na1.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteScript/UIBuilderAPIs.html#bridge… 3/4
2/28/2014 UI Builder APIs
Back to UI Builder APIs | Back to SuiteScript Functions

nlobjList
See nlobjList - defined in the section on UI Objects.
Back to UI Builder APIs | Back to SuiteScript Functions

nlobjPortlet
See nlobjPortlet - defined in the section on UI Objects.
Back to UI Builder APIs | Back to SuiteScript Functions

nlobjSubList
See nlobjSubList - defined in the section on UI Objects.
Back to UI Builder APIs | Back to SuiteScript Functions

nlobjTab
See nlobjTab - defined in the section on UI Objects.
Back to UI Builder APIs | Back to SuiteScript Functions

nlobjTemplateRenderer
See nlobjTemplateRenderer - defined in the section on UI Objects.
Back to UI Builder APIs | Back to SuiteScript Functions

https://system.na1.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteScript/UIBuilderAPIs.html#bridge… 4/4