AVEVA™ BI Gateway

ProcessValues

Save PDF

ProcessValues

Save PDF

Last UpdatedFeb 05, 2024
4 minute read

This Azure function custom query returns the process values for the given tags. The custom query expression supports the following parameters:

Parameter Name	Parameter Choice	Example	Description
QueryName	Required	ProcessValues	Azure function query name
SelectColumn	Optional	["*"] Or ["FQN", "DateTime", "OpcQuality", "Text", "Value"]	Option to pick required properties from AVEVA Insight.
Tag	Optional	{ "Filter": "startswith(Location,'/Lake')", "Select": ["FQN"] }	The Tag expression is used to apply a filter on the tags. The Filter parameter is used to apply a filter on the tags. The Select parameter is used to specify the property name that could be used in the tag filter. If extended property is used in the filter, then it is must to specify in the select.
StartDateTime	Optional	"[RequestedStartTime]"	Any valid UTC date time value. To leverage [RequestedStartTime] parameter for populating a time defining dimension, you must enable incremental update feature for the dimension. For more information, see Configure an incremental update for a dimension.
EndDateTime	Optional	"[RequestedEndTime]"	Any valid UTC date time value. This datetime value should be greater than "StartDateTime". To leverage [RequestedEndTime] parameter for populating a time defining dimension, you must enable incremental update feature for dimension. For more information, see Configure an incremental update for a dimension.
RetrievalMode	Optional	Average Cyclic Integral Delta Counter Full	Retrieval mode of the query. For more information about retrieval modes, see the AVEVA Insight Online Help.
Expression	Optional	"UOM(hl/min)" or "UOM(t/h)"	Any valid Engineering Unit. This is used to convert the destination Engineering Unit. Ensure that you use the Tag parameter in the query to support the Engineering Unit conversion. For more information about Engineering Units, see the AVEVA Insight Online Help.

The following properties are returned from the Azure function query for "ProcessValues".

Property Name	Datatype	Description
FQN	String	Fully qualified name. A fully qualified name uses the format: datasource.tagname.
DateTime	DateTime	Value recorded date time.
OpcQuality	Int32	Tag quality.
Text	String	Text value of the tag.
Value	Double	Value of the tag.
Unit	String	Engineering Unit

CQProcessValues

This Azure custom query returns the process value of the tags based on the query expression.

Note: This custom query is supported to ensure backward compatibility.

The custom query expression supports the following parameters.

Parameter Name	Parameter Choice	Example	Description
QueryName	Required	CQProcessValues	Azure function query name
SelectColumn	Optional	["*"] Or ["FQN","DateTime","OpcQuality", "Text","Value"]	Option to pick required properties from AVEVA Insight
Tag	Optional	{ "Filter": "startswith(Location,'/Lake')", "Select": ["FQN"] }	The Tag expression is used to apply a filter on the tags. The Filter parameter is used to apply a filter on the tags. The Select parameter is used to specify the property name that could be used in the tag filter. If extended property is used in the filter, then it is must to specify in the select.
StartDateTime	Optional	"[RequestedStartTime]"	Any valid UTC date time value. To leverage [RequestedStartTime] parameter for populating a time defining dimension, you must enable incremental update feature for dimension. For more information, see Configure an incremental update for a dimension.
EndDateTime	Optional	"[RequestedEndTime]"	Any valid UTC date time value. This datetime value should be greater than "StartDateTime". To leverage [RequestedEndTime] parameter for populating a time defining dimension, you must enable incremental update feature for dimension. For more information, see Configure an incremental update for a dimension.
RetrievalMode	Optional	Average Cyclic Integral Delta Counter Full	Retrieval mode of the query.
Resolution	Optional	3000	A valid numeric value in milliseconds
Expression	Optional	"UOM(hl/min)" Or "UOM(t/h)"	Any valid Engineering Unit. This is used to convert the destination Engineering Unit. Ensure that you use the Tag parameter in the query to support the Engineering Unit conversion. For more information about Engineering Units, see the AVEVA Insight Online Help.

For more information about the supported Filter expressions, see the "Query Expression Operator" section.

The following properties are returned from the Azure function query for "CQProcessValues".

Property Name	Datatype	Description
FQN	String	Fully qualified name. A fully qualified name uses the format: datasource.tagname.
DateTime	DateTime	Value recorded date time.
OpcQuality	Int32	Tag quality.
Text	String	Text value of the tag.
Value	Double	Value of the tag.

CQProcessValuesSameDataSet

This Azure custom query returns the process value of the tags that belong to a given source.

Note: This custom query is supported to ensure backward compatibility.

The custom query expression supports the following parameters.

Parameter Name	Parameter Choice	Example	Description
QueryName	Required	CQProcessValuesSameDataSet	Azure function query name.
SelectColumn	Optional	["*"] Or ["FQN","DateTime","OpcQuality","Text","Value"]	Option to pick required properties from AVEVA Insight.
Source	Optional	AVEVA Insight Datasource Name	The tag source.

Parameter Name

Parameter Choice

Example

Description

QueryName

Required

CQProcessValuesSameDataSet

Azure function query name.

SelectColumn

Optional

["*"]

Or ["FQN","DateTime","OpcQuality","Text","Value"]

Option to pick required properties from AVEVA Insight.

Source

Optional

AVEVA Insight Datasource Name

The tag source.

The following properties are returned from the Azure function query for "CQProcessValuesSameDataSet".

Property Name	Datatype	Description
FQN	String	Fully qualified name. A fully qualified name uses the format: datasource.tagname.
DateTime	DateTime	Value recorded date time.
OpcQuality	Int32	Tag quality.
Text	String	Text value of the tag.
Value	Double	Value of the tag.

CQProcessValuesTagTypes

This Azure custom query returns the process value of the tags based on the given tag type.

Note: This custom query is supported to ensure backward compatibility.

The custom query expression supports the following parameters.

Parameter Name	Parameter Choice	Example	Description
QueryName	Required	CQProcessValuesTagTypes	Azure function query name
SelectColumn	Optional	["*"] Or ["FQN","DateTime","OpcQuality", "Text","Value"]	Option to select required properties from AVEVA Insight
TagType	Optional	Analog or Discrete or String	Type of tag.

Parameter Name

Parameter Choice

Example

Description

QueryName

Required

CQProcessValuesTagTypes

Azure function query name

SelectColumn

Optional

["*"]

Or ["FQN","DateTime","OpcQuality", "Text","Value"]

Option to select required properties from AVEVA Insight

TagType

Optional

Analog or Discrete or String

Type of tag.

The following properties are returned from the Azure function query for "CQProcessValuesTagTypes".

Property Name	Datatype	Description
FQN	String	Fully qualified name. A fully qualified name uses the format: datasource.tagname.
DateTime	DateTime	Value recorded date time.
OpcQuality	Int32	Tag quality.
Text	String	Text value of the tag.
Value	Double	Value of the tag.

AVEVA™ BI Gateway

ProcessValues

Table of Contents

ProcessValues

CQProcessValues

CQProcessValuesSameDataSet

CQProcessValuesTagTypes

In This Topic

Related Links