Job Archiving configuration

9.0.20.000 This page provides information for creating Archive Rule files, that is, payload JSON files that you can submit when you configure Job Archiving.

The following code sample shows the available properties and objects that you can include within such a file. The rest of this page provides details about each of these properties and objects.

{
    "name": "All DS jobs",
    "description": "Collect all DS jobs",
    "maxOutputSize": 20,
    "maxOutputSizeType": "MB",
    "trimType": "Omit",
    "retention": 1,
    "retentionType": "Months",
    "isActive": true,
    "archivedType": "Log",
    "ruleParameters": [
        {
          "field": "ctm",
          "criteria": "*",
          "exceptions": [
            "fds*"
          ]
        },
        {
          "field": "jobName",
          "criteria": "A*",
          "exceptions": [
            "Ac*",
            "Ad*"
          ]
        },
        {
          "field": "jobType",
          "criteria": "Job:FileTransfer"
        },
        {
          "field": "application",
          "criteria": "*",
          "exceptions": [
            "c*"
          ]
        },
        {
          "field": "subApplication",
          "criteria": "s*",
          "exceptions": [
            "s4*"
          ]
        },
        {
          "field": "folder",
          "criteria": "*",
          "exceptions": [
            "f*"
          ]
        },
        {
          "field": "library",
          "criteria": "bmc*",
          "exceptions": [
            "bmc6*",
            "bmc7*"
          ]
        },
        {
          "field": "jobStatus",
          "criteria": "Ended OK"
        }
    ]
}

General rule settings

Start your Archive Rule file with the following general properties for the rule that you are defining:

Rule parameters for job filtering

Under the ruleParameters object, you can define a group of rule parameters that filter jobs based on various job properties and determine which jobs to archive. These parameters are defined with the following properties:

• field — job property by which to filter
• criteria — filter value
• exceptions — values to exclude from the filter

All rule parameters are optional, and the default for all criteria is "*" (ALL jobs).

The following table summarizes the guidelines for including rule parameters in an Archive Rule file: