Archive Service

Control-M Archive Service is a Control-M add-on that enables you to archive job data in a secure, central, and BMC-hosted repository when jobs finish execution. The Archive Service archives Control-M/Server job logsClosed The activity log of a job, which lists every job status change, such as job execution start and completion times, and how the job ended., Agent job outputClosed A tab in the job properties pane of the Monitoring domain where the job output appears that indicates whether a job ended OK, and is used, for example, with jobs that check file location., and a small amount of job metadata from Control-M SaaS for a defined period of time. This enables you to meet organizational audit and compliance requirements, troubleshoot your environment with historical data, and enable or disable users from accessing archived data, based on user and role authorizations, as described in User and Role Authorizations.

Archive Service rules determine the job data that is archived based on some of the following main criteria:

  • Data Type: Job logs or output.

  • Retention Period: The number of days, months, or years to archive the data.

  • System Type: Distributed systems or z/OS mainframes.

You can define one or more Archive Service rules, which enable you to determine the type of data that is archived and how long it is stored in the Archive Service repository, as described in Defining an Archive Service Rule.

The following procedures describe how to search, compare, and export archived job data:

For the legacy archive service, see Control-M Workload Archiving.

Begin

Defining an Archive Service Rule

This procedure describes how to define an Archive Service rule, which enables you to determine which data to archive and how long to store it in the Archive Service repository.

Archive Service rules are applied in the order that you create them, as shown in the Priority column in the Archive Service Rules tab.

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Archive Service Rules.

    The Archive Service Rule tab appears.

  3. Click Add Rule.

    The Add Archive Policy Rule dialog box appears.

  4. Type or select the required parameter values, as described in Archive Service Rule Parameters.

  5. Click Add.

    The Archive Service rule appears in the Archive Service Rule tab.

Archive Service Rule Parameters

The following table describes the Archive Service rule parameters.

Attribute

Description

Activate Rule

Determines whether to activate an Archive Service rule.

Name

Defines the Archive Service rule name.

Description

Defines a free-text description of the Archive Service rule.

Archive Data

Determines which of the following data to archive:

  • Save log

  • Save output

You can toggle both options to archive both the logs and output.

Retention Period

Determines the number of days, months, or years to archive the data that is defined in the Archive Data parameter.

Maximum: 7 years

Platform

Determines which of the following platforms archive the data:

  • All

  • Distributed

  • z/OS

Job Type

Determines the job type that is archived, such as All or File Watcher jobs.

This attribute is not relevant for z/OS.

Job Status

Determines whether to archive jobs with the following status:

  • All: Applies the rule to jobs with all job status types, as described in Job Status.

  • Ended OK: Applies the rule only to jobs that Ended OK.

  • Ended Not OK: Applies the rule only to jobs that Ended Not OK.

Output Limit

Determines the maximum amount of storage that is reserved for job output.

Range:

  • 1 MB

  • 1–999 KB

Trim Output

Discards all or part of the job output file if it exceeds the amount defined in the Output Limit parameter.

Valid Values:

  • Trim output from the start when it exceeds the limit: Removes part of the data from the beginning of the last output file.

  • Trim output from the end when it exceeds the limit: Removes part of the data from the end of the last output file.

Job Name

Filters the jobs that are archived.

You can use * and ? wildcards, as described in Pattern-Matching Strings.

Control-M/Server

Filters the jobs on the Control-M/Server that you define.

You can use * and ? wildcards, as described in Pattern-Matching Strings.

Application

Filters the jobs in the applications that you define.

You can use * and ? wildcards, as described in Pattern-Matching Strings.

Sub-application

Filters the jobs in the sub-applications that you define.

You can use * and ? wildcards, as described in Pattern-Matching Strings.

Folder Name

Filters the jobs in the folders that you define, in the following format:

<SMART_Folder_Name>/<Sub-folder_Name>

You can use * and ? wildcards, as described in Pattern-Matching Strings.

The following SMART folders and sub-folders are defined in a workspace:

  • SMART folder A_SMART contains sub-folder a_Sub.

  • SMART folder B_SMART contains sub-folder b_Sub.

  • SMART folder C_SMART contains sub-folder b_Sub.

The Folder parameter is defined as follows:

  • A_SMART: Archives the A_SMART SMART folder.

  • B_SMART/b_Sub: Archives the b_Sub sub-folder in the B_SMART SMART folder.

  • */b_Sub: Archives both b_Sub sub-folders, in the B_SMART and C_SMART SMART folders.

Folder Library

(z/OS only) Filters the folder libraries for Control-M for z/OS environments.

You can use * and ? wildcards, as described in Pattern-Matching Strings.

Searching for Archive Data

This procedure describes how to search for archived job log and output data, which is stored in the Control-M Archive Service.

Begin

  1. From the drop-down list in the Monitoring domain, select Archive Search.

    The Archive Search tab appears.

  2. Do one of the following:

    • Basic Search: To search for archive data from the last seven days, do the following:

      1. In the search box, type the required job or folder attribute name.

      2. From the Searching for section, clear the unnecessary checkboxes so that only the required job or folder attributes remain selected.

      3. Click Search.

        The search runs, and the results appear.

    • Advanced Search: To perform an advanced search, click Advanced Search and then do the following:

      1. From the Last 7 days drop-down list, select the required historical time frame or define a custom time frame.

      2. From the All Job Statuses drop-down list, select the required job status.

      3. In the job or folder attributes fields, define the required attribute names.

      4. (Optional) Click Add Attribute to select additional attributes and define the required names.

      5. Click Search.

        The search runs, and the results appear.

    • Previous and Saved Searches: To search with previous search definitions, from the My Searches section, click a previous or saved (pinned) search.

      The search runs, and the results appear.

  3. (Optional) To save search definitions for future archive searches, do the following:

    1. Click the Archive Search tab.

      The Archive Search tab appears.

    2. From the My Searches section, click to the left of a previous search.

      A icon appears next to the search.

      You can save up to three searches.

  4. In the search results pane, select a search result to view more detailed job or folder information.

    The Summary, Log, or Output tabs appear in the right pane, based on the Archive Service Rule definitions, as described in Defining an Archive Service Rule.

Comparing Archive Data

This procedure describes how to compare archived job log and output data, which is stored in the Control-M Archive Service.

  1. Search for an archived job, as described in Searching for Archive Data.

  2. From the Job Name column in the main pane, select the checkbox next to two archived job runs.

    The archived jobs appear selected.

  3. Click Compare.

    The Compare dialog appears.

  4. Click Log or Output to compare the differences.

    The selected job run data appears side-by-side, with the differences shown in bold, orange text.

  5. (Optional) To show only the differences, toggle Show only differences.

    Only the differences appear.

  6. (Optional) To compare the logs instead of the output, or vice versa, click Log or Output.

    The selected job run data appears side-by-side, with the differences shown in bold, orange text

Exporting Archive Data

This procedure describes how to export archived job log and output data, which is stored in the Control-M Archive Service.

Begin

  1. Search for an archived job, as described in Searching for Archive Data.

  2. Click Export.

    A CSV file that contains all of the archived job data downloads to your default browser download directory.