The NetSuite Schema Browser is a tool that allows developers and administrators to view the schema of the NetSuite platform’s SOAP web services.
It provides a searchable interface for exploring and understanding the available records, subrecords and fields, along with their data types and cardinalities.
The tool also offers links to related documentation, such as reference pages for data types and search objects, as well as comparisons with other NetSuite integration options, such as SuiteScript and SuiteAnalytics Connect.
The NetSuite Schema Browser is an essential developers resource for building and maintaining custom integrations with the NetSuite platform. In this article we will answer some common questions about it’s purpose and benefits and help you to better understand when to utilize it.
When logging on to the schema browser page you will notice three tabs as follows –
Differences between the NetSuite Schema Browser, Records Browser, and Connect Browser
Each of these tabs has a distinct and separate purpose and you need to know which tab to be looking on for the value you need.
The NetSuite Schema Browser
The NetSuite Schema Browser is a tool that provides developers with a detailed view of the SOAP web services objects available in NetSuite.
It enables developers to navigate the SOAP web services namespace and to view details about the data structures and operations available.
The NetSuite Records Browser
The NetSuite Records Browser is a tool that provides a user-friendly view of the NetSuite record types.
It enables users to search for and view details about the various standard record types, including the fields available, the relationships between record types, and any related record types.
The NetSuite Connect Browser
The NetSuite Connect Browser is a tool that provides a view of the data models available in SuiteAnalytics Connect.
It enables users to search for and view details about the various data models, including the tables available, the fields available in each table, and any relationships between tables.
While the Schema Browser and Connect Browser are geared towards developers and data analysts, respectively, the Records Browser is designed for use by NetSuite end-users.
Overall, these three tools provide users with a range of views of the data structures available in NetSuite, allowing them to work more efficiently and effectively with the system.
How to Use the NetSuite Schema Browser
Navigating the NetSuite Schema Browser
The left-hand pane of the Schema Browser serves as the primary navigation tool for browsing through records and sub-records. It is organized alphabetically so you first need to select the letter from the alphabet at the top of the screen.
After selecting a letter, the pane refreshes and displays all the relevant records and sub-records.
Select the desired record and the right-hand namespace and tables will update.
What is the Namespace Link?
The top of every page contains a link labelled Namespace. The namespace is the group of related records to which the current selection belongs. Clicking the link will change the left-hand list to the complete list of objects from the selected namespace.
The example below shows the Purchases Transactions namespace that I navigated to via the namespace link on the purchase order page.
The NetSuite Schema Browser Fields Table
Below the namespace link is a Fields table. This contains all the necessary data about the fields found on the specified record type. The table contains the following columns –
|The actual name of the field as it is used in the SOAP web services.
|The data type of the field. This value also has the option to click through to a type reference page. If clicked the pane at the left side of the screen will also update to show a tabbed list of other objects from that namespace.
|A measure that displays two values representing the minimum and maximum occurrences of the field in the corresponding XSD file. For instance, a value of 0..1 indicates that the field can be populated at most once, whereas a value of 0..unbounded indicates that there is no limit to the number of times the field can be populated.
|The label for the field as it appears in the user interface.
|Whether the field is mandatory in the user interface or not. If a field is required, it may have a default value, which will be set if the field is not specified in the request. It is important to observe the behavior of a field in the UI to understand its default values, especially if they are based on the current user.
|Additional details about working with the field.
The NetSuite Schema Browser Attributes Table
The NetSuite Schema Browser Related Searches Table
The related searches section in the NetSuite schema browser provides a list of search objects associated with the record being viewed.
You can click on the name of any search object to get more information about it. This action will update the page again, displaying details about the search object in the center pane, while the left pane will show a tabbed list of other objects within the namespace.
How to use the Namespace View in the Schema Browser
When you navigate to the namespace view of the schema browser, the center pane will not change it’s format but the left-hand pane will.
The list of records will no longer belong to the alphabetical categories but will all belong to the same namespace, whether that be process based or record type. Above the list will be four subtabs that split the objects as follows –
Record – records and sub-records
Search – search objects
Other – sub lists and other miscellaneous objects
Enum – enumerations
The data table shown for enumerations differs form the regular fields table. When an enumerations object is selected you will simply see a list of the values.
If you enter the namespace view accidentally or if you want to return to the default view, simply click one of the letters from the alphabetical categories at the top of the screen.
The Namespace Dropdown List
You will also notice, in every view of the NetSuite schema browser, a dropdown list below the alphabetical categories. If you know the namespace your desired object belongs to you you can use this dropdown to click directly through to the namespace view.