Promotic
WikipediaLinkedInYoutubeTwitterFacebook

GetDataFilter - method of the PmgAlarmStateViewer object

Description:
Returns single item or all items of the filtering string.
Syntax:
String GetDataFilter(String sWhat)
Parameters:
sWhat(String) Obtained information type.
all - complete filtration string in the KeyVal format
viscols - complete filtration string in the KeyVal format except for items regarding the state (displayed independently by colour buttons)
state - filter of all states separated by commas
state.0 - state filter inactive acknowledged (green)
state.1 - state filter inactive unacknowledged (blue)
state.2 - state filter active acknowledged (yellow)
state.3 - state filter active unacknowledged (red)
area - state filter area
source - state filter source
desc - state filter desc
comment - state filter comment
priority - state filter priority (0-10)
Return values:
The filtering string of returned value depends on the type of obtained information sWhat. for all complete filtration string in the KeyVal format (see Filtering string):
"state:xx;" (optional) - (states only) Display alarms whose state equals to the state xx. Multiple states separated by comma can be entered. For example "state:3,2,1;".
"hoot:xx;" (optional) - (states only) Display alarms by sound notification, where xx:
0 = alarms sounding
1 = alarms not sounding
"area:#oper:xx;" (optional) - Show alarms with area observing the defined operation #oper:xx. The part of filter dependent on user setting in the alarm viewer. For example "area:BoilerPlant1;" or "area:#eq:BoilerPlant1;" or "area:#eq:BoilerPlant1#or:BoilerPlant2;" or "area:#begin:BoilerPlant;".
"source:#oper:xx;" (optional) - Show alarms with source observing the defined operation #oper:xx. The part of filter dependent on user setting in the alarm viewer. For example "source:Boiler;" or "source:#eq:Boiler;" or "source:#eq:Boiler1#or:Boiler2;" or "source:#begin:Boiler;".
"desc:#oper:xx;" (optional) - Show alarms with description (desc) observing the defined operation #oper:xx. The part of filter dependent on user setting in the alarm viewer. For example "desc:FIQ101;" or "desc:#eq:FIQ101;" or "desc:#eq:FIQ101#or:FIQ102;" or "desc:#begin:FIQ;".
"comment:#oper:xx;" (optional) - Show alarms with comment observing the defined operation #oper:xx. The part of filter dependent on user setting in the alarm viewer. For example "comment:correction;" or "comment:#eq:correction;" or "comment:#eq:correction#or:test;" or "comment:#begin:correction;".
"priority:#oper:xx;" (optional) - Display alarms whose priority complies with the operation #oper:xx. The part of filter dependent on user setting in the alarm viewer. For example "priority:5;" or "priority:#eq:5;" or "priority:#le:5;" or "priority:#ge:5;".
Example:
JavaScriptVBScriptSelect and copy to clipboard

var oViewer = pMe.Items("/Viewer");
var sFilter = oViewer.GetDataFilter("viscols");

History:
Pm9.00.00: Created
PROMOTIC 9.0.13 SCADA system documentation - MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice