Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note
titleBETA

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

...

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
  • key: listen_to_metadata_changes
  • Description: Which type of metadata changes should the trigger look for?
  • Required: False
  • DefaultValue: all
  • Type: options
  • options: AddedOnly (addedonly), DeletedOnly (deletedonly), All (all)
  • 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

key: asset_item_id

Type

Description

Parameters

delay

Delays the execution with the Duration milliseconds

  • key: duration

WebHook trigger

Allows a workflow to be invoked using http


  • key: identifier
  • Description: The id used to invoke this trigger
  • Required: True
  • DefaultValueType: 0 string
  • Type: int
  • Exported: Falsekey: message

Business Workflow Stage Entered

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

  • @sourceItemIds
  • @sourceWorkflowInstanceGuid
  • key: workflow
  • Description: The name of the workflow to watch
  • Required: True
  • Type: string
  • Exported: False

Download Asset Format

Downloads the given asset format to disk for processing

  • key: asset_idkey: stage_name
  • Description: The name of the stage on that workflow to watch
  • Required: TrueDefaultValue: @sourceAssetId
  • Type: int string
  • Exported: False
  • key: media_format_id
  • Description: Using '-1' will get the source file for the asset

Business Workflow Stage Left

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

  • @sourceItemIds
  • @sourceWorkflowInstanceGuid
  • key: workflow
  • Description: The name of the workflow to watch
  • Required: True
  • DefaultValue: -1
  • Type: int string
  • Exported: False
  • key: destinationstage_idname
  • Required: False
  • DefaultValue: 0Description: The name of the stage to watch
  • Required: True
  • Type: int string
  • Exported: False

Business Workflow Transition Passed

Triggered whenever the specific transition is passed

  • @sourceItemIds
  • @sourceWorkflowInstanceGuid
  • key: file_name workflow
  • Description: The generated file name , the file was saved under, on the job machine.of the workflow to watch
  • Required: True
  • Type: string
  • Exported: True False

Get metadata from damapi

  • key: asset_item_id transition_name
  • Description: The name of the transition to watch
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int string
  • Exported: False

Delete Asset Permanently

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


Available actions

Type

Description

Parameters

Concat lists

Concats two lists into one larger list

  • key: first
  • Description: The ItemId of the Asset to be PERMANENTLY(warning) deletedfirst set of variables
  • Required: TrueDefaultValue
  • Type: 0Typelist: intstring
  • Exported: False
  • key: i_know_what_i_am_doingDescription: Confirmation that you actually know the consequence of this action: second
  • Description: The second set of variables
  • Required: True
  • Type: list:string
  • Exported: False
  • key: remove_duplicates
  • Description: If duplicates that appears in both First and Second should be removed, so
    the value only apperas once
  • Required: True
  • DefaultValue: false
  • Type: bool
  • Exported: False

Invoke Endpoint

  • key: endpointkey: result
  • Description: The resulting list
  • Required: True
  • Type: list:string
  • Exported: False True

delay

Delays the execution with the Duration milliseconds

  • key: method duration
  • Required: True
  • DefaultValue: get 0
  • Type: int
  • Exported: options False
  • options: GET (get), POST (post), PUT (put), DELETE (delete), HEAD (head), OPTIONS (options), PATCH (patch), MERGE (merge), COPY (copy)
  • Exported: False
  • key: response
  • Requiredkey: message
  • Required: True
  • Type: string
  • Exported: True False

Log

Logs a message to the loggerDownload Asset Format

Downloads the given asset format to disk for processing

  • key: text asset_id
  • Required: True
  • DefaultValue: @sourceAssetId
  • Type: string int
  • Exported: False
Query JSON

  • key: json media_format_id
  • Description: The json to query intoRequiredUsing '-1' will get the source file for the asset
  • Required: True
  • DefaultValue: -1
  • Type: string int
  • Exported: False
  • key: jsondestination_pathid
  • Description: The json path to execute as query. The matches items will always be stringified
  • Required: TrueRequired: False
  • DefaultValue: 0
  • Type: string int
  • 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: intfile_name
  • Description: The generated file name, the file was saved under, on the job machine.
  • Required: True
  • Type: string
  • Exported: True

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

  • key: values
  • Description: The list of values to extract from
  • Required: True
  • Type: list:string
  • Exported: False
  • key: height index
  • Description: The width of the generated image. Auto-calculated if set to 0index to find
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False
  • key: input_file result
  • Description: The name of the input file on diskvalue at that index
  • Required: True
  • Type: string
  • Exported: False True

Delete Asset Permanently

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

  • key: outputasset_item_fileid
  • Description: The name ItemId of the generated file on diskAsset to be PERMANENTLY(warning) deleted
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: string int
  • Exported: True False
  • key: output_format i_know_what_i_am_doing
  • Description: The output format of the file (png, jpg)Confirmation that you actually know the consequence of this action
  • Required: True
  • DefaultValue: false
  • Type: options bool
  • options: bmp (bmp), gif (gif), jpeg (jpeg), png (png), tiff (tiff)
  • Exported: False

Search

Y'know, for search...

  • key: searchExported: False

Invoke Endpoint


  • key: endpoint
  • Required: True
  • Type: string
  • Exported: False
  • key: search_parameters method
  • Required: True
  • DefaultValue: get
  • Type: list:KeyValueStringString options
  • options: GET (get), POST (post), PUT (put), DELETE (delete), HEAD (head), OPTIONS (options), PATCH (patch), MERGE (merge), COPY (copy)
  • Exported: False
  • key: result response
  • 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

    Log

    Logs a message to the logger

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

    Variable set

    Exports a value as a sample

    key: value

    Query JSON


    An export read sample
    • key: json
    • Description: The json to query into
    • Required: True
    • Type: string
    • Exported: False
    • key: export_as json_path
    • Description: The json path to execute as query. The matches items will always be stringified
    • Required: True
    • Type: string
    • Exported: True

    Variable read

    • False
    • key: whatRequired: True 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: string bool
    • Exported: False
    Create Folder Reference

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

    • key: folder_id result
    • Required: TrueDefaultValue
    • Type: 0Typelist: intstring
    • 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)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: result: input_file
    • Description: The name of the input file on disk
    • Required: True
    • Type: foldervalue string
    • 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 moveFalse
    • key: output_file
    • Description: The name of the generated file on disk
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int string
    • Exported: False True
    • key: folder output_format
    • Description: The folder to move the asset intooutput format of the file (png, jpg)
    • Required: True
    • Type: foldervalue options
    • options: bmp (bmp), gif (gif), jpeg (jpeg), png (png), tiff (tiff)
    • Exported: False

    Remove Asset From All ChannelsSearch

    Executes the given search

    • key: excluded_folders search
    • Description: The folder tree(s) to excludeRequired: True
    • Type: string
    • Exported: False
    • key: search_parameters
    • Required: True
    • Type: list:foldervalueKeyValueStringString
    • Exported: False
    • key: asset_item_id
    • Description: The item id of the asset to remove
    • result
    • Required: TrueDefaultValue: @sourceAssetItemId
    • Type: int string
    • Exported: False True

    Remove Delete Asset From FolderRemoves the given asset from a given folder

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

    • key: asset_item_id
    • Description: The ItemId of the asset id to remove from the folderto be soft deleted
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int
    • Exported: False

    Variable set

    Exports a value as a sample

    • key: folder value
    • Description: The folder to remove the asset from
    • Required: Required: True
    • Type: foldervalue string
    • Exported: False
    Remove Asset From Layout Folder Recursive

    • key: folder
    • Description: The folder (and all the children) to remove the asset from
    • export_as
    • Required: True
    • Type: foldervalue string
    • Exported: False True

    Variable read

    An export read sample

    • key: excluded_folders
    • Description: The folder tree(s) to exclude
    • what
    • Required: True
    • Type: list:foldervaluestring
    • 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

    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.

    • key: value
    • Description: Use your variable here, like `@foo: @bar gives me @baz`
    • Required: True
    • DefaultValue: @sourceAssetId
    • Type: int string
    • Exported: False

    Split Folder Reference


    Splits a folder reference into individual parts, so they can be used by themselves
    • key: folder result
    • Description: The Folder reference to splitresult of applying the variables
    • Required: True
    • Type: foldervalue string
    • Exported: Falsekey: folder_id True

    Join Strings

    Joins a list of strings using a specific separator

    • key: strings
    • Description: The resulting id of the folderstrings to join
    • Required: TrueDefaultValue:
    • 0Type: list:string
    • Exported: False
    • key: separator
    • Description: The separator to put between the strirngs
    • Required: False
    • Type: int string
    • Exported: True False
    • key: repository_type result
    • Description: The resulting repository type of the folderstring
    • Required: True
    • DefaultValueType: default string
    • 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" propertyExported: True

    Replace string

    Replace a value in a string with another value

    Uses regex, so you can use the found values

    • key: value
    • Description: The value to replace things in
    • Required: True
    • Type: string
    • Exported: False
    • key: from
    • Description: The thing to find in "value" to replace
    • Required: True
    • Type: regex
    • Exported: False
    • key: to
    • Description: What the found things should be replaced with
    • Required: True
    • Type: string
    • Exported: False
    • key: max_replace_count
    • Description: If all instances of the found thing should be replaced

      -1 to replace all
    • Required: True
    • DefaultValue: -1
    • Type: int
    • Exported: False
    • key: ignore_casing
    • Description: If the casing should be ignored when replacing
    • Required: True
    • DefaultValue: false
    • Type: bool
    • Exported: False
    • key: result
    • Description: The resulting string from running the replacements
    • Required: True
    • Type: string
    • Exported: True

    Split String

    Splits a string according to the specified seperator

    • key: value
    • Description: The string to split
    • Required: True
    • Type: string
    • Exported: False
    • key: separator
    • Description: The separator to split on
    • Required: True
    • Type: string
    • Exported: False
    • key: remove_empty_entries
    • Description: If empty entries should be removed
    • Required: True
    • DefaultValue: true
    • Type: bool
    • Exported: False
    • key: trim_resulting_strings
    • Description: If whitespace around the resulting strings should be trimmed
    • Required: True
    • DefaultValue: false
    • Type: bool
    • Exported: False
    • key: result
    • Description: The resulting strings as a list
    • Required: True
    • Type: list:string
    • Exported: True

    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
    • Type: int
    • Exported: True
    • key: repository_type
    • Description: The resulting repository type of the folder
    • Required: True
    • 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

    Clear metafield


    • key: asset_item_id
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: metafield
    • Required: True
    • Type: metafield
    • Exported: False

    Split Combo Value

    Splits a combo value into its components, optionValue, label and Id

    • key: value
    • Description: The value to split
    • Required: True
    • Type: combovalue
    • Exported: False
    • key: meta_field
    • Description: The meta field the value comes from
    • Required: True
    • Type: metafield
    • Exported: False
    • key: id
    • Description: The id part of the combo value
    • Required: True
    • Type: int
    • Exported: True
    • key: option_value
    • Description: The optionvalue of the combo
    • Required: True
    • Type: string
    • Exported: True
    • key: label
    • Description: The label of the combovalue
    • Required: True
    • Type: string
    • 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
    • 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
    • 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

    Get Current Date

    Gets the current timestamp. Format is compatible with Search2

    • key: offset
    • Description: How much the current time should be offset, specified in seconds (negative values allowed)
    • Required: False
    • DefaultValue: 0
    • Type: int
    • Exported: False
    • key: result
    • Description: The resulting value
    • Required: True
    • Type: datetime
    • Exported: True

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

    Add Asset(s) To Collection

    This action adds new assets to a specific collection.
    The neccessary parameters for performing this action are:
    BasketId
    Assets

    • key: collection_id
    • Required: True
    • DefaultValue: 0
    • Type: int
    • Exported: False
    • key: asset_item_id
    • Description: The list of assets should be their itemIds
    • Required: True
    • Type: list:int
    • Exported: False
    • key: success
    • Required: True
    • DefaultValue: false
    • Type: bool
    • Exported: False

    Create New Collection

    This action creates a new Collection.
    The neccessary parameters for performing this action are:
    BasketName
    Assets

    • key: collection_name
    • Required: True
    • Type: string
    • Exported: False
    • key: asset_item_id
    • Required: True
    • Type: list:int
    • Exported: False
    • key: collection_id
    • Required: True
    • Type: int
    • Exported: True

    Delete an asset from all the collections


    • key: asset_item_id
    • Required: True
    • DefaultValue: 0
    • Type: int
    • Exported: False

    Delete Collection(s)

    This action deletes a given Collection(s).
    The neccessary parameters for performing this action are:
    Basket Ids

    • key: collection_id
    • Required: True
    • Type: list:int
    • Exported: False
    • key: success
    • Required: True
    • DefaultValue: false
    • Type: bool
    • Exported: False

    Share Collection

    This action shares a given Collection with known members.
    The neccessary parameters for performing this action are:
    Basket Id
    Member Ids
    Member Group Ids
    Domain Url

    • key: collection_id
    • Required: True
    • DefaultValue: 0
    • Type: int
    • Exported: False
    • key: member_ids
    • Required: True
    • Type: list:int
    • Exported: False
    • key: member_group_ids
    • Required: True
    • Type: list:int
    • Exported: False
    • key: emails
    • Required: True
    • Type: list:string
    • Exported: False
    • key: email_msg
    • Required: True
    • Type: string
    • Exported: False
    • key: domain_url
    • Description: This parameter is for the website domain. Below is an example of how it should look like\\Example:
      https://mm5.dev.digizuite.com/\\Note the '/' at the end.
    • Required: True
    • Type: string
    • Exported: False
    • key: success
    • Required: True
    • DefaultValue: false
    • Type: bool
    • Exported: False

    Delete Business Workflow Instance


    • key: workflow_instance_id
    • Required: True
    • DefaultValue: @sourceWorkflowInstanceGuid
    • Type: guid
    • Exported: False

    Initiate Business Workflow

    Initiate a new instance of a business workflow

    • key: workflow_name
    • Description: The name of the workflow to initiate
    • Required: True
    • Type: string
    • Exported: False
    • key: item_ids
    • Description: The item ids to initiate the workflow for
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: list:int
    • Exported: False
    • key: owner_member_id
    • Description: The id of the owner of the metafield
    • Required: True
    • DefaultValue: 0
    • Type: int
    • Exported: False


    Available filters

    A list of collections will be deleted.  collectionids list:int

    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

    Is Number Filter

    Checks if some value is an integer

    • key: value
    • Description: That value that should be check if it's an int
    • Required: True
    • Type: string
    • Exported: True False
    • key: id
    • Description: The "id" property
    • negate
    • Required: True False
    • DefaultValue: 0 false
    • Type: intExported: True: bool
    • Exported: False

    Matches Regex Filter

    Checks if some value matches a regular expression

    • key: label value
    • Description: The "label" propertyvalue to check against
    • Required: True
    • Type: string
    • Exported: True

    Set Bit Metafield

    Updates a bit value

    • key: meta_fieldFalse
    • key: regex
    • Description: The regex to check against
    • Required: True
    • Type: metafield regex
    • Exported: False
    • key: new_value ignore_case
    • Description: If the casing of the value should be ignored
    • Required: True
    • DefaultValue: false
    • Type: bool
    • Exported: False
    • key: asset_item_id negate
    • Required: True False
    • DefaultValue: @sourceAssetItemId false
    • Type: int bool
    • Exported: False

    Regex extract value

    Extract values from a string using a Regex (regular expression)

    • key: use_versioned_metadata: value
    • Description: The value to match on
    • Required: True
    • DefaultValue: false
    • Type: bool string
    • Exported: False

    Set ComboValue Metafield

    Updates a ComboValue metafield

    • key: meta_fieldkey: regex
    • Description: The regex to use for matching
    • Required: True
    • Type: metafield regex
    • Exported: False
    • key: new_value matches
    • Required: True
    • Type: combovalue
    • Exported: Falsekey: asset_item_idDescription: The resulting match.

      Do note that the result here is a list.
      The first value is the full match of the regex.
      The following indexes is the matching capture groups of the regex.

      TIP: Use the Get Value At Index step to access the individual groups
    • Required: TrueDefaultValue
    • Type: @sourceAssetItemIdTypelist: intstring
    • Exported: False True
    • key: use_versioned_metadata negate
    • Required: True False
    • 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

    Is Empty or whitespace String

    Checks if the specified string is empty.
    PASSES if the string is empty. FAILS if the string has a value

    Empty is defined by string.isNullOrWhitespace in C#, meaning that whitespace values are also counted as empty

    • key: value
    • Description: The string to check
    • Required: True
    • Type: string
    • Exported: False
    • key: use_versioned_metadata negate
    • Required: True False
    • 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

    Is Empty String

    Checks if the specified string is empty. Whitespace is not counted as empty.

    PASSES if the value is empty, FAILS if not.

    • key: value
    • Description: The string to check
    • Required: True
    • Type: string
    • Exported: False
    • key: use_versioned_metadata negate
    • Required: True False
    • DefaultValue: false
    • Type: bool
    • Exported: False

    Set EditMultiComboValue Metafield

    Updates the value of the edit multi combo value meta field

    key: update_method

    String Contains

    Checks if one string contains the other

    • key: haystack
    • Description: The string to search through
    • Required: TrueDefaultValue: set
    • Type: options
    • options: Set (set), Merge (merge), Unset (unset)
    • string
    • Exported: False
    • key: meta_field: needle
    • Description: The value to search for
    • Required: True
    • Type: metafield string
    • Exported: False
    • key: new_value negate
    • Required: False
    • DefaultValue: True false
    • Type: list:combovalue bool
    • Exported: False

    Is Metafield Empty


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

    Set Float Metafield

    Updates a float metafieldMetadata bit filter

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

    • key: metaasset_item_fieldid
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: metafield int
    • Exported: False
    • key: newmetafield_item_valueid
    • Required: TrueDefaultValue: 0
    • Type: double metafield
    • Exported: False
    • key: asset_itemexpected_idvalue
    • Required: True
    • DefaultValue: @sourceAssetItemId false
    • Type: int bool
    • Exported: False
    • key: use_versioned_metadata negate
    • Required: True False
    • DefaultValue: false
    • Type: bool
    • Exported: False

    Set Int Metafield

    Sets the value of the given int metafield

    key: meta_field

    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: metafield int
    • Exported: False
    • key: newmetafield_item_valueid
    • Required: True
    • DefaultValue: 0
    • Type: int metafield
    • Exported: False
    • key: assetexpected_item_idvalue
    • Required: TrueDefaultValue: @sourceAssetItemId
    • Type: int combovalue
    • Exported: False
    • key: use_versioned_metadata negate
    • Required: True False
    • DefaultValue: false
    • Type: bool
    • Exported: False

    Set Link Metafield

    Updates the value of a link meta field

    key: meta_field

    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: metafield int
    • Exported: False
    • key: new_value reference
    • Required: True
    • Type: string metafield
    • Exported: False
    • key: assetexpected_item_idvalue
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int datetime
    • Exported: False
    • key: use_versioned_metadata negate
    • Required: True False
    • DefaultValue: false
    • Type: bool
    • Exported: False

    Set MultiComboValue Metafield

    Updates the value of a MultiComboValue field

    key: update_method

    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: set @sourceAssetItemId
    • Type: options
    • options: Set (set), Merge (merge), Unset (unset)
    • int
    • Exported: False
    • key: metametafield_item_fieldid
    • Required: True
    • Type: metafield
    • Exported: False
    • key: newexpected_value
    • Required: True
    • Type: list: combovalue
    • Exported: False
    • key: asset_item_id negate
    • Required: True False
    • DefaultValue: @sourceAssetItemId false
    • Type: int bool
    • Exported: False

    Metadata editmulticombo filter

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

    • key: useasset_versioned_metadataid
    • Required: True
    • DefaultValue: false @sourceAssetItemId
    • Type: bool int
    • Exported: False

    Set Note Metafield

    Updates the value of a note meta field

    • key: meta_field reference
    • Required: True
    • Type: metafield
    • Exported: False
    • key: newexpected_value
    • Required: True
    • Type: list: stringcombovalue
    • Exported: False
    • key: assetaction_item_idenum
    • Required: True
    • DefaultValue: @sourceAssetItemId exact
    • Type: int options
    • options: Exact (exact), All (all), Any (any)
    • Exported: False
    • key: use_versioned_metadata: negate
    • Required: True False
    • DefaultValue: false
    • Type: bool
    • Exported: False

    Set String Metafield

    Sets the value of the given string metafield

    key: meta_field

    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: metafield int
    • Exported: False
    • key: newmetafield_item_valueid
    • Required: True
    • Type: string metafield
    • Exported: False
    • key: assetexpected_item_idvalue
    • Required: True
    • DefaultValue: @sourceAssetItemId 0
    • Type: int double
    • Exported: False
    • key: use_versioned_metadata tolerance
    • Required: True
    • DefaultValue: false 0
    • Type: bool double
    • Exported: False

    Set Tree Metafield

    Updates the value of a tree meta field

    • key: update_methodkey: comparison_method
    • Description: How the actual value should be compared with the expected value, e.g., 'actual' LessThan 'expected'
    • Required: True
    • DefaultValue: set equals
    • Type: options
    • options: Set (set), Merge (merge), Unset (unsetEquals (equals), LessThan (lessthan), GreaterThan (greaterthan), LessThanOrEquals (lessthanorequals), GreaterThanOrEquals (greaterthanorequals), NotEqual (notequal)
    • Exported: False
    • key: meta_field negate
    • Required: TrueType: metafieldExported: False
    • key: new_value
    • Required: TrueDefaultValue: false
    • Type: list:treevalue bool
    • Exported: False
    • key: asset_item_id
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int
    • Exported: Falsekey: use_versioned_metadata

    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: false @sourceAssetItemId
    • Type: bool int
    • Exported: False

    Add Member to Group

    Adds a member to the given group

    • key: membermetafield_item_id
    • Description: The id of the member
    • Required: TrueDefaultValue: 0
    • Type: int metafield
    • Exported: False
    • key: groupexpected_id
    • Description: The id of the group
    • value
    • Required: True
    • DefaultValue: 0
    • Type: int
    • Exported: False

    Move Member To Folder

    Moves the member to a specific folder

    • key: membercomparison_item_idDescription: The item id of the member to movemethod
    • Description: How the actual value should be compared with the expected value, e.g., 'actual' LessThan 'expected'
    • Required: True
    • DefaultValue: 0 equals
    • Type: int: options
    • options: Equals (equals), LessThan (lessthan), GreaterThan (greaterthan), LessThanOrEquals (lessthanorequals), GreaterThanOrEquals (greaterthanorequals), NotEqual (notequal)
    • 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 accessornegate
    • 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: 0 @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: targetmetafield_item_id
    • Description: The item id of the target
    • Required: True
    • DefaultValue: 0
    • Type: int metafield
    • Exported: False

    Remove Member From Group


    Removes a given member from a given group
    • key: memberexpected_id
    • Description: The id of the member
    • value
    • Required: TrueDefaultValue: 0
    • Type: int string
    • Exported: False
    • key: group_id
    • Description: The id of the group
    • negate
    • Required: True False
    • DefaultValue: 0 false
    • Type: int bool
    • Exported: False

    Set Access Rights

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

    key: accessor

    Metadata multicombo filter

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

    • key: asset_item_id
    • Description: The id of the member or member group to assign
    • Required: True
    • DefaultValue: 0 @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: targetmetafield_item_idDescription: The item id of the asset to assign rights on
    • Required: True
    • Type: metafield
    • Exported: False
    • key: expected_value
    • Required: TrueDefaultValue
    • Type: 0Typelist: intcombovalue
    • Exported: False
    • key: read_accessDescription: If the member should have read access to the asset action_enum
    • Required: True
    • DefaultValue: false exact
    • Type: bool: options
    • options: Exact (exact), All (all), Any (any)
    • Exported: False
    • key: write_access
    • Description: If the member should have write access to the asset
    • negate
    • Required: True False
    • 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

    Metadata note filter

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

    • key: expected_value
    • Required: True
    • DefaultValue: 0
    • Type: int string
    • Exported: False
    • key: asset_item_id
    • Description: The resulting asset item id
    • Required: True
    • DefaultValue: 0 @sourceAssetItemId
    • 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: intFalse
    • key: reference
    • Required: True
    • Type: metafield
    • Exported: False
    • key: asset_idDescription: Asset resulting asset id case_sensitive
    • 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
    • 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

    Converts the given member item id to a member id
    • key: asset_item_id
    • Required: True
    • DefaultValue: 0 @sourceAssetItemId
    • Type: int
    • Exported: True

    Convert Member Item Id To Member Id

    • False
    • key: membermetafield_item_id
    • Description: The member item id
    • Required: True
    • DefaultValue: 0
    • Type: intRequired: True
    • Type: metafield
    • Exported: False
    • key: expected_value
    • Required: True
    • Type: string
    • Exported: False
    • key: member_idDescription: The resulting member id negate
    • Required: True False
    • DefaultValue: 0 false
    • Type: int bool
    • Exported: True

    Add Items To Collection

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

    • key: collectionFalse

    Metadata tree filter

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

    Create a new collection with the given collection name. 

    The action will export a 'CollectionId' after it has been executed.
    • key: asset_item_id
    • Required: True
    • DefaultValue: 0 @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: item_ids reference
    • Required: True
    • Type: list:int metafield
    • Exported: False

    Create New Collection

    • False
    • key: collectionexpected_namevalue
    • Required: True
    • Type: string list:treevalue
    • Exported: False
    • key: itemaction_idsenum
    • Required: True
    • DefaultValue: exact
    • Type: list:int options
    • options: Exact (exact), All (all), Any (any)
    • Exported: False

    Share Collection

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

    • key: collection_idkey: negate
    • Required: True False
    • DefaultValue: 0 false
    • Type: int bool
    • Exported: False

    Retrieve metadata value for bit metafield

    Gets the value of the specified bit metafield, and makes it available for
    further steps

    • key: emails item_id
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: list:string int
    • Exported: False
    • key: membermeta_idsfield
    • Required: True
    • Type: list:int metafield
    • Exported: False
    • key: member_group_ids value
    • Required: True
    • Type: list:int bool
    • Exported: False True
    • key: shared_item_url negate
    • Required: True False
    • DefaultValue: false
    • Type: string bool
    • Exported: False

    Retrieve metadata value for combo metafield

    Retrieves the value of a combo metafield for use in further steps.

    • key: emailitem_msgid
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: string int
    • Exported: False
    Delete Collection(s)

    • key:
    • meta_
    • field
    • Required: True
    • Type:
    • metafield
    • Exported: False

    ...


    • key: value
    • Required: True
    • Type

    Description

    Parameters

    Asset type filter

    Limits execution to certain asset types

    • key: asset_type: combovalue
    • Exported: True
    • key: negate
    • Required: True False
    • DefaultValue: all false
    • Type: options bool
    • 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: Falsekey: assetExported: False

    Retrieve metadata value for datetime metafield

    Gets the value of the specified datetime metafield, and makes it available for
    further steps

    • key: item_id
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: meta_field
    • Required: True
    • Type: metafield
    • Exported: False
    • key: value
    • Required: True
    • Type: datetime
    • Exported: True
    • key: negate
    • Required: False
    • DefaultValue: false
    • Type: bool
    • Exported: False

    Retrieve metadata value for edit combo metafield

    Retrieves the value of a edit combo metafield for use in further steps.

    • key: item_id
    • Required: True
    • DefaultValue: @sourceAssetId @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: negate meta_field
    • Required: False True
    • DefaultValue: false
    • Type: bool metafield
    • Exported: False
    Forced Result

    Forces a certain outcome from the filter

    • key: result value
    • Required: TrueDefaultValue: false
    • Type: bool combovalue
    • Exported: False True
    • 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_

    Retrieve metadata value for float metafield

    Gets the value of the specified float metafield, and makes it available for
    further steps

    • key: item_id
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: metafieldmeta_item_idfield
    • Required: True
    • Type: metafield
    • Exported: False
    • key: expected_value
    • Required: True
    • DefaultValue: false
    • Type: bool double
    • Exported: False True
    • 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_

    Retrieve metadata value for int metafield

    Gets the value of the specified int metafield, and makes it available for
    further steps

    • key: item_id
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: metafieldmeta_item_idfield
    • Required: True
    • Type: metafield
    • Exported: False
    • key: expected_value
    • Required: True
    • Type: combovalue int
    • Exported: False True
    • 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_

    Retrieve metadata value for link metafield

    Gets the value of the specified link metafield, and makes it available for
    further steps

    • key: item_id
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: reference meta_field
    • Required: True
    • Type: metafield
    • Exported: False
    • key: expected_value
    • Required: True
    • DefaultValue: 1/1/0001 12:00:00 AMkey: value
    • Required: True
    • Type: datetime string
    • Exported: False True
    • 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_

    Retrieve metadata value for MasterItemReference metafield

    Gets the value of the specified master item reference metafield, and makes it available for
    further steps

    • key: item_id
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: metafieldmeta_item_idfield
    • Required: True
    • Type: metafield
    • Exported: False
    • key: expected_value
    • Required: True
    • Type: combovalue list:itemReferenceOptionReference
    • Exported: False True
    • 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

    Retrieve metadata value for multi combo metafield

    Retrieves the value of a multi combo metafield for use in further steps.

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

    Retrieve metadata value for edit multi combo metafield

    Retrieves the value of a edit multi combo metafield for use in further steps.

    • key: negate item_id
    • Required: False True
    • DefaultValue: false @sourceAssetItemId
    • Type: bool int
    • Exported: False
    Metadata float filter

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

    • key: assetmeta_item_idfield
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int metafield
    • Exported: False
    • key: metafield_item_id value
    • Required: True
    • Type: list: metafieldcombovalue
    • Exported: False True
    • key: expected_value negate
    • Required: True False
    • DefaultValue: 0 false
    • Type: double bool
    • Exported: Falsekey: tolerance

    Retrieve metadata value for note metafield

    Gets the value of the specified note metafield, and makes it available for
    further steps

    • key: item_id
    • Required: True
    • DefaultValue: 0 @sourceAssetItemId
    • Type: double int
    • Exported: False
    • key: comparison_methodDescription: How the actual value should be compared with the expected value, e.g., 'actual' LessThan 'expected' meta_field
    • Required: True
    • Type: metafield
    • Exported: False
    • key: value
    • Required: True
    • DefaultValue: equals
    • Type: options
    • options: Equals (equals), LessThan (lessthan), GreaterThan (greaterthan), LessThanOrEquals (lessthanorequals), GreaterThanOrEquals (greaterthanorequals), NotEqual (notequal)
    • Exported: Falsestring
    • Exported: True
    • 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_

    Retrieve metadata value for string metafield

    Gets the value of the specified link metafield, and makes it available for
    further steps

    • key: item_id
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: metafield_item_id
    • Required: True
    • Type: metafield
    • Exported: Falsekey: expected_valuemeta_field
    • Required: True
    • DefaultValue: 0
    • Type: int metafield
    • Exported: False
    • key: comparison_methodDescription: 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: Falsestring
    • Exported: True
    • 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_

    Retrieve metadata value for tree metafield

    Retrieves the value of a tree metafield for use in further steps.

    • key: item_id
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int
    • Exported: False
    • key: metafieldmeta_item_idfield
    • Required: True
    • Type: metafield
    • Exported: False
    • key: expected_value
    • Required: True
    • Type: string list:treevalue
    • Exported: False True
    • 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: Falsekey: metafield_item_id

    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

    DateTime Comparison Filter

    Allows you to compare two distinct dates for different kinds of equality

    • key: value
    • Description: The value you are comparing
    • Required: True
    • Type: metafield datetime
    • Exported: False
    • key: expected_value compare_with
    • Description: The datetime you are comparing with
    • Required: True
    • Type: list:combovalue datetime
    • Exported: False
    • key: action_enum comparison_method
    • Description: How you want to compare the two values
    • Required: True
    • DefaultValue: exact equals
    • Type: options
    • options: Exact (exact), All (all), Any (any: 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 note filter

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

    key: expected_value

    Int Compare filter

    Compares two ints

    • key: value
    • Description: The value to compare
    • Required: True
    • DefaultValue: 0
    • Type: string int
    • Exported: False
    • key: asset_id compare_with
    • Description: The value to compare with
    • Required: True
    • DefaultValue: @sourceAssetItemId 0
    • Type: int
    • Exported: False
    • key: reference comparison_method
    • Required: True
    • Type: metafield
    • Exported: Falsekey: case_sensitiveDescription: How the actual value should be compared with the expected value, e.g., 'Value' LessThan 'CompareWith'
    • Required: True
    • DefaultValue: false equals
    • Type: bool: 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

    Metafield string Is datetime in range filter

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

    key: asset_item_id

    Checks if the specific datetime is in range of min and max

    • key: value
    • Description: The value to check against
    • Required: True
    • DefaultValue: @sourceAssetItemId
    • Type: int datetime
    • Exported: False
    • key: metafield_item_id: min
    • Description: The min value
    • Required: True
    • Type: metafield datetime
    • Exported: False
    • key: expected_max
    • Description: The max value
    • Required: True
    • Type: string datetime
    • Exported: False
    • key: negate min_inclusive
    • Description: True if min should be inclusive
    • Required: False True
    • 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 max_inclusive
    • Description: True if max should be inclusive
    • Required: True
    • DefaultValue: @sourceAssetItemId false
    • Type: int bool
    • Exported: False
    • key: reference negate
    • Required: False
    • DefaultValue: True false
    • Type: metafield bool
    • Exported: Falsekey: expected_value

    Is Int in range

    Checks if the specified int is within a certain range

    • key: value
    • Description: The value to check against
    • Required: True
    • DefaultValue: 0
    • Type: list:treevalue int
    • Exported: False
    • key: action_enum max
    • Description: The max value
    • Required: True
    • DefaultValue: exact 0
    • Type: options
    • options: Exact (exact), All (all), Any (any)
    • int
    • Exported: False
    • key: negate: min
    • Description: The min value
    • Required: False True
    • DefaultValue: false 0
    • Type: bool int
    • Exported: False
    Bool Comparison filter

    Compares 2 arbitrary booleans

    • key: value min_inclusive
    • Description: A value read from somewhereTrue if min should be inclusive
    • Required: True
    • DefaultValue: false
    • Type: bool
    • Exported: False
    • key: expectedmax_valueinclusive
    • Description: The value 'value' is expected to beTrue if max should be inclusive
    • Required: True
    • DefaultValue: false
    • Type: bool
    • Exported: False
    • key: negate
    • Required: False
    • DefaultValue: false
    • Type: bool
    • Exported: False

    ...