Executing SuiteScript 2.1 Scripts via Account Preferences

The Execute SuiteScript 2.x Server Scripts As and Execute SuiteScript 2.0 Server Scripts as SuiteScript 2.1 account-level preferences allow you to designate which version of SuiteScript (2.0 or 2.1) is leveraged, irrespective of the @NApiVersion JSDoc tag set in your script files. This flexibility is pivotal for developers looking to maximize functionality without modifying each script manually.

How Can You Run Scripts Using SuiteScript 2.1?

You have two primary approaches to execute scripts in SuiteScript 2.1:

1. Run a Single Script Using SuiteScript 2.1: Use the @NApiVersion JSDoc tag in your script to explicitly define it as a SuiteScript 2.1 script.
2. Run All SuiteScript 2.x Scripts as SuiteScript 2.1: Leverage the Execute SuiteScript preferences to run scripts annotated with @NApiVersion 2.x or 2.0 as SuiteScript 2.1 scripts. This method facilitates batch testing and migration without script alterations.

Setting Account-Level Preferences

To enable SuiteScript 2.1 for executions, follow these steps:

Enable SuiteScript 2.1 for 2.x Scripts

1. Navigate to Setup > Company > Preferences > General Preferences.
2. In the Execute SuiteScript 2.x Server Scripts As dropdown, select 2.1.
3. Click Save.

Enable SuiteScript 2.1 for 2.0 Scripts

1. Go to Setup > Company > Preferences > General Preferences.
2. Check the Execute SuiteScript 2.0 Server Scripts As SuiteScript 2.1 option.
3. Click Save.

Important Note: Only script types compatible with SuiteScript 2.1 will be executed when enabling the Execute SuiteScript 2.0 preference. Scripts that are not updated to 2.1 will not execute under this preference.

Running a Single Script

To run an individual script as SuiteScript 2.1:

1. Include the following JSDoc tag in your script file:
   suitescriptCopy

   /**
    * @NApiVersion 2.1
    */

2. Implement other necessary JSDoc tags.
3. Upload and deploy your script, which will be validated as a SuiteScript 2.1 script.

For Further Learning: Explore topics such as Differences Between SuiteScript 2.0 and SuiteScript 2.1 and Debugging SuiteScript 2.1 Scripts. Enhance your development proficiency by utilizing appropriate functionalities across versions without script amendments.