Reports

The Control-M Reports tool enables you to create and generate ad hoc reports using data collected from your environment, as described in Creating a Report Template. Control-M provides default categories that include report templates that you can use to view specific information and generate reports, as described in Generating a Report.

You can use the report templates in the following categories:

Active: Collects data regarding active jobs or other Control-M data from the active environment, such as alerts A notification about the status of a job or component that appears in the Alerts window. or audits.
SLA Management: Collects data for execution status, service A set of workflows that serves a business purpose, and can be monitored as a single unit. name and status, slack time, and total number of SLA Management jobs.
Definition: Collects definition-related information from the Planning domain regarding jobs, folders A container of jobs and sub-folders that passes its definitions to the included jobs and sub-folders., and events An conditional entity that creates a sequential relationship between jobs by enabling the successor job to execute after the predecessor job has executed..
History: Job execution-related reports.
File Transfer: Collects data about file transfers inside your organization.

If you select the Active category, you can generate a report based on Active jobs, which lists the jobs in the current active network or in a historic network.

Control-M Reports supports Acrobat (*.pdf), Excel (*.xlsx), and Comma Separated Values (*.csv) output.

To automate report generation and control report scheduling, you can define a Control-M Report job that runs a Control-M Automation API command through the CLI. If you are using an API to generate reports you can dynamically change parameters, such as filter values during report generation. For more information, see Reports Job Definition.

Active

The following table describes the report types available in the Active category:

Report	Description
Alerts	Lists the alerts raised in Server during a defined time range.
Audit	Lists the audit information for a defined time range (up to 90 days) and audit type.
Active Jobs	Lists the jobs in the current active network or in a historic network.
Active - Resource Pools	Lists the names and quantities of the Resource Pools A type of quantifiable resource, which represents the total amount of resources from a physical or logical device that a job can access. from the current active network or a historic network.
Active - Lock Resources	Lists the names and types of Lock Resources A type of prerequisite that controls the flow of the workflow, which represents a physical or logical device that folders, sub-folders, or jobs can exclusively access or share. in the current active network or in a historic network.
Active - Prerequisite Events	Lists the names and dates of prerequisite The part of the job definition that controls the flow of your jobs, such as an event that controls flow sequence or a resource that controls load balancing. events from the current active network or a historic network.
Role Authorizations	Lists the definitions of a specific Role and its associated users.
Trend Analysis	Provides information about the total amount of jobs executed per day during a time range that you define.
Host Groups	Lists the existing host groups along with their assigned Agents A Control-M component installed on a host (computer) that runs and monitors the jobs on the host. and the date of the last update to each host group.

SLA Management

The following table describes the report types available in the SLA Management category:

Report	Description
SLA Management	Provides SLA-related information, such as execution status, service name and status, slack time, and total number of SLA jobs.

Definition

The following table describes the report types available in the Definition category:

Report	Description
Jobs Definitions	Provides job definitions.
Jobs Definitions - Wait For Events	Lists the jobs with Wait for Events as a prerequisite.
Jobs Definitions - Events	Lists the jobs that add or delete Events after job completion.
Jobs Definitions - Variables	Lists the jobs that contain definitions of Variables A memory location with a name and value that you can reference in your job processing definitions, which Control-M resolves for the current job execution. within the job definition The set of parameters that defines what the job does, when it runs, its prerequisites, and the post-processing actions that Control-M performs after the job completes execution..
Jobs Definitions - Before/After Notifications	Lists the jobs that contain settings for Before Job Completion or After Job Completion notifications.
Jobs Definitions - Lock Resource	Lists the jobs that contain Lock Resource prerequisites.
Jobs Definitions - Resource Pool	Lists the jobs that contain Resource Pool prerequisites.
Folder Definitions	Lists the folders according to filters that you define.
Notify by Mail Actions	Lists the folders and jobs that are defined with a Notify by mail action.
Change Status or Run Settings Actions	Lists the folders and jobs that are defined with one of the following actions: Set to OK, Set to Not Ok, Rerun job, Stop Cyclic run.
Run Job Actions	Lists the folders and jobs that are defined with a Run Job action.
Add/Delete Events Actions	Lists the folders and jobs that are defined with an Add/Delete Events action.
Set Variable Actions	Lists the folders and jobs that are defined with a Set Variable action.
Handle Output Actions	Lists the jobs that are defined with a Handle Output action.

History

The following table describes the report types available in the History category:

Report	Description
Jobs Executions	Lists the jobs execution with information, such as start time, end time, and average run time. You can group execution information by time segment.
Workloads	Lists the jobs that ran during a time frame that you define from a specific day, and provides various statistics for each job.
Workflow Distribution	Lists the total number of entities in the active network and a summary of executions per day on a Server.

File Transfer

The following table describes the report types available in the File Transfer category:

Report	Description
MFT	Lists the files transferred by Control-M MFT with various details about each file transfer, such as source and destination path, host status, and transfer times.

Creating a Report Template

This procedure describes how to create a report template and define the criteria to generate data based on your specific requirements.

Begin

From the Reports window, click to highlight the category you want to view.

Click Report and select Add New Report.

The Add report from template pane appears.

Select the relevant report type.
Click Add.

The report template appears with a default name and description.

You can save the report template using the default name, or Click and select Save as to copy the template and use an alternative name.
In the Filters tab, define the data filters that you want to display in the report.

Filters can be specific parameter values or specific time ranges. The filter options vary depending on the report type you choose. For more information, see Filter Options.

You can filter data in an Alerts report to show all alerts that have not been reviewed, by selecting Status from the drop-down list, the Is not operator, and Reviewed as the value.
In the Visible Columns tab, select the fields you want to appear in the report and drag and drop them from the Available Columns to the Visible Columns.

You can change the order of the fields in the Visible Columns by dragging the field up or down in the list.
In the Sorting & Grouping tab, sort and group the fields you have chosen in the Visible Columns tab by doing one or both of the following:
- Click Add a sorting column.
  1. From the drop-down list select the field. If you want to change the order, click either the or arrow to arrange the fields.
  2. To sort by additional fields, click Add a sorting column and repeat the same actions in the step above.
    
    Sorting is limited to five levels.
- Click Add a grouping column (PDF only) and then select a field.
  
  The Grouping is limited to five hierarchies.
To verify and view your customized report before generating the report, click Preview in the bottom pane, and then click Refresh.

By default, the initial results are limited to the first 25.
Click Save.

Filter Options

The following table describes the filter options that are dependent on the report type:

Name	Description	Report Types
Add Filter	Defines the field to use for filtering data and the Operators to use with the value specified in the text field. For each report sub-type, a list of fields appears in the drop-down list. You can add multiple filters.	All
Time Range	Filters the data according to the time criteria you specify from the drop-down list.	Alerts Audit Workloads
Network	Loads report data from the following network: Archived network on: Enables you to select available archived networks and view jobs that were running on that date Current active network: Enables you to view data on jobs that are currently running. Last day network: Enables you to view data from jobs that were running a day before. Relevant for active jobs and Resource Pools A type of quantifiable resource, which represents the total amount of resources from a physical or logical device that a job can access., Lock Resources A type of prerequisite that controls the flow of the workflow, which represents a physical or logical device that folders, sub-folders, or jobs can exclusively access or share., and Events An conditional entity that creates a sequential relationship between jobs by enabling the successor job to execute after the predecessor job has executed..	Active Jobs Active Resource Pools Active Lock Resources
Audit type	Defines the type of Audit data to retrieve.	Audit
Audit operation	Specifies which audit action to view in the report.	Audit
Show final state	Shows only the final state of the service A set of workflows that serves a business purpose, and can be monitored as a single unit. in the report and not all the states the service was in during its life cycle.	SLA Management

Operators

The following table describes the filter operators:

Name	Description
Is	Displays all values for the selected field that equal the value specified, (does not support commas).
Is not	Displays all values for the selected field that do not equal the value specified, (does not support commas).
Any of the following	Displays all values that are any of the listed values. You can specify more than one value using commas, or set a relationship between the values (substring of *) Accepts the asterisk wildcard.
None of the following	Displays all values except the listed values. You can specify more than one value using commas. Accepts the asterisk wildcard. The relationship between the values is AND. (substring *)
Like	Displays all values that are a substring of the listed value. (app) You can use any of the following: <character>: Finds the value of the character, such as a searches for the value a. <character>: Finds any value that starts with the character, such as a* searches for any values that starts with a. <character>: Finds any value that ends with the character, such as a searches for any value that ends with a. <string>: Finds any value that has the specified string in any position, such as or searches for any value that contains or. (Does not support commas)
Not like	Displays all values that are not like the substring of the listed value. (app) You can use any of the following: <character>: Ignores the value of the character, such as a ignores the value a. <character>: Ignores any value that starts with the character, such as a* ignores any values that starts with a. <character>: Ignores any value that ends with the character, such as a ignores any value that ends with a <string>: Ignores any value that has the specified string in any position, such as orignores any value that containsor. (Does not support commas)
Greater than	Displays all values that are numerically greater than the listed value.
Greater than/Equals	Displays all values that are numerically equal to or greater than the listed value.
Lesser than	Displays all values that are numerically less than the listed value.
Lesser than/Equals	Displays all values that are numerically equal to or less than the listed value.