DC 5.6 Available steps in automations

DC 5.6 Available steps in automations

Available steps

This documentation is auto-generated from the source, hence it's very unlikely to contain mistakes.

Some additional manual documentation might be provided below. 

Available triggers

Type

Description

Exported Variables

Parameters

Type

Description

Exported Variables

Parameters

Asset Created Trigger

Triggers whenever an asset is created

  • @sourceAssetId

  • @sourceAssetItemId

  • key: upload_computer

  • Required: False

  • Type: string

  • Exported: False

Asset Deleted Trigger

Triggers whenever an asset is deleted

 

 

Asset Folder Updated Trigger

Triggers whenever an asset moved between folders

  • @sourceAssetId

  • @sourceAssetItemId

  • key: from_folder

  • Description: The folder the asset moved from

  • Required: False

  • Type: foldervalue

  • Exported: False

  • key: to_folder

  • Description: The folder the asset moved to

  • Required: False

  • Type: foldervalue

  • Exported: False

Asset Profile Published

Triggers whenever the specified profile for the asset is published

 

 

Business Workflow Stage Entered

Triggers when the specified stage in a business workflow is entered, no matter where it came from

 

 

Business Workflow Stage Left

Triggered when a stage is left, no matter where the workflow is going afterwards

 

 

Business Workflow Transition Passed

Triggered whenever the specific transition is passed

 

 

CronScheduleTrigger

Triggers the workflow on a specific schedule

 

  • key: schedule

  • Description: The cron string to use as schedule

  • Required: True

  • Type: string

  • Exported: False

  • key: misfire_instruction

  • Description: What should be done if the time passes for the trigger?

  • Required: True

  • DefaultValue: fireoncenow

  • Type: options

  • options: IgnoreMisfirePolicy (ignoremisfirepolicy), DoNothing (donothing), FireOnceNow (fireoncenow)

  • Exported: False

  • key: identity

  • Description: A unique id for this trigger specifically, if it's not unique
    amongst all cron triggers, then you will have a problem.

  • Required: True

  • Type: string

  • Exported: False

Derived Asset Created

Triggers when a new derived asset is created

 

 

Location State Changed

Triggered whenever a new asset is uploaded

  • @sourceAssetId

  • @sourceAssetItemId

  • key: new_location_state

  • Required: True

  • DefaultValue: 0

  • Type: options

  • options: Offline (offline), Online (online)

  • Exported: False

ManualTrigger

Used only by admin for manually triggering a lot of runs

 

 

Member Created

Whenever a new member is created

  • @sourceMemberId

  • @sourceMemberItemId

 

Member Deleted

Whenever an existing member is deleted. Covers both soft and permanent deletes

  • @sourceMemberId

  • @sourceMemberItemId

  • @isSoft

  • key: only_soft_deletes

  • Description: True if the trigger should trigger only for soft deletes

  • Required: True

  • DefaultValue: true

  • Type: bool

  • Exported: False

Member Metadata Changed

Whenever the Metadata on a member changes

  • @sourceMemberId

  • @sourceMemberItemId

 

  • key: meta_field

  • Description: The metafield to watch for updates

  • Required: True

  • Type: metafield

  • Exported: False

metadata

Triggers only if the metadata update was for the specified field.

  • @sourceAssetId

  • @sourceAssetItemId

  • @changedValue

  • @deleted

  • key: meta_field

  • Description: The metafield to watch for updates

  • Required: True

  • Type: metafield

  • Exported: False

Performance Test Trigger

 

  • @scheduledAt

  • key: identifier

  • Description: An identifier for the flow to limit execution

  • Required: True

  • Type: string

  • Exported: False

Replaced Asset Created

Triggers when a new replaced asset is created

 

 

Specific Metadata Value

Triggers when a metadata field changes either to or from the specified value

 

 

WebHook Trigger

Allows a workflow to be invoked using http

 

 

Available actions

Type

Description

Parameters

Type

Description

Parameters

Add Floats

Adds two floating point numbers together

 

Add Integers

Adds two integers together

 

Add Items To Collection

A list of assets will be added to the given collection. 

  • key: collection_id

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: False

  • key: item_ids

  • Required: True

  • Type: list:int

  • Exported: False

Add Member to Group

Adds a member to the given group

  • key: member_id

  • Description: The id of the member

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: False

  • key: group_id

  • Description: The id of the group

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: False

Add Member to Roles

Adds a member to the given roles

 

Add Tree Metafield value

 

 

Add time to date

Adds the specified number of seconds to the given date, and gives the new date

 

Approve Member

Approves given member

 

Change Text Casing

Changes the casing of some text

 

Calculate aspect ratio

Calculates a nice aspect ratio "16:9" from a height and width

 

Clear metafield

 

 

Concat lists

Concats two lists into one larger list

 

Convert Asset Id To Asset Item Id

Converts the given asset id to an asset item id

  • key: asset_id

  • Description: The asset id to convert

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: False

  • key: asset_item_id

  • Description: The resulting asset item id

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: True

Convert Asset Item Id To Asset Id

Converts the given asset item id to an asset id

  • key: asset_item_id

  • Description: The asset item id to convert

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: False

  • key: asset_id

  • Description: Asset resulting asset id

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: True

Convert Member Id To Member Item Id

Converts a member id into a member item id

  • key: member_id

  • Description: The member id to convert

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: False

  • key: member_item_id

  • Description: The resulting member item id

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: True

Convert Member Item Id To Member Id

Converts the given member item id to a member id

  • key: member_item_id

  • Description: The member item id

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: False

  • key: member_id

  • Description: The resulting member id

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: True

Create Entity Item

Creates an entity item from the entity type and item

 

Create Folder Reference

Creates a folder reference for use in other steps that requires a folder value reference

  • key: folder_id

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: False

  • key: repository_type

  • Required: True

  • DefaultValue: portal

  • Type: options

  • options: Default (default), Catalog (catalog), Userfolder (userfolder), Recyclebin (recyclebin), SharedFolder (sharedfolder), SearchFolder (searchfolder), UploadFolder (uploadfolder), ExportFolder (exportfolder), AdminFolder (adminfolder), SettingsFolder (settingsfolder), Portal (portal), DigiBatch (digibatch), BackendUsers (backendusers), BackendGroups (backendgroups), media_format (media_format), transcode (transcode), LanguageLabel (languagelabel), Profile (profile), MetaGroup (metagroup), Config (config), Product (product), Collection (collection)

  • Exported: False

  • key: result

  • Required: True

  • Type: foldervalue

  • Exported: True

Create New Collection

Create a new collection with the given collection name. 

The action will export a 'CollectionId' after it has been executed.

  • key: collection_name

  • Required: True

  • Type: string

  • Exported: False

  • key: item_ids

  • Required: True

  • Type: list:int

  • Exported: False

delay

Delays the execution with the Duration milliseconds

  • key: duration

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: False

  • key: message

  • Required: True

  • Type: string

  • Exported: False

Delete Asset

Soft deletes an asset (that is, keeps the actual file, but sets deleted bit)

  • key: asset_item_id

  • Description: The ItemId of the asset to be soft deleted

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: False

Delete Asset Permanently

!DANGER! Permanently deletes an asset (there is NO WAY to recover after this)

  • key: asset_item_id

  • Description: The ItemId of the Asset to be PERMANENTLY deleted

  • Required: True

  • DefaultValue: 0

  • Type: int

  • Exported: False

  • key: i_know_what_i_am_doing

  • Description: Confirmation that you actually know the consequence of this action

  • Required: True

  • DefaultValue: false

  • Type: bool

  • Exported: False

Delete Business Workflow Instance

 

 

Delete assets from all collections

 

 

Delete Collection(s)

A list of collections will be deleted. 

  • key: collection_ids

  • Required: True

  • Type: list:int

  • Exported: False

Divide Floats

Divides two floating point numbers

 

Divide Integers

Divides two integers

 

Download Asset Format

Downloads the given asset format to disk for processing

  • key: asset_id

  • Required: True

  • DefaultValue: @sourceAssetId

  • Type: int

  • Exported: False

  • key: media_format_id

  • Description: Using '-1' will get the source file for the asset

  • Required: True

  • DefaultValue: -1

  • Type: int

  • Exported: False

  • key: destination_id

  • Required: False

  • DefaultValue: 0

  • Type: int

  • Exported: False

  • key: file_name

  • Description: The generated file name, the file was saved under, on the job machine.

  • Required: True

  • Type: string

  • Exported: True

Find assets

Finds all assets that matches the given search parameters

 

Force fail

This step always fails

 

Format String

Just applies the specified variables as specified. You might not need this step, as applying the variables can be done inline when you pass variables to other steps.

 

Get Asset Information

Gets information about the specified asset

 

Get Business Workflow Instances

Gets the business workflows that matches the specified inputs. All inputs are optional.

 

Get Business Workflow task details

Gets details about the specific business workflow task

 

Get Current Date

Gets the current timestamp. Format is compatible with Search2

 

Get Layout Folders for Assets

Gets the folders the asset is currently in

 

Get Member Information

Gets information about the specified member

 

Get metadata from damapi

 

  • key: asset_item_id

  • Required: True

  • DefaultValue: @sourceAssetItemId

  • Type: int

  • Exported: False

Get Set Differences

Compares two sets and returns the differences

 

Get Value At Index

Gets a value at a certain index in a list of values. Step will fail hard if index is not in array

 

Get absolute float

Gets the absolute value of the provided floating point numbers.

 

Get absolute integer

Gets the absolute value of the provided integer.

 

Get members in group

Gets the members in a specific group

 

Get period between dates

Gets the number of seconds between two dates

 

Initiate Business Workflow

Initiate a new instance of a business workflow

 

Invoke Endpoint

 

  • key: endpoint

  • Required: True

  • Type: string

  • Exported: False

  • key: method

  • Required: True

  • DefaultValue: get

  • Type: options

  • options: GET (get), POST (post), PUT (put), DELETE (delete), HEAD (head), OPTIONS (options), PATCH (patch), MERGE (merge), COPY (copy)

  • Exported: False

  • key: response

  • Required: True

  • Type: string