%HI_SetLogDBByMask function


Function
The function %HI_OpenLogDBByMask sets the parameters for viewing data from the log database in the displayer of the Logging type (control function).
Declaration
%HI_OpenLogDBByMask(
   INT in refId,
   TEXT in mask, 
   TEXT in skupinaMask, 
   INT in priorityMask, 
   BOOL in bASC, 
   INT in pageLen, 
   INT in intervalType 
   [, HBJ in refToLG1, ...]
 ) 

or
Declaration
%HI_OpenLogDBByMask(
   INT in refId,
   TEXT in mask, 
   TEXT in skupinaMask, 
   INT in priorityMask, 
   BOOL in bASC, 
   INT in pageLen, 
   TIME in bt, 
   TIME in et
   [, HBJ in refToLG1....]
 )
Parameters
refIdReference to the displayer of the Logging type.
maskMask (in the dialog box System logging - settings).
groupMaskFilter for events source.
priorityMaskEvent type filter.
bASCOrder:
  • @TRUE - ascending
  • @FALSE - descending
pageLenPage size within the interval of 5 ... 200.
intervalTypeTime interval for browsing events. Possible values:
  • 1  - last hour
  • 8  - last 8 hours
  • 12 - last 12 hours
  • 24 - last 24 hours
btBeginning time (when you define other time interval than the intervals defined by the parameter intervalType).
etEnd time (when you define other time interval than the intervals defined by the parameter intervalType).
refToLG1, ...References to logical groups.
Description

The function parameters copy the behaviour of corresponding dialog box for opening the log database when you browse events for the objects matching given mask.

The parameter groupMask represents the filter for events source. It must be other than 0 and must be the sum of the values of the predefined variables _LOG_PRTY_*.

The parameter priorityMask represents the filter for Event type. It must be other than 0 and must be the sum of the values of the predefined variables _LOG_PRTY_*.

The parameter intervalType is INT type and allows to define the time interval for browsing events.

To define other time interval use the parameters bt and et of the Absolute time type.

Objects matching the selection condition mask can be further filtrated by their membership in logical groups using the optional parameters refLG1, refLG2, ....

Example
%HI_SetLogDBByMask(_displayer, "*s*", _LOGF_LOGONLOGOFF, _LOG_PRTY_INFO, @TRUE, 20, 8, AI_1_KB03\HBJ)
Note
The parameter mask may be replaced by a content of XML file representing an extended filter. The filter filtrates all the text columns in the log database.
ROOT element contains the column names together with the filter conditions. Each element which represents the filter condition can also contain an attribute strict. This attribute defines if the filtering in some column is necessary.

The rules for elements which represent the filter conditions:

  • name, descript, person, oldvalue, newvalue or comment are the reserved elements,
  • ROOT element must not contain other elements than reserved one,
  • each reserved element can occur only once,
  • if the reserved element is not in XML file it does not belong to filter,
  • if attribute strict has not been defined for the element or it has a different value than "off", then it is always "on"
  • the records must conform to all the elements containing the attribute strict "on" and at least to one element containing the attribute strict "off" (if it exists),
  • the filter condition in element enables the same syntax as mask.
Example: XML file

<?xml version="1.0" encoding="utf-8" ?>
  <ROOT>
    <name strict="on">!TF2\.<\name>
    <descript strict="off">SystemD2000*<\descript>
    <oldvalue strict="off">Run<\oldvalue>
  <\ROOT>

may be assembled according to this example.

Napíšte komentár