|
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 | Executes the given search | - key:
search - Required:
True - Type:
string - Exported:
False
- key:
search_parameters - Required:
True - Type:
list:KeyValueStringString - Exported:
False
- key:
result - Required:
True - Type:
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:
@sourceAssetItemId - 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:
list:string - Exported:
False
|
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 - Type:
string - Exported:
False
- key:
result - Description: The result of applying the variables
- Required:
True - Type:
string - Exported:
True
|
Join Strings | Joins a list of strings using a specific separator | - key:
strings - Description: The strings to join
- Required:
True - Type:
list:string - Exported:
False
- key:
separator - Description: The separator to put between the strirngs
- Required:
False - Type:
string - Exported:
False
- key:
result - Description: The resulting string
- Required:
True - Type:
string - Exported:
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
|
deleted