Time series properties (TSPs)

A time series property (TSP) is a property that enables the usage of time series data in Foundry applications. Review how to use time series for more details.

When viewing a time series property, the value will be displayed as a plot of the associated time series values. For example, the example below shows a temperature_id time series property, visualized using the underlying time series data in Quiver.

Time series property setup

For a guided walkthrough of the following steps, use the time series setup assistant in the platform. Launch the setup assistant by navigating directly to https://<domain>/workspace/ontology/home/overview/time-series-setup, or by navigating to a dataset preview containing a timestamp column and selecting Set up time series from the Analyze data action menu.

For more guidance on setting up time series object types, see the documentation on how to create or select a time series object type.

Time series properties are configured within the Capabilities tab of the Ontology Manager application. If you are following along with the setup assistant, you will automatically be directed to the Capabilities tab after creating a new object type or choosing an existing one. If the object type already has time series properties configured, you will see them displayed in a table view where you can also add or delete time series properties.

If there are no existing time series properties on the object type, you will be guided through adding one.

To add a time series property, select Get started. This will launch a dialog to guide you through the following steps:

1. Determine object type: Decide if this object type is a sensor object type.

2. Select property: Select a string property that contains the series IDs, then select Next.

3. Select time series sync(s): Select a time series sync if one already exists, or follow the instructions to create a new time series sync. You can select multiple time series syncs by continuing to select + Add sync. If you are backing your TSP with multiple time series syncs, you will need to use qualified series IDs.

Time series formatting

Time series formatting allows setting the desired internal interpolation and units of the time series. Applications like Quiver will respect the provided interpolation and unit values.

The unit and interpolation formatting can point to other string properties on this object type for more granular control (for example, if each time series contained in the time series property has different units and or interpolation). If granular control is not required, both interpolation and units have a set of standard values to choose from.

The internal interpolation and units for sensor object types are configured in the sensor object configuration section section.

Default time series property

An object type can have one time series property designated as the default time series property. When configuring the first time series property for an object type, that property will be set as the default time series property.

In some applications, the default time series property is displayed without additional user intervention. In Quiver, for example, the object property time series card points to the default time series property unless otherwise specified.

The single time series property of a sensor object type must be a default time series property. Review how to set up a sensor object type for more details.