Viewpoints
A viewpoint is a filtered view of folders and jobs in your active environment The workflows of jobs and SMART folders that are scheduled to execute on the current Control-M day. that enables you to monitor the real-time execution status of your workflows across multiple Control-M/Servers and Agents. You can create simple or sophisticated viewpoints based on the hierarchies, collection filters, and filters that you define, as described below:
-
Hierarchy: Enables you to determine the organizational appearance of a viewpoint.
-
Collection Filter: Enables you to limit the jobs that are collected from the Active Jobs Database
A database that is stored on Control-M/Server and contains a record of all the jobs scheduled to run on the current day and all of their relevant resources and prerequisites. which you can filter from in the Filter tool to define your viewpoint.
By default, Collection Filters include All Jobs in the Active Jobs Database. BMC recommends that you define a new Collection Filter only if you have performance issues and must limit the jobs that can be filtered in Filters.
-
Filter: Enables you to filter and refine viewpoints by Control-M attributes and Boolean operators, as described in Filters. You can also save a set of user-defined filters and apply them to public viewpoints, as described in Creating a Filter Preset.
You can create or open the following types of viewpoints:
-
Public Viewpoint: Enables you to create a shared viewpoint for an entire department or organization and is accessible to all users. For more information, see Creating a Public Viewpoint.
To apply user-defined filter presets to public viewpoints, see Creating a Filter Preset.
An operator receives an email that a specific job has ended Not OK. To discover more about the job, the operator opens an All Jobs public viewpoint with a Run ID
The identification code for a SMART folder, sub-folder, or job execution. filter for this job.
-
Private Viewpoints: Created in Control-M Web and only available to the user who creates these viewpoints, as described in Creating a Private Viewpoint.
Control-M saves the data of your active environment The workflows of jobs and SMART folders that are scheduled to execute on the current Control-M day. every day. This enables you to review past environment data and track previous workflow executions, as described in Opening a Viewpoint on Historical Data.
An operator finds that the Invoice_Eastern SMART folder has Ended Not OK. To discover when this job began to fail, the operator opens the past three days of historical viewpoints that include the Invoice_Eastern SMART folder and find that the first Ended Not OK two days ago.
You can view up to 20,000 jobs in a viewpoint. If the number of folders and jobs that appear in a public viewpoint exceeds this limit, you can open a public viewpoint with filters or presets to reduce this number.
Creating a Public Viewpoint
This procedure describes how to create a public viewpoint, which enables you to create shared viewpoints for an entire department or organization. All users can open this viewpoint to monitor the structure, scheduling, and real time execution status of workflows on one or more Control-M/Servers, and they can further refine this viewpoint with user-defined filter presets.
Begin
-
From the Monitoring domain, click Viewpoints.
The Viewpoints tab appears.
-
From the Viewpoints toolbar, click the Add Viewpoint drop-down list, and then click Public Viewpoint.
The Public Viewpoints Manager tab opens and the Add Public Viewpoint pane appears.
-
Do the following to name the viewpoint:
-
In the Public Viewpoint Name field, type a logical viewpoint name.
-
(Optional) In the Description field, type a logical viewpoint description.
-
-
From the Hierarchy drop-down list, select a defined hierarchy or do the following to add a new hierarchy:
-
Click Add Hierarchy.
The Add Hierarchy dialog box appears.
-
Click
to add a hierarchical level and from the Add Attribute drop-down list that appears, search for or select the required attribute.
The new hierarchical level appears with the defined attribute.
-
Click Save.
The new hierarchy appears selected in the Hierarchy drop-down list.
-
-
From the Filter drop-down list, select a defined filter or do the following to add a new filter:
-
Click Add Filter.
The Add Filter dialog box appears.
-
In the Filter Name field, type a logical filter name.
-
(Optional) In the Description field, type a logical filter description.
-
From the Include Attributes or Exclude Attributes areas, click the Add Attribute drop-down list, and then select and define the attributes that are included or excluded from the viewpoint, as described in Filters.
-
Click Save.
The new filter appears selected in the Filter drop-down list.
-
-
(Optional) From the Collection Filter drop-down list, select a defined collection filter or do the following to add a new collection filter:
-
Click Add Collection Filter.
The Add Collection Filter dialog box appears.
-
In the Filter Name field, type a logical collection filter name.
-
(Optional) In the Description field, type a logical collection filter description.
-
From the Include Attributes or Exclude Attributes areas, click the Add Attribute drop-down list, and then select and define the attributes that are included or excluded from the jobs that you can filter in Filters.
-
Click Save.
The new collection filter appears selected in the Collection Filter drop-down list.
By default, Collection Filters include All Jobs in the Active Jobs Database. BMC recommends that you define a new Collection Filter only if you have performance issues and must limit the jobs that can be filtered in Filters.
-
-
Click Save.
The public viewpoint is created, saved, and appears in the Public Viewpoints Manager and Viewpoints tabs.
Creating a Private Viewpoint
This procedure describes how to create a private viewpoint, which enables you to monitor the structure, scheduling, and real time execution status of workflows on one or more Control-M/Servers.
Begin
-
From the Monitoring domain, click Viewpoints.
The Viewpoints tab appears.
-
From the Viewpoints toolbar, click the Add Viewpoint drop-down list, and then click Private Viewpoint.
The Add Viewpoint dialog box appears.
-
(Optional) Do the following to name the viewpoint:
-
Click Viewpoint <#>.
The Edit Name and Description dialog box appears.
-
In the Name field, type a logical viewpoint name.
-
(Optional) In the Description field, type a logical viewpoint description.
-
-
Click Hierarchy to define the hierarchical order of the viewpoint.
The Hierarchy area expands.
-
Do one or more of the following:
-
Rearrange Hierarchy: Click any of the hierarchical attributes and drag them to the required location.
-
Add Hierarchical Level: Do the following:
-
Select a hierarchical attribute and click
to add a level below it.
A new level appears, which contains a drop-down attribute list.
-
From the attribute drop-down list in the new level, search for or select the required attribute from the drop-down list.
The new attribute appears in the hierarchy.
-
-
-
From the Filter area, do one or more of the following to define viewpoint filters that include or exclude general, plug-in, scheduling, prerequisite, or run-time attributes:
In many of the attribute fields, you can use pattern-matching strings to define multiple named attributes, as described in Pattern-Matching Strings.
-
Include Attributes: Do one or more of the following to include attributes:
-
Include Default Attributes: In one or more of the default attribute fields, search for, select, or type the required attribute names, as described in Filters.
-
And Include Attributes: Do the following to include non-default attributes:
-
Click Add Attribute and search for or select the required attribute from the drop-down list.
The added attribute appears in the Include Attributes area.
-
In the added attribute field, search for, select, or type the required attribute name.
-
-
Or Include Attributes: Do the following to add attributes that are included via a Boolean OR expression.
-
Click Add Set of Attributes and search for or select the required attribute from the drop-down list.
The added attribute appears in the Or area.
-
In the added attribute field, search for, select, or type the required attribute name.
The attribute name appears in the field.
-
-
-
Exclude Attributes: Click Exclude Attributes to expand this menu, and do one or more of the following:
-
Exclude Defined Attributes: Do the following to define attributes that are excluded:
-
Click Add Set of Attributes and search for or select the required attribute from the drop-down list.
The added attribute appears in the Exclude Attributes area.
-
In the added attribute field, search for, select, or type the required attribute name.
The attribute name appears in the field.
-
-
And Exclude Attributes: Do the following to include more attributes:
-
Click Add Attribute and search for or select the required attribute from the drop-down list.
The added attribute appears in the Exclude Attributes area.
-
In the added attribute field, search for, select, or type the required attribute name.
The attribute name appears in the field.
-
-
Or Exclude Attributes: Do the following to add a set attributes that are excluded via a Boolean OR expression.
-
Click Add Set of Attributes and search for or select the required attribute from the drop-down list.
The added attribute appears in the Or area.
-
In the added attribute field, search for, select, or type the required attribute name.
The attribute name appears in the field.
-
-
-
-
Do one of the following:
-
Click Save and Open.
The viewpoint is created, saved, and appears in a new tab. -
Click Open.
The defined viewpoint opens in a new tab.
-
Creating a Filter Preset
The following procedure describes how to create a user-defined set of filters that you can save and apply to public viewpoints, either from the Viewpoints tab or an open viewpoint.
Begin
-
From the Monitoring domain, click Viewpoints.
The Viewpoints tab appears.
-
From the Viewpoints pane, click
next to the required Public viewpoint.
A drop-down list appears.
-
Click Open with Filters.
The Open Viewpoint with Filter dialog box appears.
-
Define filters, as described in Creating a Private Viewpoint.
-
From the Filter area, click the Filter Presets drop-down list, and then click Save.
The Save Preset dialog box appears.
-
In the Name field, type a filter preset name and click Save.
The filter preset is saved.
Filters
You can filter viewpoints according to the following attributes:
-
General folder, sub-folder, job, and OS job attributes.
You can also apply similarities, equalities, and other Boolean operators to further refine viewpoints, as described in Creating a Private Viewpoint.
Run Time Attributes
The following table describes the run time attribute viewpoint filters that you can add, define, and refine.
Attribute |
Description |
---|---|
CM Application Job Status |
Defines the current execution status of the plug-in job. |
Deleted Jobs |
Determines whether deleted jobs appear in the viewpoint. |
Folder Held |
Determines whether folders that are in a hold |
Held |
Determines whether jobs that are in a hold state appear in the viewpoint. |
Run Date |
Determines the jobs that appear in the viewpoint, based on the job execution date that you define. |
Run ID |
Determines the job or SMART folders that appear in the viewpoint, based on the run ID |
Execution Time |
Determines the jobs or SMART folders that appear in the viewpoint, based on the actual or estimated job execution times that you define. |
Job Status |
Determines the jobs or SMART folders that appear in the viewpoint, based on the job status that you determine. |
Opening a Viewpoint on Historical Data
This procedure describes how to open private viewpoints that enable you to review past environment data and track workflow execution. Viewpoints with historical data are limited to the Control-M/Server that you select. To view workflows that span multiple Control-M/Servers, you must open a separate viewpoint for each Control-M/Server.
Before You Begin
-
You must create and save at least one private viewpoint.
Begin
-
From the table of saved viewpoints in the Viewpoints tab, select a private viewpoint.
-
From the Viewpoints toolbar, click History.
A dialog box with a calendar and a Control-M/Server drop-down list appears.
-
From the Control-M/Server drop-down list, select the required Control-M/Server.
-
From the calendar, click the required date.
The filtered workflows on this date and Control-M/Server appear in your selected viewpoint.