This appendix provides a detailed reference of the report group deployment descriptor elements and includes a brief overview of the descriptor. See Appendix B, "Report File Configuration Elements," for a detailed reference of the report file deployment descriptor elements that create individual report files.
This appendix includes the following sections:
The report group deployment descriptor specifies any number of individual reports to create when reporting is enabled. The coherence.jar/reports
directory contains two predefined descriptors. The report-group.xml
descriptor is the default descriptor and includes a subset of the predefined reports. The report-all.xml
descriptor includes all the predefined reports. Modify the predefined report group deployment descriptors or create new report group deployment descriptors as required. The name and location of which report group deployment descriptor to use at run time is configured in the operational deployment descriptor and is overridden in an operational override file. See Chapter 4, "Using Oracle Coherence Reporting," for detailed information.
The report group deployment descriptor schema is defined in the coherence-report-group-config.xsd
file, which is located in the root of the coherence.jar
library and at the following Web URL:
The <report-group>
element is the root element of the descriptor and typically includes the XSD reference, the namespace reference, and the location of the coherence-report-group-config.xsd
file. For example:
<?xml version='1.0'?> <report-group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.oracle.com/coherence/coherence-report-group-config" xsi:schemaLocation="http://xmlns.oracle.com/coherence/ coherence-report-group-config coherence-report-group-config.xsd">
Notes:
The schema that is located in the coherence.jar
library is always used at run time even if the xsi:schemaLocation
attribute references the Web URL.
Omit the xsi:schemaLocation
attribute to disable schema validation.
When deploying Oracle Coherence into environments where the default character set is EBCDIC rather than ASCII, ensure that the deployment descriptor file is in ASCII format and is deployed into its run-time environment in the binary format.
Table C-1 lists all nonterminal report group deployment descriptor elements.
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.
Table C-2 describes the subelements of the init-param
element.
Table C-2 init-param Subelements
Element | Required/ Optional |
Description |
---|---|---|
|
Optional |
Specifies the name of the initialization parameter. This element cannot be used with the |
|
Optional |
Specifies the Java type of the initialization parameter. The following types are supported:
This element cannot be used with the |
|
Required |
Specifies the value of the initialization parameter. The value is in a format specific to the type of the parameter. |
Used in: report-config
Table C-3 describes the subelements of the init-params
element.
Used in: report-group
The report-config
contains the configuration file name and the initialization parameters for the report.
Table C-4 describes the subelements of the report-config
element.
Used in: root element
The report-group
element describes the report list, the frequency, the report parameters, and the output directory for the batch.
Table C-5 describes the subelements of the report-group
element.
Table C-5 report-group Subelements
Element | Required/ Optional |
Description |
---|---|---|
|
Required |
Specifies how often a report batch refreshes. Enter the value in either seconds seconds ( |
|
Optional |
The directory path to prepend to the output file names from the report configuration files. The cluster member must have read/write access to this path. The The preconfigured system property override that is used in the predefined report group configuration files is |
Required |
Specifies a list of report configurations |
Used in: report-group
Table C-6 describes the subelements of the report-list
element.