Automation Platform Tasks

Schedule—create new or edit existing schedule

Use this page to create or edit a standard schedule that specifies a set of times and days when a particular procedure should run. If you need to create a continuous build integration instead, see the Help information available from the Continuous Integration Dashboard web page.

For any schedule, click the "star" icon to add this schedule to the Shortcut section on your Home page.

To create a new standard schedule

Enter information into the fields as follows:

Field nameDescription

General section

Name

Enter a Schedule name. This must be a unique name among other schedule names in this project.

Procedure

Displays the current project and procedure. Click Change to use the pop-up menu to select a new project or procedure.

Description

(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. Allowable HTML tags are <a>, <b>, <br>, <div>, <dl>, <font>, <i>, <li>, <ol>, <p>, <pre>, <span>, <style>, <table>, <tc>, <td>, <th>, <tr>, and <ul>.

For example, the following HTML:

<p>
<span style="font-family: Arial;">
  <i>Note:</i> For more information about the <b>abc</b> object, see
         <a href="https://www.google.com/">\https://www.google.com</a>.
</span>
</p>

renders as follows:

_Note:_ For more information about the *abc* object, see \https://www.google.com.

Parameters section

If the procedure has parameters, enter information in their values in this section. The procedure cannot execute unless all required parameters are provided. If you move the mouse over a field for a particular parameter, inline Help displays the description of that parameter if one was provided in the procedure’s definition.

Click this icon to displays fields to add one or more parameters.

Frequency section

Run at ???

This is a summary section: As you make selections for the following Days and Repetition sections, a summary of what you have selected appears here.

Days

Select weekdays, month days, or create a custom frequency when you want the schedule to run. The "day" applies to the start time if the time range spans two days, that is, if the time range crosses the midnight boundary.

Repetition

  • Run Once —The schedule will run once per selected day at the time you specify.

  • Run Every —The procedure will execute repeatedly during the specified time range. For example, if you select a time range from 11:00-14:00 and an interval of 40 minutes, the procedure will execute 5 times on each of the selected days: at 11:00am, 11:40am, 12:20pm, 1:00pm, and 1:40pm.

  • Run Continuously —As soon as one job ends, the scheduler will trigger immediately to run the job again.

Advanced section

Enabled

If this box is "checked," the schedule will run. You can disable this schedule whenever necessary.

Misfire Policy

Choose between two options to manage how a schedule resumes in cases where the normal scheduled time is interrupted. The server may not be able to trigger a job at the scheduled time for one of several reasons:

  • A running job extends past the next scheduled runtime.

  • The server cannot find enough available resources, and a delay occurs.

  • The server is down or disconnected from the network for a period that overlaps one or more scheduled times.

If any of these situations occur, the misfire policy defines two possible responses:

  • skip —All misfires are ignored and the job runs at the next scheduled time.

  • run once —After one or more misfires, the job runs at the soonest time that occurs within an active region. For example, at server startup a scheduled job will not trigger immediately on startup.

Time Zone

Default is the time zone of the CloudBees Flow server, or select a country from the first pull-down menu, then select an area from the second pull-down menu. Another option: Select "other" from the first pull-down menu, then select GMT [or another selection] from the second pull-down list.

Priority

Use the pull-down menu to select one of four priorities for this procedure. Also, you can select the job’s priority on the Run Procedure web page. When a job is launched, its priority cannot be changed.

Priorities take effect when two or more job steps in different jobs are waiting for the same resource. When the resource is available, it will be used by the job step that belongs to the job with the highest priority.

If the priority level is the same, the resource will be used by the job step that belongs to the job with the lowest job ID number. If the job steps are in the same job, the resource will be used first by the step with the lowest job step ID number.

If using ectool, the priority can be set by passing "--priority=<low|normal|high|highest>" to a runProcedure, createSchedule, or modifySchedule operation.

Schedules are launched by the project principal user. To raise the priority above "normal," this user must have execute permission on the system-level access control list for priorities.

Impersonation Credential section

If you select a credential for the schedule, it will be used as the default for jobs run from the schedule. For example, job steps will run under the login account specified in the credential. However, the schedule’s credential is low in priority: it will be used only if there is no credential specified in the procedure or its project. Also, individual steps can override the credential with a specific credential for that step. For more information, see Credentials and User Impersonation .

Impersonation credentials are used to set the top-level impersonation credential for a job. If specified, the impersonation credential (on the job) is used as the default impersonation credential for all steps in the job.

Credential Project

The name of the credential for the project. By default, the current project is selected. Enter a different project name or select Browse to find this name.

Credential Name

The name of the credential for the project. You might need to browse for this name.

Click OK to save your schedule information.

To create a new continuous integration "schedule"

If you selected the CI Configuration link, the New CI Configuration page is displayed. For information on populating these fields, see the “Continuous Integration Manager” plugin Help topic—click the Help link in the upper-right corner of the New CI Configuration page.

See the Standard Schedule information (above) to enter information in the fields common to both types of schedules.

To edit an existing schedule

Modify any of the information you previously specified. The following additional links are available at the top of the page:

  • Save Configuration —The information in this schedule will be copied into a new Job Configuration and displayed on your Home page for easy access.

  • Access Control —Set permissions for this schedule.

Attached Credentials

Click the Attached Credential link if you need to attach an existing credential to this schedule. If you need to create a new credential for this schedule, return to the Project Details page.

Custom Schedule Properties

Select the Create Properties, Create Nested Sheet, or Access Control links if you want to assign properties to this schedule. For more information on Properties or Access Control, see the following main Help topics: Properties , Access Control

Click OK to save your modifications for this schedule.