ReportGenerator brick

The ReportGenerator brick runs the Report Generator, which processes Log Server files into HTML-based reports that you can view in your Web browser and XML reports that you can view in Endeca Workbench.

ReportGenerator brick settings

Setting

Description

logs

Required. Path to the file or directory containing the logs to report on. If it is a directory, then all log files in that directory are read. If it is a file, then just that file is read.

output

Required. What to name the generated report file. For example:

output = C:\Endeca\reports\myreport.html on Windows

output = /endeca/reports/myreport.html on UNIX

settings

Path to the report_settings.xml file. For example:

$(sample_wine_data_dir)\etc\report_settings.xml

stylesheet

Required. Path to the report_stylesheet.xsl file. For example:

$(sample_wine_data_dir)\etc\report_stylesheet.xsl

timerange <keyword>
Optional. Set the time span of interest (or report window). Allowed keywords:
  • yesterday
  • last-week
  • last-month
  • day-so-far
  • week-so-far
  • month-so-far

These keywords assume that days end at midnight, and weeks end on the midnight between Saturday and Sunday.

start_date <date>

stop_date <date>

Optional. These set the report window to the given date and time. The date format should be either yyyy_mm_dd or yyyy_mm_dd.hh_mm_ss. For example, 2007_03_25.19_30_57 expresses March 25, 2007 at 7:30:57 in the evening.

time-series <frequency>

Generates time series data at a specified frequency. The value can be either hourly or daily.

charts <status>

Generates charts in reports. The value is either enable or disable. If unspecified, the default is set to disable.

java_binary

Optional. Should indicate a JDK 1.5.x or later. Defaults to the JDK that Endeca installs.

java_options
Optional. Command-line options for the java_binary setting. This command is primarily used to adjust the report generator memory, which defaults to 1GB. To set the memory, use the following (ignore the linebreak):
java_options = -Xmx[MemoryInMb]m
-Xms[MemoryInMb]m
This Windows example of a ReportGenerator brick generates a report for all logs in a directory:
				wine_genreport : ReportGenerator
	 					logs		 = $(sample_wine_data_dir)\logs\logserver_output\
	 					settings 		= $(sample_wine_data_dir)\etc\report_settings.xml
	 					stylesheet 	= $(sample_wine_data_dir)\etc\report_stylesheet.xsl
	 					output		 = $(sample_wine_data_dir)\reports\sample_report.html