Introduction
Automation workflows allow administrators to make the Digizuite™ DAM Center do things automatically - triggered as other things happen in the system.
Automation workflows replace the existing ItemWatcher workflows (And anything else that depends on digimonitor).
To interact with an automation workflow, a Media Manager with at least version 5.2.0 is required.
Workflow construction
Automation workflows are built with "steps". A step can be either an "action", a "trigger", a "filter", or a "foreach loop".
Triggers
A workflow is always 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.
Actions
To actually do something your workflow needs actions. Actions all do one single thing, such as: updating a metadata field, or, triggering an asset publish event.
Filters
To prevent the workflow from firing all actions without any logic, a filter must be used.
Filters check that a condition in the Digizuite is met, e.g. that the asset type of an asset is an image, or that a member has a certain role.
If the condition is not met, the subsequent filters and action below it will not be executed.
Foreach loops
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. (This is very similar to how foreach loops are in other programming languages)
Creating a new workflow
First of all, you need the proper roles to be able to access the workflow menu point
To create a new workflow, please do the following:
- Press "Workflow management" in upper-middle of the page
- Next click on "Workflows"
3. Select "Add new" (Or, for more advanced users, you may choose "Add existing")
4. A menu will open to the left.
5. In this menu, press "insert" on the type of trigger you want.
What each trigger does 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 is shown.
If you selected "Add new" - only the trigger you chose will be shown.
If you selected "Add existing", the workflow you inserted will, of course, be shown instead.
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 onto this placeholder, and let go.
When you let go, a pane will open on the left, where the step to insert must be selected. You can pick all step types than triggers.
The step should now be inserted where the placeholder was.
For the step to be valid, you need to fill out the step's parameters.
This is done by pressing the "more" button on the step - and selecting "edit".
A dialog will now open to the right.
In this dialog fill out the parameters, and select "apply" when done.
Workflow text syntax
Behind the flowchart-like UI, code is being generated by the actions you perform with the steps.
This code can be accessed by going pressing the "Text mode" button:
The code could, for example, look like the following:
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", or "foreach", and then followed by a name in quotes. This name must be unique in the workflow: trigger "Asset Uploaded"
The parameters for each step are saved in between the curly brackets: {}
Each parameter is identified by a key, an equal (=) sign, and then the value in quotes: upload_computer = "Digizuite Media Manager profile"
It is possible to have a set of values (aka. lists, arrays), by putting the values inside square brackets "[ ]", as seen from the "resolves" parameter: resolves = ["Move to User Profile Images", "Move to channel user profile folder"]
A more formal version of the format can be seen in the following railroad diagram:
Most of the parameters for each step are dynamically generated. However, 3 parameters almost always appear (depending on the keyword used for the step).
"type" is required on all steps. It refers to the action or filter that should be run. In the example above "Asset Created Trigger" is the type, which means that it will trigger when an asset is created. 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. It refers to steps that should be executed before the step with the "needs"; thus creating a chain of dependencies (This must run before that).
Foreach loops
Foreach loops are a bit special since they allow for the repeated execution of a set (chain) of steps within a workflow. To implement a foreach loop, you have to specify 5 parameters (The can, of course, be done from the visual, flowchart-like, UI):
- "type", which should be set to "ForEach".
- "resolves", which should be the last step in the chain of steps to execute.
- "needs", which specifies all steps that must have run before entering the foreach loop.
- "variable", which specifies which variable to iterate over. This accepts both one ("test 1") and many values (["test 1", "test 2", "test 3"])
- "as", specifies what "variable" should be available as, in each iteration of the foreach loop. I.e. the current variable in the list to interact with.
Variables
Workflows use variables in order to pass data between different steps. Variables are identified by starting with an at-sign (@), for example, "@sourceAssetItemId".
Triggers usually emit some variables, such as; the asset that triggered the workflow.
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 run the workflow.
Some actions have "exported" variables. This means that rather than reading a variable before it executes, it sets the variable after it has executed.
Tips and tricks
AND operator
"filter" steps below each other.
If two or more metadata fields are required before a given step should execute, you should position the filters below each other (i.e. make the workflow linear rather than branching).
OR operator
"filter" steps beside each other.
If you have multiple fields, but only one of them is required, you should position the filters beside each other.
Available steps
This documentation is auto-generated from the source, hence it's very unlikely to contain mistakes.
Some additional manual documentation might be provided below.
Available triggers
Type | Description | Exported Variables | Parameters |
---|
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 |
| | - 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 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
|