SuiteCloud Extension for Visual Studio Code is part of the SuiteCloud Software Development Kit (SuiteCloud SDK), a set of tools to customize your NetSuite accounts. SuiteCloud Extension for Visual Studio Code allows you to customize your SuiteCloud projects for NetSuite. The available SuiteCloud projects include SuiteApp projects — self-contained, standalone projects that you can publish in the SuiteApp Marketplace for other users to download and install, and Account Customization Projects — intended for customizations on accounts you own, such as your production, development, and sandbox accounts.
Read more about SuiteCloud SDK and SDF in SuiteCloud SDK Overview and SuiteCloud Development Framework Architecture.
The following software is required to work with SuiteCloud Extension for Visual Studio Code:
- Oracle JDK version 17
- VS Code version 1.80 or higher
Read the detailed list of prerequisites in Installation Prerequisites for SuiteCloud Extension for Visual Studio Code.
You should use the latest version of the SuiteCloud Extension for Visual Studio Code available in the Marketplace. The table below is informative and correlates extension versions in the Marketplace and NetSuite versions.
| Version in the Marketplace | Version in NetSuite |
|---|---|
| 1.6.X | 2024.1 |
| 1.5.X | 2023.2 |
To install SuiteCloud Extension for Visual Studio Code, follow these steps:
- Launch Visual Studio Code and select the Extensions icon in the Activity Bar.
- In the search field, enter SuiteCloud Extension for Visual Studio Code.
- Click Install.
- Restart Visual Studio Code after installation.
See more details about installation in Installing and Setting Up SuiteCloud Extension for Visual Studio Code.
Interact through the Command Palette to use SuiteCloud Extension for Visual Studio Code. To trigger it, click View > Command Palette or use the relevant shortcut:
- Ctrl+Shift+P if you are using Windows or Linux.
- Cmd+Shift+P if you are using Mac OS.
To start working with a SuiteCloud project, you can do any of the following actions:
- Create a SuiteCloud project. To do this, open the Command Palette, enter SuiteCloud and, from the dropdown list, select SuiteCloud: Create Project.
- Open a SuiteCloud project. To do this, go to File > Open Folder... and select the root folder of your SuiteCloud project.
To add a SuiteCloud project to an already opened Visual Studio Code window, go to File > Add Folder To Workspace ... and select the root folder of your SuiteCloud project. This lets you work with multiple SuiteCloud projects at the same time.
For the extension to detect the working SuiteCloud project and run any command against it, you first need to select a file from the current workspace to make it active in the editor.
To start using your NetSuite accounts with SuiteCloud Extension for Visual Studio Code, you first need to set them up. The account set up includes adding an account to the extension and setting it as default. As a prerequisite to adding an account, a SuiteCloud project must be open in Visual Studio Code.
To add an account, follow these steps:
-
Open the Command Palette.
-
Enter SuiteCloud and from the dropdown list, select SuiteCloud: Set Up Account.
-
Once the dropdown list is shown, select New authentication ID.
-
Once the dropdown list is shown, select one of the following options:
- Browser-based authentication
- Save a TBA token issued in NetSuite
-
In the text field, enter an authentication ID.
-
If you selected the browser-based authentication, press Enter to confirm your NetSuite domain and follow the instructions in the browser prompt. If you selected to save an issued TBA token, do the following:
- Enter your account ID.
- Enter the token ID of the TBA token you previously issued in NetSuite.
- Enter the token secret of the TBA token you previously issued in NetSuite.
Your account is successfully set up.
To set an account as default for a project, follow these steps:
- Open the Command Palette.
- Enter SuiteCloud and from the dropdown list, select SuiteCloud: Set Up Account.
- From the dropdown list, select the authentication ID of the account you want to set as default. The selected account is set as default for the project.
The following SuiteCloud commands are available through the Command Palette:
| Command | Description |
|---|---|
| Add Dependency References to the Manifest | Adds the defined dependencies to the Manifest file. |
| Compare with Account File | Compares a local file with its account version. |
| Create SuiteScript Files | Creates a SuiteScript file based on a script type template that also includes any modules you select to extend NetSuite and customize, search for, and process your data. |
| Create Project | Creates SuiteCloud file-based projects to develop ACPs or SuiteApp projects for internal use or for commercial distribution. |
| Deploy Project | Deploys the folder containing the project. The project folder is zipped before deployment including only the files and folders referenced in the deploy.xml file. |
| Import Files | Imports files from a NetSuite account to your project. Note that you cannot import files from a SuiteApp. |
| Import Objects | Imports SDF custom objects from a NetSuite account to your project. |
| List Files | Lists the files in the File Cabinet of your account. |
| List Objects | Lists the SDF custom objects existing in your account. |
| Manage Accounts | Lets you manage the authentication IDs associated to your accounts by renaming or removing them. It also shows the details of any specific authentication ID. |
| Set Up Account | Adds the NetSuite accounts you want to customize. It also lets you set an account as default for a project. |
| Update File from Account | Overwrites the selected file in the project with the matching file in an account. |
| Upload File | Uploads files to the FileCabinet folder without requiring the deployment of the entire project. Files must be in an SDF supported FileCabinet folder. |
| Update Object from Account | Overwrites the selected SDF custom objects in the project with their matching objects imported from your account. In the case of custom records, custom instances can be included. |
| Validate Project | Validates a project against your NetSuite account. Only the files and folders referenced in the deploy.xml file are validated. |
To read more about what you can do with SuiteCloud Extension for Visual Studio Code, visit SuiteCloud Extension for Visual Studio Code Usage.
SuiteCloud CLI for Node.js is compatible with your Visual Studio Code integrated terminal, so you can run SuiteCloud CLI for Node.js commands directly there, independently from VS Code. To read more about it, visit SuiteCloud CLI for Node.js.
To read the 2024.1 NetSuite's release notes and documentation, check the following sections of NetSuite's Help Center:
- Read the release notes for NetSuite 2024.1 in SuiteCloud SDK Release Notes.
- Read the latest updates under SuiteCloud SDK in the Help Center Weekly Updates.
- Read the SuiteCloud Extension for Visual Studio Code documentation in NetSuite's Help Center.
SuiteCloud Extension for Visual Studio Code is an open source project. Pull Requests are currently not being accepted. See Contributing for details.
Copyright (c) 2022, 2023, 2024 Oracle and/or its affiliates The Universal Permissive License (UPL), version 1.0. See License for details.
By installing SuiteCloud Extension for Visual Studio Code, you are accepting the installation of the SuiteCloud SDK dependency under the Oracle Free Use Terms and Conditions license.