Using the Finsyte SuiteApp
Finsyte requires a SuiteApp to be installed on your NetSuite instance to enable saved search functionality within Finsyte. This SuiteApp is included with your Finsyte program and is installed via the SuiteApp Deploy section of the Finsyte Preferences page.
Feature Requirements
The following features are required for your NetSuite role to deploy the SuiteApp on your NetSuite instance from the Finsyte tool.
| Feature | Location |
|---|
| SuiteCloud Development Framework | Enable Features > SuiteCloud > SuiteCloud Development Framework |
Permission Requirements
The following developer-type permissions are required for your NetSuite role to deploy the SuiteApp on your NetSuite instance from the Finsyte tool.
| Permission | Level | Details |
|---|
| SuiteAnalytics Workbook | Edit | Required for SuiteQL querying |
| Permission | Level | Details |
|---|
| Document and Files | Full | Required to add script files to the File Cabinet |
| Perform Search | Full | Required for general Saved Search functionality |
| Publish Search | Full | Required to deploy custom Saved Search objects |
| Permission | Level | Details |
|---|
| Allow JS/HTML Uploads | Full | Required to upload JavaScript files for script deployment |
| Log in using OAuth 2.0 Access Tokens | Full | Required to log in using OAuth 2.0 access tokens for performing the setup |
| SuiteApp Deployment | Full | Required to deploy Saved Search RESTlet Account Customization project via SuiteCloud Deployment Framework |
| SuiteScript | Full | Required to create and deploy the Saved Search RESTlet script |
Installation Process
- Navigate to the SuiteApp Deploy section of the Finsyte Preferences page (Help > Preferences > SuiteApp Deploy).
- Select your environment type from the dropdown (Production or Sandbox).
- Click the Deploy to NetSuite button. This will open a browser window.
- In your browser window, select the appropriate environment and role to use for authentication and installation, then click the Continue button.
- The SuiteApp will finish installing in under 30 seconds. The SuiteApp Deploy Preferences page in Finsyte shows an audit log of the entire install so that you can see whether the installation was successful and, if not, what errors arose during the process so that you can troubleshoot. A successful installation shows Installation COMPLETE on the last audit log line.
SuiteApp Structure
The Finsyte SuiteApp is composed of the following custom objects:
| Name | ID | Object Type | Description |
|---|
| FS RL Saved Search API | customscript_fs_rl_saved_search_api | RESTlet Script | Endpoint script for retrieving saved search results in Finsyte |
| FS RL Saved Search API | customdeploy_fs_rl_saved_search_api | Script Deployment | The single script deployment for the script listed above |
| Finsyte Saved Searches - DO NOT MODIFY | customsearch_fs_saved_searches | Saved Search | A saved search that retrieves a list of saved searches |