Home > Cloud Cruiser 4 > Administering > Managing reports > Automating reports > Report properties

Report properties

Report output is configured by means of XML properties. Not all reports will use the same properties, nor are the default values guaranteed to be the same for each style of report. The list of supported properties and their defaults are maintained in the report job sample (<installDirectory>/job_samples/run_report.xml ).

A summary of various properties that you can define in a batch reporting job are as follows:

Property example Description
<property name="processName" value="batchReports"/> A name for a process in the report XML file. (A file can have multiple processes.) Each process appears separately on the Monitoring page.
<property name="notifyOnSuccess" value="false"/> Defines whether to send a notification when the process completes successfully. The default is false.
<property name="notifyOnFailure" value="false"/> Defines whether to send a notification when the process fails. The default is false.
<property name="notifyAddresses" value="mailto:yourname@yourcompany.com" A comma-separated list of email addresses to receive success and failure notifications.
<property name="userGroup" value="buAgroup"/>

Defines which user groups will receive the report as an email attachment.

This property is required if you are automating email distribution of reports. For more information, see Automating reports.

<property name="recipient" value="emailAddress"/> Defines email addresses (other than those defined by the userGroup parameter) to include in the To: list when automating email distribution of reports.
<property name="ccRecipient" value="emailAddress"/> Defines email addresses (other than those defined by the userGroup parameter) to include in the CC: list when automating email distribution of reports.
<property name="bccRecipient" value="emailAddress"/> Defines email addresses (other than those defined by the userGroup parameter) to include in the BCC: list when automating email distribution of reports.
 

<property name="active" value="true" />

Defines whether or not this step is active. The default is true.

<property name="format" value="PDF" />

Specifies the output format of the report. The default is PDF.

<property name="reportId" value="ResourceInvoice" />

Specifies the name of the report to be called. The default is ResourceInvoice.

<property name="format" value="PDF"/> Specified the output format of the report. You can specify PDF (the default), XLS, and CSV.

<property name="dateRange" value="PREVPERIOD"/>

Specifies the date range of the report. For the values, see Date range values.

<property name="accountLevel" value="1"/>

Specifies the account level at which to run the report. ‘1’ refers to the highest level. By default, reports will run at the account selection level defined in the system configuration.

<property name="accountStructure" value="0"/>

Specifies the account structure at which to run the report. By default, reports run using the account structure specified as “default” in the relevant User Group.

<property name="accountRangeStart" value="lowest"/>

Specifies the start of the account range, or a comma-separated list of accounts to report. This defaults to ‘lowest’ -- the lowest account ID allowed for this particular User Group.

Reports can only be run against account IDs that are permitted by that User Group’s Customer list.

<property name="accountRangeEnd" value="highest"/>

Specifies the end of the account range, or a comma-separated list of accounts to report. This defaults to ‘highest’ -- the highest account ID allowed for this particular User Group.

Reports can only be run against account IDs that are permitted by that User Group’s Customer list.

<property name="extraParameters">

Allows the user to pass report-specific parameters as required. See Report-specific parameters.

<property name="tolerance" value="0"/>

Specifies the number of allowed failures. If the number of failures is less than or equal to the tolerance value, warning messages will be logged but the job will not fail. If the number of failures is greater than the tolerance value, the job will fail. The default is zero (0).

Date range values

The valid date range values for most reports are:

Value

Description

ALL

All dates.

CURRPERIOD

Current period.

PREVPERIOD

Previous period.

CURRMON

Current month.

MONTHTODATE

Month to current date.

PREVMON

Previous month.

CURRYEAR

Current year.

YEARTODATE

Year to current date.

PREVYEAR

Previous year.

TODAY

Current date.

PREVTODAY

Previous day’s date.

CURRWEEK

Current week.

WEEKTODATE

Week to current date.

PREVWEEK

Previous week.

CUSTOM A custom range.

Note that when using a custom range, you must also specify customStartDate and customEndDate properties. For example:

<property name="dateRange" value="CUSTOM"/>
  <property name="customStartDate">
    <bean class="com.cloudcruiser.common.dto.date.CCDateStart">
      <property name="year" value="2015"/>
      <property name="month" value="01"/>
      <property name="day" value="01"/>
    </bean>
  </property>
  <property name="customEndDate">
    <bean class="com.cloudcruiser.common.dto.date.CCDateEnd">
      <property name="year" value="2015"/>
      <property name="month" value="12"/>
      <property name="day" value="31"/>
    </bean>
  </property>

Report-specific parameters

The extraParameters property allows the user to pass report-specific parameters as required.

<property name="extraParameters">
  <map>
    <entry key="param1" value="paramValue">
    ...
  </map>
</property>

IMPORTANT: Certain reports require identifiers as parameters (for example, VMName ). The Batch system expects an identifier ID, not the name of the identifier itself. The identifier ID is typically determined by referencing the identifier table in the database. For example:

<entry key="identifierName1" value="VMName"/> <!-- INVALID -->
<entry key="identifierName1" value="10100"/>  <!-- OK -->

Each report has its own list of allowable extra parameters. Refer to the job sample file for more details.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
© Copyright 2018 Hewlett Packard Enterprise Development LP