Data reference parameters that specify values to return
- Last UpdatedDec 13, 2024
- 1 minute read
- PI System
- PI Server 2018
- PI Server
Configuration strings for PI point data references can include optional parameters that specify the value that the data reference returns. The following table lists available parameters:
|
Parameter |
Syntax |
Example |
Default |
|---|---|---|---|
|
TimeMethod |
TimeMethod=time_method where time_method is one of:
|
TimeMethod=Automatic |
Automatic |
|
RelativeTime |
RelativeTime=[*] +|- integertime_unit where time_unit is one of:
|
RelativeTime=-1h |
N/A |
|
TimeRangeMethod |
TimeRangeMethod=method_name where method_name is one of
|
TimeRangeMethod=Total |
EndTime |
|
TimeRangeMinPercentGood1 |
TimeRangeMinPercentGood= percentage |
80 |
|
|
CalculationBasis1 |
CalculationBasis= calculation_basis where calculation_basis is one of:
|
TimeWeighted |
|
|
RateConversion2 |
RateConversion=uom where uom is a defined unit of measure |
RateConversion=minute |
day |
|
UOM |
UOM=uom where uom is a defined unit of measure |
UOM=°C |
Attribute's Default UOM |
|
ReadOnly |
ReadOnly=boolean where boolean is one of:
|
ReadOnly=false |
true |
1 Used when specifying TimeRangeMethod.
2 Used only when .