This is conjecture, not fact, on my part. It began with our NetSuite upgrade to 2021.2, which broke NetSuite-Sync. NetSuite-Sync is a Visual Studio Code plugin that makes it easy to upload JavaScript files to sandbox or production NetSuite with a couple of keystrokes. It only supports credentialed authentication.
After waiting a couple days, trying to upload to both our production and sandbox, and even swapping URLs to NetSuite SOAP API, nothing worked. I even tried a different plugin “Netsuite Upload.” Again, I used a credentialed based authentication. It failed too.
I had been notified that all SuiteTalk apps were going to require Token Based Authentication, and would no longer support credential-based authentication, but I never equated this to NetSuite-Sync or “NetSuite Upload.” However, this appears to be what broke them.
And now I’ll cut to the case. If you are using NetSuite-Sync… well… you’re sunk! npm uninstall netsuite-sync -g.
I installed “NetSuite Upload” from directly from within vsCode. It’s a plugin. Just find it by name and click install. It’s different from NetSuite-Sync in that it doesn’t use the Netsuite SOAP API, but instead uses it’s own custom Restlet. It also supports Token Based Authentication (TBA).
There is a link in the NetSuite Upload documenation to download the latest vscodeExtensionRestlet.js. If you are a developer, you’ll know how to upload that to the NetSuite file cabinet and create a Script File Definition, as well as a Deployment. Do that next.
Here are some notes about setting up the Token Based Authentication.
Setup >> Integreations >> Manage Integrations >> New
Setup >> Users/Roles >> Access Tokens >> New
Be sure to copy the output from both the Integration and the Access Token when you hit save in the previous two screens. You won’t ever see that info again. So paste it into Notepad and put it somewhere safe. Then use it to fill out your NetSuite upload settings. Your Realm is your account number. In this case, it is my sandbox account.
The last thing I’ll mention is that I have folders in my source code repository. I organize my scripts by type, like Event Scripts, Suitelets, Restlets, etc. I do not have similar folders in the NetSuite SuiteScripts directory. I upload all scripts to s single folder. When I was using NetSuite-Sync, it always uploaded to one and only one folder, no matter where the file was located on my local hard drive. So I wanted NetSuite Upload to work the same. To accomplish this, I modified the vscodeExtensionRestlet.js file as follows:
I make sure that no matter what folder on my hard drive a file originates from, it ends up in “SuiteScripts/[2nd level folder]/”. Be sure to modify all three functions, getFunc, postFunc and deleteFunc.
That’s the lowdown. From there you can open any JavaScript file in your source tree and hit [ctl+n] & [ctl+u] to unload it to NetSuite. If you right click the file in the left Nav, you’ll see you have options to download files, compare files between your local copy and Netsuite. NetSuite Upload is more robust than NetSuite-Sync. The only drawback is it is not so easy to swap between production and sandbox. I’ll save that for another blog post. Happy computing!
Tabs are a great way to organize screen real estate. However, there are some things that you need to keep in mind when adding tabs to a Suitelet.
If all controls in your Suitelet are standard NetSuite controls and you do not add any INLINEHTML, you should be fine. However, there are times when you need to do your own thing. If that is your situation, read on!
If you add <input> or <textarea> or any other standard HTML controls tags inside an INLINEHTML, the values in those will correctly POST. They work just like NetSuite controls, form.addField({ type: ANYTHING_BUT_INLINHTML}). However, once you add tabs to your Suitelet, those same <input> controls no longer POST.
The workaround is this. In the client script, be sure to populate a standard NetSuite control, which can be hidden, with any values you need to POST back to your server-side program.
Here is an example of how this works. In this Suitelet, I have 2 tabs and 3 controls which I POST back to the server. You can’t see it here, but Tab 2 has a hidden serverWidget.FieldType.HIDDEN control which I POST back to the server. What I’m demonstrating is that you can still use INLINEHTML <input>, <textarea> tags, but be sure to move the results into your HIDDEN field before submitting the page.
When you click POST, which is just a standsard <submit> control, here is what you see.
The <textarea> control that is nested inside an INLINEHTML control, but not inside a tab, works great. Results are sent back to the server. The <textarea> control inside Tab 1 does not make it back. And finally the serverWidget.FieldType.TEXT, but hidden, inside Tab 2 also works fine and POSTs correctly back to the server.
One more things before I show you my code. If you dissect the DOM, you’ll find that each tab has become it’s own <form>. If you have 2 tabs, you’ll have at least 3 forms . Form[0] is full of a bunch of NetSuite variables. Once I added tabs, I could no longer jQuery(‘form’).submit(). I ended up doing a jQuery(‘input[type=”submit”]’)[0].click().
Here is my example code, which hopefully makes better sense of this topic.
/**
*@NApiVersion 2.x
*@NScriptType Suitelet
*/
define(['N/ui/serverWidget'],
function (serverWidget) {
function onRequest(context) {
var form = serverWidget.createForm({
title: 'Custom Suitelet Demo of Tabs Response on POST'
});
form.addFieldGroup({
id: 'fieldgroup_main',
label: 'Primary Information'
})
if (context.request.method === 'POST') {
// Show results of POST
var parameters = context.request.parameters;
var results = form.addField({
id: 'custpage_not_in_tab_inlinehtml',
type: serverWidget.FieldType.INLINEHTML,
label: 'This label will not show',
container: 'fieldgroup_main'
});
results.defaultValue = [
'<b>custpage_not_in_tab:</b> ' + parameters.custpage_not_in_tab + '<br />',
'<b>custpage_in_tab:</b> ' + parameters.custpage_in_tab + '<br />',
'<b>custpage_std_control:</b> ' + parameters.custpage_std_control + '<br />',
].join("\n");
}
else {
// Build the initial Page on GET
form.addField({
id: 'custpage_label1',
type: serverWidget.FieldType.LABEL,
label: 'There is a standard HTML control outside of tabs',
container: 'fieldgroup_main'
});
// Add a standard html control (not a NetSuite form.addField()) outside of the tabs
var results = form.addField({
id: 'custpage_not_in_tab_inlinehtml',
type: serverWidget.FieldType.INLINEHTML,
label: 'This label will not show',
container: 'fieldgroup_main'
});
results.defaultValue = [
'<textarea id="custpage_not_in_tab" name="custpage_not_in_tab">This will make it back on POST</textarea>'
].join("\n");
// You'll need at least 2 tabs for them to show.
form.addTab({
id: 'custpage_tab_1',
label: 'Tab 1'
});
form.addField({
id: 'custpage_label2',
type: serverWidget.FieldType.LABEL,
label: 'There is a standard HTML control inside a tab',
container: 'custpage_tab_1'
});
// Add another standard html control inside of the tabs
var control_in_tab = form.addField({
id: 'custpage_in_tab_inlinehtml',
type: serverWidget.FieldType.INLINEHTML,
label: 'This label will not show',
container: 'custpage_tab_1'
});
control_in_tab.defaultValue = [
'<textarea id="custpage_in_tab">This will NOT make it back on POST</textarea>'
].join("\n");
form.addTab({
id: 'custpage_tab_2',
label: 'Tab 2'
});
form.addField({
id: 'custpage_label3',
type: serverWidget.FieldType.LABEL,
label: 'There is a hidden NetSuite control inside a tab',
container: 'custpage_tab_2'
});
/**
* The shipmethod control must be a standard netsuite control
* in order to post back to the server while the control is placed inside a
* tab.
*/
var custpage_std_control = form.addField({
id: 'custpage_std_control',
type: serverWidget.FieldType.TEXT,
label: 'This label will not show',
container: 'custpage_tab_2'
}).updateDisplayType({
displayType: serverWidget.FieldDisplayType.HIDDEN
});
custpage_std_control.defaultValue = 'This text WILL make it back to the server';
}
form.addSubmitButton({
label: 'POST'
});
context.response.writePage(form);
}
return {
onRequest: onRequest
}
}
);
Why can’t I calculate shipping in sandbox? How can I test that shipping rates change when I change the shipping method? In sandbox, I get this nebulous error: “Could not calculate cost for the selected Realtime rate. UPS did not return any rates for the specified origin and destination addresses.”
There are two places to configure shipping in NetSuite. I’m referencing these from the Administrator role.
Setup >> Accounting >> Shipping – where you define your shipping carrier information
Lists >> Accounting >> Shipping Items – where you define the delivery methods (like ground, next day air, etc.)
When you refresh your sandbox, most of the carrier info gets transferred, but not all of it. And it is possible that when you setup your carrier info in sandbox, you’ll need special accounts (test accounts) from your carriers.
Since sandbox is not production, but you still need to test, you can simply set unique rates for each of your shipping items. That way, when you change from UPS Ground to 2nd Day air, shipping cost will change. It won’t be correct, but who cares? It’s sandbox! Here is where you’ll do that under the shipping item.
My job is to find ways to make other people’s job easier. One of my tasks involved calculating shipping from a custom Suitelet. This presented multiple obstacles. Here are my notes. I’m betting this will save both of us time if we ever need to come back to calculating shipping.
First, the code that calculates shipping works like this. It’s client-side code that builds an XML request which is sent to the server to do the heavy lifting. All of NetSuite’s client-side code is written in SuiteScript 1.0. It all ends with a server call that looks like this…
As you can see, the client side code sends a request to the server where it passes xmlStr to getShippingRates. However, all the code which builds xmlStr is buried deep in the standard estimate Edit screen and not available in a custom Suitelet, unless you put it there yourself.
Trick number one, how to find the NetSuite’s client side code that handles building the xmlStr. Using Chrome Developer Tools, you can inspect the button and see which event it fires.
However, searching in Chrome Dev Tools to find calculateRates was futile. So here’s how I found it.
Edit an estimate (or sales order)
Open Dev Tools
In the console tab, type the following and hit enter. It exposes the calculateRates function, along with all the other code which builds the xmlStr parameter.
Once I could see the JavaScript, I could cut and paste it into a text file where I was able to rewrite the SuiteScript 1.0 code and integrate it into my client side JavaScript in my custom Suitelet.
Here is my sample code written in SuiteScript 2.0. It was derived from NetSuite standard “Calculate Shipping” code written in SuiteScript 1.0. If you jump to the bottom and review the calculateRate function, this is where it all begins. And please remember, THIS IS CLIENT-SIDE CODE. It will ultimately be fired by a button click or some other event in your custom Suitelet.
Like almost all my posts, this is a simple concept that quickly turned into brain surgery. So let’s dumb this down.
I needed a way to select and set the shipping method on an estimate from a Suitelet. Before I even started coding, I noticed that I had different shipping methods based on my selection of shipping carriers. What I mean by this is that when editing an estimate, when you change the shipping carrier, it blanks the shipping methods dropdown and the choices change. So how does NetSuite know which methods (also known as shipitem) are associated with each of the two carriers? Great question!
Setup >> Accounting >> Shipping — Shows carriers
List >> Accounting >> Shipping Items — Shows shipping methods
I’ll share some code written in SuiteScript 2.1 that can be dropped into debugger. When you run it, you’ll see the list of all shipping methods. It is not limited by carrier and in fact the carrier field is blank. Why? Who knows?
However, what I learned was that any custom shipping methods (shipitem) gets associated with the FedEx/USPS/more carrier. AND… when you change the shipping method, it automatically changes the carrier. So set to one of the UPS methods and the carrier magically becomes UPS. Set to any method not prefixed with UPS, and the carrier becomes FedEx/USPS/more.
In an estimate, after changing the method to any method other than one of the UPS methods, and inspect it using SuiteScript Field Explorer (a Chrome plugin), you’ll see the carrier is set to “nonups”.
So it would appear that the two carriers (under the hood) are UPS and “Other”!
Here is my code. The commented section at the bottom was my great revelation. Changing the method automatically changes the carrier. Be sure to select script type of 2.1 when you run this in debugger.
require(['N/search', 'N/record'],
(search, record) => {
log.debug('Start');
let mySearch = search.create({
type: 'shipitem',
columns: [
search.createColumn({ name: 'internalid'}),
search.createColumn({ name: 'carrier', sort: 'ASC'}),
search.createColumn({ name: 'itemid', sort: 'ASC'})
],
filters: [
['isinactive', 'is', false]
]
})
let myPages = mySearch.runPaged({ pageSize: 1000 });
for (let i = 0; i < myPages.pageRanges.length; i++) {
let myPage = myPages.fetch({ index: i });
myPage.data.forEach(
function (result) {
let internalid = result.getValue('internalid');
let carrier = result.getValue('carrier');
let itemid = result.getValue('itemid');
log.debug(`${carrier}: ${itemid}: ${internalid}`)
}
)
}
// var rec = record.load({
// type: record.Type.ESTIMATE,
// id: xxxxxxxx,
// isDynamic: false
// });
// rec.setValue('shipmethod', xxx);
// rec.save();
log.debug('Done');
}
)
Here is another coding challenge that set me back more time than I would have liked. Passing an array of objects to the Array.sort() function worked most of the time, but not always. And when it blew up, the error was completely unhelpful.
Please note this is server-side code. Client-side code runs in a different JavaScript engine. In my case it was running inside a Suitelet written in SuiteScript 2.0. I did NOT try this same problem in SuiteScript 2.1 which gets a completely new JavaScript engine and ES6. Perhaps it might have worked. Moving from 2.0 to 2.1 requires also updating libraries. That was too much work. Here was my basic problem:
var transactions = [
{
salesrep: salesrep_id,
salesorder_total: salesorder_total
},...
/* In my case, there were less than 200
records in this array when it failed.
This was far short of the number of
records it processed successfully.
The only thing I noticed about this
particular set of records which caused
the failure was the number of records
where salesorder_total was zero.
Not all, but more than a few! */
]
var sortedbyTotalDescending = transactions.sort(
function(a, b) {
return a.salesorder_total <= b.salesorder_total ? 1 : -1;
}
);
This worked correctly for months. However, there were certain times when it blew up. This is what solved the problem. And don’t ask me why. I’m clueless. It should have. Please direct your questions to NetSuite. I believe it is a bug in their SuiteScipt 2.0 JavaScript engine!
/* This one works! */
var sortedbyTotalDescending = transactions.sort(
function(a, b) {
if (a.salesorder_total == b.salesorder_total) return 0;
return a.salesorder_total < b.salesorder_total ? 1 : -1;
}
);
Understanding how to edit addresses under a customer turned out to be a bit tricky. Here is how I did it.
First, you can add custom fields, but to do that, you need to go to
Customization >> Forms >> Address Forms
Customize the “Standard Address Form.” Assign a country or countries to your form. This is important if you plan to use custom fields in an address. The form is where you add them. Custom fields will then be available to addresses in the assigned countries.
Next, it is important to understand that addresses are a subrecord. The sublist is called “addressbook” and is indexed by “addressbookaddress”. This will make more sense when you review the code below. You read the sublist, and then the associated subrecord under it. Here are the standard fields in the sublist for “addressbook”.
Label – not unique and if omitted becomes Address Line 1 defaultbilling – must be unique to one address defaultshipping – must be unique to one address isresidential – can apply to any or all addresses
Under each address is a subrecord that contains these fields:
Attention Addressee Address Line 1 Address Line 2 Address Line 3 City State Zip Any custom fields that you’ve created
Here is a code example that demonstrates how to update addresses. The variable “line” corresponds with a zero-based index of the address as it appears in the Address tab under a customer. The variable “customer_id” is the internal ID of the customer and all assigned values are coming from variables which you’d set prior to running this code.
/**
* Load the record to gain access to the Address sublist
*/
var rec = record.load({
type: record.Type.CUSTOMER,
id: customer_id,
isDynamic: false
});
if (/* you need to insert an address, do it here. You decide! */) {
rec.insertLine({
sublistId: 'addressbook',
line: 0
});
line = 0;
}
/**
* Modify those fields present in the Address sublist lines
*/
rec.setSublistValue({
sublistId: 'addressbook',
fieldId: 'label',
value: label,
line: line
});
rec.setSublistValue({
sublistId: 'addressbook',
fieldId: 'defaultbilling',
value: defaultbilling,
line: line
});
rec.setSublistValue({
sublistId: 'addressbook',
fieldId: 'defaultshipping',
value: defaultshipping,
line: line
});
rec.setSublistValue({
sublistId: 'addressbook',
fieldId: 'isresidential',
value: is_residential,
line: line
});
/**
* Load the sublist record, which holds all the actual address fields
*/
var subrec2 = rec.getSublistSubrecord({
sublistId: 'addressbook',
fieldId: 'addressbookaddress',
line: line
});
/**
* Modify all subrecord fields
*/
subrec2.setValue({
fieldId: 'attention',
value: attention
});
subrec2.setValue({
fieldId: 'addressee',
value: addressee
})
subrec2.setValue({
fieldId: 'addr1',
value: addr1
});
subrec2.setValue({
fieldId: 'addr2',
value: addr2
});
subrec2.setValue({
fieldId: 'addr3',
value: addr3
})
subrec2.setValue({
fieldId: 'city',
value: city
});
subrec2.setValue({
fieldId: 'state',
value: state
});
subrec2.setValue({
fieldId: 'zip',
value: zip
});
/**
* Save the record
*/
rec.save();
I recently got this in an email from NetSuite: “You are receiving this notification because you use the Token-based Authentication (TBA) feature in your account for integrations that use HMAC-SHA1 as a signature method. As of NetSuite 2021.2, the use of HMAC-SHA1 will be deprecated. Before your account is upgraded to 2021.2, you must change your integrations to use HMAC-SHA256 as the signature method.“
It sounded ominous, but turned out not to be a huge effort. If you’re like me, this TBA stuff captured my attention just long enough to get it working. So getting back into it took a little refamiliarizing. Hopefully this will save you some time.
In my post SuiteTalk TBA Example in C#, you’ll find the following code snippet. Here are the changes required to move from HMAC-SHA1 to HMAC-SHA256. I commented out the old block to highlight what changed.
I needed a method that would validate dates in multiple formats. Here are examples of dates that needed to pass validation: ‘6/9/2021’, ‘6/10/2021’, ‘9-Jun-2021′, ’10-Jun-2021′, ’06/09/2021′, ’06/10/2021’. This problem came to me on June 9th, 2021. So ’06/09/2021′ failed, but ’06/10/2021′ passed. Hmm… If you guessed it was not allowing backdates, you’d be wrong.
In my testing I learned that typeof 09 == ‘number’, but parseInt(09) = NaN. How can that be?
The NetSuite (server-side) JavaScript engine treats numbers with leading zeros as base-8 (octal). So be sure to strip leading zeros, even on integer numbers of type ‘number’. Since base-8 only included digits 0 through 7, parseInt(09) is not a number!
NetSuite’s native rich text editor has some problems. It often accepts or even creates HTML that NetSuite won’t print. Here’s how to replace it with TinyMCE, a rich text editor that works much better.
Now that you know all the steps, here’s my method. It’s much shorter and has fewer moving parts, but it breaks a few NetSuite rules regarding not editing the DOM.
It all begins with understanding what make’s NetSuite’s out-of-the-box rich text control work. Here is what the control looks like. In this case, I’m editing a custom fields called custbody_note_internal.
And here is the code that represents this control.
This is the control that is read back by the server to update the field in the underlying record. I found that if I swapped this type=”hidden” for a textarea control, the server accepted it just the same! And once you make the swap to a textarea, you can easily turn that textarea into a TinyMCE control.
Per Marty’s article above, you need to include the TinyMCE javascript library. He does this via client-side JavaScript and also adds code to wait for it to load. In my case (and I’m not showing this here), I load the reference along with other JavaScript libraries on the server-side. I download the link as part of the page. I’m still referencing the CDN delivered library. Because I’m delivering the link in the page and not dynamically via client-side JavaScript, I don’t need to wait for the library to load, which saves a step for me.
Next, anyplace client-side where I can run an after-load script tucked away inside a $(document).read() function, I place this code.
Let’s walk through this.
Line 1367: I’m getting a reference to multiple custom fields that all require a rich text edit swap to TinyMCE. Line 1370: I’m getting the name and ID of the “Rubber meets the road hidden input field.” Line 1371: I’m getting the initial value of the rich text editor I’m replacing. Line 1372: I’m replacing the span tag on line 18 of the HTML with a textarea that has the name and ID of my custom field. It also has a class of “tinymce-richtext”. Line 1379: I’m initializing TinyMCE on all my swapped textareas. I use the class to initialize them all at once. Line 1384: Here is magic! This is an onchange event fired by TinyMCE. It copies the contents of the TinyMCE editor into the textarea that I created in line1372.
What’s amazing about this is that TinyMCE will convert pasted images into base-64 encoded html tags. These “Image” tags cut and paste just like regular text. so you can paste snippets of screens or any other image from your clipboard into the TinyMCE editor and not only will it save with the underlying record, it prints too!
This solution breaks NetSuite’s rule of not editing the DOM. However, it saves a number of steps outlined in Marty’s article. It comes with no guarantees. Use it at your own risk. And… be sure to test it with each new release of NetSuite. OK… That’s my final disclaimer. Good luck!
NetSuite Experiences 