Netsuite Tips | Ursus Code

Suitescript 2.0 SFTP Tool

August 24, 2022 Adolfo Garza Comments 3 comments

One of the new features of SuiteScript API 2016.2 is the ability to connect to SFTP Servers directly from Netsuite.

Here are some downsides I found:

~~Not way to list the contents of a remote directory~~ <– This has been added
~~No way of connecting using a private key~~. <– This has been added
Not all SFTP servers are supported as Netsuite requires the server to support some encryption algorithms.
No way of obtaining the server’s hostkey natively.

Unfortunately the process is a bit confusing if you are new to the SFTP world so I created a tool that will help you jump-start your script. I found this tool very useful as I was able to test an SFTP connection quickly for a client and turned out the SFTP server that they were trying to use didn’t actually support Netsuite’s approved algorithms (aes256-ctr, es192-ctr, es128-ctr), so it saved me a lot of time as I was able to quickly discard it and move on.

I also included an endpoint to get the HostKey of the URL you are trying to connect to. I think this will be very useful for people who don’t have a Linux server lying around where they can run ssh keyscan.

Note: The HostKey endpoint should be used to grab the hostkey and store it elsewhere on your end. Do not use the endpoint to request the hostkey every time you make a request. If your server HostKey changes very frequently then I suggest to build your own tool.

Here’s a video tutorial:

https://www.youtube.com/watch?v=azxo7GS3xRQ

And here’s the code ready to be uploaded as a Suitelet, have fun!:

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

/* = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =\

|| This script is a tool to help develop SFTP connections ||

|| in Suitescript 2.0 ||

|| ||

|| Version Date Author Remarks ||

|| 1.0 Oct 03 2016 Adolfo Garza Initial commit ||

|| 1.1 Oct 11 2016 Adolfo Garza Casting Port and Timeout ||

|| to Number ||

|| 1.2 Dec 23 2016 Adolfo Garza Added support for HostKey ||

|| Port and Type ||

\= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = */

var HTTPSMODULE, SFTPMODULE, SERVERWIDGETMODULE;

var HOST_KEY_TOOL_URL = 'https://ursuscode.com/tools/sshkeyscan.php?url=';

/**

*@NApiVersion 2.x

*@NScriptType Suitelet

*@NModuleScope Public

define(["N/https", "N/sftp", "N/ui/serverWidget"], runSuitelet);

//********************** MAIN FUNCTION **********************

function runSuitelet(https, sftp, serverwidget){

HTTPSMODULE= https;

SERVERWIDGETMODULE= serverwidget;

SFTPMODULE= sftp;

var returnObj = {};

returnObj.onRequest = execute;

return returnObj;

}

function execute(context){

var method = context.request.method;

var form = getFormTemplate(method);

if (method == 'GET') {

form = addSelectorFields(form);

}

if (method == 'POST') {

var selectaction = context.request.parameters.selectaction;

if(selectaction == 'getpasswordguid'){

form = addPasswordGUID1Fields(form);

}

else if(selectaction == 'gethostkey'){

form = addHostKeyFields(form);

}

else if(selectaction == 'downloadfile'){

form = addDownloadFileFields(form);

} else {

var password = context.request.parameters.password;

var username = context.request.parameters.username;

var passwordGuid = context.request.parameters.passwordguid;

var url = context.request.parameters.url;

var hostKey = context.request.parameters.hostkey;

var hostKeyType = context.request.parameters.hostkeytype;

var port = context.request.parameters.port;

var directory = context.request.parameters.directory;

var timeout = context.request.parameters.timeout;

var filename = context.request.parameters.filename;

var restricttoscriptids = context.request.parameters.restricttoscriptids;

var restricttodomains = context.request.parameters.restricttodomains;

if(restricttoscriptids && restricttodomains){

form = addPasswordGUID2Fields(form, restricttoscriptids, restricttodomains);

}

if(password){

form.addField({

id : 'passwordguidresponse',

type : SERVERWIDGETMODULE.FieldType.LONGTEXT,

label : 'PasswordGUID Response',

displayType: SERVERWIDGETMODULE.FieldDisplayType.INLINE

}).defaultValue = password;

}

if(url && passwordGuid && hostKey && filename){

var sftpConnection = getSFTPConnection(username, passwordGuid, url, hostKey, hostKeyType, port, directory, timeout);

var downloadedFile = sftpConnection.download({

filename: filename

}).getContents();

form.addField({

id : 'filecontents',

type : SERVERWIDGETMODULE.FieldType.LONGTEXT,

label : 'File Contents',

displayType: SERVERWIDGETMODULE.FieldDisplayType.INLINE

}).defaultValue = downloadedFile;

} else if (url) {

var myUrl = HOST_KEY_TOOL_URL + url + "&port=" + port + "&type=" + hostKeyType;

var theResponse = HTTPSMODULE.get({url: myUrl}).body;

form.addField({

id : 'hostkeyresponse',

type : SERVERWIDGETMODULE.FieldType.LONGTEXT,

label : 'Host Key Response',

displayType: SERVERWIDGETMODULE.FieldDisplayType.INLINE

}).defaultValue = theResponse;

}

context.response.writePage(form);

return;

}

function addSelectorFields(form){

var select = form.addField({

id: 'selectaction',

type: SERVERWIDGETMODULE.FieldType.SELECT,

label: 'Select Action'

});

select.addSelectOption({

value: 'getpasswordguid',

text: 'Get Password GUID',

});

select.addSelectOption({

value: 'gethostkey',

text: 'Get Host Key'

});

select.addSelectOption({

value: 'downloadfile',

text: 'Download File'

});

return form;

}

function addPasswordGUID1Fields(form){

form.addField({

id : 'restricttoscriptids',

type : SERVERWIDGETMODULE.FieldType.TEXT,

label : 'Restrict To Script Ids',

}).isMandatory = true;

form.addField({

id : 'restricttodomains',

type : SERVERWIDGETMODULE.FieldType.TEXT,

label : 'Restrict To Domains',

}).isMandatory = true;

return form;

}

function addPasswordGUID2Fields(form, restrictToScriptIds, restrictToDomains){

form.addCredentialField({

id : 'password',

label : 'Password',

restrictToScriptIds: restrictToScriptIds.replace(' ', '').split(','),

restrictToDomains: restrictToDomains.replace(' ', '').split(','),

});

return form;

}

function addHostKeyFields(form){

form.addField({

id : 'url',

type : SERVERWIDGETMODULE.FieldType.TEXT,

label : 'URL (Required)',

});

form.addField({

id : 'port',

type : SERVERWIDGETMODULE.FieldType.INTEGER,

label : 'Port (Optional)',

});

form.addField({

id : 'hostkeytype',

type : SERVERWIDGETMODULE.FieldType.TEXT,

label : 'Type (Optional)',

});

return form;

}

function addDownloadFileFields(form){

form.addField({

id : 'url',

type : SERVERWIDGETMODULE.FieldType.TEXT,

label : 'URL (Required)',

});

form.addField({

id : 'username',

type : SERVERWIDGETMODULE.FieldType.TEXT,

label : 'Username',

});

form.addField({

id : 'passwordguid',

type : SERVERWIDGETMODULE.FieldType.LONGTEXT,

label : 'PasswordGuid (Required)',

});

form.addField({

id : 'hostkey',

type : SERVERWIDGETMODULE.FieldType.LONGTEXT,

label : 'Host Key (Required)',

});

form.addField({

id : 'hostkeytype',

type : SERVERWIDGETMODULE.FieldType.TEXT,

label : 'Host Key Type',

});

form.addField({

id : 'filename',

type : SERVERWIDGETMODULE.FieldType.TEXT,

label : 'File Name',

});

form.addField({

id : 'port',

type : SERVERWIDGETMODULE.FieldType.INTEGER,

label : 'Port',

});

form.addField({

id : 'directory',

type : SERVERWIDGETMODULE.FieldType.TEXT,

label : 'Directory',

});

form.addField({

id : 'timeout',

type : SERVERWIDGETMODULE.FieldType.INTEGER,

label : 'Timeout',

});

return form;

}

function getFormTemplate(){

var form = SERVERWIDGETMODULE.createForm({

title : 'SFTP Helper Tool'

});

form.addSubmitButton({

label : 'Submit'

});

return form;

}

function getSFTPConnection(username, passwordGuid, url, hostKey, hostKeyType, port, directory, timeout){

var preConnectionObj = {};

preConnectionObj.passwordGuid = passwordGuid;

preConnectionObj.url = url;

preConnectionObj.hostKey = hostKey;

if(username){ preConnectionObj.username = username; }

if(hostKeyType){ preConnectionObj.hostKeyType = hostKeyType; }

if(port){ preConnectionObj.port = Number(port); }

if(directory){ preConnectionObj.directory = directory; }

if(timeout){ preConnectionObj.timeout = Number(timeout); }

var connectionObj = SFTPMODULE.createConnection(preConnectionObj);

return connectionObj;

}

Suitescript 2.0 Quickstart Examples

August 24, 2022 Adolfo Garza Comments 3 comments

Here I will be posting the most used scripts from Suitescript 2.0. These code examples are meant for beginners to be a quick start so they can quickly get a script started and add their code to them. I tried to keep them short. If you are a beginner I recommend you to check Netsuite’s Help section and navigate to Suitescript 2.0 API so you can learn more about each.

Client Script

Note: Check out how the helper functions in clientscript have to be nested inside the main runClientscript function. This is something particular to client scripts.

100

101

102

var SEARCHMODULE;

/**

*@NApiVersion 2.x

*@NModuleScope Public

*@NScriptType ClientScript

define(['N/search'], runClientscript);

function runClientscript(search){

SEARCHMODULE = search;

//*********** HELPER FUNCTIONS ***********

function lineInit(context) {

//SEARCHMODULE.load(123);

context.currentRecord;

context.sublistId;

alert("lineInit Triggered!");

return;

}

function pageInit(context) {

context.currentRecord;

context.mode;

alert("pageInit Triggered!");

return;

}

function postSourcing(context) {

context.currentRecord;

context.sublistId;

context.fieldId;

alert("postSourcing Triggered!");

return;

}

function saveRecord(context) {

context.currentRecord;

alert("saveRecord Triggered!");

return true; //Return true if you want to continue saving the record.

}

function sublistChanged(context) {

context.currentRecord;

context.sublistId;

alert("sublistChanged Triggered!");

}

function validateDelete(context) {

context.currentRecord;

context.sublistId;

alert("validateDelete Triggered!");

return true; //Return true if the line deletion is valid.

}

function validateField(context) {

context.currentRecord;

context.sublistId;

context.fieldId;

context.line;

context.column;

alert("validateField Triggered!");

return true; //Return true to continue with the change.

}

function validateInsert(context) {

context.currentRecord;

context.sublistId;

alert("validateInsert Triggered!");

return true; //Return true if the line insertion is valid.

}

function validateLine(context) {

context.currentRecord;

context.sublistId;

alert("validateLine Triggered!");

return true; //Return true if the line is valid.

}

function fieldChanged(context) {

context.currentRecord;

context.sublistId;

context.fieldId;

context.line;

context.column;

alert("fieldChanged Triggered!");

return;

}

var returnObj = {};

returnObj.lineInit = lineInit;

returnObj.pageInit = pageInit;

returnObj.postSourcing = postSourcing;

returnObj.saveRecord = saveRecord;

returnObj.sublistChanged = sublistChanged;

returnObj.validateDelete = validateDelete;

returnObj.validateField = validateField;

returnObj.validateInsert = validateInsert;

returnObj.validateLine = validateLine;

returnObj.fieldChanged = fieldChanged;

return returnObj;

}

User Event Script

var SEARCHMODULE;

/**

*@NApiVersion 2.x

*@NModuleScope Public

*@NScriptType UserEventScript

define(['N/search'], runUserEvent);

function runUserEvent(search) {

SEARCHMODULE = search;

var returnObj = {};

returnObj.beforeLoad = beforeLoad;

returnObj.afterSubmit = afterSubmit;

returnObj.beforeSubmit = beforeSubmit;

return returnObj;

}

function beforeLoad(context) {

//SEARCHMODULE.load(123);

log.debug('beforeLoad Triggered');

context.newRecord;

context.type;

context.form;

return;

}

function afterSubmit(context) {

//SEARCHMODULE.load(123);

log.debug('afterSubmit Triggered');

context.newRecord;

context.oldRecord;

context.type;

return;

}

function beforeSubmit(context) {

//SEARCHMODULE.load(123);

log.debug('beforeSubmit Triggered');

context.newRecord;

context.oldRecord;

context.type;

return;

}

Scheduled Script

var SEARCHMODULE;

/**

*@NApiVersion 2.x

*@NScriptType ScheduledScript

*@NModuleScope Public

define(["N/search"], runScheduledScript);

//********************** MAIN FUNCTION **********************

function runScheduledScript(search){

SEARCHMODULE = search;

var returnObj = {};

returnObj.execute = execute;

return returnObj;

}

function execute(context){

//SEARCHMODULE.load(123);

context.type;

log.debug("ScheduledScript Triggered");

}

Suitelet

var SEARCHMODULE, UIMODULE;

/**

*@NApiVersion 2.x

*@NScriptType Suitelet

*@NModuleScope Public

define(['N/search', 'N/ui/serverWidget'], runSuitelet);

//********************** MAIN FUNCTION **********************

function runSuitelet(search, ui){

SEARCHMODULE = search;

UIMODULE = ui;

var returnObj = {};

returnObj.onRequest = execute;

return returnObj;

}

function execute(context){

//SEARCHMODULE.load(123);

if (context.request.method == 'GET') {

context.response.write('Hello World'); //Example writing HTML string

return;

} else {

var form = UIMODULE.createForm({ title: 'Demo Suitelet Form' }); //Example writing form object

context.response.writePage(form);

}

RESTlet

var SEARCHMODULE;

/**

*@NApiVersion 2.x

*@NScriptType Restlet

*@NModuleScope Public

define(['N/search'], runRestlet);

//********************** MAIN FUNCTION **********************

function runRestlet(search){

SEARCHMODULE = search;

var returnObj = {};

returnObj.get = doGet;

returnObj.post = doPost;

returnObj.put = doPut;

returnObj.delete = doDelete;

return returnObj;

}

function doGet(restletBody){

log.debug('Called from GET', restletBody);

return "Hello from GET.<br /> Data received:<br />" + JSON.stringify(restletBody);

}

function doPost(restletBody){

log.debug('Called from POST', restletBody);

return "Hello from POST.\nData received:\n" + JSON.stringify(restletBody);

}

function doPut(restletBody){

log.debug('Called from PUT', restletBody);

return "Hello from PUT.\nData received:\n" + JSON.stringify(restletBody);

}

function doDelete(restletBody){

log.debug('Called from DELETE', restletBody);

return "Hello from DELETE.\nData received:\n" + JSON.stringify(restletBody);

}

Leave a comment if you want to see other examples.

11 Secret Suitescript 2.1 Features That Reptilians Don’t Want You To Know

May 1, 2020 Adolfo Garza Comments 4 comments

Suitescript 2.1 is out of beta and beginning on 2021.1 release all Suitescript 2.x scripts will be running as Suitescript 2.1 so better test your existing scripts for any bugs.

To change your scripts to use Suitescript 2.1 all you have to do is change this JSTag:

From:

1	“@NApiVersion 2.x”

To:

1	“@NApiVersion 2.1”

It’s also worth mentioning that as of today Suitescript 2.1 is not available for client scripts yet so bear that in mind.

“let” keyword:

This is basically a super local variable, it’s very useful for using them in for loops. Now you can have multiple nested for loops and declare all of your loop counter variables “i” and not worry about conflicts.

Example

Using var:

var i = 5;

for (var i = 0; i < 10; i++) {

// after last loop i equals 10

}

// Here i is 10

Using let:

let i = 5;

for (let i = 0; i < 10; i++) {

// after last loop i equals 10

}

// Here i is 5

For details check out w3schools.

“for of” statement

This is another way to loop through an array, I find it easier to write although it only works on iterables so this means it doesn’t work on objects as opposed to “for in” which works on both objects and arrays.

Example

Considering:

1	var array = [1];

Using “for in”:

for (let index in array){

let value = array[index];

//value equals 1

}

Using “for of”:

for (let value of array){

//value equals 1

}

This looks more elegant to me, but you be the judge.

For details check out w3schools.

String includes() Method

If you are like me and hate the sight of using .search() or regex to check if a string includes some text then you need this in your life.

Example

Considering the following string:

1	var myString = "The quarantine is a hoax designed by the government to change the batteries in all the birds";

Using search method:

1	var includesBirds = myString.search("birds") != -1; //true

Using includes method:

1	var includesBirds = myString.includes("birds"); //true

So your code would end up looking like this:

var sendFBI = myString.includes("birds") &&

myString.includes("government") &&

myString.includes("batteries"); //true

Holy molly, this was long overdue. I love this and will be using it very oftenly.

For details check out w3schools.

Array includes() Method

This is the same thing as the previous example with String includes() method. I find it easier and more elegant than using Array indexOf.

Example

Considering the following string:

1	var myArray = ["banana", "apple", "illuminati", "watermelon"];

Using indexOf method:

1	var includesIlluminati = myArray.indexOf("illuminati") != -1; //true

Using includes method:

1	var includesIlluminati = myArray.includes("illuminati"); //true

For details check out w3schools.

Array every() Method

This method is useful for validating if all of the elements of the array meet certain condition, if one of them doesn’t meet the condition then it returns false.

Example

var guestAges = [17,18,21,22,24];

var allAdults = guestAges.every( function (age){ return age >= 18; } );

//allAdults equals false because one of the guest ages is under 18

For details check out w3schools.

Set Object

The set object is a list of unique values of any type. This is very useful for removing duplicates from an Array.

Example

let myArray = [1,2,3,4,4,4,4,4,4,4,4,4,4,4,4,4,5];

let mySet = new Set(myArray); // mySet now equals {1, 2, 3, 4, 5}

let deDuplicatedArray = Array.from(mySet); //deDuplicatedArray now equals [1,2,3,4,5]

Here’s another example

let animals = new Set();

animals.add('pig');

animals.add('bear');

animals.add('cat');

animals.add('dog');

console.log(animals.size); // 4

animals.add('bear'); // Adding a duplicate

console.log(animals.size); // Still 4!

It has several methods you can use like: add, size, has, forEach, delete and clear so it makes a powerful tool by itself. Sets also outperforms Arrays so that’s another reason to love it.

For details check out Alligator.io and Mozilla Docs.

Spread syntax

This is basically used to expand an array or compact several parameters into an array.

Examples

Useful for concatenating two arrays like:

let array1 = ["bears", "beets"];

let array2 = ["battlestar galactica", ...array1 ];

//array2 equals ["bears","beets","battlestar galactica"]

Or making copies of arrays like:

let array1 = [1, 2, 3];

let array1Copy = array1; //This is a shallow copy

let array1CopySpread = [...array1 ];

array1Copy.push(4); //Pushing to the shallow copy

//array1 equals [1,2,3,4]

//array1Copy equals [1,2,3,4]

//array1CopySpread equals [1,2,3] //The copy using spread remains unmodified

For details and more uses check out Scotch.io and Mozilla Docs.

Template literals (Template strings)

This is a life changer. You can now use backtick characters (`) to have more freedom when defining strings, they also support placeholders and multi-line strings!

Example

Using string concatenation:

var myNumber = 23;

var myString = 'text line 1\n' +

'text line 2\n' +

'text with "double quotes" and \'single quotes\'\n' +

'text with variable value of ' + myNumber;

Using template literals:

var myNumber = 23;

var myString =

`text line 1

text line 2

text with "double quotes" and 'single quotes'

text with variable value of ${myNumber}`;

The output is the same:

text line 1

text line 2

text with "double quotes" and 'single quotes'

text with variable value of 23

For details and more uses check out Mozilla Docs.

Arrow functions

These functions work the same as regular functions but have a more compact syntax.

Example

Regular function:

function hello() {

return "Hello World!";

}

Arrow function:

hello = () => {

return "Hello World!";

}

And it can get even shorter:

1	hello = () => "Hello World!";

Anonymous arrow function with params:

1	((name)=> `Hello ${name}!`)('stranger'); //"Hello stranger!"

For details and more uses check out w3schools.

Serverside promises

Promises are now supported serverside so you can now write asynchronous code.

Example

https.get.promise({

url: 'https://jsonplaceholder.typicode.com/todos/1'

})

.then(function(response){

log.debug({

title: 'Response',

details: response

});

})

.catch(function onRejected(reason) {

log.debug({

title: 'Invalid Get Request: ',

details: reason

});

})

You can also create your own Promises now like so:

let promise = new Promise((resolve) => {

let response = https.get({url: 'https://jsonplaceholder.typicode.com/todos/1'});

resolve(response.body);

});

promise.then(log.debug); //This calls log.debug and uses whatever data is returned as parameter

For details and more uses check out Mozilla Docs.

Async functions (Async/Await)

Async functions provide a way to structure and simplify your asynchronous code. I find this very useful to avoid callback hell that comes with Promises as it can get pretty complex, I have seen some code where there’s an unending statements of .then.then.then….. in a row.

Example

async function asyncRequest(){ //<< Note the async keyword next to the function

let promise = new Promise((resolve) => {

let response = https.get({url: 'https://jsonplaceholder.typicode.com/todos/1'});

resolve(response.body);

});

//promise.then(log.debug); //No longer using this

let responseBody = await promise; //Using await instead

log.debug('responseBody', responseBody); //Logs correctly

}

For details and more uses check out Mozilla Docs.

So what do you think? Do you agree with our list? Share your comments below.