Module 10: Script Parameters

🎯 Learning Objectives

• Understand what script parameters are and why to use them
• Learn the three parameter types (Company, User, Deployment)
• Create script parameter fields
• Read parameter values using N/runtime

1. What Are Script Parameters?

Script parameters are configurable values attached to your script that can be changed without modifying code. Think of them as settings that administrators can adjust.

2. Parameter Types

Type	Scope	Set By	Use Case
Company	Whole account	Admin	Company-wide settings
User	Per user	Each user	Personal preferences
Deployment	Per deployment	Developer	Different configs per deployment

3. Creating Parameters

Step 1: Create Custom Field

1. Go to Customization → Scripting → Script Parameters → New
2. Set ID (e.g., custscript_default_discount)
3. Choose Type (Integer, Text, List/Record, etc.)
4. Select Parameter Type (Company, User, or Deployment)
5. Save

Step 2: Add to Script Record

1. Edit your Script Record
2. Go to Parameters subtab
3. Add your parameter field
4. Save

Step 3: Set Value

• Company: Set on Script Record → Parameters tab
• User: Home → Set Preferences
• Deployment: Set on Script Deployment record

4. Reading Parameter Values

/**
 * @NApiVersion 2.1
 * @NScriptType UserEventScript
 */
define(['N/runtime'], function(runtime) {
    
    function beforeSubmit(context) {
        // Get current script
        var script = runtime.getCurrentScript();
        
        // Read parameter value
        var defaultDiscount = script.getParameter({
            name: 'custscript_default_discount'
        });
        
        log.debug('Parameter Value', 'Discount: ' + defaultDiscount + '%');
        
        // Use the value
        if (defaultDiscount) {
            context.newRecord.setValue({
                fieldId: 'discountrate',
                value: defaultDiscount
            });
        }
    }
    
    return { beforeSubmit: beforeSubmit };
});

Reading Different Types

// Text parameter
var emailAddress = script.getParameter({ name: 'custscript_notify_email' });

// Integer parameter
var maxRecords = script.getParameter({ name: 'custscript_max_records' });

// Checkbox (returns true/false)
var isEnabled = script.getParameter({ name: 'custscript_feature_enabled' });

// List/Record (returns internal ID)
var defaultCustomer = script.getParameter({ name: 'custscript_default_customer' });

🏋️ Practice Exercises