Report Management

In the Control-M Reports tool, you can manage your reports by using one or more of the following functions:

Generating a Report

This procedure describes how to generate a report.

  • You must have user authorization to generate reports.

  • Based on BMC testing, it is recommended that you limit the size of your reports to 25,000 records for reports in CSV or Excel format or to 10,000 records for reports in PDF format. To ensure that you do not exceed the maximum size recommendation, adjust your choice of filters during the creation of the report, as described in Reports.

Before You Begin

Ensure that you are authorized to generate a report in the RFAllowReportForJobLevelAuth parameter in the CCM.

Begin

  1. From My Reports, select the report that you want to generate.

  2. Click Generate, and select the report format — PDF, CSV, or EXCEL.

  3. Select to open the report, or save it locally.

Exporting a Report

This procedure describes how to export a report in a JSON file format. You can then import the file, as described in Importing a Report from a File.

Begin

  1. From My Reports, select the report that you want to export.

  2. Click , and select Export.

  3. Save the JSON file.

Importing a Report from a File

This procedure describes how to Import a JSON file that contains report definitions and load it into Reports.

Begin

  1. From the Reports icon, click Report and select Load from file.

  2. Navigate to the directory where the file is located and click Open.

    The Report appears.

    If you want to edit report definitions, see Reports.

Sharing a Report

This procedure describes how to share a report with other Control-M users without exporting or importing the report.

If sharing a report with other Control-M users, and a user wants to edit and save the changes, it needs to be saved under a different name, using Save As. Users cannot make changes to the original report. Only the user who created the shared report can edit or delete. A shared report must have a unique name. You cannot have more than one shared report with the same name.

Begin

  1. From My Reports, select the report you want to share.

  2. Click , and select Share With.

    The Share With dialog box opens.

  3. In the Users field, type the name of the Control-M user to share the report with.

    If you want to list multiple users, type a comma or press enter after each name. If you want all users, type ALL.

  4. Click Save.

Exporting Filter Definitions

This procedure describes how to export filter definitions from a report to a JSON file. You can use the exported JSON file as the basis for a configuration file that you can use to adjust and override filter definitions when you define a Control-M Report job using the Control-M Automation APIClosedA set of programmatic interfaces that provide developers and DevOps engineers access to the capabilities of Control-M SaaS within the modern application release process. Time definitions, which appear above the filters in certain types of report templates are not included in the export. For more information, see Reports Job Definition.

Before You Begin

To enable overriding of filter values when you later run a Control-M Report job using Control-M Automation API, ensure that all filters have a unique left-hand-side field (that is, any value in a left-hand-side field is used in only one filter in the report).

Begin

  1. From My Reports, select the relevant report.

  2. Click , and select Export Filters.

  3. Save the JSON file.