Table of contents
5.3Dashboard dashboard released
1 Introduction
SuiteQL is a powerful tool for data query in the NetSuite data analysis framework. Proper use can greatly improve the efficiency of data query. First of all, its main technical advantage is that it can help users query data across multiple tables, which is what Saved Search and Dataset do not have. At the same time, due to the complexity of sharing and migration of Saved Search and Workbook, SuiteQL is more convenient in use. In addition, combined with project practice, we found that it is actually more necessary to gradually accumulate common management reports in projects and reuse them in different projects in order to reduce manpower and time waste.
Therefore, TOI developed the SuiteQlet function package based on the above three points, aiming to contribute to the construction of the NetSuite reporting tool system and to explore more possibilities for developing data query tools.
2. Function description
2.1 Terminology
SuiteQlet: A package of features based on SuiteQL.
SuiteChart: A chart control for displaying SuiteQL query results.
2.2 Function overview
The main functions of this function pack include the following three points:
Query by entering and calling SuiteQL statements
Users can create new SQL statements for query; at the same time, they can also save the previously used SQL statements for subsequent query calls for easy reuse.
Enter SQL statement interface
Save query results to an Excel table
Users can export the queried data results to an Excel table, and can also generate different types of Chart charts for presentation of the data results.
Publish query results to the Dashboard dashboard
The generated charts of different types can be selected by the portlet, and finally published to the dashboard, so that users can directly view them on the NetSuite homepage dashboard.
Dashboard interface
2.3 Logical Interpretation
The overall logic of this feature pack is based on the combination of the following 5 custom record designs:
| ID |
custom record name |
explain |
| 1 |
SuiteChart Data Source |
Data source definition, which can include SuiteQL, Saved Search, Dataset. |
| 2 |
SuiteChart Chart DSD |
Chart sub-table, associated with multiple data sources, used for multiple series selection of Chart. |
| 3 |
SuiteChart Chart |
Chart main table, which can be displayed by portlet calls. |
| 4 |
SuiteChart Chart Type |
Definition of the chart type. |
| 5 |
SuiteChart Chart Type Param |
Parameters for the chart type. |
The overall logic can refer to the following table:
3. Install
| Bundle name |
SuiteQlet |
| Bundle ID |
485557 |
| Release scope |
Public |
| code control |
Locked |
4. Permission configuration
This feature pack requires full access to custom records.
5. Operation Guide
When the user enters the correct SQL statement on the Query interface, the system will display the query result after running. The user can choose to export to Excel, or save and add the SQL statement to the list for future reuse.
The portlet is called when the user publishes the dashboard after the chart is generated on the Chart interface.
5.1 Query query
Through the global search, the keyword "SuiteQlet" gets the program entry.
After opening SuiteQlet, enter the following interface:
Query interface to edit SQL statements
Query interface displays query results
The main operation and explanation of the interface:
| ID |
main operation |
explain |
| 1 |
Run |
Run the SQL statement in the editor. After clicking the button, the data query results will be displayed at the bottom of the interface, and the words "Successfully Run SuiteQL" will appear on the interface, indicating that the SQL statement was successfully run. After the successful operation, the query results will appear at the bottom of the interface, and the user can select the number of entries that display up to 50/100/150/200 query results on the page according to their needs. |
| 2 |
Clear |
Clear the contents of the SQL statement in the current editor. |
| 3 |
Save |
Save the SQL statement in the current editor. If you want to reuse the query SQL statement again, you can use the save function so that it can be run directly in the next query, and the words "Successfully Saved" will appear on the interface. |
| 4 |
Save As |
Save and keep the SQL statement in the current editor. |
| 5 |
List |
All saved SQL statements are displayed, and keywords can be used to search in Search. When the user clicks "Load", the interface will refresh the SQL statement to the editor. |
| 6 |
Name |
The name of a custom query operation, such as statistical transactions. |
| 7 |
Functional |
There are 10 types including Customer Service, Financial, Human Resource, Manufacturing, Marketing, Purchase, Quality Management, R&D, Sales, Warehouse, etc. Users can choose according to their needs. |
| 8 |
Description |
Enter the description of the current query operation, which is convenient to help users distinguish the selection when using it in the future, for example, it is used to count the number of daily transaction processing since 2023/01/01. |
| 9 |
Export Excel |
Download and export the current data results in Excel form. |
About the SuiteQL Sample Library sample library:
Users can refer to the official post of the NetSuite knowledge meeting - "SuiteQL Sample Library" sample library to create a new SQL statement. In addition, we will use this post as a sharing platform to regularly update the sample, for everyone to exchange and learn, and to better reuse management reports. If you are also willing to contribute and share, you can also leave a message and reply to show your work. The specific link is as follows:
[SuiteQL Sample Library sample library] 
https://nk-community.blog.csdn.net/article/details/130669113
5.2Chart chart
preview chart
The main operation and explanation of the interface:
| ID |
main operation |
explain |
| 1 |
Save |
Save the chart to a custom record for the portlet to call when the dashboard is published, otherwise the chart will not be displayed in the chart list. |
| 2 |
Preview |
Preview the currently generated chart. |
| 3 |
Type |
At present, there are 6 types of charts for users to choose and use according to business scenarios. Different types have different attributes, which will be explained in the table below. |
| 4 |
Name |
The name of a custom chart, such as a transaction statistics table. |
Explanation of 6 different charts:
| type name | Applicable scene | Chart sample |
| Line line chart |
The chart needs to define the X-axis and 2 Serie. It is used to display the change trend of data over time or other continuous variables, and is suitable for displaying historical trends, comparing changes between different groups, etc. |
 |
| Bar histogram |
The chart needs to define the X-axis and 2 Serie. It is used to display the quantity difference between different groups, and is suitable for displaying data such as sales and number of users. |
 |
| Pie pie chart |
The chart needs to define Indicator and 1 Serie. It is used to display the quantity ratio between different categories, and is suitable for displaying market share, product classification and other data. |
 |
| Rose rose diagram |
The chart needs to define Indicator and 1 Serie. A variation of the pie chart, used to show the distribution of data on a circle. |
 |
| Funnel funnel chart |
The chart needs to define 1 Serie. It is used to display the conversion of the process, and is suitable for displaying data such as pipelines of sales opportunities and user conversions. |
 |
| Calendar Heatmap Calendar heat map |
The chart needs to define Date and 1 Serie. It is used to display the relationship between time and data, and is suitable for displaying the data distribution of a certain day or a certain period of time. |
 |
5.3Dashboard dashboard released
Step 1: Click "Personalize" and select "Custom Portlet" to add the component to the dashboard;
Step 2: After opening the upper right corner of the component, click "Set Up" to enter the settings, select "SuiteChart" in the "Source" drop-down list, and click "Save" to save the settings;
Step 3: Open the upper right corner of the component again and click "Edit" to complete the selection of the required Chart. It should be noted that a maximum of 4 Charts can be placed on a Portlet, and users can choose different "Layouts" according to their needs (currently available Choose from 1*1, 1*2, 1*3, 2*2). After filling in the "Height" and Portlet "Title" names, click "Save" to save the settings.
Step 4: Complete the personal dashboard setup.
Dashboard display
6. Precautions
a) After the function package is installed, the administrator can customize the access path of SuiteQlet;
b) When finally publishing the dashboard and selecting charts, it should be noted that the number of charts displayed in the list cannot exceed the parameter "Maximum number of drop-down lists displayed" set by personal preferences, otherwise it will appear as shown in the following figure. The case where the name is not displayed. Assuming that the maximum display of personal preference list is 20, when the number of all saved charts in the system exceeds 20, the list cannot be displayed, and it is necessary to return to change the settings of personal preference. Currently NetSuite version 23.1 has this problem.
Personal Preferences Parameter Settings
c) After clicking "Run" on the Query interface to generate data results, the corresponding chart can be generated on the Chart interface, otherwise no chart will be generated;
d) If you need to delete the saved SQL query statement in the List, you need to select the corresponding custom record in the SuiteChart Data Source List to delete;
e) If you need to delete the saved chart, you need to select the corresponding custom record in the SuiteChart Chart List to delete;
f) Three types of charts of Line/Rose/Funnel can be downloaded and saved in the form of pictures after generation, and three types of charts of Bar/Pie/Calendar Heatmap cannot be downloaded and saved in the form of pictures after generation;
g) During installation or use, if you encounter any problems, you can send emails to
[email protected] email to contact us.
7. Video link
NK Bundles - SuiteQlet Feature Pack