C Report Group Configuration Reference

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 Reference," for a detailed reference of the report file deployment descriptor elements that are used to create individual report files.

The following sections are included in this appendix:

Report Group Configuration Deployment Descriptor
Element Reference

C.1 Report Group Configuration Deployment Descriptor

The report group deployment descriptor specifies any number of individual reports that are created when the Coherence JMX Reporter is run. Two predefined descriptors are located in the coherence.jar file within the /reports directory. The default descriptor is called report-group.xml and includes a subset of the predefined reports. The report-all.xml descriptor includes all the predefined reports. The predefined report group deployment descriptors can be modified as required or new report group deployment descriptors can be created. The name and location of which report group deployment descriptor to use at run time is configured in the operational deployment descriptor and can be overridden in an operational override file. See Chapter 4, "Using JMX Reporting," for detailed information.

The report file 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:

http://xmlns.oracle.com/coherence/coherence-report-group/1.0/coherence-report-group.xsd

The <report-group> element is the root element of the descriptor and typically includes the XSD reference, the Coherence 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 located in the coherence.jar library is always used at run time even if the xsi:schemaLocation attribute references the Web URL.
The xsi:schemaLocation attribute can be omitted to disable schema validation.
When deploying 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.

Element Reference

Table C-1 lists all non-terminal report group deployment descriptor elements.

Table C-1 Report Group Deployment Descriptor None-Terminal Elements

Element	Used in
init-param	init-params
init-params	report-config
report-config	report-group
report-group	root element
report-list	report-group

init-param

Used in: init-params

Description

The init-param element contains an initialization parameter for a report. The parameter consists of either a parameter name or type, and its value.

Elements

Table C-2 describes the subelements of the init-param element.

Table C-2 init-param Subelements

Element Required/
Optional Description

Element	Required/ Optional	Description
`param-name`	Optional	Specifies the name of the initialization parameter. This element cannot be used with the `param-type` element.
`param-type`	Optional	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` This element cannot be used with the `para-name` element.
`param-value`	Required	Specifies the value of the initialization parameter. The value is in a format specific to the type of the parameter.

param-name

Optional

Specifies the name of the initialization parameter.

This element cannot be used with the param-type element.

param-type

Optional

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

This element cannot be used with the para-name element.

param-value

Required

Specifies the value of the initialization parameter. The value is in a format specific to the type of the parameter.

init-params

Used in: report-config

Description

The init-params element contains a list of initialization parameters.

Elements

Table C-2 describes the subelements of the init-params element.

Table C-3 init-params Subelements

Element	Required/ Optional	Description
`init-param`	Optional	Specifies an initialization parameter for a report.

report-config

Used in: report-group

Description

The report-config contains the configuration file name and the initialization parameters for the report.

Elements

Table C-4 describes the subelements of the report-config element.

Table C-4 report-config Subelements

Element	Required/ Optional	Description
`location`	Required	Specifies a path to a report configuration descriptor that conforms to the `coherence-report-config.xsd` file. This path could be either a file or a URL.
`init-params`	Optional	Specifies a list of initialization parameters.

report-group

Used in: root element

Description

The report-group element describes the report list, the frequency, the report parameters, and the output directory for the batch.

Elements

Table C-5 describes the subelements of the report-group element.

Table C-5 report-group Subelements

Element	Required/ Optional	Description
`frequency`	Required	A string containing the number of seconds, minutes between each execution of the report batch. 10s runs the report ever 10 seconds. 5m runs 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, not enough information is generated. It is recommended that a process for purging and archiving historical information is in place before configuring the reporter.
`output-directory`	Optional	The directory path to prepend to the output file names from the report configuration files. The username which the member is executing must have read write access to this path.
`report-list`	Required	Specifies a list of report configurations.

report-list

Used in: report-group

Description

The report-list element contains the list of reports to include in the batch.

Elements

Table C-6 describes the subelements of the report-list element.

Table C-6 report-list Subelements

Element	Required/ Optional	Description
`report-config`	Required	The report configuration location and corresponding initialization parameters.