Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Introduction

Automation workflows allows the administrator to make the Digizuite™ Dam Center do things automatically, as other things happens in the system. 
Automation workflows replaces existing ItemWatcher workflows (And anything else that depends on digimonitor).

To interact with automation workflow, a Media Manager with at least version 5.2 is required. 

BETA

Do note that automation workflows are in beta in 5.2. It is recommended that you start migrating any existing workflows to the automation engine, as R&D is expecting to sunset digimonitor with the 5.3 release. If you find any actions missing, please open a feature request in the Dam project on JIRA, and R&D have a look at it. 

Workflow construction

Automation workflows are build of steps. A step can be either an "action", a "trigger", a "filter" or a foreach loop. 

A workflow is started by a "trigger". A trigger is a special kind of step that listens for events in the overall system, such as an asset being uploaded, or metadata changing.

To actually do thing a workflow has "action"s. An action does a single thing, such as update a metadata field, a trigger an asset publish. 

To prevent parts of a workflow from running it is possible to use a "filter". A filter checks some condition in the Digizuite, such as the value of a metadata field for an asset.

Lastly there are loops, which is a special construct that allows for repeating a certain set of steps, over a set of data, executing the steps for each data point in the set. 

Creating a new workflow

To create a new workflow, open the workflow page by selecting the workflow dropdown (1) from the upper-right side of the Media Manager, next select "workflows" (2):


Next select "Add new" (3)

A menu should open to the left, in this menu, press "insert" on the type of trigger you want. What the different triggers can do, is documented at the bottom of this document. 

Using the visual editor

Once a workflow has been opened in the editor, a flowchart like view should be shown, either with only the trigger chosen earlier, or with a larger workflow, if an existing workflow was opened. 

Adding a new step

To add a new step to the workflow, drag from the colored circle on the bottom of an existing step. When you start dragging, a new node placeholder will appear, drag your cursor to this placeholder, and let go. 


When you let go, a pane will open on the left, where the step to insert can be selected. Pick a type of step. 

The step should now be inserted where the placeholder was. Now you need to fill out the parameters for the step. 

This is done by selecting the "more" button on the step and selecting "edit". This should open a dialog to the right. 

In this dialog fill out the parameters, and select "apply" when done. 

Workflow text syntax

Underneath the visual edtior, the workflows are supported by a relatively simple text format, for example:


Sample
trigger "Asset Uploaded" {
    type = "Asset Created Trigger"
    resolves = ["Move to User Profile Images", "Move to channel user profile folder"]
    upload_computer = "Digizuite Media Manager profile"
}


Each step is identified first by a keyword "trigger", "filter", "action", "foreach", then followed by a name in qoutes. This name should be unique within the workflow. 

In between the curly brackets we have the actual parameters for the steps. Each parameter is identified by a key, e.g., "upload_computer", an equal sign "=", and then some value in qoutes.
It is possible to have a set of values, by putting the values inside square brackets "[ ]", as seen from the "resolves" parameter above. 


A more formal version of the format can be seen in the following railroad diagram:


Most of the parameters for each step is dynamic generated, however 3 parameters almost always appear, depending on the keyword used for the step. 

"type" is specified on all steps, and refers to the specific kind of action/filter that should be run, from the example above "Asset Created Trigger". The specified types available, are documented at the bottom of this document. 

Next we have "resolves", as seen in the above example. "resolves" is specified on all triggers, and refers to the last step in a chain of steps, that should be executed. 

Lastly we have "needs", which is used on actions and filters, and refers to steps that should be executed before this step, thus creating a chain of dependencies. 

For loops

For loops are a bit special, since they allow for execution of a set of steps multiple times within the same workflow. To do this, you have to specify 5 parameters:

  • "type", which should be set to "ForEach".
  • "resolves", which should be the last step in the chain of steps to execute. 
  • "needs", which specifies any steps that should be run before the for loop. 
  • "variable", which specifies which variable to iterate over. 
  • "as", specifies what "variable" should be available as, in each iteration of the for loop. 

Variables

To pass data between different steps, workflows use variables. Variables are identified by starting with an at sign "@", for example "@sourceAssetItemId". 

Triggers usually emit some variables, such as which asset triggered them. 

To pass a variable to an action or filter, just write the variable name, such as "@sourceAssetItemId". 

If you try to use a variable before it's ready, you will get an error when you have the workflow. 

Some actions have "exported" variables, which means that rather than reading a variable before it executes, it sets a variable after it is done. 


Tips and tricks

Required metadata fields

If two or more metadata fields are required: you should position the filters below each other.

If you have multiple fields, but only one of them are required: you should position the filters beside each other.

AND operator = "filter" steps below each other.

OR operator = "filter" steps besides each other.

Available steps

This documentation is auto generated from source, so it should be correct. Some additional manual documentation might be provided below. 

Available triggers

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 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

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

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

CronScheduleTrigger



  • 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

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

Performance Test Trigger


  • @scheduledAt
  • key: identifier
  • Description: An identifier for the flow to limit execution
  • Required: True
  • Type: string
  • Exported: False

Available actions

Type

Description

Parameters

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

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

Get metadata from damapi


  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • 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(warning) 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

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
  • Exported: True

Log

Logs a message to the logger

  • key: text
  • Required: True
  • Type: string
  • Exported: False

Query JSON


  • key: json
  • Description: The json to query into
  • Required: True
  • Type: string
  • Exported: False
  • key: json_path
  • Description: The json path to execute as query. The matches items will always be stringified
  • Required: True
  • Type: string
  • Exported: False
  • key: error_on_not_found_items
  • Description: Should an error be emitted if the query doesn't find any matching items?
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False
  • key: result
  • Required: True
  • Type: list:string
  • Exported: True

scale image

Scales an image to the specified height/width and format

  • key: width
  • Description: The width of the generated image. Auto-calculated if set to 0
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False
  • key: height
  • Description: The width of the generated image. Auto-calculated if set to 0
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False
  • key: input_file
  • Description: The name of the input file on disk
  • Required: True
  • Type: string
  • Exported: False
  • key: output_file
  • Description: The name of the generated file on disk
  • Required: True
  • Type: string
  • Exported: True
  • key: output_format
  • Description: The output format of the file (png, jpg)
  • Required: True
  • Type: options
  • options: bmp (bmp), gif (gif), jpeg (jpeg), png (png), tiff (tiff)
  • Exported: False

Search

Y'know, for search...

  • key: search
  • Required: True
  • Type: string
  • Exported: False
  • key: search_parameters
  • Required: True
  • Type: list:KeyValueStringString
  • Exported: False
  • key: result
  • Required: True
  • Type: list:string
  • Exported: True

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

Variable set

Exports a value as a sample

  • key: value
  • Required: True
  • Type: string
  • Exported: False
  • key: export_as
  • Required: True
  • Type: string
  • Exported: True

Variable read

An export read sample

  • key: what
  • Required: True
  • Type: string
  • Exported: False

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

Move Asset To Folder

Moves an asset into a specific folder

  • key: asset_item_id
  • Description: The item id of the asset to move
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: folder
  • Description: The folder to move the asset into
  • Required: True
  • Type: foldervalue
  • Exported: False

Remove Asset From All Channels


  • key: excluded_folders
  • Description: The folder tree(s) to exclude
  • Required: True
  • Type: list:foldervalue
  • Exported: False
  • key: asset_item_id
  • Description: The item id of the asset to remove
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False

Remove Asset From Folder

Removes the given asset from a given folder

  • key: asset_item_id
  • Description: The asset id to remove from the folder
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: folder
  • Description: The folder to remove the asset from
  • Required: True
  • Type: foldervalue
  • Exported: False

Remove Asset From Layout Folder Recursive


  • key: folder
  • Description: The folder (and all the children) to remove the asset from
  • Required: True
  • Type: foldervalue
  • Exported: False
  • key: excluded_folders
  • Description: The folder tree(s) to exclude
  • Required: True
  • Type: list:foldervalue
  • Exported: False
  • key: asset_item_id
  • Description: The item id of the asset to remove
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False

RePublish Asset

Triggers a republish of the specified asset

  • key: asset_id
  • Required: True
  • DefaultValue: @sourceAssetId
  • Type: int
  • Exported: False

Split Folder Reference

Splits a folder reference into individual parts, so they can be used by themselves

  • key: folder
  • Description: The Folder reference to split
  • Required: True
  • Type: foldervalue
  • Exported: False
  • key: folder_id
  • Description: The resulting id of the folder
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: True
  • key: repository_type
  • Description: The resulting repository type of the folder
  • Required: True
  • DefaultValue: default
  • 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: True

Split Tree value

Splits a tree value into its components

  • key: value
  • Description: The value to split
  • Required: True
  • Type: treevalue
  • Exported: False
  • key: meta_field
  • Description: The meta field the value comes from
  • Required: True
  • Type: metafield
  • Exported: False
  • key: option_value
  • Description: The "optionvalue" property
  • Required: True
  • Type: string
  • Exported: True
  • key: id
  • Description: The "id" property
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: True
  • key: label
  • Description: The "label" property
  • Required: True
  • Type: string
  • Exported: True

Set Bit Metafield

Updates a bit value

  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Set ComboValue Metafield

Updates a ComboValue metafield

  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • Type: combovalue
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Set Date Metafield

Updates a date field

  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • DefaultValue: 1/1/0001 12:00:00 AM
  • Type: datetime
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Set EditComboValue Metafield

Updates the value of an edit combo value meta field

  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • Type: combovalue
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Set EditMultiComboValue Metafield

Updates the value of the edit multi combo value meta field

  • key: update_method
  • Required: True
  • DefaultValue: set
  • Type: options
  • options: Set (set), Merge (merge), Unset (unset)
  • Exported: False
  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • Type: list:combovalue
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Set Float Metafield

Updates a float metafield

  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • DefaultValue: 0
  • Type: double
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Set Int Metafield

Sets the value of the given int metafield

  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Set Link Metafield

Updates the value of a link meta field

  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • Type: string
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Set MultiComboValue Metafield

Updates the value of a MultiComboValue field

  • key: update_method
  • Required: True
  • DefaultValue: set
  • Type: options
  • options: Set (set), Merge (merge), Unset (unset)
  • Exported: False
  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • Type: list:combovalue
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Set Note Metafield

Updates the value of a note meta field

  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • Type: string
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Set String Metafield

Sets the value of the given string metafield

  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • Type: string
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Set Tree Metafield

Updates the value of a tree meta field

  • key: update_method
  • Required: True
  • DefaultValue: set
  • Type: options
  • options: Set (set), Merge (merge), Unset (unset)
  • Exported: False
  • key: meta_field
  • Required: True
  • Type: metafield
  • Exported: False
  • key: new_value
  • Required: True
  • Type: list:treevalue
  • Exported: False
  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: use_versioned_metadata
  • Required: True
  • DefaultValue: false
  • Type: bool
  • 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

Move Member To Folder

Moves the member to a specific folder

  • key: member_item_id
  • Description: The item id of the member to move
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False
  • key: folder
  • Description: The folder to move to member to
  • Required: True
  • Type: foldervalue
  • Exported: False

Remove Access Rights

Removes the access rights for a given target from a given accessor
If you want to explicitly prevent an accessor from accessing an asset,
you probably need SetAccessRights instead, with Read and Write set to false.

  • key: accessor_item_id
  • Description: The item id of the accessor
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False
  • key: target_item_id
  • Description: The item id of the target
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False

Remove Member From Group

Removes a given member from a 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

Set Access Rights

Sets the access rights on a specific asset for a specific member

  • key: accessor_item_id
  • Description: The id of the member or member group to assign
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False
  • key: target_item_id
  • Description: The item id of the asset to assign rights on
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False
  • key: read_access
  • Description: If the member should have read access to the asset
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False
  • key: write_access
  • Description: If the member should have write access to the asset
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

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

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

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

Share Collection

Sharing a collection with a list of members, member groups or per email. 

  • key: collection_id
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False
  • key: emails
  • Required: True
  • Type: list:string
  • Exported: False
  • key: member_ids
  • Required: True
  • Type: list:int
  • Exported: False
  • key: member_group_ids
  • Required: True
  • Type: list:int
  • Exported: False
  • key: shared_item_url
  • Required: True
  • Type: string
  • Exported: False
  • key: email_msg
  • Required: True
  • Type: string
  • Exported: False
Delete Collection(s)A list of collections will be deleted. 
  • key: collection_ids
  • Required: True
  • Type: list:int
  • Exported: False

Available filters

Type

Description

Parameters

Asset type filter

Limits execution to certain asset types

  • key: asset_type
  • Required: True
  • DefaultValue: all
  • Type: options
  • options: All (all), Video (video), Audio (audio), Image (image), PowerPoint (powerpoint), Html (html), Text (text), Word (word), Excel (excel), InDesign (indesign), Zip (zip), META (meta), PDF (pdf), Archive (archive), Photoshop (photoshop), Illustrator (illustrator), Visio (visio), Cad (cad), ODT (odt), OTT (ott), ODS (ods), OTS (ots), ODP (odp), OTP (otp), ODG (odg), OTG (otg), ODB (odb), ODF (odf), ODM (odm), OTH (oth), Live (live)
  • Exported: False
  • key: asset_id
  • Required: True
  • DefaultValue: @sourceAssetId
  • Type: int
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Forced Result

Forces a certain outcome from the filter

  • key: result
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Metadata bit filter

Limits the execution if the expected Bit value does not equal the requested Metafield value

  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: metafield_item_id
  • Required: True
  • Type: metafield
  • Exported: False
  • key: expected_value
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Metadata combo filter

Limits the execution if the expected Combo value does not equal the requested Metafield value

  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: metafield_item_id
  • Required: True
  • Type: metafield
  • Exported: False
  • key: expected_value
  • Required: True
  • Type: combovalue
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Metadata datetime filter

Limits the execution if the expected DateTime value does not equal the requested Metafield value

  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: reference
  • Required: True
  • Type: metafield
  • Exported: False
  • key: expected_value
  • Required: True
  • DefaultValue: 1/1/0001 12:00:00 AM
  • Type: datetime
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Metadata editcombo filter

Limits the execution if the expected Edit Combo value does not equal the requested Metafield value

  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: metafield_item_id
  • Required: True
  • Type: metafield
  • Exported: False
  • key: expected_value
  • Required: True
  • Type: combovalue
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Metadata editmulticombo filter

Limits the execution if the expected Edit Multi Combo value does not equal the requested Metafield value

  • key: asset_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: reference
  • Required: True
  • Type: metafield
  • Exported: False
  • key: expected_value
  • Required: True
  • Type: list:combovalue
  • Exported: False
  • key: action_enum
  • Required: True
  • DefaultValue: exact
  • Type: options
  • options: Exact (exact), All (all), Any (any)
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Metadata float filter

Limits the execution if the expected Float value does not equal the requested Metafield value

  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: metafield_item_id
  • Required: True
  • Type: metafield
  • Exported: False
  • key: expected_value
  • Required: True
  • DefaultValue: 0
  • Type: double
  • Exported: False
  • key: tolerance
  • Required: True
  • DefaultValue: 0
  • Type: double
  • Exported: False
  • key: comparison_method
  • Description: How the actual value should be compared with the expected value, e.g., 'actual' LessThan 'expected'
  • Required: True
  • DefaultValue: equals
  • Type: options
  • options: Equals (equals), LessThan (lessthan), GreaterThan (greaterthan), LessThanOrEquals (lessthanorequals), GreaterThanOrEquals (greaterthanorequals), NotEqual (notequal)
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

metadata int filter

Limits the execution if the expected Int value does not equal the requested Metafield value

  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: metafield_item_id
  • Required: True
  • Type: metafield
  • Exported: False
  • key: expected_value
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False
  • key: comparison_method
  • Description: How the actual value should be compared with the expected value, e.g., 'actual' LessThan 'expected'
  • Required: True
  • DefaultValue: equals
  • Type: options
  • options: Equals (equals), LessThan (lessthan), GreaterThan (greaterthan), LessThanOrEquals (lessthanorequals), GreaterThanOrEquals (greaterthanorequals), NotEqual (notequal)
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Metadata link filter

Limits the execution if the expected Link value does not equal the requested Metafield value

  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: metafield_item_id
  • Required: True
  • Type: metafield
  • Exported: False
  • key: expected_value
  • Required: True
  • Type: string
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Metadata multicombo filter

Limits the execution if the expected Multi Combo value does not equal the requested Metafield value

  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: metafield_item_id
  • Required: True
  • Type: metafield
  • Exported: False
  • key: expected_value
  • Required: True
  • Type: list:combovalue
  • Exported: False
  • key: action_enum
  • Required: True
  • DefaultValue: exact
  • Type: options
  • options: Exact (exact), All (all), Any (any)
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Metadata note filter

Limits the execution if the expected Note value does not equal the requested Metafield value

  • key: expected_value
  • Required: True
  • Type: string
  • Exported: False
  • key: asset_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: reference
  • Required: True
  • Type: metafield
  • Exported: False
  • key: case_sensitive
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Metafield string filter

Limits the execution if the expected String value does not equal the requested Metafield value

  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: metafield_item_id
  • Required: True
  • Type: metafield
  • Exported: False
  • key: expected_value
  • Required: True
  • Type: string
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Metadata tree filter

Limits the execution if the expected Tree value does not equal the requested Metafield value

  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False
  • key: reference
  • Required: True
  • Type: metafield
  • Exported: False
  • key: expected_value
  • Required: True
  • Type: list:treevalue
  • Exported: False
  • key: action_enum
  • Required: True
  • DefaultValue: exact
  • Type: options
  • options: Exact (exact), All (all), Any (any)
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False

Bool Comparison filter

Compares 2 arbitrary booleans

  • key: value
  • Description: A value read from somewhere
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False
  • key: expected_value
  • Description: The value 'value' is expected to be
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False
  • key: negate
  • Required: False
  • DefaultValue: false
  • Type: bool
  • Exported: False
  • No labels