Module 2: Developing SuiteScripts

🎯 Learning Objectives

• Set up Eclipse IDE with SuiteCloud plugin
• Understand SuiteScript 2.0 file structure
• Write and deploy a Hello World script
• View script execution in the Execution Log

1. SuiteScript 2.0 Anatomy

Every SuiteScript 2.0 file has three required parts:

1. Required Annotations — Tell NetSuite about your script
2. Define Statement — Import modules and create your script module
3. Entry Point Functions — The functions NetSuite will call

2. Required Annotations

/**
 * @NApiVersion 2.1
 * @NScriptType UserEventScript
 */

Annotation	Purpose	Values
@NApiVersion	SuiteScript version	2.0 or 2.1
@NScriptType	Script type	UserEventScript, ClientScript, ScheduledScript, etc.
@NModuleScope	Module visibility (optional)	SameAccount, Public

3. The Define Statement

The define statement imports NetSuite modules and creates your script module:

define(['N/record', 'N/log'], function(record, log) {
    // Your code here
    
    return {
        afterSubmit: afterSubmit
    };
});

How It Works

Part	Purpose
['N/record', 'N/log']	Array of modules to import
function(record, log)	Parameters that receive the imported modules
return { ... }	Object mapping entry point names to functions

4. Entry Point Functions

Entry points are functions that NetSuite calls automatically when certain events occur:

function afterSubmit(context) {
    log.debug('Title', 'Record saved successfully!');
}

Entry Points by Script Type

Script Type	Entry Points
User Event	beforeLoad, beforeSubmit, afterSubmit
Client Script	pageInit, fieldChanged, validateField, saveRecord, etc.
Scheduled	execute
Map/Reduce	getInputData, map, reduce, summarize
Suitelet	onRequest
RESTlet	get, post, put, delete

5. Development Workflow

The complete process to deploy a script:

1. Write the Script — Create your .js file in Eclipse or any IDE
2. Upload to File Cabinet — Put the file in SuiteScripts folder
3. Create Script Record — Customization → Scripting → Scripts → New
4. Create Deployment — Link script to specific records/triggers
5. Test — Trigger the script and check Execution Log

6. Hello World Example

Here's a complete User Event script that logs a message after every record save:

/**
 * @NApiVersion 2.1
 * @NScriptType UserEventScript
 * @description Hello World - logs after record save
 */
define(['N/log'], function(log) {
    
    /**
     * After the record is submitted to the database
     * @param {Object} context
     * @param {Record} context.newRecord - The saved record
     * @param {string} context.type - Trigger type (create, edit, delete)
     */
    function afterSubmit(context) {
        log.debug({
            title: 'Hello World',
            details: 'Script executed! Trigger type: ' + context.type
        });
    }
    
    return {
        afterSubmit: afterSubmit
    };
});

Viewing the Execution Log

After triggering your script, check the output:

1. Go to Customization → Scripting → Script Deployments
2. Click on your deployment
3. Click the Execution Log subtab
4. Look for your log messages

🏋️ Practice Exercises