Scheduled Script Deployment Record

Script

A link to the script record associated with the deployment

Title

The user-defined name for the deployment

ID

A unique identifier for the deployment:

• If this field is left blank when the deployment is created, the system generates the ID.

• Enter a custom ID if you plan to bundle the script and deployment for another account—this helps avoid naming conflicts. Use lowercase, no spaces, and “_” to separate words.

You can edit this value on an existing deployment if needed; just click Edit on the deployment record, then click Change ID.

Deployed

This box marks whether the deployment is active—check it if you want your script to run. If it’s not checked:

• The script won’t execute, even if there’s a schedule set.

• The Save and Execute option disappears from the Save dropdown when editing.

• The script can’t be submitted programmatically. For details, see Submitting an On-Demand Scheduled Script Instance from Another Script.

Status

This setting controls how and when a script can be submitted to SuiteCloud Processors. Options include:

• Testing: You can test the script in SuiteScript Debugger as a deployed script. See Debugging Deployed SuiteScript 1.0 and SuiteScript 2.0 Server Scripts for more. Deployed debugging is only for the script owner.

• Scheduled: You can set up single or recurring runs from the Schedule subtab, but you can’t submit the script on-demand when it’s set this way.

  Note:

  If you set up recurring runs, the deployment status stays as Scheduled on the Scheduled Script Status Page, even after the script finishes running.

• Not Scheduled: If the script isn’t scheduled, you can submit it on-demand using either:

  • The Save and Execute button on the deployment record

  • The task.ScheduledScriptTask API

  You can only run one on-demand instance of a script at a time—if one’s still running, you can’t start another.

See Scheduled Script Submission for a table that compares scheduled script submissions to the Status value.

See Instances

A link to the Scheduled Script Status Page, filtered for all deployment instances of this deployment.

Log Level

This setting controls what’s logged for this deployment—find entries on the Execution Log subtab. Options include:

• Debug: Use Debug for testing mode—it shows all Audit, Error, and Emergency logs.

• Audit: Use Audit for production—it keeps records of script events, like when a request is made to an external site.

• Error: Use Error for production—this only logs unexpected script errors.

• Emergency: Use Emergency for production—it only shows the most critical errors.

Execute as Role

For scheduled script deployments, this is always set to Administrator and can’t be changed.

Priority

This setting affects when the processor scheduler sends jobs to the pool—by default, it’s set to Standard. For more, see SuiteCloud Processors Priority Levels.

Possible options are:

• High: Use High for critical jobs—the scheduler puts these at the front of the line.

• Standard: Standard is the default medium priority—the scheduler sends these jobs next, after any high priority jobs.

• Low: Use Low if your job can wait longer, and the scheduler processes these after high and standard jobs.

Queue (Deprecated)

This field’s deprecated. If you click Remove Queue, it disappears from the deployment record..

Single Event

This option submits the script only once—use it for a one-time future run.

Daily Event

This submits the script every set number of days. If you set it to go every x minutes or hours, the schedule restarts on the next scheduled day.

For example, if your deployment submits daily at 3:00 am and repeats every 5 hours, instances are submitted at 3:00 am, 8:00 am, 1:00 pm, 6:00 pm, and 11:00 pm. At midnight, it restarts and the next one is at 3:00 am.

Weekly Event

This submits the script at least once a week. If it’s set to recur every x minutes or hours, it starts over on the next scheduled day.

For example, if it’s set to run on Tuesday and Wednesday at 3:00 am, repeating every 5 hours, it submits at 3:00 am, 8:00 am, 1:00 pm, 6:00 pm, and 11:00 pm each day. The schedule starts over each day at 3:00 am.

Monthly Event

This submits the script at least once every month.

Yearly Event

This submits the script at least once every year.

Start Date

The first submission happens on this date—required for one-time or recurring schedules.

Start Time

If you set a time, the first run happens then.

The deployment shows times in the time zone of whoever last edited it, based on their user preferences. If a new user edits it, the displayed time updates to their time zone—even if the time itself doesn’t change.

Repeat

If you pick a date and time, the first submission happens then, and a new script runs every x minutes or hours until the day ends. The schedule restarts on the next scheduled day if needed.

For example, if it’s scheduled at 3:00 pm on Tuesday and Wednesday and set to recur every 5 hours, it runs at 3:00 pm and 8:00 pm on each day, and then the schedule restarts.

End By

If you set an end date, the last submission is then. If it’s recurring, a new script runs every x minutes or hours until that end date.

No End Date

If you don’t set an end date, the schedule goes on indefinitely.