SuiteCloud Reference Tools

Oracle NetSuite provides several browser and tools to help you find information in NetSuite, including:

Browser tool
REST API Browser
Records Catalog
SuiteCloud Development Framework (SDF) XML reference
Advanced printing XML reference
Execution contexts
Application Performance Management (APM) SuiteApp

Browser Tools

In every release, the metadata related to the records, fields, sublists, search joins, and other data, is collected in a browser. This metadata is available through SuiteScript, the SuiteAnalytics Connect Service, and SOAP web services. The browser is a single tool with separate tabs. Each tab offers access to a different schema:

Schema Browser tab contains the information that you need to query the data sources available for the N/search module in SOAP web services.
Records Browser tab contains the information that you need to query the data sources available for the N/search module in SuiteScript.
Connect Browser tab contains the information that you need to query the data sources available for the N/search module in NetSuite.com in SuiteAnalytics Connect.

You can access the browser from the help pages of records in the Help Center, and you can also use the following direct link: SOAP Schema Browser.

Tip:

Bookmark this link for quick access to the Records, Connect, and SOAP Schema Browsers.

The browser tool is separate from the information available in the Help Center, and you do not need to be logged in to your NetSuite account to access it.

A new version of the browser tool is released twice a year, for each NetSuite version. The new version is published about a month after the new SOAP web services endpoint is generally available. The availability of the SOAP web services endpoint is announced in the SOAP web services release notes and in the Integration Newsletter, which is sent to SOAP web services users.

For details about the various SuiteCloud record reference tools available, see the following topics.

The REST API browser is a separate browser tool that provides a visual overview of the structure and capabilities of the REST web services Record API. The REST API browser provides information about the support level of records, the available operations, field names, field types, the structure of potential HTTP responses, and a summary of all records, sublists, schema definitions and other objects. For more information, see The REST API Browser.

Other Reference Tools

The following references tools are available to assist you when you use SuiteCloud Platform tools.

Reference Tool	Description	More Information
Records Catalog	Custom records, forms, and fields in the current user’s account and only includes data based on the features currently enabled in the account. Find information for creating constructed queries and SuiteQL queries using the N/query Samples module. You can also use Records Catalog data in the Workbook API.	Access the Records Catalog in NetSuite from Setup > Records Catalog. Records Catalog Overview
SuiteCloud Development Framework (SDF) XML reference	Record-related metadata. SDF lets you create XML representations of NetSuite objects, such as custom record types, custom record instances, workflows, and other customizations both for internal use and for commercial distribution.	The SDF XML Reference
SuiteBuilder Advanced Template Reference	Specific fields and sublists available for each standard advanced PDF/HTML template.	SuiteBuilder Advanced Template Reference
Execution contexts	How or when a SuiteScript script or SuiteFlow workflow is triggered to execute. You can specify that a script or workflow should execute only in certain contexts, which can improve performance in contexts where the script or workflow is not required.	Execution Contexts
Application Performance Management (APM) SuiteApp	Dashboard you can use for monitoring and troubleshooting performance of the SuiteCloud platform and NetSuite overall. APM includes dashboards for page time summary, SuiteScript analysis, SuiteCloud processors monitor, web services analysis, and search performance analysis.	Application Performance Management for the SuiteCloud Platform

Reference Tool

Description

More Information

Records Catalog

Custom records, forms, and fields in the current user’s account and only includes data based on the features currently enabled in the account.

Find information for creating constructed queries and SuiteQL queries using the N/query Samples module.

You can also use Records Catalog data in the Workbook API.

Access the Records Catalog in NetSuite from Setup > Records Catalog.

Records Catalog Overview

SuiteCloud Development Framework (SDF) XML reference

Record-related metadata.

SDF lets you create XML representations of NetSuite objects, such as custom record types, custom record instances, workflows, and other customizations both for internal use and for commercial distribution.

The SDF XML Reference

SuiteBuilder Advanced Template Reference

Specific fields and sublists available for each standard advanced PDF/HTML template.

SuiteBuilder Advanced Template Reference

Execution contexts

How or when a SuiteScript script or SuiteFlow workflow is triggered to execute. You can specify that a script or workflow should execute only in certain contexts, which can improve performance in contexts where the script or workflow is not required.

Execution Contexts

Application Performance Management (APM) SuiteApp

Dashboard you can use for monitoring and troubleshooting performance of the SuiteCloud platform and NetSuite overall.

APM includes dashboards for page time summary, SuiteScript analysis, SuiteCloud processors monitor, web services analysis, and search performance analysis.

Application Performance Management for the SuiteCloud Platform

Browser Tools

Other Reference Tools

Related Topics