Container Output (File)

This node makes a file accessible to an external caller (for example the REST interface) by providing the path to the file as a resource. It can then for example be downloaded after executing a job that isn't discarded yet. The file has to exist and be located in the current workflow's data area.

This node uses a path flow variables to select which file to expose. To convert the string variables created by some nodes that have not been migrated yet to paths you can use the String to Path (Variable) node. For further information about file handling in general see the File Handling Guide.

Options

Parameter name
A name for the output parameter (preferably unique). This name is exposed in the REST interface and will have the resource attached to it. It must start with a letter, followed by letters and digits and single minus signs or dashes and must end with a letter.
Append unique ID to parameter name
If checked, the name set above will be amended by the node's ID to guarantee unique parameter names. Usually it's a good idea to have this box not checked and instead make sure to use meaningful and unique names in all container nodes present in a workflow.
Description
A description for the resource output parameter. It is currently not shown in the API specification of the REST interface.
File Path Variable
Defines the variable that contains the path to the resource to be exposed. This has to be a path flow variable. The path must be relative to the workflow data area and must point to an existing and regular file (e.g. not a folder).

Input Ports

Icon
The local location of the resource as a path flow variable.

Output Ports

This node has no output ports

Views

This node has no views

Workflows

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.