Creating report templates and custom reports

You can create report templates and use those templates to generate custom reports. You can configure templates to report data from many data sources. 

To create a report template

  1. Click the Report tab.
  2. From the left menu, select Templates.
  3. Under the list of existing templates, click New Template.
  4. Enter a name for the template.
  5. Select the type of chart for this template to render (bar chart or 3D bar chart). Click Create.
  6. Enter the labels for the X-axis and Y-axis, and select the type of data which is going to be represented. Click Save.

    Note

    To modify the X-axis and Y-axis values, click on the template's name in the crumb bar.

     

  7. To configure the report template, click its name in the templates list. You can delete an existing report component, or series, by clicking Remove in its associated Actions menu under Configure.
  8. To add a new series, click Add Series.
    Each series identifies a data source, the color to render with, and the name to use.
  9. Enter a name for the series. This will be shown in the report legend.
  10. From the Series data menu, select the data set for the series.
  11. To set a color for the series, slide the red, green, and blue color icons left or right along the bar to mix the colors for the hue that you want.
    For black, move them all the way to the left.
  12. Click Save.

    Note

    You can add the same source multiple times to a report template. This means that you can create reports such as Pass/Fail comparisons.

Predefined report templates

The system includes the following predefined report templates and reports.

Note

The data for the reports is generated by the System Stat module. Schedule this module to run nightly. If this schedule is disabled or deleted, the reports might become inaccurate. (See Creating and managing schedules.)

Report

Description

Database Objects Individual Counts Weekly Report

Shows the volume of specific individual objects. The objects are instances, packages, and deployments.

Database Objects Total Count Weekly Report

Shows the sum of the total count of instances, packages, and deployments in the system

Database Records Individual Count Weekly Report

Shows the volume of log content (in number of records) for the audit log, deployment logs, and instance/repository logs

Database Records Total Count Weekly Report

Shows the trend in total number of log records

Deployment Results Monthly

Shows a chart of deployment status results (pass, fail, cancelled) for any package and environment for the period that you select: day, week, month, or year

Instance Size Usage Weekly Report

Shows how much instance content (in bytes) is stored in the database

To create custom reports

You can create custom reports after you define one or more report templates. A custom report is based on a template and identifies specific values for the configurable options of the template. The configurable options vary depending upon the template chosen.

  1. Click the Report tab.
  2. Click Reports in the left menu.
  3. Click the Custom tab and click New Report after the list of existing reports.
  4. Click the link for the report template you want to use for this report.
  5. Enter a name for the custom report and select the period of time to generate the report for.
  6. Click Save.
  7. Configure the filter options for each report series by selecting a value from the Value menu for each.
  8. Click Save Filters.
  9. Review the custom report settings on the summary page.
  10. When satisfied, click Render.
    The custom report is displayed. To modify an existing custom report, click the report name.

Report template data sets

The following table describes the data sets available for report templates, including what data is in the set and the filter options for the set.

Data set name

Data set data

Filter options

Package Instances

Packages, instances

Package Name, Instance Name

Channel Flux

Channel changes, including configuration

Channel Name, Bridge

User Login and Engine Creation Activity

Sessions

Login Source (User or Engine), User Name

User and Engine Activity

Audit records

Source (User, System, or Engine)

Processes Completed

Executed processes

Name, Type, Status

Deployments Completed

Deployments

Package Name, Deployment Status, Target Environment

Quantity of Content Fetched

Instance content

Deployment Count, Instance size, Total Count, Waiting Jobs, Instance Count, Repository Count, Deploy Log Records, Total Records, Package Count, Instance Log Records, Audit Records

Server Output Activity

Task feeds

No filters

Database Usage Metrics

Databse statistics

Deployment Count, Instance size, Total Count, Waiting Jobs, Instance Count, Repository Count, Deploy Log Records, Total Records, Package Count, Instance Log Records, Audit Records

Content CountContent of instancesNo filters

Related topic

Creating and running reports

Was this page helpful? Yes No Submitting... Thank you

Comments