Deploying a Script by using the Deployments Sublist
You can use the Deployments sublist when you create a script record that you want to deploy. When you deploy a script using the Deployments sublist, you can define values for some deployment fields but not all. For example, if you want to set up context filtering (execution context filtering or localization context filtering), you must do it in the script deployment record. You cannot set context filtering on the Deployments subtab. For more information, see Using the Context Filtering Tab.
Depending on the script type, you can also use the Deployments sublist when you are editing an existing script record. However, for other script types, the Deployments sublist is read-only when you are editing the script record.
For information about other ways of deploying a script, see Methods of Deploying a Script.
Make sure that you have the correct permissions and features for deploying a script. For more information, see Methods of Deploying a Script.
Be aware that the script deployment process varies somewhat depending on the script type. The following procedure describes basic steps for using the Deployments sublist. For certain script types, additional steps may be required.
To deploy a script by using the Deployments sublist:
-
Open the script record by going to Customization > Scripting > Scripts.
-
Locate the script for which you want to create a script deployment. Click the corresponding Edit link.
-
Click the Deployments subtab.
-
Add a value to the sublist, as follows:
-
If the Title column is displayed, enter a title.
-
If the Applies to column is displayed, select the record type where you want to deploy the script. To deploy the script on all record types supported in SuiteScript, click the Add Multiple button to select additional record types.
-
Enter a meaningful id in the ID column. The script deployment record ID lets you work with the deployment programmatically. Note that the system automatically adds a prefix of customdeploy to the value you enter. If you do not specify an ID, a system-generated ID is created for you.
-
Check or clear the Deployed box, as appropriate. For most script types, the default value is Yes. However, for map/reduce and scheduled scripts, the default is Not Scheduled.
-
In the Status column, select the appropriate deployment status. Note that the available values vary depending on the script type. See Setting Script Deployment Status.
-
If the Event Type list is displayed, optionally select a value from the list. This value identifies the event type that triggers the script execution. Only one event type can be selected. If you need to have multiple event types trigger your script, you will need to create additional script deployments. See Setting Script Execution Event Type from the UI.
-
Optionally, in the Log Level field, specify which type of log messages will appear on the Execution Log tab when the script is executed. See Setting Script Execution Log Levels.
-
If the Execute as Role column appears, optionally select whether you want the script to execute using Administrator privileges, regardless of the permissions of the currently logged-in user. See Executing Scripts Using a Specific Role.
-
Click Add to add the new line to the sublist.
-
-
Click Save.
The system saves the deployment. If you view the Deployments subtab again, the deployment you created is represented as a link. You can click the link to view the script deployment record that has been created. In some cases, this page lets you configure additional fields. For more information, see Updating a Script Deployment.