Scheduled Script Deployment Record
Before you submit a scheduled script to SuiteCloud Processors, make sure you’ve created at least one deployment record for the script.
Body Fields
|
Field |
Description |
|---|---|
|
Script |
A link to the script record associated with the deployment
Note:
You can’t change this value—even on a new deployment record. If you pick the wrong script record, you’ll need to start over. |
|
Title |
The user-defined name for the deployment |
|
ID |
A unique identifier for the deployment:
Note:
For any custom or system ID, NetSuite adds “customdeploy” to the start. 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:
|
|
Status |
This setting controls how and when a script can be submitted to SuiteCloud Processors. Options include:
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:
|
|
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.
Note:
Each SuiteScript 2.x scheduled script instance is handled by a single job within SuiteCloud Processors.
Important:
Make sure you understand SuiteCloud Processors before changing this setting.. Possible options are:
|
|
Queue (Deprecated) |
This field’s deprecated. If you click Remove Queue, it disappears from the deployment record.. |
Schedule Subtab
The Schedule subtab is always available, no matter what Status is chosen.
|
Field |
Description |
|---|---|
|
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 enter a Start Time, the first run starts then. When you save the deployment, NetSuite saves the Start Date and Start Time in your time zone. When another user opens the record, NetSuite shows them in their preferred time zone. Example:
Note:
NetSuite automatically applies time-zone rules, including Daylight Saving Time, based on the Start Date. For details on setting your time zone, see Time Zone in General Personal Preferences. |
|
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. |