Skip to content

TSTool / Command / CopyTimeSeriesPropertiesToTable

Overview

The CopyTimeSeriesPropertiesToTable command copies time series properties to a table.

A common use case is to read multiple time series using a Read command. Read commands can implement a ReadData=False parameter to only read time series metadata, which will improve performance. Then:

  • use the CopyTable command to further filter the initial table
  • use the table for iteration using the For command
  • output a list of time series

Properties can be copied to an existing table, or a new table can be created. Time series properties are typically set in the following ways:

  1. Location and time series metadata from original data (e.g., database or web service) are set as properties when the time series are read.
  2. The SetTimeSeriesProperty command sets a property.
  3. Other commands set properties as a bi-product of processing.

Command Editor

The command is available in the following TSTool menu:

  • Commands(Table) / Table, Time Series Processing

The following dialog is used to edit the command and illustrates the command syntax (in this case the location part of the time series identifier is used to match the contents of the “loc” column in the table).

CopyTimeSeriesPropertiesToTable command editor

CopyTimeSeriesPropertiesToTable Command Editor (see full-size image)

Command Syntax

The command syntax is as follows:

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

Command Parameters

Parameter                                  Description Default                           
TSList Indicates the list of time series to be processed, one of:
  • AllMatchingTSID – all time series that match the TSID (single TSID or TSID with wildcards) will be processed.
  • AllTS – all time series before the command.
  • EnsembleID – all time series in the ensemble will be processed (see the EnsembleID parameter).
  • FirstMatchingTSID – the first time series that matches the TSID (single TSID or TSID with wildcards) will be processed.
  • LastMatchingTSID – the last time series that matches the TSID (single TSID or TSID with wildcards) will be processed.
  • SelectedTS – the time series are those selected with the SelectTimeSeries command.
 AllTS
TSID The time series identifier or alias for the time series to be processed, using the * wildcard character to match multiple time series. Can be specified using ${Property}. Required if TSList=*TSID
EnsembleID The ensemble to be processed, if processing an ensemble. Can be specified using ${Property}. Required if TSList=*EnsembleID
IncludeProperties A list of user-defined (dynamic) time series property names to be copied to the table, separated by commas. Can be specified using ${Property}. Copy all dynamic properties.
IncludeBuiltInProperties A list of built-in time series property names to be copied to the table, separated by commas. Use * for all properties. Can be specified using ${Property}. The following built-in properties are available:
  • alias
  • datatype
  • description
  • interval
  • tsid
  • units
 Copy no built-in properties.
TableID The identifier for the existing or new table to receive properties. Can specify using processor ${Property}. None – must be specified.
TableTSIDColumn Table column name that is used to match the time series identifier for processing, to select the row. Can be specified using ${Property}. None – must be specified.
TableTSIDFormat The specification to format the time series identifier to match the TSID column. Use the format choices and other characters to define a unique identifier. Time series alias if available, or otherwise the time series identifier.
AllowDuplicates Allow duplicate TSID rows in the output:
  • False – match TSID, intended for cases where TSID are distinct
  • True – add new rows regardless, for cases where multiple time series having the same TSID are processed and should each have a row in the output table.
 False (if TSID is matched, set the properties for that row).
NameMap A map of time series property name to table column name in format PropertyName1:ColumnName,PropertyName2:ColumnName2,.... Can be specified using ${Property}. Time series property name is used for the table column name.
TableOutputColumns The NameMap parameter should be used instead of this older parameter. This parameter may be removed in the future. The name(s) of the column(s) to receive properties for the matching time series. Separate column names with commas. If a column name is specified as *, the property name is used for the column name. Can be specified using ${Property}. If not specified, use IncludeProperties.

Examples

See the automated tests.

Troubleshooting

See the main TSTool Troubleshooting documentation.

See Also