Media Triggers

Media triggers are system events that trigger Ingest workflows.

System Ingest

Introduction

When an Ingest workflow is started, it is considered to be triggered by a system event named SystemIngestTrigger. This system event will contain all the necessary information to run the first steps in the ingest process

Event structure

• fileLocator: S3FileLocator - file locator object representing the file that caused the trigger
• fileUrl: string - URL of the file that caused the trigger (includes 's3://' protocol header)
• bucket: string - the S3 bucket where the file is stored
• key: string - path to the file (inside the S3 bucket)
• fileName: string - the name of the file
• fileExtension: string - the extension of the file
• origin: string - file origin type (source, intermediate, deliverable)
• titleId: string - optional, ID of attached title
• titleName: string - optional, name of the attached title

Examples

Here is an example of how these values will be represented for a file called earth-spin.mov, located in the tf-s3-ownzones-vulcan bucket, on the /maine-coon/uploads/ path:

{
  "fileLocator": {
    "accessKeyId": null,
    "bucket": "tf-s3-ownzones-vulcan",
    "endpoint": null,
    "key": "maine-coon/uploads/earth-spin.mov",
    "secretAccessKey": null,
    "type": "S3FileLocator",
    "url": "s3://tf-s3-ownzones-vulcan/maine-coon/uploads/earth-spin.mov"
  },
  "fileUrl": "s3://tf-s3-ownzones-vulcan/maine-coon/uploads/earth-spin.mov",
  "bucket": "tf-s3-ownzones-vulcan",
  "key": "maine-coon/uploads/earth-spin.mov",
  "fileExtension": ".mov",
  "fileName": "earth-spin.mov",
  "origin": "source"
}

Inside a workflow definition file, the trigger properties can be accessed using the $.Trigger path, like in this example:

Workflow:
  Name: Ingest
  Type: IngestWorkflow
  Steps:
    EnsureAccess:
      Type: Task
      Resource: EnsureAccess
      Parameters:
        fileLocator: $.Trigger.fileLocator
      Next: ChooseFlow

    ChooseFlow:
      Type: Choice
      Choices:
        - Variable: $.EnsureAccess.fileId
          Operator: IsPresent
          Value: true
          Next: ProbeFile
        - Variable: $.EnsureAccess.fileId
          Operator: IsPresent
          Value: false
          Next: Failed
      Default: Failed

    ProbeFile:
      Type: Task
      Resource: Probe
      Parameters:
        fileId: $.EnsureAccess.fileId
      End: true

Failsafe

Introduction

If a Task fails during an execution, the workflow definition can be configured to go through a separate path using the Failsafe trigger. This will create a new path in the workflow definition, which needs to be configured.

Configuration

• Error type: the type of error that will activate the Failsafe trigger, it can be one or more or all types of errors.