7.5.1 equipment

The equipment is the only section that can have only one copy in the expression, i.e. it cannot have a numbers after its name.

The section variables:

·       strict=1: If this line is present and an equipment is modified using this template and it has measurements which are not in this template then PVSR deletes them

·       description: Equipment description field. The possible values:

o   In this case the same Equipment description field is going to appear during the creation process as during normal creation

o   <input;default value> In this case the same field is going to appear during the creation process as during normal creation, but its default value becomes the one defined here

o   Other cases: In this case no field appears and the value is going to be the value defined in the template. In this case the <name> value can be used, which the application is going to substitute automatically with the value in the template. Example: if its value is “<name> equipment”, and the created equipment is Test, the description becomes “Test equipment”.

If it is not specified in the template, the system considers it as <input>

·       retention: For how long should the non summarized data be stored. Possible values:

o   <input> In this case the same “Keep collected data for days” field is going to appear during the creation process as during normal creation

o   <input;default value> In this case the same “Keep collected data for days” field is going to appear during the creation process as during normal creation, but its default value becomes the one defined here.

o   Other cases: In this case no field appears and the value is going to be the value defined in the template.

If it is not specified in the template, the system considers it automatically the value used in normal equipment creation

·       interval: Basic measurement interval. Possible values:

o   <input> In this case the same measurement interval field is going to appear during the creation process as during normal

o   <input;default value> In this case the same basic measurement interval field is going to appear during the creation process as during normal creation, but its default value becomes the one given here in seconds

o   Other cases: In this case no field appears and the value is going to be the value defined in the template. Here, the value should also be given in seconds. If the system does not know the specified value, the default value is used instead.

If it is not specified in the template, the system selects the first choice automatically

·       timeout: Possible values:

o   <input> In this case the same timeout field is going to appear during the creation process as during normal creation, filled as blank.

o   <input;default value> In this case the same timeout field is going to appear during the creation process as during normal creation, but its default value becomes the one given here in seconds.

o   Other cases: In this case no field appears and the value is going to be the one defined in the template. In this case too the value should be given in seconds. If the system does not know the specified value, the default value is used instead.

If it is not specified in the template, the system selects the second choice automatically, the default value given in the CONFIG_INI – or if it is not specified, then 5 – already selected in case of SNMP, or with the blank value for non-SNMP data collectors.

·       retries: Possible values:

o   <input> In this case the same retries field is going to appear during the creation process as during normal creation, as blank values.

o   <input;default value> In this case the same retries field is going to appear during the creation process as during normal creation, but with the number specified as the default count

o   Other cases: In this case no field appears and the value is going to be the value defined in the template. Also in this case the value should be given by the piece. If the system does not know the specified value, the default value is used instead.

If it is not specified in the template, then the system selects the second choice automatically, the default value given in CONFIG_INI – or if it is not specified, then 1 – already selected in case of SNMP, or with the lank value for non-SNMP data collectors.

·       timezone: Possible values:

o   <input> In this case the same time zone selection field is going to appear during the creation process as during normal creation.

o   <input;default value> In this case the same time zone selection field is going to appear during the creation process as during normal creation, but with the specified default value; the value has to be the ID of a time zone configured in the system

o   Other cases: In this case no field appears and the value is going to be the value defined in the template. Also in this case the value has to be the ID of a time zone configured in the system. If the system does not know the specified value, then an error message is displayed.

If it is not specified in the template, then the system selects the second choice automatically.

·       business_hours: Possible values:

o   <input> In this case the same business hours selection field is going to appear during the creation process as during normal creation.

o   <input;default value> In this case the same business hours selection field is going to appear during the creation process as during normal creation, but with the specified default value; the value has to be the ID of a business hours configured in the system

o   Other cases: In this case no field appears and the value is going to be the value defined in the template. Also in this case the value has to be the ID of a business hours configured in the system. If the system does not know the specified value, then an error message is displayed.

If it is not specified in the template, then the system selects the second choice automatically.

·       icon: what kind of icon should there be used on the user interface. Possible values:

o   <input> In this case the same pull down list field is going to appear during the creation process as during normal creation

o   <input;default value> In this case the same pull down list field is going to appear during the creation process as during normal creation. However, by default, the icon specified by the default value is selected.

o   Other cases: In this case no field appears and the value is going to be the value defined in the template.

If it is not specified in the template, the system selects the first choice automatically.

The other parameters depend on whether the data collector is of an SNMP or a non-SNMP type. For SNMP the additional parameters are:

·       community: Community string of the equipment. Possible values:

o   <input> In this case the same Community field is going to appear during the creation process as during normal creation

o   <input;default value> In this case the same Community field is going to appear during the creation process as during normal creation, but its default value becomes the one defined here.

o   Other cases: In this case no field appears and the value is going to be the value defined in the template.

If it is not specified in the template, the system considers it as <input;public>

·       version: SNMP version. Possible values:

o   <input> In this case the same SNMP version field is going to appear during the creation process as during normal creation, with blank value

o   <input;default value> In this case the same SNMP version field is going to appear during the creation process as during normal creation. However, the specified default value part is selected. Possible values are 1 and 2

o   In other cases no field appears and the value is going to be the value defined in the template. Also in this case, the value can be 1 and 2. If the system does not know the given value, the default value is used instead.

If it is not specified in the template, the system selects the second choice automatically, the default value given in CONFIG_INI – or if it is not specified, then version 2.

In case of non-SNMP, additional parameters are the codes of the additional parameters in the definition of the data collector (see the description of the data collector, or in general: 7.5.6 on Parameters of non-SNMP data collectors). For each of the additional parameters, the possible values, similarly to the ones above, are:

·       <input> In this case the same field is going to appear during the creation process as during normal creation, with the default value given in the parameter definition

·       <input;default value> In this case the same field is going to appear during the creation process as during normal creation. However, by default, the default value is not the one in the definition but the one specified here. In case of a selection list parameter (e.g. the permission parameter in a pull down menu for the Oracle data collector) it is important to select a value from the list of permissible value codes (see the description of the data collector, or in general: 7.5.6 on Parameters of non-SNMP data collectors)

·       Other cases: In this case no field appears and the value is going to be the one defined in the template. Similarly, in case of a selection list parameter it is also important to select a value from the list of permissible value codes

If there is no field in the template definition, then its value in the template:

·       In case of a mandatory parameter: <input>

·       In case of a optional parameter having a default value: the default value

·       In other cases: it does not appear and has no value

An example for SNMP equipment definition:

[equipment]

#Beside name and address two more fields are to be displayed

description=<name> equipment

community=<input;public>

retention=100

#10-minute measurement period

interval=<input;600>

#SNMP version 1

version=1

#10 second timeout by default

timeout=<input;10>

An example for Oracle equipment definition:

[equipment]

description=<name> equipment

ORA EQ 1 CONN=<input>

ORA EQ 2 USER=<input;system>

#ORA EQ 3 PASSWORD is not specifid, but mandatory,

#therefore it is not displayedi

ORA EQ 4 SYS=<input;NORMAL>

retention=100

#with 1 minute measurement cycle

interval=<input;60>