[Index]

Model: data/Schedule

Scheduling

Full HTML Help

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.

Add or Update a Schedule

Full HTML Help

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.

  1. Log in to the Admin Portal and select the relevant hierarchy.

  2. Go to (default menus) Administration Tools > Scheduling to open the Scheduling list view.

  3. 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.

  4. Choose an option:

  5. Mandatory. At Schedule Name, fill out a name for the schedule.

  6. Optional. At Owner, fill out the name of the schedule owner.

  7. 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
    • At Execution Date and Time, choose a date and time from the calendar date/time picker.
    • Choose the execution timezone.
    Multiple Executions

    Choose one or more of the following options:

    • Use Specific Executions
    • Use Calendar Executions
    • Use Timed Executions

    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.

  8. 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:

    1. 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.

    2. At Action, choose an action (e.g. Execute).

    3. Choose a Resource Type (resources that can be executed, for example, data/DataSync).

    4. 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).

    5. At Resource, select the value of the resource attribute. For example, if the attribute is name, then the name of the resource.

    6. At Perform Action, select or clear the checkbox to enable or disable the resource scheduled action.

    7. Repeat this step to add additional scheduled resources.

  9. 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.

  10. 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.

Model Details: data/Schedule

Title Description Details
Schedule Name * Name of this Schedule
  • Field Name: name
  • Type: String
Last Executed (UTC Time) Last time that this schedule executed
  • Field Name: last_executed
  • Type: String
Owner A business key that identifies the data/User who created the schedule.
  • Field Name: owner
  • Type: String
Schedule Type * Type of Schedule
  • Field Name: schedule_type
  • Type: String
  • Choices: ["Single Execution", "Multi Execution"]
Active Is the entire schedule active or not. Default: True
  • Field Name: active
  • Type: Boolean
  • Default: True
Skip execution on activation. Skip immediate execution on activation.
  • Field Name: skip_next
  • Type: Boolean
Scheduled resources List of resources that will be actioned
  • Field Name: scheduled_resources.[n]
  • Type: Array
  • Cardinality: [1..n]
Action * Action to perform
  • Field Name: scheduled_resources.[n].action
  • Type: String
  • Choices: ["Execute"]
Resource Type * Resource types to which this schedule will apply.
  • Field Name: scheduled_resources.[n].resource_type
  • Type: String
  • Choices: [""]
Resource Attribute * Resource attribute that will be used to filter/choose from.
  • Field Name: scheduled_resources.[n].resource_attribute
  • Type: String
  • Choices: [""]
Resource * DESCRIPTION
  • Field Name: scheduled_resources.[n].resource_instance
  • Type: String
  • Choices: [""]
Perform Action DESCRIPTION Default: True
  • Field Name: scheduled_resources.[n].perform_action
  • Type: Boolean
  • Default: True
Single Execution Single Execution
  • Field Name: single_execute
  • Type: Object
Execution Date (YYYY-MM-DD. Local date) Execution Date
  • Field Name: single_execute.single_date
  • Type: String
  • Pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12]\d|3[01])$
Execution Time (HH:MM:SS. Local time) Execution Time
  • Field Name: single_execute.single_time
  • Type: String
  • Pattern: ^([0-1]\d|2[0-3]):(0[0-9]|[1-5]\d):(0[0-9]|[1-5]\d)$
Execution Timezone (Local timezone) Timezone for Execution Default: 0
  • Field Name: single_execute.single_timezone
  • Type: String
  • Default: 0
  • Pattern: ^[-+]?\d+$
Multiple Executions Multi Execution
  • Field Name: multi_execute
  • Type: Object
Use Specific Executions Use specific executions.
  • Field Name: multi_execute.use_specific
  • Type: Boolean
Use Calendar Executions Use calendar executions.
  • Field Name: multi_execute.use_calender
  • Type: Boolean
Use Timed Executions Use timed executions.
  • Field Name: multi_execute.use_timed
  • Type: Boolean
Specific Execution Dates Specific Execution Dates
  • Field Name: specific_execute.[n]
  • Type: Array
Execution Date (YYYY-MM-DD. Local date) Execution Date
  • Field Name: multi_execute.specific_execute.[n].specific_date
  • Type: String
  • Pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12]\d|3[01])$
Execution Time (HH:MM:SS. Local time) Execution Time
  • Field Name: multi_execute.specific_execute.[n].specific_time
  • Type: String
  • Pattern: ^([0-1]\d|2[0-3]):(0[0-9]|[1-5]\d):(0[0-9]|[1-5]\d)$
Execution Timezone (Local timezone) Timezone for Execution Default: 0
  • Field Name: multi_execute.specific_execute.[n].specific_timezone
  • Type: String
  • Default: 0
  • Pattern: ^[-+]?\d+$
Calendar Executions Repeated Execution by Calendar
  • Field Name: calender_execute
  • Type: Object
Calendar Month Calendar Month
  • Field Name: multi_execute.calender_execute.calender_month
  • Type: Integer
  • Minimum: 1
  • Maximum: 12
Calendar Day Calendar Day
  • Field Name: multi_execute.calender_execute.calender_day
  • Type: Integer
  • Minimum: 1
  • Maximum: 31
Calendar Hour Calendar Hour
  • Field Name: multi_execute.calender_execute.calender_hour
  • Type: Integer
  • Maximum: 23
Calendar Minute Calendar Minute
  • Field Name: multi_execute.calender_execute.calender_minute
  • Type: Integer
  • Maximum: 59
Execution Timezone (Local timezone) Timezone for Execution Default: 0
  • Field Name: multi_execute.calender_execute.calender_timezone
  • Type: String
  • Default: 0
  • Pattern: ^[-+]?\d+$
Timed Executions Timed Execution
  • Field Name: timed_execute
  • Type: Object
First Execution Date (YYYY-MM-DD. Local date) Execution Date
  • Field Name: multi_execute.timed_execute.first_date
  • Type: String
  • Pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12]\d|3[01])$
First Execution Time (HH:MM:SS. Local time) Execution Time
  • Field Name: multi_execute.timed_execute.first_time
  • Type: String
  • Pattern: ^([0-1]\d|2[0-3]):(0[0-9]|[1-5]\d):(0[0-9]|[1-5]\d)$
First Execution Timezone (Local timezone) Timezone for Execution Default: 0
  • Field Name: multi_execute.timed_execute.first_timezone
  • Type: String
  • Default: 0
  • Pattern: ^[-+]?\d+$
Repeat after (x) Days Repeat Days
  • Field Name: multi_execute.timed_execute.repeat_day
  • Type: Integer
Repeat after (x) Hours Repeat Hours
  • Field Name: multi_execute.timed_execute.repeat_hour
  • Type: Integer
Repeat after (x) Minutes Repeat Minutes
  • Field Name: multi_execute.timed_execute.repeat_minute
  • Type: Integer
Number of Repeats (0 = infinite) Number of Repeats
  • Field Name: multi_execute.timed_execute.repeat_number
  • Type: Integer