SuiteScript 2.1 Event Subscriber Script Code Samples
The following samples provide the files required to set up an Event Subscriber script. The SDF object definition references the eventSubscriber.js script file.
-
Event Subscriber Script File - Contains the SuiteScript code, including the
@NScriptType EventSubscriberJSDoc tag and the handle(options) entry point. -
Event Subscriber SDF Object Definition - Identifies the script file and defines one or more subscription criteria for the supported events that trigger the script.
Event Subscriber Script File
The following example shows an Event Subscriber script file:
/**
* @NApiVersion 2.1
* @NScriptType EventSubscriber
*/
define([], () => {
async function handle(options) {
const recordType = options.context.recordType;
const recordId = options.payload.recordId;
if (recordType === 'SALESORDER') {
// Add your sales order event handling logic.
} else if (recordType === 'CUSTOMER') {
// Add your customer event handling logic.
}
}
return {
handle: handle
};
});
Event Subscriber SDF Object Definition
The following example shows an Event Subscriber SDF object definition with multiple criteria:
<eventsubscriber scriptid="custevsub_created">
<scriptfilepath>[/SuiteScripts/eventSubscriber.js]</scriptfilepath>
<criteria>
<criterion>
<domain>RECORD</domain>
<type>CREATED</type>
<parameters>
<parameter>
<name>RECORDTYPE</name>
<operator>EQ</operator>
<value>SALESORDER</value>
</parameter>
</parameters>
</criterion>
<criterion>
<domain>RECORD</domain>
<type>CREATED</type>
<parameters>
<parameter>
<name>RECORDTYPE</name>
<operator>EQ</operator>
<value>CUSTOMER</value>
</parameter>
</parameters>
</criterion>
</criteria>
</eventsubscriber>
For information about creating and deploying SDF projects, see SuiteCloud Development Framework.