J. Ritchie CarrollUpdate FilterExpressions.md131991f9 years agoHistory

344 lines · 9.0 KB · MarkdownRaw Download

Filter Expressions

Filter expressions can be used to filter inputs and outputs for streams, subscribers and adapters. This syntax is similar to a SQL WHERE clause, but does not implement the full SQL language. See DataTable.Select() for more information.

Filtering Syntax

FILTER <TableName> [TOP n] WHERE <Expression> [ORDER BY <SortField>]

Available Options and Clauses

Keyword	Example	Description	Required?
FILTER	See Examples	Starts the filter expression	Yes
TOP n	TOP 100	Selects only the first number of items	No
WHERE <Expression>	WHERE SignalType='FREQ'	Uses DataTable.Select(string)	Yes
ORDER BY <ColumnName>	ORDER BY SignalType	Uses DataTable.Select(string, string)	No

Examples

An example input filter to only pass measurements with the company of GPA and type of Frequency(FREQ).

inputMeasurementKeys = {
    FILTER ActiveMeasurements WHERE Company='GPA' AND SignalType='FREQ' ORDER BY ID
};

An example input filter to only pass first 20 Statistics(STAT) measurments.

inputMeasurementKeys = {
    FILTER TOP 20 ActiveMeasurements WHERE SignalType = 'STAT'
};

An example output filter to only send Current Angle and Voltage Angle for the Positive Sequence(+) measurments.

outputMeasurements = {
    FILTER ActiveMeasurements WHERE SignalType IN ('IPHA','VPHA') AND Phase='+' ORDER BY PhasorID
};

See more examples of allowed DataTable.Select() syntax.

Available Table Definitions

Available table defintions are defined in the ConfigurationEntity table of the host Time-Series Library application configuration database.

For selection of input and output measurements for adapters, ActiveMeasurements is the most common source. Other commonly defined tables are listed here for reference as well.

ActiveMeasurements
ActionAdapters
Alarms
ConfigurationDataSet
ConfigurationEntity
InputAdapters
InputStreamDevices
MeasurementGroupMeasurements
MeasurementGroups
NodeInfo
OutputAdapters
OutputStreamDevicePhasors
OutputStreamDeviceAnalogs
OutputStreamDeviceDigitals
OutputStreamDevices
OutputStreamMeasurements
Statistics
SubscriberMeasurementGroups
SubscriberMeasurements
Subscribers

ActiveMeasurements

ColumnName	DataType
SourceNodeID	Guid
ID	string
SignalID	Guid
PointTag	string
AlternateTag	string
SignalReference	string
Internal	int
Subscribed	int
Device	string
DeviceID	int
FramesPerSecond	int
Protocol	string
ProtocolType	string
SignalType	string
EngineeringUnits	string
PhasorID	int
PhasorType	string
Phase	string
Adder	double
Multiplier	double
Company	string
Longitude	Decimal
Latitude	Decimal
Description	string
UpdatedOn	DateTime

ActionAdapters

ColumnName	DataType
ID	int
AdapterName	string
AssemblyName	string
TypeName	string
Connectionstring	string

Alarms

ColumnName	DataType
ID	int
TagName	string
SignalID	Guid
AssociatedMeasurementID	Guid
Description	string
Severity	int
Operation	int
SetPoint	double
Tolerance	double
Delay	double
Hysteresis	double
LoadOrder	int
Enabled	bool
CreatedOn	DateTime
CreatedBy	string
UpdatedOn	DateTime
UpdatedBy	string

Alarm Severity Values

Value	Acronym	Description
0	None	Alarm is of no importance
50	Info	Alarm is informative, but not dangerous
150	Low	Alarm is not very important
300	MedLow	Alarm is somewhat important
500	Med	Alarm is moderately important
700	MedHigh	Alarm is important
850	High	Alarm is very important
900	Range	Alarm for a value that is unreasonable
950	Critical	Alarm signifies a dangerous situation
980	FlatLine	Alarm value is latched
1000	Error	Alarm reports bad data

ConfigurationDataSet

ColumnName	DataType
Version	string

ConfigurationEntity

ColumnName	DataType
SourceName	string
RuntimeName	string
Description	string
LoadOrder	int
Enabled	bool

InputAdapters

ColumnName	DataType
ID	int
AdapterName	string
AssemblyName	string
TypeName	string
Connectionstring	string

InputStreamDevices

ColumnName	DataType
ParentID	int
ID	int
Acronym	string
Name	string
AccessID	int

MeasurementGroupMeasurements

ColumnName	DataType
MeasurementGroupID	int
SignalID	Guid
CreatedOn	DateTime
CreatedBy	string
UpdatedOn	DateTime
UpdatedBy	string

MeasurementGroups

ColumnName	DataType
ID	int
Name	string
Description	string
FilterExpression	string
CreatedOn	DateTime
CreatedBy	string
UpdatedOn	DateTime
UpdatedBy	string

NodeInfo

ColumnName	DataType
Name	string
CompanyName	string
Longitude	Decimal
Latitude	Decimal
Description	string
ImagePath	string
Settings	string
MenuType	string
MenuData	string
Master	bool
Enabled	bool

OutputAdapters

ColumnName	DataType
ID	int
AdapterName	string
AssemblyName	string
TypeName	string
Connectionstring	string

OutputStreamDevicePhasors

ColumnName	DataType
OutputStreamDeviceID	int
ID	int
Label	string
Type	string
Phase	string
ScalingValue	int
LoadOrder	int
CreatedOn	DateTime
CreatedBy	string
UpdatedOn	DateTime
UpdatedBy	string

OutputStreamDeviceAnalogs

ColumnName	DataType
OutputStreamDeviceID	int
ID	int
Label	string
Type	int
ScalingValue	int
LoadOrder	int
CreatedOn	DateTime
CreatedBy	string
UpdatedOn	DateTime
UpdatedBy	string

OutputStreamDeviceDigitals

ColumnName	DataType
OutputStreamDeviceID	int
ID	int
Label	string
MaskValue	int
LoadOrder	int
CreatedOn	DateTime
CreatedBy	string
UpdatedOn	DateTime
UpdatedBy	string

OutputStreamDevices

ColumnName	DataType
ParentID	int
ID	int
IDCode	int
Acronym	string
BpaAcronym	string
Name	string
PhasorDataFormat	string
FrequencyDataFormat	string
AnalogDataFormat	string
CoordinateFormat	string
LoadOrder	int

OutputStreamMeasurements

ColumnName	DataType
AdapterID	int
Historian	string
PointID	int
SignalReference	string

Statistics

ColumnName	DataType
ID	int
Source	string
SignalIndex	int
Name	string
Description	string
AssemblyName	string
TypeName	string
MethodName	string
Arguments	string
IsConnectedState	bool
DataType	string
DisplayFormat	string
Enabled	bool

SubscriberMeasurementGroups

ColumnName	DataType
SubscriberID	Guid
MeasurementGroupID	int
Allowed	bool
CreatedOn	DateTime
CreatedBy	string
UpdatedOn	DateTime
UpdatedBy	string

SubscriberMeasurements

ColumnName	DataType
SubscriberID	Guid
SignalID	Guid
Allowed	bool
CreatedOn	DateTime
CreatedBy	string
UpdatedOn	DateTime
UpdatedBy	string

Subscribers

ColumnName	DataType
ID	Guid
Acronym	string
Name	string
SharedSecret	string
AuthKey	string
ValidIPAddresses	string
RemoteCertificateFile	string
ValidPolicyErrors	string
ValidChainFlags	string
AccessControlFilter	string
Enabled	bool
CreatedOn	DateTime
CreatedBy	string
UpdatedOn	DateTime
UpdatedBy	string