Using Report Config

[ Main Window | Report Settings | Report | Command Line | XML Configuration File | Program's Parameters ]

       ParametersCommand Liners

When running the Report Agent in the command line, you can inform the configuration of that report in the program's parameters. The parameters shall be informed as follows:

Report Parameters in the command line

The parameters syntax is:

[Report Label] [Host] [Server] [Device] [probe] [Initial Date] [Final Date] [Average Interval] [Directory]

[Report Label]

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.

[Host]

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

[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.

[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 Probe and, as the Device, should include groups and subgroups.

[Initial Date]

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.

[Final Date]

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.

[Average Interval]

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.

[Directory]

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

Examples:

In the following example, Report Test is configured to take data from the local host SNMP server's Device_Health Probe of the local machine(12.0.0.1) in the group Main_Group.Subgroup. the report interval is from 2007-10-21 10:00:00 to 2007-10-26 04:05:00 and the average interval is 3600 seconds, or one hour. The files will be saved in the folder C:\ReportTest.

C:\Program Files\XRatel Performance Suite\Report\XRReportAgent.exe "Report Test" localhost snmp Main_Group.Subgroup.127_0_0_1 Main_Group.Subgroup.127_0_0_1.Device_Health "2007-10-21 10:00:00" "2007-10-26 04:05:00" 3600  C:\ReportTest

The following example configures Report Test Relative Date to take data from the perfmon server in the host 192.168.24.56. The data is from the TestComputer_HardDisk[C:]_Usage Probe of the device 192.168.24.73 in the group My_Group. The report interval is from one month in the past to now and the average interval is 86400 seconds, or one day. The files will be saved in the folder C:\ReportTest.

C:\Program Files\XRatel Performance Suite\Report\XRReportAgent.exe "Report Test Relative Date" 192.168.24.56 perfmon Group.192_168_24_73 Group.192_168_24_73.TestComputer_HardDisk[C:]_Usage m now 86400 C:\ReportTest

Attention: Any parameter that has an empty space has to be given in inverted commas ("parameter").