SuiteCloud Reference Tools
Oracle NetSuite provides several browsers and tools to help you find information in NetSuite, including:
-
Browser tool
-
Analytics data source
-
REST API Browser
-
Records Catalog
-
SuiteCloud Development Framework (SDF) XML reference
-
Advanced printing XML reference
-
Execution contexts
-
Application Performance Management (APM) SuiteApp
Browser Tools
With every release, metadata for records, fields, sublists, search joins, and other data is collected in a browser. This metadata is available through SuiteScript, and SOAP web services. The browser is a one tool with separate tabs, and each tab gives you access to a different schema:
-
Schema Browser tab has the information you need to query data sources for the N/search module in SOAP web services.
-
Records Browser tab has the information you need to query data sources for the N/search module in SuiteScript.
The Connect Browser is no longer being updated and shows only tables and columns that were made available up to 2021.2.
You can access the browser from the Help Center records pages, and you can use the following direct link: SOAP Schema Browser.
Bookmark this link for quick access to the Records, Connect, and SOAP Schema Browsers.
The browser tool is separate from the Help Center, and you don't need to be logged in to NetSuite to use it.
A new version of the browser tool is released twice a year with each NetSuite version. The new version is published about a month after the new SOAP web services endpoint is 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 analytics data source lets you analyze your NetSuite data with SuiteQL queries. SuiteQL lets you run complex queries using SuiteAnalytics Connect, SuiteScript, and SuiteTalk REST web services. For more information about the analytics data source, NetSuite2.com, see Analytics Data Source Overview.
The REST API browser is a separate browser tool that provides a visual overview of the REST web services Record API. The REST API browser provides the support level of records, available operations, field names, field types, possible 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 your account, showing only data based on the features you have enabled. 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. |
|
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. |
|
|
Advanced Template Reference |
Specific fields and sublists available for each standard advanced PDF/HTML template. |
|
|
Execution contexts |
How or when a SuiteScript script or SuiteFlow workflow is triggered to run. You can set up a script or workflow to run only in certain contexts, which can improve performance where the script or workflow is not required. |
|
|
Application Performance Management (APM) SuiteApp |
Dashboard you can use for to monitor and troubleshoot performance for the SuiteCloud platform and NetSuite overall. APM has dashboards for page time summaries, SuiteScript analysis, SuiteCloud processor monitoring, web services analysis, and search performance. |
Application Performance Management for the SuiteCloud Platform |