Skip to main content

Base functionality

This project export contains commonly used functionality. We recommend importing it into your Cloudomation workspace. You can use the provided examples as-is or use them as a boilerplate to develop your own version.

Content

Download the "Base functionality" export for Cloudomation version 5 here: Base_functionality_v5.yaml

Importing the file will create a project called "Base functionality" in your Cloudomation workspace. It contains several wrappers as well as schedulers.

Wrappers

Please refer to Wrappers for details.

Retry

The retry wrapper can be used for executions which sometimes fail due to external factors. When used without additional configuration it will start the child execution up to three times with a 10 second delay in between tries. Take a look at the retries page for more details and an example.

Parameters

ParameterDescriptionDefault value
max_triesThe number of times to try starting the child before failing.3
delay_secThe number of seconds to wait in between retries.10
timeout_secFail, if the child did not succeed within the timeout. Set to 0 to disable.0
archive_retriesArchive failed retries.True

Notify

The notify wrapper observes a child execution and generates notifications on end. Take a look at the notifications page for more details and an example.

Parameters

ParameterDescriptionDefault value
notify_on_successIf a notification should be generated when the child ends with ENDED_SUCCESS.False
notify_on_errorIf a notification should be generated when the child ends with ENDED_ERROR or ENDED_CANCELLED.True
toA list of Cloudomation user names who will receive notifications.None
subjectThe subject line of the email.{child_name} {child_status}
bodyThe email body.<p>Execution <a href="{self_url}/execution/{child_id}">{child_name}</a> ended with status <strong>{child_status}</strong></p><pre>{child_message}</pre>

The following substitutions are performed on the subject and body parameters

PlaceholderDescription
{child_name}The name of the child execution.
{child_id}The ID of the child execution.
{child_status}The end status of the child execution.
{child_message}The end message of the child execution.
{self_url}The URL to the workspace where the execution was running.

Interactive

The interactive wrapper observes a child execution and, in case of an error, allows an operator to decide if to retry, ignore the error or fail. Take a look at the interactive mode page for more details and an example.

Parameters

ParameterDescriptionDefault value
interactive_limit_minutesAfter how many minutes of inactivity a Cloudomation user is considered "away".30
archive_retriesArchive failed retries.True

Check

The check wrapper can be used to verify if a child execution succeeded by analyzing the output_value of the child execution.

Parameters

ParameterDescriptionDefault value
checker_flowThe name of a flow which performs the validation of the child's output_value.None
checker_scriptA flow script which performs the validation of the child's output_value.None
checkerAn alias for checker_script.None
inputsAdditional inputs passed to the checker flow or script.None

Schedulers

All provided schedulers are integrated into the Cloudomation frontend using a plugin. There are additional buttons available when opening a flow to configure a new schedule for that flow.

Please refer to Scheduling for details.

Daily

Run a flow at the same time every day.

Parameters

ParameterDescriptionDefault value
max_iterationsAfter how many iterations to stop.None
timeAt which time to start the flow08:15
timezoneWhich timezone to use. The scheduler will adjust for daylight saving time changes accordingly.Europe/Vienna
input_valueAdditional inputs to pass to the scheduled flow.{}

Monthly

Run a flow on specific days of each month.

Parameters

ParameterDescriptionDefault value
max_iterationsAfter how many iterations to stop.None
timeAt which time to start the flow08:15
timezoneWhich timezone to use. The scheduler will adjust for daylight saving time changes accordingly.Europe/Vienna
input_valueAdditional inputs to pass to the scheduled flow.{}
days_of_monthA list of day numbers on which to start the flow. Negative numbers can be used to count from the end of the month.[1]

Recurring

Run a flow repeatedly with a delay.

Parameters

ParameterDescriptionDefault value
max_iterationsAfter how many iterations to stop.None
timeAt which time to start the flow08:15
timezoneWhich timezone to use. The scheduler will adjust for daylight saving time changes accordingly.Europe/Vienna
input_valueAdditional inputs to pass to the scheduled flow.{}
interval_secondsHow many seconds to wait in between executions.60

Learn more

Wrappers
Scheduling
Plugins
Import / Export and Upload