Previous 7.7 Chart templates Next

7.7.2 member_group

This section may occur more than once, it is processed according to its numbering. It is only recommended to use more sections if we want to show multiple kinds of quantities on the same chart. If we only want to display more measurements on the same chart, then it is recommended to use more member variables. The section controls the properties of displayed measurements on the chart, for example line or bar, which measurements should be selected and what names they should be displayed with on the chart, etc. Most of the variables mentioned here are fully described in the chart template configuration chapter.

 

The variables of this section can be divided into two groups:

Can appear on the user interface:

These fields can be used to narrow down the measurements. The possible values in the template:

  • <input> In this case at the creation of the chart the field appears and it is possible to filter by it. If a field does not appear in the template, then this is its default value
  • <input;default value> In this case at the creation of the chart the filter field appears and filled with the default value specified here
  • Other case: In this case the field does not appear, and the value will be the one defined in the template. If a value is specified there, then the filtering is performed, otherwise not.

Such types of fields are:

  • site_filter: can be used to filter by the site containing the measurement at any level
  • equip_filter: can be used to filter by the equipment containing the measurement
  • obj_name_filter: can be used to filter by the measurement

If the creation of the chart is done from a site page, then the system handles the site_filter value as empty irrespectively of the configuration; if it is done from the device page then the site_filter and equip_filter are handled by the system as empty irrespectively of the configuration. If the chart creation is done automatically then PVSR takes the value of both fields into consideration.

The filtering is performed in all cases similar to the "Searching for equipments" and "Measuring multiple equipments" menu items: the % character matches any characters and the _ character matches a single arbitrary character.

 

Cannot appear on the user interface:

These fields control the naming, order, etc. of the measurements on the chart. The possible fields:

  • member_NUMBER: This field may occur more than once, each controls the first or second (input or output in case of traffic) result of measurements. Each member must have a unique number inside each member_group. The value of the field consists of maximum three point separated subfields from which only the first is mandatory, the others have default values if they are omitted:
    • The identifier of the measurement type: F interface traffic, H interface error, C interface carrier up/down. For other measurements it consists of the letter O and the identifier of the measurement template; i.e. the identifier of the basic SNMP based CISCO memory load is CM, thus OCM should be specified
    • Whether the first or second measurement value should be defined. For first the IN, for the second the OUT strings should be specified, if omitted then the IN value is used
    • The direction/subname of the selected first or second value. If not defined then for IN the value will default to in, and for OUT the value will default to out. This value is used in the member_direction variable for chart member naming (see below)
  • obj_name_parse: The name of the founded measurement can be parsed into elements by it. The value of the field is a regular expression which must fit to the full name of the measurement. The role of this field is dual: firstly the chart will not contain measurements that do not fit the regular expression, and secondly from the match the individual name elements can be used separately for the specification of the chart name and of the order of members inside the member group. For example: if the name of two measurements are AAA BBB1 and AAA CCC123 and the value of the field is.+ CCC(\d+), then the first measurement won't appear on the chart and for naming and ordering the number 123 can be used separately in the second case. If no value is specified, then no regular expression is matched and this is the default case if this field does not appear in the template
  • member_name: This will be the name of the chart. Arbitrary field may be given, or rather many kinds of variables exist which are substituted by the system automatically. These variables must always be enclosed between the < and > characters:
    • site: the name of the site
    • equip: the name of the equipment
    • obj_name: the name of the measurement
    • member_descr: the discovered name of the measurement (Name in the equipment parameter on the Site and equipment configuration page)
    • member_port: the index parameter of the measurement
    • member_type: the type of the measurement: Traffic, Error, for carrier or other measurements the type name of the measurement
    • member_direction: the direction of the measurement, see at the member_NUMBER field
    • obj_name_parse_NUMBER: The text element of the given number defined by the matching regular expression, the numbering starts from 1
    • member_count: The value of NUMBER from the member_NUMBER field

Example: if the value of the filed is <site> <equip> <obj_name_parse_1>, and the obj_name_parse field and the name of the measurement is the example described at the previous field, the name of the equipment is EQUIPMENT, and the name of the site is SITE, then the name of the chart member will be SITE EQUIPMENT 123. Of course the name designed this way can be modified by the system according to the remove_common_prefix and remove_common_postfix fields described in the chart section. For example, if the value for the remove_common_prefix is 1 and the chart configuration was started from the equipment configuration or the measurement view, then the SITE EQUIPMNET part will disappear from the name of the measurement if there were at least two hits. If the member_name field does not appear in the template, then its value will be “<obj_name> <member_direction>”.

  • order: This controls the order of chart members. More ordering fields can be supplied and the ordering will be performed in the order of the fields. The default ordering direction is ascending, which can be reversed by the desc attribute following the field value separated from it by a space (the space delimiter plus the asc attribute is also permitted, but it is implicitly the same as the default order). The ordering can be defined using any of the variables which can occur in the member_name field or by the member_name field itself (if not defined, then this is the default). The ordering is done text based except for the member_count variable, for which it is performed numerically. For example: order=obj_name_parse_1,obj_name_parse_2,member_count
  • chart_type: The type of the member which is either a line (L), area (A) or bar (B), the default is area (A).
  • base: What the chart base of the member should be. In case of the previous chart base Z, in case of the previous value V must be specified. V is the default value
  • with_peak: If it is 1, then there will be a peak; if 0, then not (the default value)
  • zero_value: If its value is 0, then in case of missing data the last value is “drawn further”; if it is 0, then not (the default)
  • transparent: If the value is 1, then the chart element will be transparent