User Event Scripts (SuiteScript 2.1 Deep Dive)

/**
 * @NApiVersion 2.1
 * @NScriptType UserEventScript
 */
define(['N/record','N/search','N/runtime','N/ui/serverWidget','N/log','N/task'], 
(record, search, runtime, ui, log, task) => {

  const beforeLoad = (ctx) => {
    const { type, form, newRecord } = ctx;
    if (type === ctx.UserEventType.VIEW) {
      form.addButton({
        id: 'custpage_btn_do_something',
        label: 'Do Something',
        functionName: "alert('Hello from beforeLoad!')"
      });
      // Set a default field value on create mode
      if (runtime.executionContext === runtime.ContextType.USER_INTERFACE && ctx.type === ctx.UserEventType.CREATE) {
        newRecord.setValue({ fieldId: 'memo', value: 'Created via UI' });
      }
    }
  };

  const beforeSubmit = (ctx) => {
    const rec = ctx.newRecord;
    // Strict validation: prevent save with missing customer
    if (rec.type === 'salesorder' && !rec.getValue('entity')) {
      throw new Error('Customer is required before saving the Sales Order.');
    }
    // Normalize: ensure memo always has prefix
    const memo = rec.getValue('memo') || '';
    if (!memo.startsWith('[SO] ')) {
      rec.setValue({ fieldId: 'memo', value: `[SO] ${memo}` });
    }
  };

  const afterSubmit = (ctx) => {
    const rec = ctx.newRecord;
    try {
      // Post-commit: flag record for async processing if total is large
      const total = rec.getValue('total') || 0;
      if (total > 10000) {
        task.create({
          taskType: task.TaskType.MAP_REDUCE,
          scriptId: 'customscript_mr_high_value_handler',
          deploymentId: 'customdeploy_mr_high_value_handler',
          params: { custscript_source_tran_id: rec.id }
        }).submit();
      }
    } catch (e) {
      log.error('afterSubmit error', e);
    }
  };

  return { beforeLoad, beforeSubmit, afterSubmit };
});

form.clientScriptModulePath = './CS_custom_actions.js';
form.addButton({
  id: 'custpage_btn_refresh_rates',
  label: 'Refresh FX Rates',
  functionName: "refreshRates()"
});

const terms = rec.getValue('terms');
if (!terms) {
  throw new Error('Terms are required before saving.');
}

const externalId = rec.getValue('externalid') || '';
rec.setValue({
  fieldId: 'externalid',
  value: externalId.trim().toUpperCase()
});

if (ctx.type !== ctx.UserEventType.DELETE) {
  record.create({ type: 'customrecord_audit_log', isDynamic: true })
    .setValue({ fieldId: 'custrecord_source', value: rec.id })
    .setValue({ fieldId: 'custrecord_message', value: 'SO posted to audit log' })
    .save();
}

const lineCount = rec.getLineCount({ sublistId: 'item' });
let totalQty = 0;
for (let i = 0; i < lineCount; i++) {
  totalQty += Number(rec.getSublistValue({ sublistId: 'item', fieldId: 'quantity', line: i })) || 0;
}
if (totalQty > 500) {
  throw new Error('Total item quantity exceeds the limit (500).');
}

if (runtime.executionContext === runtime.ContextType.WEBSERVICES) {
  // Relax certain checks for integrations, or log differently
}