Add Custom Button to Execute a Suitelet

Script Summary

The following table summarizes the script:

For more information about script types and entry points, see SuiteScript 2.x Script Types.

The Complete Script

This tutorial includes the complete script along with individual steps you can follow to build the script in logical sections. The complete script is provided below so that you can copy and paste it into your text editor and save the script as a .js file (for example, sl_executeSuiteletButton.js).

If you would rather create your script by adding code in logical sections, follow the steps in Build the Script.

              /**
 * @NApiVersion 2.1
 * @NScriptType UserEventScript
 * @NModuleScope SameAccount
 */

define(['N/runtime', 'N/log'], (runtime, log) => {
    function beforeLoad(scriptContext) {
        try {
            const recCurrent = scriptContext.newRecord;
            const objForm = scriptContext.form;
            const stStatus = recCurrent.getValue({
                fieldId: 'status'
            });
            const stSuiteletLinkParam = runtime.getCurrentScript().getParameter({
                name: 'custscript_suiteletlink'
            });
            const suiteletURL = '\"' + stSuiteletLinkParam + '\"';
            if (stStatus === 'Pending Fulfillment') {
                objForm.addButton({
                    id: 'custpage_suiteletbutton',
                    label: 'Open Suitelet',
                    functionName : 'window.open(' + suiteletURL + ')',
                });
            }
        } catch(error) {
            log.error({
                title: 'beforeLoad_addButton',
                details: error.message
            });
        }
    }
    return {
        beforeLoad: beforeLoad
    };
}); 

            

Build the Script

You can write the script using a step-by-step approach that includes the following:

• Start with required opening lines

• Create the entry point function

• Add the custom button to the sales order

• Create the return statement

• Save your script file

                /**
 * @NApiVersion 2.1
 * @NScriptType UserEventScript
 * @NModuleScope SameAccount
 */

define(['N/runtime', 'N/log'], (runtime, log) => {
}); 

              

                function beforeLoad(scriptContext) {
    try {
    } catch(error) {
        log.error({
            title: 'beforeLoad_addButton',
            details: error.message
        });
    }
} 

              

                const recCurrent = scriptContext.newRecord;
const objForm = scriptContext.form;
const stStatus = recCurrent.getValue({
    fieldId: 'status'
});
const stSuiteletLinkParam = runtime.getCurrentScript().getParameter({
    name: 'custscript_suiteletlink'
});
const suiteletURL = '\"' + stSuiteletLinkParam + '\"';
if (stStatus === 'Pending Fulfillment') {
    objForm.addButton({
        id: 'custpage_suiteletbutton',
        label: 'Open Suitelet',
        functionName : 'window.open(' + suiteletURL + ')'
    });
} 

              

                return {
    beforeLoad: beforeLoad
}; 

              

To create the script record:

1. Upload your script to the NetSuite File Cabinet.

2. Go to Customization > Scripting > Scripts > New.

3. Select your script from the Script File list and click Create Script Record. The Script page is displayed.

4. On the Script page, enter the following values:

   Field	Value
   Name	Add Button to Execute Suitelet
   ID	_ue_custom_suitelet_button NetSuite prepends ‘customscript’ to this ID.
   Description	This script adds a button to the sales order form. When clicked, the button opens the Suitelet URL provided on the Parameters tab. (You may opt to include the button name you choose in the description to help others identify that this scripts controls that specific button.)

5. Optionally set any other fields on the script record as desired.

6. Click Save and Deploy. The Script Deployment page appears. Continue with Step 3: Deploy the Script.

To deploy the script:

1. Complete the steps in Step 2: Create the Script Record.

2. On the Script Deployment page, enter the following values:

   Field	Value
   Applies To	Sales Order
   ID	_ue_custom_suitelet_button NetSuite prepends 'customdeploy' to this ID.
   Status	Testing The Testing status allows the script owner to test the script without affecting other users in the account.
   Log Level	Debug The Debug level will write all log.debug statements in a script to the Execution Log tab of the script deployment record as well as all errors.
   Execute As Role	Current Role It is normally best practice to have scripts execute with the user’s current role to avoid granting unwanted access.
   Audience > Roles	Check Select All

3. Click Save.

To create the script parameter:

1. Go to Customization > Scripting > Scripts.

2. Locate your script in the list of scripts and click Edit next to the script name.

3. On the Script page, click the Parameters tab and click New Parameter. The Script Field page appears.

4. On the Script Field page, enter the following values:

   Label	ID	Type	Description	Preference
   Suitelet Link	_suiteletlink NetSuite prepends ‘custscript’ to this ID. The value ‘custscript_suiteletlink’ is used in the script.	Hyperlink	This is the location of the Suitelet.	Leave blank.

5. Click Save to save the script parameter. The Script page appears.

6. Click Save to save the script record with the updated script parameter.

To set the script parameter:

1. Go to Customization > Scripting > Script Deployments.

2. Locate your script deployment in the list of script deployments and click Edit next to the script deployment name.

3. On the Parameters tab, enter your script parameter value for the URL from the Suitelet deployment that you want to display when the button is clicked.

4. Click Save.

To test your solution:

1. Go to Transactions > Sales > Enter Sales Orders > List.

2. Click View next to a sales order that is in Pending Fulfillment status.

3. Verify your custom button, labeled ‘Open Suitelet’ appears on the sales order form. For example:

   

4. Click the button and verify your Suitelet opens in a new window.