[Index]
Single or Multiple actions can be executed on one or more resources. The actions can be scheduled to take place at a specified time or to repeat.
Currently, the action is to execute.
The resources that can be executed are:
Care should be taken when transactions are scheduled. For example, data synchronization should be scheduled outside of peak times. The size and scope of the transactions that run determine the length of the time that they need to run. This therefore impacts on the start time. The number of clusters on the system and their size need to be considered as part of a data sync approach.
This procedure displays and edits existing schedules, and adds a new schedule.
Note
VOSS Automate also provides a tool to deactivate and reactivate schedules in bulk, if required. See Deactivate and Activate Schedules.
Log in to the Admin Portal and select the relevant hierarchy.
Go to (default menus) Administration Tools > Scheduling to open the Scheduling list view.
View existing schedules in the summary list view, which include a number of attributes for each schedule.
Note
Resource attributes are used for filtering when you want to choose a resource.
Choose an option:
Mandatory. At Schedule Name, fill out a name for the schedule.
Optional. At Owner, fill out the name of the schedule owner.
Mandatory. At Schedule Type, choose an option, either Multi Execution or Single Execution.
A new tab/panel displays on the page, either Multiple Executions or Single Execution, depending on the option you choose for Schedule Type.
Fill out relevant schedule execution details:
Single Execution |
|
Multiple Executions | Choose one or more of the following options:
Fill out the fields for the option/s you selected. When choosing two or more options, the first scheduled time takes priority. If a schedule is in a state where the last executed and next execution time are equal, the next execution time is recalculated to ensure its execution. |
At the Active checkbox, define whether to activate scheduled syncs. Clear the checkbox to disable the schedule.
Note
When enabling the schedule in this step, and there is a "next execution" in the past, the sync executes immediately, once you save.
However, if Skip execution on activation is enabled, the sync executes on the newly calculated next scheduled execution date and time.
When Active is selected, you can (optionally) add one or more scheduled resources. In this case, at Scheduled resources, configure the following:
Click the Plus icon (+) to configure an action to execute on a resource.
Note
You can schedule one or more actions or one or more resource types, and choose resource attributes for each.
At Action, choose an action (e.g. Execute).
Choose a Resource Type (resources that can be executed, for example, data/DataSync).
For the selected resource type, at Resource Attribute, choose a unique identifier (the resource attribute, which is used for filtering when choosing the resource type, which is typically name).
At Resource, select the value of the resource attribute. For example, if the attribute is name, then the name of the resource.
At Perform Action, select or clear the checkbox to enable or disable the resource scheduled action.
Repeat this step to add additional scheduled resources.
At Skip execution on activation, define whether to skip the immediate execution of a pending scheduled sync when activating the schedule (via the Active checkbox in the previous step).
Note
Selecting Skip execution on activation prevents a situation where, for example, you wish to pause the execution of scheduled syncs for a period, perhaps to perform an upgrade. Post-upgrade, when activating the schedule, a number of pending syncs may execute immediately. This setting clears pending scheduled syncs so that the schedule executes again only at the next scheduled execution time, after the schedule is set to active.
Click Save to create (or update) the schedule.
The schedule you added (or updated) displays in the Scheduling list view.
The Schedule model allows scheduling of execute actions. Scheduling can be performed once, or multiple times, depending on the choices given to the schedule instance.
Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Schedule Name * | Name of this Schedule |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Last Executed (UTC Time) | Last time that this schedule executed |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Owner | A business key that identifies the data/User who created the schedule. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Schedule Type * | Type of Schedule |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Active | Is the entire schedule active or not. Default: True |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Skip execution on activation. | Skip immediate execution on activation. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Scheduled resources | List of resources that will be actioned |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Action * | Action to perform |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Resource Type * | Resource types to which this schedule will apply. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Resource Attribute * | Resource attribute that will be used to filter/choose from. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Resource * | DESCRIPTION |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Perform Action | DESCRIPTION Default: True |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Single Execution | Single Execution |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Execution Date (YYYY-MM-DD. Local date) | Execution Date |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Execution Time (HH:MM:SS. Local time) | Execution Time |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Execution Timezone (Local timezone) | Timezone for Execution Default: 0 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Multiple Executions | Multi Execution |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Use Specific Executions | Use specific executions. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Use Calendar Executions | Use calendar executions. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Use Timed Executions | Use timed executions. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Specific Execution Dates | Specific Execution Dates |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Execution Date (YYYY-MM-DD. Local date) | Execution Date |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Execution Time (HH:MM:SS. Local time) | Execution Time |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Execution Timezone (Local timezone) | Timezone for Execution Default: 0 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Calendar Executions | Repeated Execution by Calendar |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Calendar Month | Calendar Month |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Calendar Day | Calendar Day |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Calendar Hour | Calendar Hour |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Calendar Minute | Calendar Minute |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Execution Timezone (Local timezone) | Timezone for Execution Default: 0 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Timed Executions | Timed Execution |
|
|||||||||||||||||||||||||||||||||||||||||||||||
First Execution Date (YYYY-MM-DD. Local date) | Execution Date |
|
|||||||||||||||||||||||||||||||||||||||||||||||
First Execution Time (HH:MM:SS. Local time) | Execution Time |
|
|||||||||||||||||||||||||||||||||||||||||||||||
First Execution Timezone (Local timezone) | Timezone for Execution Default: 0 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Repeat after (x) Days | Repeat Days |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Repeat after (x) Hours | Repeat Hours |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Repeat after (x) Minutes | Repeat Minutes |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Number of Repeats (0 = infinite) | Number of Repeats |
|