TSTool / Command / SetPropertyFromTable

Overview
- Cell Embedded Properties
Command Editor
Command Syntax
Examples
Troubleshooting
See Also

Overview

The SetPropertyFromTable command sets the value of a property used by the command processor, using table data:

Table cell value:
- Filters (or row number) are used to match one or more rows.
- The filters use simple string matching with * wildcard character.
- The first matched row is used to set the property.
- If no row is matched then the property is not set.
Table cell string embedded property:
- First match a cell as described above.
- Then decode and set embedded properties as per the Cell Embedded Properties section.
- If PropertyName is provided, also set the property to the cell contents without the properties text (only supported for the DoubleSlash format).
Table property:
- Number of rows: Useful to check that a table size is as expected.
- Number of columns: Useful to check that a table size is as expected.

The properties will be available to subsequent commands that support using ${Property} notation in parameters, for example to dynamically specify time series identifiers or input to commands. This command is useful in cases where iteration is processing data from a table using a For command, in which case the property can be used in other commands.

Cell Embedded Properties

There are cases when one or more properties may be encoded in a cell's text, for example, in database columns containing descriptive text. The following syntax is supported using the DecodeEmbeddedProperties=True property and optionally EmbeddedPropertyFormat. All of the named properties will be decoded and set as string properties. Double or single quotes can be used for property values that contain spaces. URLs with query parameters that use an equal sign will be ignored as properties if not quoted and can be quoted to set as a value.

Example `EmbeddedPropertyFormat=DoubleSlash` cell contents:

Some text // random text PropertyName1=PropertyValue1 PropertyName2="Property value with spaces and double quotes"
Some text // random text PropertyName1 = PropertyValue1 PropertyName2 = "Property value with spaces and double quotes"
Some text // random text PropertyName1 = PropertyValue1 PropertyName2 = 'Property value with spaces and double quotes'

If the PropertyName parameter is also specified, the associated property will be set to the cell's text prior to the delimiter. but only for the DoubleSlash format.

Example `EmbeddedPropertyFormat=PropertyValue` Cell contents:

Some text random text PropertyName1=PropertyValue1 PropertyName2="Property value with spaces and double quotes"
Some text random text PropertyName1 = PropertyValue1 PropertyName2 = "Property value with spaces and double quotes"
Some text random text PropertyName1 = PropertyValue1 PropertyName2 = 'Property value with spaces and double quotes'

Command Editor

The command is available in the following TSTool menu:

Commands(Table) / Running and Properties

The following dialog is used to edit the command and illustrates the command syntax.

SetPropertyFromTable Command Editor for Cell Parameters (see full-size image)

SetPropertyFromTable Command Editor for Cell Embedded Property Parameters (see full-size image)

SetPropertyFromTable Command Editor for Table Row and Column Count Parameters (see full-size image)

Command Syntax

The command syntax is as follows:

SetPropertyFromTable(Parameter="Value",...)

Command Parameters

Tab	Parameter	Description	Default
*All*	`TableID`	The identifier for the table. Can be specified using `${Property}`.	None – must be specified.
*Cell Property*	`Column`	The name of the column containing the value that will be used to set the processor property. Can be specified using `${Property}`.	None – must be specified.
	`ColumnIncludeFilters`	Filters that include rows being matched, by matching column values: `ColumnIncludeFilter1:FilterPattern1,ColumnIncludeFilter2:FilterPattern2` Patterns can use `*` to indicate wildcards for matches. Values are treated as strings for checks. All patterns must be matched to include the row. Can be specified using `${Property}`.	All rows are matched.
	`ColumnExcludeFilters`	Filters that exclude rows being copied, by matching column values: `ColumnExcludeFilter1:FilterPattern1,ColumnExcludeFilter2:FilterPattern2` Patterns can use `*` to indicate wildcards for matches. Values are treated as strings for checks. All patterns must be matched to exclude the row. Can be specified using `${Property}`.	All rows are matched.
	`IgnoreCase`	Whether the filter comparisons should ignore case (`True`) or consider case (`False`).	`True`
	`Row`	The row number (1+) to match or `last` to match the last row in the table.	If not specified, use the column filters to match rows.
	`PropertyName`	The property name to be set. Can be specified using `${Property}`. If `DecodedEmbeddedProperties=True`, property will be set to all text except the embedded property text.	None – must be specified.
	`DefaultValue`	The default value to use if no table cell is matched: `Blank` – to use a blank string `Null` – to use a null value Specified value to set to a string value. Can be specified using `${Property}`.	Property is set to null.
*Cell Embedded Properties*	`DecodeEmbedded` `Properties`	Whether to set properties from Cell Embedded Properties: `False` - do not decode embedded properties `True` - decode embedded properties.	`False`
	`EmbeddedProperty` `Format`	The format of embedded properties used if `DecodeEmbeddedProperties=True`: `DoubleSlash` - double slashes (`//`) at the end of the cell text followed by properties `PropertyValue` - `Property=Value` strings anywhere in the text See the Cell Embedded Properties documentation.	`DoubleSlash`
*Table Property*	`RowCountProperty`	The name of the property to set to the complete table row count.
	`ColumnCountProperty`	The name of the property to set to the complete table column count.

Examples

See the automated tests.

The command shown in the editor dialog, used with the following table, will set StringProp1=“Abba”

SetPropertyFromTable Example Table (see full-size image)

Troubleshooting

See the main TSTool Troubleshooting documentation.