Sample Data

Synopsis

This operator samples one or more PI data points via the PI Web API. Alternatively, a single performance equation can be evaluated.

Input

connection

This input port expects a Connection object if any. See the parameter connection entry for more information.

Output

output

This output port delivers sampled time series for the specified data points or performance equation.

connection

This output port delivers the Connection object from the input port. If the input port is not connected the port delivers nothing.

Parameters

Connection entry

This parameter is used to specify a repository location that represents a connection entry. Theconnectioncan also be provided using the connection input port.

Root path

Overrides the root path (data server) specified in the connection.

Query type

Specifies whether to look up a list of data items or to evaluate a performance equation.

Data item

The tag of the data item to look up.

额外的数据项

An optional list of additional tags of data items to look up.

Client side batching

Enabling client-side batching splits the request into a sequence of smaller requests. Client-side batching allows to pull data sets larger than the PI Web API limit for single requests (often set to 150000 values), but adds overhead for requests below this limit.

Expression

The performance equation to be evaluated.

Result type

The expected result type of the given performance equation.

Start time

The start time of the period to sample data from. Supports both date times and relative intervals. The default behavior is to start one day ago ('*-1d').

End time

The end time of the period to sample data from. Supports both date times and relative intervals. The default behavior is to sample data until the moment the operator is executed ('*').

Time zone

Specifies the time zone to use for evaluating the given start and end time.

Filter expression

An optional filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute.

Time interval

The sampling interval. The default is '1h'.