connect
search

Creating a workflow definition using the code editor

To create a workflow definition using the code editor:

  1. Open the Workflows menu and select Manager. The Workflow Manager page is displayed.

  2. Click New workflow definition. The Create new workflow definition window is displayed. The Workflow Manager

  3. Click Switch to code editing [Ctrl+Shift+V]. The Switch to code editing option The code editor is displayed. The Workflow code editor Note: If you want to keep editing your workflow in Canvas mode, click Switch to canvas editing. The Switch to canvas mode option

  4. In the workflow editor, you can define your workflow using YAML.

    Note

    Each workflow has a few base details that must be filled in when starting to define your workflow, such as Name, Type, ExecutionNameFormat, Description and Trigger. For more information, see the Base Details section.

  5. In the Components section, you can copy and paste the existing code snippets to integrate into your workflow definition. For more information about components, see Component Types.

Base Details

DetailDescription
NameThe name of the workflow.

Note: When creating or editing a definition, the workflow name can only be Ingest, as only the ingest process is supported.
TypeCan only be IngestWorkflow.
ExecutionNameFormatHow the workflow executions that use this workflow definition are named. It can be a combination of a static string and any of the available variables: fileLocator.bucket, fileLocator.key, fileLocator.type, fileUrl, fileExtension, fileName, bucket, key, origin, titleId, titleName.
DescriptionThe description of the workflow definition.
TriggerCan only be Resource: SystemIngestTrigger.

Example configuration

Workflow:
Name: Ingest
Type: IngestWorkflow
ExecutionNameFormat: Ingest - {{fileName}}
Description: A definition based on an configuration of an existing client, includes an Interlace Scan, Frame Scan, Crop detection and MediaView Caching at the end
Trigger:
Resource: SystemIngestTrigger
Creating a workflow definition using the canvas editorMedia tasks