Skip to main content
Version: 8 - Apfelstrudel

Glossary

Connection, Connector, Connector Type

Cloudomation Engine can interact with third party systems via Connections, among others. Often used connections can be configured and stored in a Connector. Imagine that you frequently query data from a database. You can store the necessary configuration (e.g. database name, port, etc.) in a Connector so you don't have to define it for each Connection separately.

Different third party systems have different configuration needs, hence Engine provides many Connector Types, e.g. SSH, PostgreSQL, Google Cloud, ... . Each Connector Type specifies the required input parameters to connect to a remote system.

Refer to Connector Types for a detailed list.
Learn how to configure a Connection via the respective Connector.

Execution

Executions in Cloudomation Engine are what "get things done". An easy way to think about them is as follows: Let's say that you define a business logic in the form of a script, to check the weather. You don't only want to do this once, but each day. Every time your script runs it creates an Execution. There are Executions that are finished (past Executions), there could be Executions running right now doing their work. There might be Executions that are scheduled for a future time.

Multiple Executions can be started by a single Resource that defines business logic (e.g. a Flow). Even though those Executions can share the same script, they can have different status (running, finished, etc.) and different behaviours (e.g. an Execution can check the weather and depending on the weather conditions send a mail notification).

Learn more about Executions.

Flow, Flow Script

Flows are Resources in Cloudomation Engine. They are the home to Flow Scripts and as such are vital for your automations. A Flow Script is a script written in Python that defines business logic (e.g. if X happens do Y, get data from system A to B, etc.).

Think of Flows as the base building blocks of potentially complex processes. Flows can interact with other Flows, can create Connections, and much more. There are many ways, a Flow can be started e.g. manually, via a webhook call, with a schedule.

When you run a Flow, you create an Execution.

See: Flows.

Flow API

The Flow API extends base Python functionality and provides you with methods to manipulate Cloudomation Engine Resources within your Flow Scripts.

As simple example would be the connect method of an Execution object, that makes connecting to third party systems seamless.

See Flow API.

Records

Records are the base type of all content in Cloudomation Engine. This includes flow scripts, files, messages, users, executions and anything else you or the system create on the platform. Think of Records as the lowest common denominator of everything else.

Learn more about available Records.
Learn how to Access and Manipulate Records

Resources vs. Activities

Both Resources and Activities are based on Records.

Resources are Records that can be created and edited by the user (e.g. a Flow).
Activities are Records that are created only by the system (e.g. an Execution). You cannot directly create or change Activities, but can use the UI, the Flow API or Cloudomation Engine's REST API to interact with them.

Learn more about the different Activities and Resources.

Two-factor authentication (2FA)

Two-factor authentication (2FA) is a method of adding additional security to your account. The first "factor" is your usual password that is standard for any account. The second "factor" is a verification code retrieved from an app on a mobile device or computer.
(Source: Wikipedia - Two-factor authentication)

Vault

A Vault allows you to store sensitive information, such as passwords and manage this data and access permissions. Vault services also allow you to access this sensitive information from anywhere and from within applications.
Cloudomation Engine offers an integration for the Vault by HashiCorp to ease automation where sensitive data is required for logging in at different external services (see Vault Integration).

Workspace

A Workspace is an installation of Cloudomation Engine. You can have multiple workspaces, running in the cloud or on premise.
Engine enables the user to synchronize executions on different workspaces. Syncronization is even possible between a workspace in the cloud and one that is installed in a company Intranet.

For more information on configuring on-premise installations, see Workspace Configuration.

Webhook

With Webhooks you can create REST endpoints which can be accessed by third-party applications to integrate with Cloudomation Engine. When such a REST endpoint is called this creates a corresponding execution in Engine.

Use webhooks to

  • start Engine executions from third party systems
  • receive notifications from third party systems
  • receive callbacks from asynchronous processes running in third party systems
  • create custom status HTML pages which display information gathered from Engine
  • expose information or functionality to consumers which do not have an Engine user

(See Webhooks)