Automation app: Overview

The Automation app in Aspera on Cloud lets you create automated workflows that initiate file transfers, make calls to an API, and send notifications to users. This article describes the app, its components, key concepts for automated workflows and jobs, and provides an example use case.

Automation is available to users with a Standard Plus or Premium edition of Aspera on Cloud.

Highlights

  • Automate your file transfer workflows with event-based triggers cued to IBM Aspera on Cloud endpoints.
  • Seamlessly integrate with external web services via API calls.
  • Communicate workflow status with event-driven email notifications.
  • Easily build, execute, and manage workflows with an intuitive interface.

Automation monitors your file storage system for event triggers; for example, a specific date and time can initiate a transfer, and a file upload to a shared folder can trigger an email notification.

You can transfer files and folders to an Aspera on Cloud (AoC) workspace, an on-premises node, or a node in the cloud. The IBM Aspera FASP protocol embedded in AoC allows you to transfer files of any size, securely and reliably, at unrivaled speed.

The Job Queue page in the Automation app allows you to easily monitor all running and completed workflow jobs.

Key concepts

To build an automated workflow in the Automation app, create the new workflow, then add steps: first, a workflow trigger, then a number of various actions. When your workflow is complete, activate it to generate jobs (a job is a running instance of a workflow). For a sample build, see Tutorial: Create a simple workflow that transfers a package.

Key concepts: Workflows

The elements below are available on the Workflows page. You interact with them when you build a new workflow or edit an existing workflow.

Element Description
workflow A workflow is the container for a trigger and for all the tasks you need to accomplish. A workflow can contain any number of steps. Each workflow starts with a trigger that you configure to run the workflow.
step The first step in the workflow always contains the trigger that runs the workflow.

All subsequent steps contain one or more actions, which perform the actual "work" in the workflow.

The steps in a workflow organize and sequence these actions for maximum effectiveness.

trigger The first step in a workflow is always a trigger step. It defines the conditions for launching the workflow. These are the available triggers types (for details, see Workflow triggers and their attributes):
  • Manual: Trigger the workflow with a manual action.
    • A user can run the workflow by clicking the workflow row to open it, then clicking Run now.
    • An API call can run the workflow.
    • A workflow with a Manual trigger must contain at least one Transfer or Send a Package action.
  • Time schedule: Use this trigger to launch a workflow at a scheduled time. You can make this a recurring scheduled launch, repeating as required by your situation. A workflow with a Time schedule trigger must contain at least one Transfer or Send a Package action.
  • File event: Trigger the workflow when Automation detects a new file added to a folder. You need the node secret to select the folder.
  • Shared inbox event: Trigger the workflow when a package arrives in a shared inbox.
  • File/folder delete event: Trigger the workflow when a file or folder is deleted.
action An action step in Automation performs the tasks required in the workflow. It performs one of the following tasks (for details, see Workflow actions and their attributes):
  • Transfer: Transfer files or folders.
  • Send a package: Create and send a digital package to users, groups, or a shared inbox in Aspera on Cloud. See Packages app: Send and receive files and folders.
  • Call an API: Call an external API.
  • Notify: Send an email notification to stakeholders.
  • Custom variables: Create custom variables.
  • Create a folder: Create a new sub-folder inside an existing folder on a workspace or a node.
Note: You can have multiple parallel actions in a step. To create a parallel action, click the plus icon below an existing action step.

Key concepts: Jobs

The Job queue page displays your running jobs and any jobs still in the queue:
Components Description
job An instance of an active workflow that is launched each time that workflow is triggered. You can see the status of your jobs on the Job queue page.
Depending on your Aspera on Cloud subscription edition, these are the concurrent job maximums:
  • Standard Plus edition: 5 concurrent jobs max
  • Premium edition: 10 concurrent jobs max
queue The queue contains all jobs beyond the allowed maximum number of running jobs. As each running job completes, another job is released from the queue. Jobs move from the queue to running in the order that they were added to the queue.
Depending on your Aspera on Cloud subscription edition, these are the queue size maximums:
  • Standard Plus edition: 5,000 jobs
  • Premium edition: 10,000 jobs

Example use case

For a team that submits video content to a shared inbox in the AoC Packages app, the project lead sets up a workflow that triggers each time a member submits a package with the metadata value, 'rev'. When the workflow is triggered, the following things happen:
  1. AoC automatically transfers the video files in the package from shared storage to remote cloud storage.
  2. Three stakeholders receive email notifications that the files have successfully transferred.
  3. Once the transfer is successfully completed, an API triggers a step than runs a transcoder on the files.
  4. The project lead receives an email that contains the success or error response code from the API.