Create, view, or edit Task Schedule page
Use the task schedule page to schedule the execution of a task on a timed basis. A task must be configured before it is available to be scheduled to run. To create a new scheduled configuration for a task, click Create on the scheduler page.
All of the configured tasks that are being scheduled need an initial start date and time. The subsequent execution times are calculated using the selected frequency. The time zone that is used by the task scheduler is configured on the Services Framework general properties page.
Fields
This page has the following fields. Required fields are indicated with an asterisk.
- Configuration *
- Select the task to schedule from the list of configured tasks. Only tasks with a value of yes in the can be scheduled field during registration are available to be selected. This field is read-only in view and edit mode.
- Description *
- A detailed description for the scheduled configuration for the task. It can be a maximum of 512 characters.
- Start time *
- The date and time that the configured task is to be initially executed by the scheduler. Either enter the
start date and time in this field, or use the calendar and time selection tools to choose the date and time.
The combination of the start date and start time must be in the future. The required format for the date is
MM/DD/YYYY. - Frequency *
- Select the interval to use when executing this scheduled configuration. Valid values for this field are
shown in the following list.
- One time only
- When one time only is selected for the frequency, the task is run only once. It runs at the time that is defined in the start time field of this scheduled configuration. After the task processes, it is complete and does not process again.
- Seconds
- The task runs after waiting for an interval that is specified by the user in seconds. The interval repeats continuously until this scheduled configuration is deleted.
- Minutes
- The task runs after waiting for an interval that is specified by the user in minutes. The interval repeats continuously until this scheduled configuration is deleted.
- Hours
- The task runs after waiting for an interval that is specified by the user in hours. The interval repeats continuously until this scheduled configuration is deleted.
- Daily
- The task runs at the start time on every day that has been selected by the user.
- Monthly
- The task runs at the start time on the same day of the month for every month that has been selected by the user. For example, a user enters 12:00 PM for the start time, enters 15 for the day, and selects the months of January, February, and December. The task runs at 12:00:00 PM on January 15, February 15, and December 15.
- Schedule Parameters
- The fields that are available in this section depend on which frequency interval is selected. This section
does not appear when one time only is selected for the frequency.
- Seconds *
- Enter the number of seconds to wait between each execution of the task. This field is displayed only when the frequency is seconds.
- Minutes *
- Enter the number of minutes to wait between each execution of the task. This field is displayed only when the frequency is minutes.
- Hours *
- Enter the number of hours to wait between each execution of the task. This field is displayed only when the frequency is hours.
- Daily option *
- When the frequency is daily, use this field and its sub-fields to configure how often the task runs. Use
the daily option field to indicate whether the task is run only on certain days or if it is run at an interval
that is specified in days. When the daily option is set to Custom Day(s), use the
available days and selected days fields to select one or more days on which the task should run. The task runs
at the task configuration start time on the selected days.
- Available days
- Displays a list of the days of the week that are available to be assigned to the scheduled configuration for this task. To assign days of the week to this scheduled configuration, select one or more days of the week on which the task should run. For example, every Monday, Wednesday, and Friday.
- Selected days
- Displays a list of the days of the week that have been assigned to the scheduled configuration for this task. To remove days of the week from this scheduled configuration, select at least one day of the week from this list.
- Days *
- Enter the number of days to wait between each execution of the task. This field is displayed only when every x days is selected for the daily option.
- Day of the month *
- When the frequency is monthly, use this field and its sub-fields to configure how often the task runs.
Enter the numeric day of the month in this field and use the following fields to select one or more months in
which the task should run. The task runs at the task configuration start time on the day of the month.
- Available months
- Displays a list of the months that are available to be assigned to the scheduled configuration for this task. To assign months to this scheduled configuration, select one or more months on which the task should run. For example, March, June, September, and December.
- Selected months
- Displays a list of the months that have been assigned to this task configuration. To remove months from the scheduled configuration for this task, select at least one month from this list.
Actions
The actions that are available on the page are shown in the following list.
- Filter column displays the build filter link that you can use to create a filter for the columns on the page.
- Create opens the create task schedule dialog box.
- Search entry field. Typing text in this field automatically filters the scheduled configurations that are displayed in the table. The table displays only those scheduled configurations that match what was typed in the search field.
- Refresh updates the displayed scheduled configurations.
- Download CSV saves the displayed table view as a .csv file.
- Customize columns displays a page to select which columns are shown or hidden on the scheduler page.
- Row settings configures the size and the spacing of the text that is displayed in the cells of the table.
- Open documentation opens the help page.
- displays the activities of the selected scheduled task.
- A menu appears in the table header when you select one or more rows in the table.
- Select all selects all the rows in the table.
- Delete deletes the selected scheduled task configurations.
- Cancel closes the menu in the table header.
- Close returns to the scheduler page.