Control-M Archive Service Configuration

Control-M Archive Service is a Control-M add-on that enables you to archive job data in a secure central repository when jobs finish execution. The Archive Service archives Control-M/Server job logs, Agent job output, and a small amount of job metadata from Control-M SaaS for a defined period of time, based on the active Workload Archiving policy.

Workload Archiving policies 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 Workload Archiving policies, which enable you to determine the type of data that is archived and how long it is stored in the Archive Service database, as described in Defining a Workload Archiving Policy.

Defining a Workload Archiving Policy

This procedure describes how to define a Workload Archiving policy that enables you to determine which data to archive and how long to store it in the Archive Service database.

Control-M Archive Service applies policies in the order that you create them, as shown in the Priority column in the Workload Archiving tab.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Workload Archiving.

    The Workload Archiving 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 Workload Archiving Policy Rule Parameters.

  5. Click Add.

    The Workload Archiving policy rule appears in the Workload Archiving tab.

Workload Archiving Policy Rule Parameters

The following table describes the Workload Archiving policy rule parameters.

Attribute

Description

Activate Rule

Determines whether to activate a Workload Archiving policy rule.

Name

Defines the Workload Archiving policy name.

Description

Defines a free-text description of the Workload Archiving policy.

Archive Data

Determines which of the following data to archive:

  • Log and Output

  • Log

  • 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 on the Workload Archiving Server 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.

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.

Job Name

Filters the jobs that are archived.

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 z/OS.

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