Upload to Netsuite With Visual Studio Code

netsuite-upload VS Code plugin

netsuite-upload is a Visual Studio Code extension that allows yous to manage your SuiteScript files straight from VS Lawmaking. It also helps yous with defining new modules and adding server-side module dependecies.

Under New Direction

In Feb 2019, original author original author Tomáš Tvrdý @tvrdytom transferred buying of this projection to me @silverl. The last version under this line of development was 0.ane.3.

New releases will be versioned 1.0+.

If you lot are having bug with the 1.0+ release line, and so make certain you've updated the vscodeExtensionRestlet.js RESTlet to the latest version.

Features

i. Push and Pull Files and Folders betwixt VS Code and the NetSuite File Cabinet

Correct-click a file or binder in the navigation console to see the context menu options:

• Pull file from NetSuite - downloads a file from NetSuite
• Push file to NetSuite - uploads a file to NetSuite
• Delete file in NetSuite - deletes a file in NetSuite
• Compare file with NetSuite - unequal your local version with the NetSuite version
• Pull folder from NetSuite - Download the folder and all contents from NetSuite
• Push button folder to NetSuite - Uploads the folder and all contents to NetSuite

two. NetSuite-Specific Lawmaking Snippets & Commands

• Snippets for module initialization - type defineRestlet..., choose your module type and hit enter
• Commands for adding new NetSuite/custom dependencies - open up command line (Ctrl-Shift-P) and type
  • add netsuite dependency for choosing of the NetSuite built-in module from the listing
  • add custom dependency for defining od custom dependecies

iii. Rebase the Root Folder

You can prepare the remote destination binder in NetSuite to SuiteScripts (default) or a subfolder of SuiteScripts with the netSuiteUpload.rootDirectory setting. This might be useful if you accept a folder in the NS file cabinet called SuiteScripts\Development where yous experiment with scripts earlier you motility them to a SuiteScripts\Production folder.

In this kind of work flow, you might exercise development work inside SuiteScripts\Development. When y'all're satisfied, you'd change Settings.json (or Workspace settings in your .vscode\settings.json file) to alter the base to SuiteScripts\Production. So you'd push upward all the files y'all were working with.

Nothing changes on your local disk due to this setting change. It only modifies the root folder in NetSuite where files get pushed to or pulled from.

This was a requested enhancement. Virtually people would probably be better off using a sandbox surround as it would be easy to lose track of which files were modified, and which versions of which files were in Development vs Production.

NetSuite Setup

To be able to push and pull folders and files to NetSuite, this extension requires the manual installation of a RESTlet in NetSuite. Through configuration settings, you volition inform the extension as to the URL of the RESTlet.

How to install the RESTlet

Yous'll need to know how to publish a script and do a script deployment in NetSuite to make it work. Consult the NetSuite docs if this is new to yous.

• Download a copy of the RESTlet from here (employ Raw view to copy/paste).
• Upload the vscodeExtensionRestlet.js file to somewhere in your SuiteScripts file cabinet folder in NetSuite.
• Create a new Script tape for this RESTlet.
• Create a new Script Deployment for this Script. Note the URL.
• Edit your workspace or user settings in VS Lawmaking (see Settings section below) and set the RESTlet URL.

Special Notice Regarding the RESTlet

• Future versions of this VS Lawmaking Extension may require that you upgrade the RESTlet file in NetSuite. Take annotation if the extension receives an update, and read the Changelog.
• If you have an erstwhile version of the RESTlet in your Production NetSuite instance, and a new version in a SandBox NetSuite instance, be warned. A SandBox refresh might overwrite the SandBox RESTlet with the older version from Production.

VS Code Setup

Install the VS Code Extension

The extension can be installed from the VS Lawmaking Extensions Marketplace within VS Code.

The Marketplace URL is https://marketplace.visualstudio.com/items?itemName=nsupload-org.netsuite-upload

VSCode - Open Binder

Very Important Fact - Your VS Code project MUST MUST MUST be rooted at a binder that maps or corresponds to NetSuite's "SuiteScripts" file chiffonier folder. This extension assumes the working root is equivalent to the remote "SuiteScripts" folder.

In VS Code, open the folder that corresponds to your local copy of the SuiteScripts folder in VSCode. That folder may not be named "SuiteScripts", just information technology should exist the folder that corresponds to SuiteScripts in the NetSuite file cabiner.

VS Code Extension Settings

You may manage settings for this extension either in your global user settings for all VS Code projects, or in a project-specific Workspace settings file that can be created or found beneath .vscode\settings.json.

Keep reading for required settings relating to authentication and more.

Authentication Setup

This extension tin authenticate to NetSuite and access the RESTlet script using either NLAuth authorization or OAuth 1.0 authority.

Place the post-obit in either Workspace settings or general User settings:

          {   // Hallmark header   "netSuiteUpload.authentication": "NLAuth nlauth_account=<ACCOUNTID>, nlauth_email=<LOGIN>, nlauth_signature=<PASSWORD>, nlauth_role=<Function>",  }                  

Where:

• ACCOUNTID is your NetSuite account ID number
• LOGIN is your email address used to log into NetSuite
• Countersign is your password (make sure you don't commit this file to source command)
• Role is the numeric NetSuite RoleID for which yous take spider web service/API permissions. Yous may need to become look this upwards in NetSuite Setup…Users/Roles…Manage Roles.

Hallmark Option 2: OAuth

Generating the necessary tokens for OAuth is covered in the NetSuite help site. It's not fun.

• If y'all wish to apply OAuth hallmark instead of basic authentication you lot tin can leave the hallmark header blank and use the OAuth settings properties.
• Outset, generate an Integration record in NetSuite, make certain the 'token based authentication' scheme is checked, and hang on to the token and undercover details.
• Second, log into a role yous wish to use for authentication. From the "manage tokens eye", generate a new token and undercover using the Integration from the previous footstep.
• Input the four values from above (NetSuite key and token and Consumer key and token) in the corresponding settings options.
• Set the realm setting equal to your numeric NetSuite account number.

Authorization - Required Role Permissions

This extension requires the use of a NetSuite RESTlet. That RESTlet volition be manipulating files and folders in the SuiteScripts folder of the File Cabinet. Therefore, the user being authenticated must have sufficient permissions assigned to their Part to permit these file changes, and to call the RESTlet script deployment.

At a minimum, the Role must have the following permissions:

• Lists…Documents and Files: Full
• Setup…Allow JS / HTML Uploads
• Setup…Log in using Access Tokens: Full
• Setup…SuiteScript: Full

If you wish to upload and download into the SuiteBundles folder past changing the rootDirectory setting, add the following permission to your Role.

• Setup…SuiteBundler: Full

settings.json

The post-obit demonstrates all possible settings.

          {   // Script Deployment URL for the deployed vscodeExtensionRestlet.js   "netSuiteUpload.restlet": "<RESTlet URL>",    // Base of operations NetSuite folder path to upload script to (e.m. "SuiteScripts/Developer"). Default if unset is "SuiteScripts".   "netSuiteUpload.rootDirectory": "<Base FOLDER PATH>"    // Temporary folder (east.one thousand. C:\\temp or /tmp) - used for diffing files betwixt local and remote.   "netSuiteUpload.tempFolder": "<TEMP FOLDER PATH>"    // Authentication - Use either NLAuth or Token Auth.    // Authentication header for NLAuth. remove or comment out if using OAuth.   "netSuiteUpload.hallmark": "NLAuth nlauth_account=<ACCOUNTID>, nlauth_email=<LOGIN>, nlauth_signature=<Countersign>, nlauth_role=<Role>",    // If using OAuth, set all of these.   // Oauth NetSuite Cardinal or Token ID   "netSuiteUpload.netSuiteKey": "<NETSUITE TOKEN KEY>",   // Oauth NetSuite Hole-and-corner   "netSuiteUpload.netSuiteSecret": "<NETSUITE Cloak-and-dagger>",   // Oauth NetSuite Consumer Key   "netSuiteUpload.consumerToken": "<CONSUMER TOKEN>",   // Oauth NetSuite Consumer Surreptitious   "netSuiteUpload.consumerSecret": "<CONSUMER Hush-hush>",   // Account number   "netSuiteUpload.realm": "<NETSUITE Business relationship NUMBER>", }                  

keybindings.json

You tin add keybindings for a number of operations.

By default, 2 keybindings are pre-set in the Extension: upload and download.

• Upload: Ctrl+n,Ctrl+u
• Download: Ctrl+northward,Ctrl+d

You lot tin can remap or set new like so in your keybindings.json file:

          { "key": "ctrl+u",                "command": "netsuite-upload.uploadFile"},                  

Known Issues and Limitations

The plugin is using a RESTlet for the communication with NetSuite. RESTlets have some governance limitations, pregnant NetSuite may throttle API calls if they are sent too rapidly. The electric current implementation does not deal with this, so there could be problems pulling folders containing a lot of items from NetSuite.

cunninghamcank1945.blogspot.com

Source: https://marketplace.visualstudio.com/items?itemName=nsupload-org.netsuite-upload

Share this post