!!! warning "Legacy Documentation" This page contains documentation for the original RoboFlow application. Some features described here may not exist in the new Damtoolkit WAP interface.

Actions

Introduction

Action syntax

Actions are executed one after the other, so the result of an action
is stored in variable (formerly called TAG) and can be used for the next action.
The result field is called 'Output variable'

Output variable: in this field you specify the variable-name of the result of this action

Variable of ... to process: any variable-name for a result of this type that you specified in a previous action, can be used in this field.
If the result was created in this action-script, it will appear in the dropdown-list.
If it was created in another script, e.g. Parameters of the workflow, it will not appear in the list, but you can type it.

NOTE: Workflows also create variables on the fly. They are usually called 'hot'.
A hotfolder workflow will store the current file to process under the variable name 'hot', so you can use it in your actions.

NOTE: In the dropdown of a 'Variable of ... to process' there might be a variable name that is created by an action later in the script. Don't use it!

Inline scripting

Over time an inline scripting language (also called placeholders) was developed within RoboFlow, similar to formula fields. These inline scripts can still be used, but due to the flexibility of the actions they might become obsolete in the future.

There is however 1 inline-script-instruction that you might still need.

TAG(variable-name)TAG

This instruction allows you to call the result stored under that variable-name.
This is very useful when using stored text. e.g a filename

Help is available under the help-button. If another help-chapter appears,
you can select 'scripting-help' in the dropdown at the bottom of the window

NOTE: If you used the inline scripting language in previous versions, you might have seen a different syntax: $TAG(..)TAG$ or $TAG(...)$
In actions all inline script instructions should start and end with # NOT with $

Field types

In the action-setup there are 3 types of input fields

• Normal input field: in these fields you can type in any text

• Dropdown input field: in these fields you can type in any text or select from the dropdown

• Input field with a select-button: in these fields you can type in any text.
Clicking on the button will open a new window that will in most cases allow
you to select a value or perform a test e.g. perform a query

NOTE: Values set to the input fields will only be saved after clicking on 'OK'.

NOTE: 'Cancel' will close the action-window unsaved

Conditional Actions

Test Boolean OR AND

This action is an if-test. If performs and AND/OR instruction between 2 stored Boolean values
This action can have child-actions which are only executed if the result was 'true'.

Variable of boolean to process: select the variable of the stored object

Variable of boolean for OR operation: select the variable of the stored object

Variable of boolean for AND operation: select the variable of the stored object

Output variable: name of variable under which to store Boolean result

NOTE: A Boolean has a 'true' or 'false' value

Test ELSE

This action is an if-test. It tests a stored Boolean for value 'false'.
This action is very often the counterpart of an IF-test to perform some actions is result was 'false'.
This action can have child-actions which are only executed if the result was 'false'.

Variable of Boolean to process: select the variable of the stored Boolean

NOTE: A Boolean has a 'true' or 'false' value

Test File

This action is an if-test. It performs its test on a stored file-object
This action can have child-actions which are only executed if the result was 'true'.

Output variable to process: select the variable of the stored object

Type of test:
- file-available

file-exists
file-starts-with
file-ends-with
file-name-contains
folder-starts-with
folder-ends-with
folder-name-contains
folder-name-equals
folder-path-contains
file-text-contains
rootfolder-starts-with
rootfolder-ends-with
rootfolder-name-contains
rootfolder-name-equals

Output variable: name of variable under which to store Boolean result

NOTE: A Boolean has a 'true' or 'false' value

Test Folder

This action is an if-test. It can perform several type of tests on a stored folder.
This action can have child-actions which are only executed if the result was 'true'.

Variable of folder to process: select the variable of the stored folder

Type of test: set the type of test to perform:
- folder exists
- folder name starts with
- folder name ends with
- folder name contains
- subfolder (= parent folder) name starts with
- subfolder (= parent folder) name ends with
- subfolder (= parent folder) name contains
- subfolder (= parent folder) name equals
- subfolder (= parent folder) path contains
- root folder name starts with
- root folder name ends with
- root folder name contains
- root folder name equals

Output variable: name of variable under which to store Boolean result

Test Record

This action is an if-test. It can perform several type of tests on a stored Cumulus record.
This action can have child-actions which are only executed if the result was 'true'.

Variable of record to process: select the variable of the stored Cumulus record

Type of test: set the type of test to perform:
- record-is-available
- asset-is-versioned
- asset-is-accessible-as-file
- asset-is-available
- asset-is-vaulted
- asset-is-subasset
- asset-is-checked-out
- record-is-master
- record-is-slave

Output variable: name of variable under which to store Boolean result

NOTE: A Boolean has a 'true' or 'false' value

Test Category

This action is an if-test. It can perform several type of tests on a stored Cumulus Category.
This action can have child-actions which are only executed if the result was 'true'.

Variable of category to process: select the variable of the stored Cumulus category

Type of test: set the type of test to perform:
- category-is-available

category-is-root-category
category-has-sub-categories
category-is-master-category
category-has-parent-category
category-is-normal-category
category-is-related-category
category-has-normal-parent-category
category-has-directory-parent-category
category-has-records-attached
category-has-root-parent-category

Output variable: name of variable under which to store Boolean result

NOTE: A Boolean has a 'true' or 'false' value

Test Catalog

This action is an if-test. It can perform several type of tests on a stored Cumulus Catalog.
This action can have child-actions which are only executed if the result was 'true'.

Variable of catalog to process: select the variable of the stored Cumulus Catalog

Type of test: set the type of test to perform:
- server-is-available

catalog-is-available
catalog-has-records
catalog-has-records-to-process
catalog-has-category-field
catalog-has-record-field

Output variable: name of variable under which to store Boolean result

NOTE: A Boolean has a 'true' or 'false' value

Test result exists

This action is an if-test. It tests if a stored object (from Output Variable of Action) exists.
This action can have child-actions which are only executed if the result was 'true'.

Output variable to process: select the variable of the stored object

Type of result: depending on the action that stored this output variable, the variable has a type:
- result-without-a-tag (this option rarely occurs)
- Boolean
- file
- folder
- text = string
- SQL-Database
- Cumulus Catalog (=record item collection)
- Cumulus record
- Cumulus category
- Cumulus table field (item collection)
- Cumulus table field record (= item )
- table-row (= vector)
- table (= hashtable)
- error (opject type stored if action ran into an error)

Output variable: name of variable under which to store Boolean result

NOTE: A Boolean has a 'true' or 'false' value

Test text

This action is an if-test. It can perform several types of tests on a stored text.
This action can have child-actions which are only executed if the result was 'true'.

Variable of text to process: select the variable of the stored text

Type of test: set the type of test to perform:
- text starts with
- text (ignore case) starts with
- text ends with
- text (ignore case) ends with
- text contains
- text (ignore case) contains
- text equals
- text (ignore case) equals
- regular expression
- greater (= text compare > 0)
- not greater (= text compare <= 0)
- smaller (= text compare < 0)
- not smaller (= text compare >= 0)

Text to test with: set the text to perform the test with

Output variable: name of variable under which to store Boolean result

NOTE: A Boolean has a 'true' or 'false' value

NOTE: ignore case = discard upper case and lower case differences

Test workflow progress

This action is an if-test. This action returns 'true' depending on the workflow-progress state.
In some cases the workflow only needs to perform an action on the first or last run of this workflow-script.
e.g. open catalog only needs to be executed on first-item-of-loop while close catalog only on last-item-of-loop
This action can have child-actions which are only executed if the result was 'true'.

Workflow-Progress: set the type of workflow-progress:
- First Loop = when workflow is run for the first time (= once when on time interval or = every time called when on demand -2)
- First Item Of Loop (= e.g. on first file to process in that loop)
- Last Item Of Loop (= e.g. on last file to process in that loop)

Output variable: name of variable under which to store Boolean result

NOTE: A Boolean has a 'true' or 'false' value

NOTE: ignore case = disgard upper case and lower case differences

Cumulus Catalog Actions

NOTE: Cataloging/Importing a file in Cumulus Catalog can be done in several ways. The best and safest way is using the catalog-file action. As a result it will return the record that was created and the next actions can work with this record. You can speed up this import-process by fine-tuning the Asset Handling Set. The lesser filters and asset stores that are enabled the faster it will be. You can setup multiple workflows that ingest files. Creating simultaneous cataloging processes. Always monitor and test if your server can take the heavy duty that comes will simultaneous ingestion. You will also notice that there is a breaking point where more simultaneously ingestion workflows will make the average ingestion time go down instead of up. Roboflow has other actions that do the multithreaded cataloguing inside the same worklow. These actions (open-catalog-process, add-file-to-catalog-process, process-files-of-catalog-process, process-records-of-catalog-process, close-catalog-process, create-catalog-batch, catalog-file-batch, process-files-of-catalog-batch, process-records-of-catalog-batch) are not explained blow because they are only to be used under supervision of a Roboflow specialist, because by multithreaded cataloging inside one workflow, you lose control over the individual ingestion process and thus ingestion-errors are harder to handle and can have bigger impact …

Add record to collection

This action adds a stored record to a stored Cumulus Catalog Collection.
Make sure first to open a catalog (and close add the end), thus creating a catalog collection you can add records to.

Variable of record to process: select the variable of the stored Cumulus record

Variable of catalog to use: select the variable of the stored catalog

Type of Action:
- add-record
- add-record-as-only-record-of-collection

NOTE: This action is used in conjunction with save (pin) collection. So open a catalog (of the same catalog that the records comes from), add the (hot)record (e.g. from a hotcollection) with this action, save the (pin) collection and close the catalog

Catalog file

This action catalogs (= imports) a stored file in Cumulus Catalog.
The behavior of the process it determined by the Asset Handling Set and Permission Template.

Variable of file to process: select the variable of the stored file

Variable of catalog to use: select the variable of the stored catalog

Asset Handling Set: select Cumulus Asset Handling Set, required for this process

Permission Template: select Cumulus Permission Template,
if Cumulus version has Permission Templates

Output variable: name of variable under which to store new record

NOTE: – Should the cataloging process case multiple records to be created, only the first (main) records is stored.
– Permission Template are available in Cumulus Enterprise or with Roles and Permissions option

Backup catalog

This action creates a backup-file of the Cumulus catalog. In the folder path the full path including backup-file-name must be specified.

Cumulus-Catalog Name: name of Cumulus Catalog

Folder Path: path of folder including the target file name of the backup file

Output variable: name of variable under which to store the result (string). If backup was successful, the result is an empty string. If backup failed the result will contain the error message.

Compress catalog

This action will compress the Cumulus catalog. This should not be executed while the catalog is being used.

Cumulus-Catalog Name: name of Cumulus Catalog

Output variable: name of variable under which to store the result (string). If compress was successful, the result is an empty string. If compress failed the result will contain the error message.

Create field in Catalog

This action creates a field (if it not already exists in the catalog). It can be a record, category or table field.

Variable of catalog to use: select the variable of the stored catalog

Field Options: Editable and/or Sortable and/or Searchable

Field Content: Integer, Audio, Binary, Picture, Boolean, Date, Double, StringList, …

Field Type: Record field, Category field, Record-Table field or Category Table field

Field Name: afieldname or {guid}:afieldname. In case of a table field tablefieldname/afieldname or tablefieldname/{guid}:afieldname. If table field does not exist, it will be create too.

Output variable: name of variable under which to store the result (string). If successful, the result is the GUID of the(new) field.

Close Catalog

This action closes a stored Cumulus catalog.

Variable of catalog to use: select the variable of the stored catalog

Create PDF with Print Template

This action creates a pdf using a predefined print-template.
The records are specified in a comma separated stored text.

Variable of catalog to use:

Cumulus Print Set: select Cumulus Print Template Set, required for this process

Variable of record IDs: select the variable of the stored text of id's separated by ;

Variable of target file path: select variable of stored text under which the complete file path of the target file for this process is stored

Output variable: name of variable under which to store new pdf-file

Delete collection

This action deletes a Cumulus collection.

Login of User: to be able to delete the collection, it either has to be a shared one that can be accessed by the user running Roboflow (always best to use the Cumulus administrator) in which case you can leave this parameter empty or if it is not accessible by the roboflow-user, here is the place to specify the login of the user who is allowed to access and delete this collection.

Name of Collection: the exact name of the collection to delete

Output variable: name of variable under which to store the result (string). If successful, the result will contain delete=ok. In case of an error, it will contain the error-message

Find records by file

This action searches for a record in a stored catalog using a file.

Variable of catalog to use: select the variable of the stored catalog

Variable of-file: select the variable of the stored file

Output variable: name of variable under which to store the count of the records found

NOTE: Use action: process-record-in-collection to process the records from this query

Find records

This action performs a Cumulus record query on a stored catalog.

Variable of catalog to use: select the variable of the stored catalog

Cumulus Record Query: name of Cumulus stored query or query in Advanced Find Window from Cumulus Client syntax

Output variable: name of variable under which to store the count of the records found

Open Catalog

This action opens a Cumulus Catalog.

Catalog name: select the catalog to open

Output variable: name of variable under which to store the catalog

NOTE: Make sure first to set up the global parameters, to be able to connect to Cumulus.

Process records in collection

This action performs the sub-actions for every record in a stored catalog (collection).
Usually a 'Find Query' action is performed before this action.

Variable of catalog to use: select the variable of the stored catalog

Output variable: name of variable under which to store every record before executing the child-actions.

Process collections

This action performs the child-actions for every collectionof the user specified or of the roboflow-user if no user is specified. Both private, shared and shared restricted. The output variable is the name of the variable under which the collection name is stored as a string. It will under the same tag store the properties in an xml table (hashtable) which can be queried with table-actions.

Login of User: to be able to access the collection, it either has to be a shared one that can be accessed by the user running Roboflow (always best to use the Cumulus administrator) in which case you can leave this parameter empty or if it is not accessible by the roboflow-user, here is the place to specify the login of the user who is allowed to access this collection.

Output variable: name of variable under which to store each collection name as a string before executing the child-actions.

Process related records

This action performs the child-actions for every collection of the user (shared and private).
If no login of user is specified, the user that runs Roboflow (usually Cumulus Administrator) is used.

Variable of record to process: select the variable of the stored Cumulus record

Cumulus Record Filter: type in GUID of record-relation! NOT Filter

Output variable: name of variable under which to store every record before executing the child-actions.

Read preference parameter

This action can read (and write) a Cumulus Preference Parameter.

Type of Action: select type of action:
- read
- read, save (=write) preference and add 1 to result if number
- read, add 1 to result if number and save (= write) preferences

Type of value: the preference-value can be stored in different formats: string, integer, long, Date

ID of Preference: specify the ID of the preference. e.g. com.mycompany.mykey .

Key of Parameter of Preference: a Preference is stored in a 'Pack'
Each parameter in such a pack is stored with a key e.g. 'abcd' .

Default Value: if the read is unsuccessful, this default value will be return (and optionally saved in the Preferences).

Output variable: name of variable under which to store the value of the parameter.

NOTE: More info on Preference-packs can be found in Cumulus Java SDK documentation.

Rebuild Catalog

This action rebuilds a Cumulus Catalog. Make sure that this is executed when nobody else is accessing it. After the rebuild, Roboflow-service or daemon should be restarted before using the catalog again.

Cumulus Catalog Name: name of Cumulus Catalog

Output variable: name of variable under which to store the result (string). If rebuild was successful, the result is an empty string. If rebuild failed the result will contain the error message.

Remove record from collection

This action removes (not delete) a stored record from a stored Cumulus Catalog Collection.

Variable of record to process: select the variable of the stored Cumulus record

Variable of catalog to use: select the variable of the stored catalog

NOTE: This action is used in conjunction with save (pin) collection. See Add record to collection.

Save collection from catalog

This action saves the current records from a catalog as a shared Cumulus collection.

Name of Collection: Unique name for the collection (a number will be added if not unique)

Variable of catalog to use: select the variable of the stored catalog

Type of Collection:
- normal
- basket
- upload

Records for collection: if empty, the records of the catalog collection specified above are used. Otherwise specify the records like this: catalog-id_record-id, catalog-id_record-id, etc...

Output variable: name of variable under which to store the unique id as text for this collection.

NOTE: This action is used in conjunction with add-record-to-collection. See Add record to collection.

Save pincollection from catalog

This action saves the current records from a catalog as a shared Cumulus pincollection (used in Sites/Portals).

Name of Collection: Unique name for the collection (a number will be added if not unique)

Variable of catalog to use: select the variable of the stored catalog

Permissions: these are the permissions of the pin-collection in Sites. Remove what is not wanted
default value: info-window;preview;download;print

New since 11.0.3: to=[email] e.g. info-window;download;to=peter@camto.com REMARK: this will not send the mail, just store the email in the pincollection custom data

New since 11.0.3: expires=[mili-secs since 1970 ] e.g. info-window;download;expires=#DATEFORMAT(mili;+14;DAY)#

New since 11.0.3: password=[a password] e.g. info-window;download;password=mypassw

New since 11.0.3: update=[UID] e.g. info-window;download;password=mypassw;update={1c2e9353-f23e-4842-b9e0-f8aee4d14bac} REMARK: this will force updating of existing pincollection instead of creating a new one.

Records for collection: if empty, the records of the catalog collection specified above are used. Otherwise specify the records like this: catalog-id_record-id, catalog-id_record-id, etc...

Output variable: name of variable under which to store the unique id as text for this collection.
This unique id can be used in e-mail with url for Portals, Sites or Cumulus Web Client:
Sites and Portals: http://www.mycompanydomein.xyz/sites/pincollection.jspx?collectionName={1c2e9353-f23e-4842-b9e0-f8aee4d14bac}
CWC: http://www/mycompanydomain.xyz/cwc/catalog/Sample+Catalog/collection/view/collectionName={1c2e9353-f23e-4842-b9e0-f8aee4d14bac}/tabActive=tab-collection-content

NOTE: This action is used in conjunction with add-record-to-collection. See Add record to collection.

Save preference parameter

This action can write a Cumulus Preference Parameter.

Value-To-Store: text value to store in the preference parameter.

Type of value: the preference-value can be stored in different formats: string, integer, long, Date

ID of Preference: specify the ID of the preference. e.g. com.mycompany.mykey .

Key of Parameter of Preference: a Preference is stored in a 'Pack'
Each parameter in such a pack is stored with a key e.g. 'abcd' .

NOTE: More info on Preference-packs can be found in Cumulus Java SDK documentation.

Set collection property value

This action sets a property of a Cumulus collection.

Login of User: to be able to access the collection, it either has to be a shared one that can be accessed by the user running Roboflow (always best to use the Cumulus administrator) in which case you can leave this parameter empty or if it is not accessible by the roboflow-user, here is the place to specify the login of the user who is allowed to access this collection.

Name of Collection: Unique name for the collection (a number will be added if not unique)

Property to set: display name, description, modification date, user-restriction, clear restriction, custom data

Value to set: value to set

Output variable: name of variable under which to store the result (string). If successful, it repeats the property and end it with =ok

Cumulus Category Actions

Add category to record

This action adds a stored Cumulus Category to a stored Cumulus record

Variable of category to process: select the variable of the stored Cumulus category

Variable of record to process: select the variable of the stored Cumulus record

Apply Permission Template to Category

This action applies aPermission Template to a stored Cumulus Category

Variable of category to process: select the variable of the stored Cumulus category

Permission Template: select Cumulus Permission Template,
if Cumulus version has Permission Templates

NOTE: Can only be used if Preferences Module is licensed on the CumulusC Server.

Delete category

This action deletes a stored Cumulus Category from a stored Cumulus Catalog

Variable of catalog to use: select the variable of the stored catalog

Variable of category to process: select the variable of the stored Cumulus category

Process categories from record

This action performs child-actions for every category attached to a stored Cumulus record

Variable of record to process: select the variable of the stored Cumulus record

Category path starts with: optionally specify a filter for which categories to process. e.g. $Categories

Output variable: name of variable under which to store every category before executing the child-actions.

Process categories from collection (catalog)

This action performs child-actions for every category in a (catalog)-collection

Variable of catalog to process: select the variable of the stored Cumulus Catalog

Category query: optionally specify a category-query to find the categories to process. Syntax of the query is same as record-query and can be found the Cumulus Client in the Find window under advanced.

Output variable: name of variable under which to store every category before executing the child-actions.

Process records from categories

This action performs child-actions for every record attached to a stored Cumulus category

Variable of catalog to use: select the variable of the stored catalog

Variable of category to process: select the variable of the stored Cumulus category

Output variable: name of variable under which to store every record before executing the child-actions.

Process sub-categories from category

This action performs child-actions for every sub-category attached to a stored Cumulus category

Variable of category to process: select the variable of the stored Cumulus category

Output variable: name of variable under which to store every sub-category before executing the child-actions.

Remove category from record

This action removes a stored Cumulus Category from a stored Cumulus record

Variable of category to process: select the variable of the stored Cumulus category

Variable of record to process: select the variable of the stored Cumulus record

Set Category field value

This action sets a field value of a stored Cumulus category

Variable of category to process: select the variable of the stored Cumulus category

Category Field: select Cumulus category field

Category field value: value to set

Store Category field value as text

This action sets a field value of a stored Cumulus category

Variable of category to process: select the variable of the stored Cumulus category

Category Field: select Cumulus category field. “path” can be used as field name to get the category-path

Output variable: name of variable under which to store the Category field value as text.

Store Category from path

This action stores the category from the category-path.
Optionally the category can be created.

Variable of catalog to use: select the variable of the stored catalog

Path of category to process: complete path of category separated by / e.g. $Categories/mycat/mysubcat

Type of Action: select type of action: Fail if category is missing or create category if missing

Output variable: name of variable under which to store the category.

Store Category from id

This action stores the category from its ID.

Variable of catalog to use: select the variable of the stored catalog

ID of category: ID of Category. e.g. 255

Output variable: name of variable under which to store the category if found.

Store category path as text

This action stored the path of a stored Cumulus category as text

Variable of category to process: select the variable of the stored Cumulus category

Output variable: name of variable under which to store the category path as text.

Store parent Category

This action stores the parent category from a stored Cumulus category-path.

Variable of catalog to use: select the variable of the stored catalog

Variable of category to process: select the variable of the stored Cumulus category

Update Formula Field of Category

This action updates the field using its predefined formula.

Variable of category to process: select the variable of the stored Cumulus category

Category field: specify the field name or UID

Update Modification Date: select ‘yes’ if you want the Category Modification Date updated. Select ‘no’ if not.

Cumulus File Actions

Check-in File

This action checks in a stored file into a stored record

Variable of record to process: select the variable of the stored Cumulus record

Variable of file to process: select the variable of the stored file

Asset Handling Set: select Cumulus Asset Handling Set.

Check-in comment: Optionally specify the comment to add to the check-in process

Check-out File

This action checks out the asset of a stored record to a stored folder

Variable of record to process: select the variable of the stored Cumulus record

Variable of folder to process: select the variable of the target stored folder

Asset Handling Set: select Cumulus Asset Handling Set.

Output variable: name of variable under which to store the checked out file.

Convert Asset from record (perform a Cumulus Action)

This action will perform an Cumulus Action. The resulting file is store in a predefined stored folder

Variable of record to process: select the variable of the stored Cumulus record

Cumulus Action: specify or select the name of the Cumulus Action to execute

Variable of folder to process: select the variable of the target stored folder

Asset Handling Set: select Cumulus Asset Handling Set.

Target file name: Optionally specify the target file name

Output variable: name of variable under which to store the converted file.

Copy Asset from record

This action will perform a copy of the asset of the record to a predefined stored folder

Variable of record to process: select the variable of the stored Cumulus record

Variable of folder to process: select the variable of the target stored folder

Asset Handling Set: select Cumulus Asset Handling Set.

Target file name: Optionally specify the target file name

Output variable: name of variable under which to store the copied file.

Copy Asset from record to Vault

This action will perform a copy of the asset of the record to a predefined stored folder

Variable of record to process: select the variable of the stored Cumulus record

Variable of folder to process: select the variable of the target stored folder

Asset Handling Set: select Cumulus Asset Handling Set.

Target file name: Optionally specify the target file name

Output variable: name of variable under which to store the copied file.

Move Asset from record

This action will perform a move of the asset of the record to a predefined stored folder (not Vault)

Variable of record to process: select the variable of the stored Cumulus record

Variable of folder to process: select the variable of the target stored folder

Asset Handling Set: select Cumulus Asset Handling Set.

Move Asset from record to vault

This action will perform a move of the asset (stored in a folder) of the record to the Central Asset Location for the catalog (e.g. Vault, but can also be other CAL like Amazon S3)

Variable of record to process: select the variable of the stored Cumulus record

Vault Folder Name: this parameter should be left empty unless CAL requires setting of target folder

Asset Handling Set: select Cumulus Asset Handling Set.

Process Vault asset version

This action will perform an action on the version of asset(s) and will store the text-info as text (string)

(no child-instructions)

Variable of record to process: select the variable of the stored Cumulus record

Type of Action: select the variable of the target stored folder

store-number-of-asset-versions
store-asset-version-numbers
store-all-asset-versions-info
store-oldest-version-all-info
store-most-recent-version-all-info
delete-all-but-most-recent-asset-version
delete-most-recent-version
delete-all-except-first-and-last-version
delete-asset-version-if-older-then-1-month
delete-asset-version-if-older-then-3-months
delete-asset-version-if-older-then-6-months
delete-asset-version-if-older-then-1-year
delete-asset-version-if-older-then-2-years
delete-asset-version-if-older-then-3-years

Asset Handling Set: select Cumulus Asset Handling Set.

Output variable: name of variable under which text - info is stored.

Rename Asset from record

This action will rename the asset of the record

Variable of record to process: select the variable of the stored Cumulus record

New File Name: Name to rename the asset to

Set Asset Reference

This action assigns a file as asset to a record

Variable of record to process: select the variable of the stored Cumulus record

Variable of file to process: select the variable of the stored file

Asset Handling Set: select Cumulus Asset Handling Set.

Permission Template: select Cumulus Asset Handling Set.

Update record after Assignment: Update meta-data or not

Set Asset Reference Field Name

This action sets the name of the Asset Reference field for this record. By default this is “Asset Reference” but a records could have a second or even third Asset Reference field pointing to other assets. In which case by changing the Asset Reference field name, Cumulus actions (and copy-asset) get access to the other assets.

Variable of record to process: select the variable of the stored Cumulus record

Field Name: Name of Asset Reference field

Set Asset Reference Value

This action sets the (current) Asset Reference field to a stored Asset Reference field value

Variable of record to process: select the variable of the stored Cumulus record

Variable of Asset Reference Value to process: select the variable of the stored Asset Reference Value

Asset Handling Set: select Cumulus Asset Handling Set.

Permission Template: select Cumulus Asset Handling Set.

Store Asset Reference Value

This action stores the value of the (current) Asset Reference field

Variable of record to process: select the variable of the stored Cumulus record

Output variable: name of variable under which Asset Reference field value is stored.

Store File from record

This action stores the asset as a file so this can only be used with real files, not vaulted files.

Variable of record to process: select the variable of the stored Cumulus record

Output variable: name of variable under which the file is stored.

Update Asset Reference

This action updates the Asset Reference of the record

Variable of record to process: select the variable of the stored Cumulus record

Asset Handling Set: select Cumulus Asset Handling Set.

Cumulus Record Actions

Apply Permission Template to record

This action applies a permission template to a stored record

Variable of record to process: select the variable of the stored Cumulus record

Permission Template: select Cumulus Permission Template,
if Cumulus version has Permission Templates

NOTE: Can only be used if Preferences Module is licensed on the Cumulus Server.

Copy asset from record to other vault record

This actions copies an asset of a stored record into the vault of another record
and assigns the new vaulted asset to that stored record

Variable of record to process: select the variable of the stored Cumulus record

Variable of target record to process: select the variable of the stored Cumulus record

Vault-Folder-Name: Name of folder in Vault, leave empty if Catalog has catalog-vault-folder

Asset Handling Set: select Cumulus Asset Handling Set, required for this process

Copy move record

Copy/move a stored record (not Asset) to a stored catalog

Variable of record to process: select the variable of the stored Cumulus record

Variable of catalog to use: select the variable of the stored catalog

Type of action: select which type of action to take: copy or move

Permission Template: select Cumulus Permission Template,
if Cumulus version has Permission Templates

Delete record and file

Delete a stored record (and optionally Asset = file of record)

Variable of record to process: select the variable of the stored Cumulus record

Type of action: select which type of action to take: delete-record, delete-record-and-file,delete-file-of-record

Duplicate record

Native duplicate record (not Asset) to a stored catalog

Variable of record to process: select the variable of the stored Cumulus record

Variable of catalog to use: select the variable of the stored catalog

Permission Template: select Cumulus Permission Template, if Cumulus version has Permission Templates

Output variable: name of variable under which the new record is stored.

Export record to Cumulus export file

Export the stored record to Cumulus export file. Type of export defined in Global parameters: xml = Cumulus 8 or cre = Cumulus 5)

Variable of record to process: select the variable of the stored Cumulus record

Variable of folder to use: select the variable of the folder to store the file in

NOTE: If Cumulus 5 format is chosen, new types of fields like table-fields will be ignored.

Export record to Cumulus export file

Export the stored record to Cumulus export file. Type of export defined in Global parameters: xml = Cumulus 8 or cre = Cumulus 5)

Variable of record to process: select the variable of the stored Cumulus record

Variable of folder to use: select the variable of the folder to store the file in

NOTE: If Cumulus 5 format is chosen, new types of fields like table-fields will be ignored.

Import Cumulus export file

Import a stored file (Cumulus export format) to create a record.

Variable of file to process: select the variable of the file

Variable of catalog to use: select the variable of the stored catalog

Permission Template: select Cumulus Permission Template,
if Cumulus version has Permission Templates

Log record usage

This action adds an item (usage-entry) to the Asset Usage History field.

Variable of record to process: select the variable of the stored Cumulus record

Type-Of-Usage: select the type of Usage to add.
- PREVIEW
- COPY_TO
- MOVE_TO
- MAIL_TO
- PERFORM_ACTION
- CONVERT
- CREATE_SLIDE_SHOW
- CREATE_WEB_ALBUM
- CHECKOUT
- CHECKIN
- UNDO_CHECKOUT
- TRANSFORM_ORIGINAL
- SHOW_LOCATION
- WRITE_METADATA_TO_ASSET
- EDIT_WITH_APPLICATION
- PRINT_WITH_APPLICATION
- PRINT_USING_PRINT_SET
- DOWNLOAD
- COLLECT_FOR_CD
- SHOW_ORIGINAL
- UPDATE
- UPDATE_ASSET_REFERENCE
- COPY_TO_BACKUP
- RESTORE_FROM_BACKUP
- MOVE_TO_ARCHIVE
- RESTORE_FROM_ARCHIVE
- COMMENTED

Comment: text comment to add to the usage-entry

Catalog must contain record field: Asset Usage History.

Create new empty record

Create a new empty record in a store catalog.

Variable of catalog to use: select the variable of the stored catalog

Optional Record Name: value to set to the Record Name field of the new record.

Permission Template: select Cumulus Permission Template, if Cumulus version has Permission Templates

Set record field value

Set a stored text value to a field of a stored record.

Variable of record to process: select the variable of the stored Cumulus record

Cumulus-Record-Field-Name: select the name of the field.

Variable of text: select variable of store text to use (if text = null, field value will be emptied)

Set record field text value

Set a text value to a field of a stored record.

Variable of record to process: select the variable of the stored Cumulus record

Cumulus-Record-Field-Name: select the name of the field.

Text value: text value to set, if text = null, field value will be emptied

Set related record

Set or remove related record(s) of a stored record.

Variable of record to process: select the variable of the stored Cumulus record

Name or UID of relation: UID or UID_ASSET_RELATION_IS_VARIATION or UID_ASSET_RELATION_IS_ALTERNATE

Type of Action: set_master_record, set_slave_record, remove_master_record, remove_slave_record

Query : record query to find the related records

Store record field value as text

Stores the value old a field of a stored record as text.

Variable of record to process: select the variable of the stored Cumulus record

Field Name: select the name of the field.

For date-field suffix of format optional e.g. Item Modification Date(yyyy-MM-dd)

catid will return catalogid

See inline-scripting #RECORDFIELD()# for more options

NOTE: If field has no value, it stores an empty text string.

Update Formula Field

Update value of formula field of a stored record.

Variable of record to process: select the variable of the stored Cumulus record

Cumulus record field name: select Cumulus record field to update

Update Modification Date: yes or no

Update record

Update a stored record.

Variable of record to process: select the variable of the stored Cumulus record

Type of action: select which type of action to take: update always, update only if asset changed

Asset Handling Set: select Cumulus Asset Handling Set, required for this process

Permissions Template: select Cumulus Permission Template, if Cumulus version has Permissions Templates

Cumulus Table Field Actions (Record and Category)

A table field is like a catalog, that requires Open and Close, that can be queried and the resulting items processed. Opening a table-field is different because it’s part of either a Record, Category or Table Record. But all the other instructions are the same, because the open creates a generic Table Collection.

Close Category/Record/Table field Table

This action closes a table-collection which was created by an open … table field. It is mandatory to close when finished a table field that was opened. This instruction is the same for Record, Category or Table (table field in table field)

Variable of Table to process: select the variable of the stored Cumulus Table collection

Delete Table Field Record

This action deletes a stored table field record

Variable of Table Field Record to process: select the variable of the stored Cumulus Table Field Record

New Table Field Record

This action creates a new table field record in a stored Table Field collection

Variable of Table to process: select the variable of the stored Cumulus Table collection

Field Name: optionally a field can be set in the new table field record.

Field Value: optionally a field can be set in the new table field record

Output variable: name of variable under which the new Table field record is stored.

Open Category Table Field

This action opens Table field and stores the result as a Table collection

Variable of Category to process: select the variable of the stored Cumulus Category

Catergory Table Field Name: name of Table field to open.

Output variable: name of variable under which the Table field collection is stored.

Open Record Table Field Record

This action opens Table field and stores the result as a Table collection

Variable of Record to process: select the variable of the stored Cumulus Record

Record Table Field Name: name of Table field to open.

Output variable: name of variable under which the Table field collection is stored.

Open Table field in Table Field Record

This action opens Table field of a Table field record and stores the result as a Table collection

Variable of Table Field Record to process: select the variable of the stored Cumulus Table Field Record

Table Field Name: name of Table field to open.

Output variable: name of variable under which the Table field collection is stored.

Open Table field

This action opens Record Table field of a stored Cumulus Catalog and stores the result as a Table collection.
The difference with open record table field action, is that this collection is not bound to the record.

Behind the scenes it has a live-filter (ID of record == Host ID field in the table field) which is not the case in this action.

So when processing this Table Collection, the records go across all host records.

Variable of Catalog to process: select the variable of the stored Cumulus Catalog

Table Field Name: name (or UID) of Table field to open.

Output variable: name of variable under which the Table field collection is stored.

Process Table Field Records

This action optionally first performs a query and then loops thru the records of this table collection. For each record it stores it under the predefined Output variable (TAG) and then executes the child actions defined under this action.

Variable of Catalog to process: select the variable of the stored Cumulus Catalog

Optional Query: Optional query (syntax matches the Cumulus Record query described in the Cumulus-Catalog/find-records action

Output variable: name of variable under which the Table field record is stored.

Set Table Field Record Field Value

This action sets the value of a stored table field record field

Variable of Table Field Record to process: select the variable of the stored Table Field Record

Field Name: Name (or UID) of field in Table Field Record

Field Value: Value to set for the field in Table Field Record

Store Table Field Record Field Value As Text

This action stores the value of a stored table field record field as text

Variable of Table Field Record to process: select the variable of the stored Table Field Record

Field Name: Name (or UID) of field in Table Field Record

Field Value: Value to set for the field in Table Field Record

Output variable: name of variable under which the text (string) is stored

Update Formula Field of Table Field

This action updates the field using its predefined formula.

Variable of Table Field Record Field to process: select the variable of the stored Table Field Record

Table Field Record field: specify the field name or UID

Update Modification Date: select ‘yes’ if you want the Modification Date updated. Select ‘no’ if not.

Cumulus Workflow Actions

Apply Workflow Activity To Record

This action applies a workflow-activity a stored record.
It can be an initial activity, starting a new workflow for this record
or an activity in an already running workflow.

Variable of record to process: select the variable of the stored Cumulus record

Workflow: select workflow from the Catalog of this record

Activity: select activity from the selected workflow

Destination-State: select destination-state from the selected workflow

Activity-User: select user for this activity (or leave empty)
Can only be set if in activity configured as -user-selectable-

NOTE: This action can only be used if a workflow is added configured and added to the Catalog of this record.

Execute Action Script

Excecute external actionscript. Specify the full path of the action-script.

File-Path-Of-Actions-Script: Full path of action script file (string).

Output variable: name of variable under which to store the resulting text (string). Text will be empty if call was successful.

Store LDAP Info As Table

This action connects to an Active Directory using LDAP and queries it. The result is stored in table you can process.

LDAP server: ip or dns name of AD server . e.g. ldap.myserver.com:389

LDAP user: user name of AD user. e.g. CN=MY-USER,OU=DAM,OU=MISC,DC=na,DC=server,DC=com

LDAP password: password of AD user

LDAP search: AD query to be used for finding the result e.g. (& (objectClass=person)(sAMAccountName=#TAG(LDAP user)TAG#) )

LDAP Base: used for search. e.g. CN=MY-DEPARTMENT,OU=DAM,OU=MISC,DC=na,DC=server,DC=com

LDAP Filter:

all info
cn=login
mail
sn=surname
givenname
memberof
roles (same as memberof but only CN part)

Output variable: name of variable under which to store result as a table

Store Roles As Text

This action stores the names of the Cumulus roles separated by ; as text

Output variable: name of variable under which to store the role-names as text

NOTE: Can only be used if Roles Module is licensed on the Cumulus Server.

Store User Info As Text

This action stores info of a Cumulus user as text

Type-Of-Info: select the type of info to store:
- e-mail
- user uid
- full name
- roles (separated by ;)
- department

Selected-User: select login of user (can also be User UID e.g. from User UID field)

Output variable: name of variable under which to store the user-info as text

Store Users As Text

This action stores the login of the Cumulus users separated by ; as text

Output variable: name of variable under which to store the user-logins as text

Store Users of Role As Text

This action stores the login of the Cumulus users of a Cumulus Role separated by ; as text

Selected-Role: select name of role

Output variable: name of variable under which to store the user-logins as text

NOTE: Can only be used if Roles Module is licensed on the Cumulus Server.

Store Workflow Names As Text

This action stores the names of the workflows of a stored Cumulus catalog as text separated by ;

Variable of Catalog to process: select the variable of the stored Cumulus Catalog

Output variable: name of variable under which to store the workflow-names as text separated by ;

File Folder Actions

Copy Move File

This action copies or moves a stored file to an existing stored folder.

Variable of File to process: select the variable of the stored File

Variable of Folder to process: select the variable of the stored Folder

Target File Name: if left empty, original file name is used

Type of Action: copy or move (move is a copy with deleting the original at the end )

Output variable: name of variable under which to store resulting file

NOTE: For a native MOVE or RENAME (not copy) check-out rename-file and rename-folder

Create ZIP from Folder

This action creates a zip from a stored folder.

Variable of Folder to process: select the variable of the stored Folder

Path of File: full path of zip file to create

File Filter: file filter (same as File Filter for hotfolder workflow) e.g. .xml.db (this skips the xml and db files)

Folder Filter: folder filter (same as Folder Filter for hotfolder workflow)

Output variable: name of variable under which to store resulting zip-file

Create ZIP from Path

This action creates a zip from a stored folder.

List of paths of files or folders: list of paths of files or folders or folderpath/* for files in folder. Separate by ;

Path of File: full path of zip file to create

File Filter: file filter (same as File Filter for hotfolder workflow) e.g. .xml.db (this skips the xml and db files)

Folder Filter: folder filter (same as Folder Filter for hotfolder workflow)

Output variable: name of variable under which to store resulting zip-file

Delete File

This action deletes a stored file.

Variable of file to process: select the variable of stored file to delete

Delete Files and folders

This action deletes files and/or folders of a stored folder

Variable of folder to process: select the variable of the stored folder

Type of Action: select the type of action

delete-empty-folder
delete-all-from-folder
delete-empty-subfolders
delete-all-files-from-folder
delete-files-older-then-1-hour-from-folder
delete-files-older-then-1-day-from-folder
delete-files-older-then-1-week-from-folder
delete-files-older-then-4-weeks-from-folder
delete-files-older-then-12-weeks-from-folder
delete-files-older-then-52-weeks-from-folder

Increment Counter File

This action reads a stored text file that contains a counter, adds 1 and writes the counter back to the text-file.

Paths of file: path of counter file

Number of digits: number of digits for the counter e.g. 6 => 000001

Output variable: name of variable under which to store resulting counter as text (string)

Process Files in Folder

This action makes an inventory of the files in the folder (and its subfolders), stores each file and executes the child actions with each file.

Variable of Folder to process: select the variable of the stored Folder

File Filter: file filter (same as File Filter for hotfolder workflow) e.g. .xml.db (this skips the xml and db files)

Output variable: name of variable under which to store each file to process

Process Text lines from Text File

This action reads a stored text file, stores each line and executes the child actions with each text-line.

Variable of File to process: select the variable of the stored File

Output variable: name of variable under which to store each text-line (string) to process

Rename or Move File

This action renames or moves a stored file.

Variable of File to process: select the variable of the stored File

Target filename: Name of file to rename to (rename) or full path for target file location including filename (move)

Output variable: name of variable under which to store the resulting file

Rename or Move Folder

This action renames or moves a stored folder.

Variable of Folder to process: select the variable of the stored Folder

Target foldername: Name of folder to rename to (rename) or full path for target folder location including foldername (move)

Output variable: name of variable under which to store the resulting folder

Store part of File as Text

This action stores a part of a stored file as text

Variable of File to process: select the variable of the stored File

Type of Action: select the type of information to store

store-filename
store-filename-without-extension
store-filename-extension
store-filepath
store-folderpath
store-foldername

Output variable: name of variable under which to store the resulting text (string)

Store part of Folder as Text

This action stores a part of a stored folder as text

Variable of Folder to process: select the variable of the stored Folder

Type of Action: select the type of information to store

store-foldername
store-folderpath
store-parent-folderpath
store-parent-foldername

Output variable: name of variable under which to store the resulting text (string)

Store path as File

This action stores a path as a stored file

Path of File: specify the full path of the file to store

Type of Action: select the type action

store-path-as-file
store-path-as-file-if-exists
delete-file-if-exists
create-file-if-not-exists
delete-create-file
make-filename-unique
create-filename-unique

Output variable: name of variable under which to store the resulting file

Store path as Folder

This action stores a path as a stored folder

Path of Folder: specify the full path of the folder to store

Type of Action: select the type action

store-path-as-folder
store-path-as-folder-if-exists
create-folder-if-not-exists
make-foldername-unique
create-foldername-unique

Output variable: name of variable under which to store the resulting folder

Store select path as file

This action stores a path and a stored filename (string) as a stored file

Path of Folder: specify the full path of the folder to store

Variable of Filename to process: select the stored filename (string)

Type of Action: select the type of action

store-path-as-file
store-path-as-file-if-exists
delete-file-if-exists
create-file-if-not-exists
delete-create-file
make-filename-unique
create-filename-unique

Output variable: name of variable under which to store the resulting file

Store text File as table

This action reads a stored text file into a table. Lines become rows and a line is split into columns. This resulting table can be process with actions found under the table actions category.

Variable of File to process: select the stored file

Type of Separator: select the type column separator

tab-delimited-file
CSV-comma
CSV-semi-colon

Type of Table: select the type of table

sorted---not-searchable-table (the text file has a sort-order to keep intact)
unsorted---searchable-table (the text file needs to sorted according to the Search-Column-Number)

Search Column Number: leave empty in case sorted, otherwise specify column number to use as unique key for each row

Output variable: name of variable under which to store the resulting table

Store text File as text

This action reads a stored text file into a text-variable (string).

Variable of File to process: select the stored file

File-Encoding: leave empty if standard encoding is used. Otherwise specify the encoding of the file to process.
e.g. UTF-8, MacRoman, Latin-1

Output variable: name of variable under which to store the resulting text (string)

Store xml File as xml table

This action reads a stored xml file into a xml table (table).

Variable of File to process: select the stored file

Output variable: name of variable under which to store the resulting xml table (table)

Write text to File

This action writes a stored text (string) to a stored file.

Variable of File to process: select the stored file

Variable of Text to process: select the stored text (string)

Type of Action: select the type of action

append
overwrite

File-Encoding: leave empty if standard encoding is used. Otherwise specify the encoding of the file to process.
e.g. UTF-8, MacRoman, Latin-1

Output variable: name of variable under which to store the resulting file

Write xml Table to xml File

This action writes a stored xml table (table) to a stored file.

Variable of File to process: select the stored file

Variable of Text to process: select the stored xml table (table)

Top-Level-XML: specify top level tag of xml

File-Encoding: leave empty if standard encoding is used. Otherwise specify the encoding of the file to process.
e.g. UTF-8, MacRoman, Latin-1

Output variable: name of variable under which to store the resulting file

FTP Actions

Delete file on FTP

Deletes a file on ftp server

FTP-Server: IP or DNS of FTP-server. Default port is 21 otherwise specify port e.g. 127.0.0.1:458

FTP-User-Name: user name on FTP-server

FTP-Password: password of user on FTP-server

FTP-Protocol: select type of connection: ftp, sftp, ftp-ssl, ftp-tls, ftp-passive

Tag of FTP file-path: select the variable of the stored text which contains the ftp-file-path

Download file from FTP

Download file from ftp server

FTP-Server: IP or DNS of FTP-server. Default port is 21 otherwise specify port e.g. 127.0.0.1:458

FTP-User-Name: user name on FTP-server

FTP-Password: password of user on FTP-server

FTP-Protocol: select type of connection: ftp, sftp, ftp-ssl, ftp-tls, ftp-passive

Variable of folder to process: select the variable of the stored folder

Variable of file name: optionally select the variable of the stored file name

Delete-After-Download: select type of action: delete-remote-file-after-download or no-delete

Tag of FTP file-path: select the variable of the stored text which contains the ftp-file-path

Upload file from FTP

Upload stored file from ftp server

FTP-Server: IP or DNS of FTP-server. Default port is 21 otherwise specify port e.g. 127.0.0.1:458

FTP-User-Name: user name on FTP-server

FTP-Password: password of user on FTP-server

FTP-Protocol: select type of connection: ftp, sftp, ftp-ssl, ftp-tls, ftp-passive

Variable of File to process: select the variable of the stored file

Delete-After-Upload: select type of action: delete-remote-file-after-download or no-delete

Tag of FTP file-name: select the variable of the stored text which contains the ftp-file-name

Tag of FTP folder-path: select the variable of the stored text which contains the ftp-folder-path

Store path of ftp-files in table

Store path of fit-file in specified ftp folder in a table

FTP-Server: IP or DNS of FTP-server. Default port is 21 otherwise specify port e.g. 127.0.0.1:458

FTP-User-Name: user name on FTP-server

FTP-Password: password of user on FTP-server

FTP-Protocol: select type of connection: ftp, sftp, ftp-ssl, ftp-tls, ftp-passive

Variable of FTP folder path: select the variable of the stored folder path

Notification Actions

Call URL

Call http(s) url and store resulting text (string)

HTTP(s)-URL: specify url to call

Output variable: name of variable under which to store the resulting text (string)

Call URL to File

Call http(s) url and store resulting text in a file

HTTP(s)-URL: specify url to call

File path: specify full file path to which the result will be store

Output variable: name of variable under which to store the resulting file

Exit current loop

This action sets a flag, which is checked at then end of a loop. When set the loop will exit the loop. The loop can be a process… loop or can be the workflow loop of the items.

Execute External Application

Excecute external application and store text result

Variable of Instruction to process: select the variable of the stored instruction (string). Separate the parameters of the commandline instruction with #TAB#.

Output variable: name of variable under which to store the resulting text (string). The result contains the console-output of the application called. E.g. 14 Files Copied If you prefix the instruction exit: the result will be prefixed with the exit-code. E.g. 0;14 Files Copied Exit-code 0 usually means the execution was ok.

Send e-mail

Send mail using the creditials set in the global Roboflow parameters

E-mail TO: specify e-mail-adresse(s) separated by ; (no spaces)

E-mail Subject: specify the e-mail subject

Variable of E-mail Message: select the variable of the stored e-mail message

Set debug status

Set Debug status value

Debug Status: select debug status: Disabled or Enabled

Set log status

Set Log status value

Log Status: select log status: Disabled or Enabled

Wait

Makes the workflow sleep some mili-seconds

Mili-Seconds-To-Wait: specify the number of mili-seconds to wait

Write Text To Log

Writes text to log file (if logging is enabled)

Text to Log: specify the text to write to the log file.

Write Text To Debug Log

Writes text to log file (if debug is enabled)

Text to Log: specify the text to write to the debug log file.

SQL Actions

Close SQL database

Close stored SQL database connection

Variable of SQL database: select the variable of the stored database connection

Open SQL database

Open SQL database connection

SQL-Driver: java class of the JDBC driver:
e.g. MySQL = com.mysql.jdbc.Driver
e.g. MS SQL Server = net.sourceforge.jtds.jdbc.Driver

SQL-Database-Connection: the sql-connection-string:
e.g MySQL = jdbc:mysql://IPorDNS/aDatabase?user=aUser&password=aPassword
e.g. MS SQL Server = jdbc:jtds:sqlserver://localhost:1433/aDatabase?user=aUser&password=aPassword

NOTE: JDBC drive must be installed separately and JDBC jars must be added to wrapper.conf (and/or startup scripts)

SQL query

Perform SQL query on stored SQL database connection and store result as text

Variable of SQL database: select the variable of the stored database connection

SQL-Query: sql-instructions that returns single result. e.g. update, insert, delete, select count(*)

SQL query store result in table

Perform SQL query on stored SQL databases connection and store result as table

Variable of SQL database: select the variable of the stored database connection

SQL-Query: sql-instructions e.g. select * from mytable

Table Actions

Process columns from row

This action stores every element (column) of a row (array) as text (string) and performs the child-actions for every row

Variable of array to process: select the variable of the stored array

Output variable: name of variable under which to store the resulting text (string)

Process rows from table

This action stores every row as an array and performs the child-actions for every row

Variable of table to process: select the variable of the stored text table

Search-Value: if the table is searchable, this parameter specifies the search-value performed as filter
either exact-search e.g. prod123 or starts-with-search e.g. prod123* or ends-with-search e.g. *prod123

Skip-First-Row: choose if first row should be processed: do-not-process-first-row or process-all-rows

Type-Of-Table: searchable-table or unsorted-table

Output variable: name of variable under which to store the resulting row (array)

Process xml-table-element as xml table

This action stores every xml-sub-table-part as an xml-table and performs the child-actions for every xml-table

Variable of xml-table to process: select the variable of the stored xml-table

Search-Value: If the table is searchable, this parameter specifies the search-value performed as filter
either exact-search e.g. prod123 or starts-with-search e.g. prod123* or ends-with-search e.g. *prod123

Output variable: name of variable under which to store the resulting table (table)

Store column from row (array) as text

This action stores a specified column of a stored row (array) as text

Variable of row to process: select the variable of the stored row (array)

Column-Number: the column-number of the row to store, 1 = first column

Default-Value: this default value will be stored, if row does not exist or column-number does not exist

Store empty (xml) table

This action stores an empty (xml) table

Output Variable: name of variable under which to store the resulting table (table)

Store row in table

This action adds a row (array) to a stored table

Variable of table to process: select the variable of the stored table

Variable of row to process: select the variable of the stored row (array)

Key-Value: Key to store the row with

Store table row element as text

This action searches in a stored table for a row (array ) and stores a column of that row (array) as text (string)

Variable of xml-table to process: select the variable of the stored xml-table

Search-Value: key;col.no This parameter specifies the search-value used to find the row and the column-number to be stored

Default-Value: if search fails to find a row, this value is returned

Output variable: name of variable under which to store the resulting text (string)

Store text as xml table

This action parses text (string) similar to the “Store Text File as Table”. Creating an array per line and adding that a table. So, the result is a table.

Text-To-Parse: Specifiy the text to parse

Type Of Row separator: e.g. #CR# #LF# #CRLF# #TAB# , / ;

Type Of Column separator: e.g. #TAB# #CR# #LF# #CRLF# , / ;

Type of Table: select the type of table

sorted---not-searchable-table (the text has a sort-order to keep intact)
unsorted---searchable-table (the text needs to sorted according to the Search-Column-Number)

Search Column Number: leave empty in case sorted, otherwise specify column number to use as unique key for each row

Output variable: name of variable under which to store the resulting table

Store text in (xml) table

This action adds a text (string) to a stored table

Variable of table to process: select the variable of the stored table

Variable of text to process: select the variable of the stored text (string)

Key-Value: Key to store the text with

Store xml table as flat xml table

This action stores an xml table (which could be nested with other tables into a flat table for which each element is text-key and text-value.

Variable of table to process: select the variable of the stored table

Search Value: Optional key-value to search

Output variable: name of variable under which to store the resulting table

Store xml table element as text

This action searches in a stored table for an element (string) and stores it

Variable of xml-table to process: select the variable of the stored xml-table

Search-Value: This parameter specifies the search-value used to find the element

Default-Value: if search fails to find the element, this value is returned

Output variable: name of variable under which to store the resulting text (string)

Store xml table elements as stored texts

This action processes all elements of a table and store the text-value under the key in the global parameters

Variable of xml-table to process: select the variable of the stored xml-table

Store xml table in xml table

This action stores and xml table inside a stored xml

Variable of table to process: select the variable of the stored table

Variable of table to store: select the variable of the stored table to be stored

Key-Value: Key to store the table with

Text Actions

Process parts of split text

This action splits a text using a specified separator and performs for every part of the text the child-actions

Text-To-Split: text to process

Text-Part-Separator: character(s) that separate the parts of this string: e.g. peter;tom;john separater is ;

Output variable: name of variable under which to store the part of text before processing the child-actions

Remove global stored text

Remove a global stored text

Variable of text to process: select the variable of the stored text

NOTE: by default all variables from actions are stored only for that action-script unless #GLOBAL# is added in front of the name of the variable.
e.g. in case of opening and closing a catalog it might be useful.

Remove stored text

Remove a stored text

Variable of text to process: select the variable of the stored text

NOTE: by default all variables from actions are stored only for that action-script unless action "Store global text" used or #GLOBAL# is added in front of the name of the variable; e.g. in case of opening and closing a catalog it might be useful.

Replace in text

Remove a text by another text in a stored text

Text-To-Find: text to find. Multiple text-items can be separated by ,
if , is to be replaced use #COMMA# and #SEMI-COLON# for ;

Text-To-Replace-With: text to replace with. Multiple text-items can be separated by ,
if , is to be replaced with use #COMMA# and #SEMI-COLON# for ;

Variable of text to process: select the variable of the stored text

Output variable: name of variable under which to store the resulting text (string)

Store date as text

Store current date as text. Optionally add or subtract time-units

Format-Of-Date-Time: date format, see script-help for syntax. e.g. yyyy-MM-dd HH:mm:ss:SSS 2013-05-18 22:45:05:925

Add-Or-Substract-Time-Units: optionally specify a number of time-units to add or subtract e.g. 5 or -3

Time-Unit-To-Add-Or-Substract: optionally select time-unit to add or subtract. YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE

Output variable: name of variable under which to store the resulting text (string)

NOTE: detailed info on date-format-syntax available in scripting-help under #DATEFORMAT-FILE()# instruction.

Store evaluated stored text

This action evaluates a stored text and store it again as text

Variable of text to process: select the variable of the stored text

Output variable: name of variable under which to store the resulting text (string)

NOTE: when evaluating a text, it executes all inline script instructions in that text

Store global text

Store text as global variable, available across all items processed

Text To Store: text to store for later reuse

Output variable: name of variable under which to store the resulting text (string)

Store incremented text value

Store incremented value of stored text as a stored text (string)

Variable of text to process: select the variable of the stored text

Value to Add: integer value to add

Format-Of-Result: (optional) e.g. 0000 will return 0054 for value of 54

Output variable: name of variable under which to store the resulting value as text (string)

Store left part of text

Store part of text as variable. The part of the text is from the first character up to the first instance of the text

Variable of text to process: select the variable of the stored text

Text To Search: text to search

Output variable: name of variable under which to store the resulting text (string)

Store last left part of text

Store part of text as variable. The part of the text is from the first character up to the last instance of the text

Variable of text to process: select the variable of the stored text

Text To Search: text to search

Output variable: name of variable under which to store the resulting text (string)

Store last right part of text

Store part of text as variable. The part of the text stored is starting after last instance of the text to the end of the text

Variable of text to process: select the variable of the stored text

Text To Search: text to search

Output variable: name of variable under which to store the resulting text (string)

Store length of text

Store text length of a text

Text To Use: text to store the length of

Output variable: name of variable under which to store the resulting length as text (string)

Store right part of text

Store part of text as variable. The part of the text stored is starting after first instance of the text to the end of the text

Variable of text to process: select the variable of the stored text

Text To Search: text to search

Output variable: name of variable under which to store the resulting text (string)

Store object

Text To Store: text to store as a certain type for later reuse

Type of result: depending on the selected type, the text value will be converted to that type and stored, Types:
- text (String)
- Boolean: text-value should be true or false
- file: text-value should be a file-path
- folder:text-value should be a folder-path
- array: text-value e.g. peter;vince;tom or peter,vince,tom
- table-row (= vector) text-value e.g. peter;vince;tom or peter,vince,tom
- table (= hashtable): text-value e.g. peter##male

Output variable: name of variable under which to store the resulting object

Store split text as array

The actions splits a text and stored the result in an

Text To Split: text to store as a certain type for later reuse

Text Part Separator: #CR# #CRLF# #TAB# for special characters: e.g. peter;tom;john separator is ;

Output variable: name of variable under which to store the resulting text (string)

Store subpart of text

Store a part of the text

Variable of Text to process: select stored text (string)

Text To Search: x;y x stands for the starting character (0 is the first character of the text) y (optional) stands for the number up to which to substring the text.

E.g. abcdef 2;2 returns empty

E.g. abcdef 0;2 ab

E.g. abcdef 1 bcdef

E.g. abcdef 1;-1 bcde

Output variable: name of variable under which to store the resulting text (string)

Store text

Text To Store: text to store as a certain type for later reuse

Output variable: name of variable under which to store the resulting text (string)