clientscript | Ursus Code

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.

SuiteScript 2.0 Dialog Prompt + On SaveRecord

December 29, 2016 Adolfo Garza Comments 4,931 comments

One of the new modules in Suitescript 2.0 is the “N/ui/dialog” module but unfortunately it doesn’t include a prompt method. I did some digging and found that the dialog module uses Sencha Ext JS. Since Ext JS doesn’t require the dialog module it can run on both SS 1.0 and 2.0!

Here’s how they look like side by side:

Native JS

jsprompt

Ext JS

extjsprompt

Note: This is a hack.

Here’s the code sample on how to achieve this (Works on both SS 1.0 and SS 2.0):

function showPrompt(){

Ext.Msg.prompt("My Prompt Title", "Please enter your text:", handlePromptResult, this);

function handlePromptResult(buttonClicked, text) {

if (buttonClicked !== 'ok') { return; }

console.log("You entered: " + text);

}

Additionally, thanks to this post from Abaci I was able to run this code right before the record is saved, which can be very useful to set the value of a field right before saving.

Here’s the code sample running on SaveRecord in SS 2.0:

/**

* @NApiVersion 2.0

* @NScriptType ClientScript

* @NModuleScope Public

define(['N/ui/dialog'],runClientScript);

function runClientScript(dialog){

var DIALOGMODULE = dialog;

var IS_CONFIRMED; //This global is used to detect if user has pressed "OK" in the prompt box

var returnObj = {};

returnObj.saveRecord = saveRecord;

return returnObj;

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

function saveRecord(context) { //If user clicked "OK" in prompt box then save, else show the confirmation box if record passes validation

if(IS_CONFIRMED){

return true;

} else {

if(!validateSaveRecord()){ //Here you do your own saveRecord validation/automation.

return false;

}

Ext.Msg.prompt("My Prompt Title", "Please enter your text:", handlePromptResult, this);

}

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

function handlePromptResult(buttonClicked, text) {

if (buttonClicked !== 'ok') { return; }

console.log("You entered: " + text);

IS_CONFIRMED = true;

getNLMultiButtonByName('multibutton_submitter').onMainButtonClick(this); //NS Hack to call simulate user clicking Save Button

}

function validateSaveRecord(){//Here you do your own saveRecord validation/automation.

return true; //Return true if you want to proceed with the save.

}

I hope that was useful for you. Don’t forget to leave a comment if you have any questions!