Time series properties (TSPs)（时间序列属性（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. Select property: Select a string property that contains the series IDs, then select Next.

:::callout{theme="warning"} The primary key property of an object type cannot be selected as the time series property. :::

1. 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 +Choose file. If you are backing your TSP with multiple time series syncs, you will need to use qualified series IDs.

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

:::callout{theme="neutral"} If you want to add or modify time series properties but have closed the setup assistant, you can resume your progress with either of the following:

• Navigate to your object type in Ontology Manager and then to the Capabilities tab in the panel to the left.
• Relaunch the setup assistant by navigating directly to https://<domain>/workspace/ontology/home/overview/time-series-setup or navigate to a dataset preview containing a timestamp column, and select Set up time series from the Analyze data action menu. :::

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.

:::callout{theme="neutral"} The units provided in the time series formatter are mainly used for visual display purposes. For example, as an axis label on plots in Quiver. :::

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.

---

中文翻译

---

时间序列属性（Time Series Properties, TSPs）

时间序列属性（Time Series Property, TSP） 是一种支持在 Foundry 应用中使用时间序列数据的属性。更多详情请参阅时间序列使用指南。

查看时间序列属性时，其值将以关联时间序列值的图表形式显示。例如，下方示例展示了一个 temperature_id 时间序列属性，通过 Quiver 基于底层时间序列数据进行可视化呈现。

时间序列属性配置

如需分步指导操作，请使用平台中的时间序列设置助手。可通过直接访问 https://<domain>/workspace/ontology/home/overview/time-series-setup 启动设置助手，或导航至包含时间戳列的数据集预览，从分析数据操作菜单中选择设置时间序列。

有关设置时间序列对象类型的更多指导，请参阅如何创建或选择时间序列对象类型文档。

时间序列属性在 Ontology Manager 应用的功能（Capabilities）选项卡中进行配置。若跟随设置助手操作，在创建新对象类型或选择现有对象类型后，系统将自动跳转至功能选项卡。若对象类型已配置时间序列属性，将以表格视图展示，您可在此添加或删除时间序列属性。

若对象类型尚无时间序列属性，系统将引导您添加。

要添加时间序列属性，请选择开始使用。这将启动一个对话框，引导您完成以下步骤：

1. 选择属性： 选择包含序列 ID 的 string 类型属性，然后选择下一步。

:::callout{theme="warning"} 对象类型的主键属性不能选作时间序列属性。 :::

1. 选择时间序列同步（Time Series Syncs）： 若已有时间序列同步，请选择一个；或按照说明创建新的时间序列同步。可通过继续选择+选择文件来选取多个时间序列同步。若使用多个时间序列同步支持 TSP，则需要使用限定序列 ID（Qualified Series IDs）。

1. 确定对象类型： 判断此对象类型是否为传感器对象类型（Sensor Object Type）。

:::callout{theme="neutral"} 如需添加或修改时间序列属性但已关闭设置助手，可通过以下任一方式继续操作：

• 在 Ontology Manager 中导航至对象类型，然后进入左侧面板的功能选项卡。
• 直接访问 https://<domain>/workspace/ontology/home/overview/time-series-setup 重新启动设置助手，或导航至包含 timestamp 列的数据集预览，从分析数据操作菜单中选择设置时间序列。 :::

时间序列格式化

时间序列格式化允许设置时间序列所需的内部插值（Interpolation）和单位（Units）。Quiver 等应用将遵循所提供的插值和单位值。

单位和插值格式可指向此对象类型的其他 string 属性，以实现更精细的控制（例如，当时间序列属性中包含的每个时间序列具有不同的单位和/或插值时）。若无需精细控制，插值和单位均有一组标准值可供选择。

传感器对象类型的内部插值和单位在传感器对象配置部分中进行配置。

:::callout{theme="neutral"} 时间序列格式化器中提供的单位主要用于视觉显示目的，例如作为 Quiver 图表中的轴标签。 :::

默认时间序列属性

一个对象类型可指定一个时间序列属性作为默认时间序列属性。为对象类型配置第一个时间序列属性时，该属性将被设为默认时间序列属性。

在某些应用中，默认时间序列属性无需额外用户操作即可显示。例如在 Quiver 中，除非另行指定，对象属性时间序列卡片默认指向默认时间序列属性。

传感器对象类型的单一时间序列属性必须为默认时间序列属性。更多详情请参阅如何设置传感器对象类型。