Skip to main content

 

Documentation & User Guides | FotoWare

Action tags in FotoWeb

 

This article describes all dynamic tags that can be used in metadata macros and dynamically generated file names in actions and marker actions.

These tags cannot be used in search expressions.

Tags in the namespace task refer to the currently running action or marker action.

Tags in the namespace asset refer to the asset that is currently being processed.

For more information about actions and markers, see the Configuring Workflows guide for FotoWeb.

Tag

Description

Examples

{{task.count}}

{{task.count:DIGITS}}

Index of the current asset in the list of assets being processed by the currently running action.

Indexes start with zero.

If present, the DIGITS parameter specifies the minimum number of digits that are used to represent the index. If the number has fewer digits, then leading zeroes are added.

If not present, then no leading zeroes are added.

For the third assset being processed, {{task.count}} expands to

2

whereas {{task.count:3}}expands to

002

{{task.total}}

{{task.total:DIGITS}}

Total number of assets being processed by the currently running action.

If present, the DIGITS parameter specifies the minimum number of digits that are used to represent the number. If the number has fewer digits, then leading zeroes are added.

If not present, then no leading zeroes are added.

If 5 assets are being processed, {{task.total}} expands to

5

whereas {{task.total:3}}expands to

005

.

{{task.href}}

URL of the action or marker.

Can be used to uniquely identify the marker or action.

The format of the URL is intentionally unspecified. No assumptions should be made about the format of URLs. URLs should not be parsed or generated by third-party applications.

No requests should be made to these URLs, as they are not part of the official FotoWeb API.

{{task.job}}

Unique ID of the task that is currently running.

Whenever an action or marker action is run, a new unique ID is generated.

Can be used to identify assets that were processed in the same batch.

Unspecified format. Treat as an opaque string.
{{task.id}} Unique ID of the action or marker. Unspecified format. Treat as opaque string.
{{task.metadata:FIELD}}

Value of a metadata field that was entered interactively by the user when running he action.

Interactive actions may be configured to show a metadata editor to the user. This tag expands to the value that the user entered for a specific metadata field.

If the metadata field can be specified per asset rather than per job, then this tag expands to the value that was entered by the user for the asset which is currently being processed.

The FIELD parameter must be the numeric ID of the metadata field. For a reference of standard field numbers, see the FotoWare default field code reference topic.

 
{{task.name}}

Human-readable name of the action or marker.

Do not use this programmatically as a unique ID. Use {{task.href}} or {{task.id}} instead.

 
{{task.type}} Either action or marker, depending on whether an action or marker actions is being run.  

{{asset.ext}}

{{asset.extension}}

File extension of the asset, not including the dot. jpg

{{asset.name}}

{{asset.filename}}

File name of the asset, not including the folder path  
{{asset.href}} URL of the asset

The format of the URL is intentionally unspecified. No assumptions should be made about the format of URLs. URLs should not be parsed or generated by third-party applications.

The URL can be used by an API client to query the asset representation of the asset.

For more information, see The FotoWeb REST API.

{{asset:FIELD}}

{{asset.metadata:FIELD}}

Value of a metadata field of the asset.

If the metadata field was changed interactively by the user entering a new value in an interactive metadata editor as part of running the action, then this tag expands to the latest modified value.

If multiple metadata macros are run as part of the action, and they modify the same metadata field, then this tag expands to the value of the field after applying all of the previous metadata macros in the order in which they are defined in the action configuration.

This means that the order of metadata macros matters.

The FIELD parameter must be the numeric ID of the metadata field. For a reference of standard field numbers, see the FotoWare default field code reference topic.

If the user entered he value foo for field 5 in an interactive editor, then

{{asset.metadata:5}}

if used in the first metadata macro expands to foo.

If the following metadata macro is used to set he value of field 120:

Title: {{asset.metadata:5}}

then in the next metadata macro, the tag

{{asset.metadata:120}}

expands to:

Title: foo