Using XRatel Server Config

[ Main Window | Scan Devices | Device Config | Group Settings | Probes | Probe View Settings | Profile Management |

MIB Management | License and Activation ]

       XML Configuration File

 Configuration File

When running the Report Agent in the command line, you can use a xml configuration file to configure the report. To use it, the agent must be called in the command line with three parameters, which are:

[Report Label] -f [Configuration Filename]

In this case, you shall inform the Report Label, which should be the name of the node with the report's configuration in the xml file. See the following example of the command line call:

C:\Program Files\XRatel Performance Suite\Report\XRReportAgent.exe ResponseTimeTest -f C:\Config.xml

Attention: Any parameter with spaces must be given in inverted commas. Also, as xml requires, the node's name must not have spaces, what doesn't mean that this is valid for the Report Label, only omit the spaces in the command line parameter and in the xml file.

XML Configuration File Structure

This is an example of a configuration file that follows the xml format.

<File> 

 <ResponseTimeTest> 

  <Server>snmp</Server> 

  <Host>localhost</Host> 

  <ReportName>Response Time Test</ReportName> 

  <Device>172_19_40_123</Device> 

  <Tag>172_19_40_123.Device_Average_Response_Time</Tag> 

  <Directory>C:\</Directory> 

  <InitialDate>2007-09-19 00:00:00</InitialDate> 

  <FinalDate>2007-09-24 23:59:59</FinalDate> 

  <AverageInterval>1800</AverageInterval> 

  <Last>false</Last> 

  <LastNumber>0</LastNumber> 

  <LastType>h</LastType> 

  <LastRun>2007-11-06T15:19:39.283Z</LastRun> 

  <TagAvailabilityPercent>false</TagAvailabilityPercent>

  <DeviceAvailability>false</DeviceAvailability>

 </ResponseTimeTest> 

</File>

<Server>

This specifies the server's type. It could be snmp or perfmon and tells the agent which XRatel OPC Server it is to be connected.

<Host>

This is the server host where the agent shall find the Probe's data.

<ReportName>

This is the label of the report. As an identifier, the Report Label is present in the report's filename and also in the chart's filename. There, it will be followed by the date and time of the report's generation.

<Device>

This is the identifier of the device to which the data is related. Here you shall inform the complete path to the device, including groups and subgroups.

<Probe>

This is the complete path to the Probes and, as the Device, should include groups and subgroups.

<Directory>

This is the directory where the report and all its images and style shall be saved.

<InitialDate>

This is the date and time where the time interval of the report begins. All data comes from after this moment. The initial data should be specified as a date and time value in the format yyyy-mm-dd hh:mm:ss, or as a relative date. A relative date could be one hour, day, week or month in the past. They should be informed as h, d, w, or m, respectively.

<FinalDate>

This is the date and time where the time interval of the report ends. All data comes from before this moment. As the Initial Date, it could be informed as a date and time value( format yyyy-mm-dd hh:mm:ss) or a relative date. The relative date here could be one hour, day, week, or month in the past, or even now. They should be informed as h, d, w, m or now, respectively.

<AverageInterval>

This is the size in seconds of interval in which the average will work. It means the agent will take intervals of this size to calculate their average and generate segments to the graphic.

<Last>

This is an optional parameter, if it has a value true in the configuration file, it means the time interval of the report has been specified as a relative date. In this case, InitialDate and FinalDate can be omitted. In the other hand, if you don't want to use a relative date, Last, LastNumber and LastType can be omitted as well.

<LastNumber>

This specifies the count of hours, days, weeks or months from the current time that might configure the initial date.

<LastType>

This specifies the kind of interval to consider in the relative date. It can be h indicating hour, d for day, w for week or m for month.

The next example shows the same report made with a relative date of two months in the past.

<File> 

 <ResponseTimeTest> 

  <Server>snmp</Server> 

  <Host>localhost</Host> 

  <ReportName>Response Time Test</ReportName> 

  <Device>172_19_40_123</Device> 

  <Tag>172_19_40_123.Device_Average_Response_Time</Tag> 

  <Directory>C:\</Directory> 

  <AverageInterval>1800</AverageInterval> 

  <Last>true</Last> 

  <LastNumber>2</LastNumber> 

  <LastType>m</LastType> 

  <LastRun>2007-11-06T15:19:39.283Z</LastRun> 

  <TagAvailabilityPercent>false</TagAvailabilityPercent>

  <DeviceAvailability>false</DeviceAvailability>

 </ResponseTimeTest> 

</File>

To disable the KPI's (Key Performance Indicators) , you must specify it in the configuration:

To disable a specific KPI, use the format:

<KPI_Name>false</KPI_Name>

Example:

<TagAvailabilityPercent>false</TagAvailabilityPercent>

By default, all the KPI's are activated.