Previous 7.7 Chart templates Next

7.7.1 chart

From the chart section only one may exist thus its name may not be followed by a number. This section contains the default settings of the base chart created by the template and the variables which modifies the execution of the template.

 

There are two main cases when creating a chart template:

·       There will be maximum one chart per equipment based on this template. In this case the usage of the global_regexp and chart_name parameters are not recommended. For example: Unix/Linux Load factor

·       There will be multiple charts per equipment based on this template. In this case the global_regexp and chart_name parameters must be used: the application will look at all the possible measurement names and build all the possible chart names from them using these two parameters and it will also create all possible charts. For example: Oracle tablespace MByte

 

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

Can appear on the user interface:

The possible values of the template

  • <input> In this case the same field will appear during the creation process as during normal creation
  • <input;default value> In this case the same field will appear during the creation process as during normal creation, but its default value becomes the one defined here.
  • Other case: In this case no field appears and the value will be the value defined in the template.

Fields of this type:

  • ylegend: The metric unit of the chart, namely the title of the Y axis. Must be specified.
  • min_value: The minimum value of the chart: either a number or a number followed by the percent sign. If not specified then the system handles it as it was defined with the empty value thus the minimum value will be 0.
  • max_value: The maximum value of the chart: either a number or a number followed by the percent sign. If not specified then the system handles it as it was defined with empty value thus the maximum will be automatically the same value as seen at normal charts
  • max_displayed: The maximum number of chart elements displayed
  • other_color: The color of the Others element if not all of the elements are displayed on the chart. The value must be in the format #RRGGBB. If not specified then the application uses the default grey color
  • summary: Defines whether the chart should contain a summary with the sum of the variables. The possible default or non input field value can be 0 or 1. As it is described at chart modification, summary is only available if the chart base of every chart member is the value of the previous variable (base field in the member section), thus the value defined here is also overridden during chart creation if the chart base of any of the members is the chart base of the previous member. If unspecified, then the system handles it as it was defined with the 0 value, i.e. there will be no summary created.
  • help_url: The help page URL assigned to the chart

Cannot appear on the user interface:

In this case the template contains fix values which cannot be altered during the creation from the template. The fields are:

  • global_regexp: Optional regular expression filtering on the name of the measurements which can be put on the chart. The regular expression match groups (the “(“ and “)” characters) can be used in naming the chart
  • chart_name: The name of the chart to be created. If it is not specified then the application uses the name <name of the equipment> + <name of the template>. There are two types of variables which can be used in the name:
    • <equip>: name of the equipment
    • <global_regexp_N>: the Nth regular expression match group from the global_regexp parameter
  • minimum: At least how many measurements must be found by the system in order to apply the template. If not specified, then its value is 0
  • maximum: The maximum number of measurements the system searches for the chart. If not specified, then its value is 50
  • need_confirm: If its value is 1 then the system will show the measurements which it found for the chart and the user may exclude the ones which he finds unnecessary. If it is 0, then the chart is created instantly. Its default value is 1
  • remove_common_prefix: If its value is 1 then the system strips the identical text of full words from the beginning of each of the chart names; if its value is 2 then it strips all matching text; and if its value is 0 then it does not change anything. Example: if two member names are defined as AAA BBB1 and AAA BBB2 then in case of value 1 they are changed to BBB1 and BBB2, and in case of value 2 they are changed to 1 and 2, respectively. If it is not defined, then its value is 1
  • remove_common_postfix: If its value is 1 then the system strips the identical text of full words from the end of each of the chart names; if its value is 2 then it strips all matching text; and if its value is 0 then it does not change anything. Example: if two member names are defined as 1BBB AAA and 2BBB AAA then in case of value 1 they are changed to 1BBB and 2BBB, and in case of value 2 they are changed to 1 and 2, respectively. If it is not defined, then its value is 1
  • colors: When creating instances the system will use these colors. The colors are always taken from the list, if all values are used up then using the colors again from the beginning of the list. One member requires one color if no peak is drawn otherwise two. If no values are defined here, then the colors are taken from the general configuration (as they appear on the chart template configuration page). The colors can be defined by a comma separate list of color codes in the format of #RRGGBB, i.e. the hexadecimal values of red-green-blue tones

 

Example:

[chart]

#The unit can be modified but by default it is Bits per Second

ylegend=<input;Bits per Second>

#The minimum of the chart is 0 as if this line would not exist

min_value=

#The system must find at least 1 measurement

minimum=1

#It uses only blue and green colors

colors=#0000FF,#00FF00