Viewpoints

A Viewpoint is a filtered view of folders and jobs in your environment 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 and filters that you define, as described below:

  • Hierarchy: Enables you to determine the organizational appearance of a Viewpoint.

  • 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: Created in Control-M Desktop and accessible to all Control-M Desktop and Control-M Web users. This enables you to create shared Viewpoints for an entire department or organization. You can only create and edit a public Viewpoint in Control-M Desktop, as described in 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 IDClosed 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.

Administrators can determine the number of private Viewpoints that users can create with the Maximum Viewpoints a User Can Define system parameter, as described in Control-M Web Parameters. If you exceed this limit, the oldest saved Viewpoint is deleted.

Control-M saves the data of your active environmentClosed 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. Administrators can increase this limit, if required. For more information about Administrator roles, see User and Role Authorizations.

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

  1. From the Monitoring domain, click Viewpoints.

    The Viewpoints tab appears.

  2. From the Viewpoints toolbar, click Add Viewpoint.

    The Add Viewpoint dialog box appears.

  3. (Optional) Do the following to name the Viewpoint:

    1. Click Viewpoint <#>.

      The Edit Name and Description dialog box appears.

    2. In the Name field, type a logical Viewpoint name.

    3. (Optional) In the Description field, type a logical Viewpoint description.

  4. Click Hierarchy to define the hierarchical order of the Viewpoint.

    The Hierarchy area expands.

  5. 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:

      1. Select a hierarchical attribute and click to add a level below it.

        A new level appears, which contains a drop-down attribute list.

      2. 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.

  6. 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:

        1. 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.

        2. 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.

        1. 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.

        2. 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:

        1. 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.

        2. 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:

        1. 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.

        2. 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.

        1. 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.

        2. In the added attribute field, search for, select, or type the required attribute name.

          The attribute name appears in the field.

  7. 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 pane or an open Viewpoint.

Begin

  1. From the Monitoring domain, click Viewpoints.

    The Viewpoints tab appears.

  2. From the Viewpoints pane, click next to the required Public Viewpoint.

    A drop-down list appears.

  3. Click Open with Filters.

    The Open Viewpoint with Filter dialog box appears.

  4. Define filters, as described in Creating a Private Viewpoint.

  5. From the Filter area, click the Filter Presets drop-down list, and then click Save.

    The Save Preset dialog box appears.

  6. 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:

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 holdClosed A job action that stops the job from executing or pauses a job that is currently executing. state appear in the Viewpoint.

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 IDClosed The identification code for a SMART folder, sub-folder, or job execution. number that you define.

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

  1. From the table of saved Viewpoints in the Viewpoints tab, select a private Viewpoint.

  2. From the Viewpoints toolbar, click History.

    A dialog box with a calendar and a Control-M/Server drop-down list appears.

  3. From the Control-M/Server drop-down list, select the required Control-M/Server.

  4. From the calendar, click the required date.

    The filtered workflows on this date and Control-M/Server appear in your selected Viewpoint.