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 |
|
|
Asset Deleted Trigger | Triggers whenever an asset is deleted | ||
Asset Folder Updated Trigger | Triggers whenever an asset moved between folders |
|
|
Asset Profile Published | Triggers whenever the specified profile for the asset is published | ||
Business Workflow Stage Entered | Triggers when the specified stage in a business workflow is entered, no matter where it came from | ||
Business Workflow Stage Left | Triggered when a stage is left, no matter where the workflow is going afterwards | ||
Business Workflow Transition Passed | Triggered whenever the specific transition is passed | ||
CronScheduleTrigger | Triggers the workflow on a specific schedule |
| |
Derived Asset Created | Triggers when a new derived asset is created | ||
Location State Changed | Triggered whenever a new asset is uploaded |
|
|
ManualTrigger | Used only by admin for manually triggering a lot of runs | ||
Member Created | Whenever a new member is created |
| |
Member Deleted | Whenever an existing member is deleted. Covers both soft and permanent deletes |
|
|
Member Metadata Changed | Whenever the Metadata on a member changes |
|
|
metadata | Triggers only if the metadata update was for the specified field. |
|
|
Performance Test Trigger |
|
| |
Replaced Asset Created | Triggers when a new replaced asset is created | ||
Specific Metadata Value | Triggers when a metadata field changes either to or from the specified value | ||
WebHook Trigger | Allows a workflow to be invoked using http |
Available actions
Type | Description | Parameters |
---|---|---|
Add Floats | Adds two floating point numbers together | |
Add Integers | Adds two integers together | |
Add Items To Collection | A list of assets will be added to the given collection. |
|
Add Member to Group | Adds a member to the given group |
|
Add Member to Roles | Adds a member to the given roles | |
Add Tree Metafield value | ||
Add time to date | Adds the specified number of seconds to the given date, and gives the new date | |
Approve Member | Approves given member | |
Change Text Casing | Changes the casing of some text | |
Calculate aspect ratio | Calculates a nice aspect ratio "16:9" from a height and width | |
Clear metafield | ||
Concat lists | Concats two lists into one larger list | |
Convert Asset Id To Asset Item Id | Converts the given asset id to an asset item id |
|
Convert Asset Item Id To Asset Id | Converts the given asset item id to an asset id |
|
Convert Member Id To Member Item Id | Converts a member id into a member item id |
|
Convert Member Item Id To Member Id | Converts the given member item id to a member id |
|
Create Entity Item | Creates an entity item from the entity type and item | |
Create Folder Reference | Creates a folder reference for use in other steps that requires a folder value reference |
|
Create New Collection | Create a new collection with the given collection name. The action will export a 'CollectionId' after it has been executed. |
|
delay | Delays the execution with the Duration milliseconds |
|
Delete Asset | Soft deletes an asset (that is, keeps the actual file, but sets deleted bit) |
|
Delete Asset Permanently | !DANGER! Permanently deletes an asset (there is NO WAY to recover after this) | ⚠
|
Delete Business Workflow Instance | ||
Delete assets from all collections | ||
Delete Collection(s) | A list of collections will be deleted. |
|
Divide Floats | Divides two floating point numbers | |
Divide Integers | Divides two integers | |
Download Asset Format | Downloads the given asset format to disk for processing |
|
Find assets | Finds all assets that matches the given search parameters | |
Force fail | This step always fails | |
Format String | Just applies the specified variables as specified. You might not need this step, as applying the variables can be done inline when you pass variables to other steps. | |
Get Asset Information | Gets information about the specified asset | |
Get Business Workflow Instances | Gets the business workflows that matches the specified inputs. All inputs are optional. | |
Get Business Workflow task details | Gets details about the specific business workflow task | |
Get Current Date | Gets the current timestamp. Format is compatible with Search2 | |
Get Layout Folders for Assets | Gets the folders the asset is currently in | |
Get Member Information | Gets information about the specified member | |
Get metadata from damapi |
| |
Get Set Differences | Compares two sets and returns the differences | |
Get Value At Index | Gets a value at a certain index in a list of values. Step will fail hard if index is not in array | |
Get absolute float | Gets the absolute value of the provided floating point numbers. | |
Get absolute integer | Gets the absolute value of the provided integer. | |
Get members in group | Gets the members in a specific group | |
Get period between dates | Gets the number of seconds between two dates | |
Initiate Business Workflow | Initiate a new instance of a business workflow | |
Invoke Endpoint |
| |
Item Guid to Item Id conversion | Converts a set of ItemGuids into ItemIds | |
Item id to Item Guid Conversion | Converts a set of ItemIds into ItemGuids | |
Join Strings | Joins a list of strings using a specific separator | |
Log | Logs a message to the logger |
|
lookup value | Looks up a specific value in the specified lookup | |
Move Asset To Folder | Moves an asset into a specific folder |
|
Move Member To Folder | Moves the member to a specific folder |
|
Multiply Floats | Multiplies two floating point numbers | |
Multiply Integers | Multiplies two integers | |
Publish Asset | Triggers a publish for the specified assets | |
Query JSON |
| |
Regex Remove | Removes values from a string based on a regex pattern | |
Remove Asset From All Channels |
| |
Remove Asset From Folder | Removes the given asset from a given folder |
|
Remove Asset From Layout Folder Recursive |
| |
RePublish Asset | Triggers a republish of the specified asset |
|
Remove Access Rights | Removes the access rights for a given target from a given accessor |
|
Remove Member From Group | Removes a given member from a given group |
|
Remove Member from Roles | Removes member from the given roles | |
Rename Business Workflow Instance | Rename a workflow instance | |
Replace string | Replace a value in a string with another value Uses regex, so you can use the found values | |
scale image | Scales an image to the specified height/width and format |
|
Search | Executes the given search |
|
Send email to member | Send email to members | |
Split Combo Value | Splits a combo value into its components, optionValue, label and Id | |
Split Entity Value | Splits an entity item into it's components | |
Split Folder Reference | Splits a folder reference into individual parts, so they can be used by themselves |
|
Split String | Splits a string according to the specified separator | |
Split Tree value | Splits a tree value into its components |
|
Set Bit Metafield | Updates a bit value |
|
Set ComboValue Metafield | Updates a ComboValue metafield |
|
Set Date Metafield | Updates a date field |
|
Set EditComboValue Metafield | Updates the value of an edit combo value meta field |
|
Set EditMultiComboValue Metafield | Updates the value of the edit multi combo value meta field |
|
Set Float Metafield | Updates a float metafield |
|
Set Int Metafield | Sets the value of the given int metafield |
|
Set Link Metafield | Updates the value of a link meta field |
|
Set MasterItemReference Metafield | Updates the value of a MasterItemReference field | |
Set MultiComboValue Metafield | Updates the value of a MultiComboValue field |
|
Set Note Metafield | Updates the value of a note meta field |
|
Set String Metafield | Sets the value of the given string metafield |
|
Set Tree Metafield | Updates the value of a tree meta field |
|
Set Access Rights | Sets the access rights on a specific asset for a specific member |
|
Share Collection | Sharing a collection with a list of members, member groups or per email. |
|
Start Text Extraction | Starts indexing the content of the specified asset. | |
Subtract Floats | Subtracts two floating point numbers | |
Subtract Integers | Subtract two integers | |
Upload asset to FTP | Uploads the specified asset to FTP | |
Variable read | An export read sample |
|
Variable set | Exports a value as a sample |
|
Available filters
Type | Description | Parameters |
---|---|---|
Asset type filter | Limits execution to certain asset types |
|
Bool Comparison filter | Compares 2 arbitrary booleans |
|
DateTime Comparison Filter | Allows you to compare two distinct dates for different kinds of equality | |
Do Member Have Role | Checks if the specified member has the specified role | |
Forced Result | Forces a certain outcome from the filter |
|
Has archived versions | ||
Int Compare filter | Compares two ints | |
Is Array Empty | Checks if the given array is empty | |
Is Asset Soft Deleted | Checks if the specified asset has been soft deleted | |
Is Derived Asset | Checks if the specified asset is a derived asset | |
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. | |
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 | |
Is Int in range | Checks if the specified int is within a certain range | |
Is Member In Group | Checks if the specified member is in the specified group | |
Is Metafield Empty | ||
Is Number Filter | Checks if some value is an integer | |
Is Replaced Asset | Checks if the specified asset is a replaced asset | |
Is datetime in range filter | Checks if the specific datetime is in range of min and max | |
Matches Regex Filter | Checks if some value matches a regular expression | |
Metadata bit filter | Limits the execution if the expected Bit value does not equal the requested Metafield value |
|
Metadata combo filter | Limits the execution if the expected Combo value does not equal the requested Metafield value |
|
Metadata datetime filter | Limits the execution if the expected DateTime value does not equal the requested Metafield value |
|
Metadata editcombo filter | Limits the execution if the expected Edit Combo value does not equal the requested Metafield value |
|
Metadata editmulticombo filter | Limits the execution if the expected Edit Multi Combo value does not equal the requested Metafield value |
|
Metadata float filter | Limits the execution if the expected Float value does not equal the requested Metafield value |
|
metadata int filter | Limits the execution if the expected Int value does not equal the requested Metafield value |
|
Metadata link filter | Limits the execution if the expected Link value does not equal the requested Metafield value |
|
Metadata multicombo filter | Limits the execution if the expected Multi Combo value does not equal the requested Metafield value |
|
Metadata note filter | Limits the execution if the expected Note value does not equal the requested Metafield value |
|
Metafield string filter | Limits the execution if the expected String value does not equal the requested Metafield value |
|
Metadata tree filter | Limits the execution if the expected Tree value does not equal the requested Metafield value |
|
Regex extract single value | Extract single value from a string using a Regex (regular expression) | |
Regex extract value | Extract values from a string using a Regex (regular expression) | |
Retrieve metadata value for MasterItemReference metafield | Gets the value of the specified master item reference metafield, and makes it available for further steps | |
Retrieve metadata value for bit metafield | Gets the value of the specified bit metafield, and makes it available for further steps | |
Retrieve metadata value for combo metafield | Retrieves the value of a combo metafield for use in further steps. | |
Retrieve metadata value for datetime metafield | Gets the value of the specified datetime metafield, and makes it available for further steps | |
Retrieve metadata value for edit combo metafield | Retrieves the value of a edit combo metafield for use in further steps. | |
Retrieve metadata value for edit multi combo metafield | Retrieves the value of a edit multi combo metafield for use in further steps. | |
Retrieve metadata value for float metafield | Gets the value of the specified float metafield, and makes it available for further steps | |
Retrieve metadata value for int metafield | Gets the value of the specified int metafield, and makes it available for further steps | |
Retrieve metadata value for link metafield | Gets the value of the specified link metafield, and makes it available for further steps | |
Retrieve metadata value for multi combo metafield | Retrieves the value of a multi combo metafield for use in further steps. | |
Retrieve metadata value for note metafield | Gets the value of the specified note metafield, and makes it available for further steps | |
Retrieve metadata value for string metafield | Gets the value of the specified link metafield, and makes it available for further steps | |
Retrieve metadata value for tree metafield | Retrieves the value of a tree metafield for use in further steps. | |
String Contains | Checks if one string contains the other | |
Upload Computer Filter | Checks if the asset was from the specified upload computer | |
Upload Member Filter | Checks if the asset was uploaded by the specified member |
Other steps
Type | Description | Parameters |
---|---|---|
ForEach | For each value in a set of values, execute a set of steps |