Return Property Value

Function:

This tool is used to return values in the specified tool output parameters. This tool overrides the property values of the modelled output parameters with the values of the modelled input parameters. The tool supports mass processing and a file descriptor as output parameters.

Attributes:

Attribute Type Description
Mode [M] Selection Specifies the mode of the tool. The values determine the mapping: Property to Property or Property to Structured File Descriptor or Structured File Descriptor to Property.

The default value is Property to Property.

Parameters:

Parameter Name I/O Type Description
Source Property [M] I String/File The source property or structured file descriptor, which value(s) are returned as property value(s) to the target property or are written in the has property relationship(s) of the target file descriptor.
Source Property * [O] I String Additional source properties, which values are returned as further property values to the target properties or are written in the has property relationships of the target file descriptor. Additional input parameters are not permitted if the first input parameter is of type File.
Target Property [M]   O String/File The target property or a structured file descriptor. Type File is not permitted, if the first input parameter is of type File.

If the referenced file descriptor type is not InputStream, the tool will attempt to physically create or overwrite the target file.

Target Property * [O] O String Further target properties. It is not possible to combine a structured file descriptor with further target properties.
Note: Output parameter values of type String are truncated to the length specified in the attribute Value Max Length of the referenced property. This applies to all property values written to an output file parameter.

Supported scenarios

By specifying an input and output parameter with Mass Processing attribute set to true, the given property values of all given entity contexts are returned by the matching output parameters.

By specifying an input parameter with Mass Processing attribute set to false and a output parameter with Mass Processing attribute set to true, the given property value is returned for each mass processing context by the matching output parameter.

By specifying an input parameter with Mass Processing attribute set to false and an output parameter with Mass Processing attribute set to false, the given property value is returned by the matching output parameter.

By specifying an input parameter with Mass Processing attribute set to true and structured file descriptor as an output parameter, a new line with the given property values is written into the file descriptor for every mass processing context. In this scenario, the file descriptor has to be of the structure type Table.

Use the tool Create Structured File for the use case to map Mass Processing input parameters to a file descriptor of structure type JSON.

By specifying an input parameter with Mass Processing attribute set to false and structured file descriptor as an output parameter, one line with the given property values is written into the file descriptor. If input parameter with Mass Processing attribute set to false are used in a mass processing action, a new line with the given property values is written into the file descriptor for every mass processing context. The value in every line of the file descriptor is the same for the input parameters with Mass Processing attribute set to false.

By specifying a structured file descriptor as an input parameter and output parameters with Mass Processing attribute set to true, property values of each line of the file descriptor are written in a new mass processing context. The properties referenced in the output parameters have to be equal to the properties referenced in the file descriptor. In this scenario, supported file descriptor structures are Table or JSON.

By specifying a structured file descriptor as an input parameter and output parameters with Mass Processing attribute set to false, property values of the first line of the file descriptor are returned to the corresponding output parameters. The properties referenced in the output parameters have to be equal to the properties referenced in the file descriptor. In this scenario, supported file descriptor structures are Table or JSON.