Configuring a report batch is one of the steps in creating a custom report. You typically configure it after creating report configuration files. This configuration file determines what reports the reporter executes, how often the reports get executed, and where the reports are saved. If a single report can be used with different parameters, these parameters are also configured in the report batch. For more information on report configuration files, see Chapter 24, "How to Create a Custom Report".
Use the report batch deployment descriptor to specify the various options for creating custom reports.
The name and location of the descriptor defaults to report-group.xml. The default descriptor (packaged in coherence.jar) will be used unless a custom file is found in the application's classpath.
The root element of the POF user type descriptor is report-group. This is where you may begin specifying the format of the custom report.
Table 25-1 describes the system properties that can be used to control report batch from the command line.
Table 25-1 System Properties for Controlling Report Batch
| Property | Default | Description |
|---|---|---|
|
|
|
The XML file containing the Reporter configuration settings, such as the list of reports, the report frequency, and so on. |
|
|
|
Flag to automatically start the reporter when the node is started. |
|
|
|
Determines if the reporter is running in a central model ( |
The report batch descriptor should begin with the following DOCTYPE declaration:
<!DOCTYPE report-group SYSTEM "report-group.dtd">
Example 25-1 illustrates the nesting of elements in a report batch document.
Table 25-2 describes the relationship between the report batch elements.
Used in: report-group
Required. A string containing the number of seconds, minutes between each execution of the report batch. 10s will run the report ever 10 seconds. 5m will run the report every 5 minutes. Selecting an appropriate frequency is critical. If the frequency is too short, the reporter can generate a large amount of data and consume significant disk space. If the frequency is too long, the information will not be useful. It is recommended that a process for purging and archiving historical information is in place before configuring the reporter.
Used in: report-list
Required. The path to the report configuration file. For more information on this file, see Chapter 24, "How to Create a Custom Report".
Used in: init-params
The init-param element contains an initialization parameter for a report. The parameter consists of either a parameter name or type, and its value.
Used in: report-config
Optional. The init-params element contains a list of initialization parameters.
Used in: report-group
Optional. The directory path to prepend to the output file names from the report configuration files. The username which the node is executing must have read write access to this path.
Used in: init-param
The param-name element specifies the name of the initialization parameter.
Used in: init-param
The param-type element specifies the Java type of the initialization parameter. Supported types are:
string—indicates that the value is a java.lang.String
long—indicates that the value is a java.lang.Long
double—indicates that the value is a java.lang.Double
Used in: init-param
The param-value element specifies a value of the initialization parameter. The value is in a format specific to the type of the parameter.
Used in: report-group
The report-config contains the configuration file name and the initialization parameters for the report.
Used in: root element
Describes the report list, the frequency, the report parameters, and the output directory for the batch.
Used in: report-group
Required. The list of reports to include in the batch. This element contains the <report-config> subelement.