A class that describes a ReportGenerator component within an application.
The ReportGenerator component 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 Workbench.
hostID (required) is a unique string identifier for this host.
workingDir is a string identifying the working directory for this component. Any relative paths in component properties are be interpreted as relative to the component's workingDir. The workingDir property, if specified, must be an absolute path.
logFile is a string identifying the log file for this component. args is a list of command-line flags to pass to the ReportGenerator.
javaBinary, if used, should indicate a JDK 1.6.x or later. Defaults to the JDK that Endeca installs.
javaOptions are the command-line options for the javaBinary parameter. This parameter is primarily used to adjust the ReportGenerator memory, which defaults to 1GB. To set the memory, use the following: java_options = -Xmx[MemoryInMb]m -Xms[MemoryInMb]m inputDirOrFile (required) is the 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.
outputFile (required) is the name the generated report file and path to where it is stored.
stylesheetFile (required) is the filename and path of the XSL stylesheet used to format the generated report.
timerange sets the time span of interest (or report window). Allowed keywords: Yesterday, LastWeek, LastMonth, DaySoFar,WeekSoFar, and MonthSoFar. These keywords assume that days end at midnight, and weeks end on the midnight between Saturday and Sunday. Note that your stub generation tool may generate a Boolean property (for example, timerangeSpecified in .NET) that is used to detect whether the user called the set method for this attribute; the property will be used to determine whether to include this field in the serialized XML.
startDate 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.
stopDate sets 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. timeSeries turns on the generation of time-series data and specifies the frequency, Hourly or Daily.
charts turns on the generation of report charts. Note that your stub generation tool may generate a Boolean property (for example, chartsSpecified in .NET) that is used to detect whether the user called the set method for this attribute; the property will be used to determine whether to include this field in the serialized XML.
