@broadcom/ca7-for-zowe-cli/lib/cli/dataset/items/PutTrigger.definition.js

CA 7 Workload Automation Plug-in for Zowe CLI

"use strict";
/*
* Copyright © 202X Broadcom Inc. and/or its subsidiaries
* © 202X Broadcom Inc and/or its subsidiaries; All rights reserved
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.PutTriggerDefinition = void 0;
exports.PutTriggerDefinition = {
    name: "update-dataset-trigger",
    aliases: ["udt"],
    summary: "Modify Dataset Trigger definition",
    description: "Modify Dataset Trigger",
    examples: [
        {
            options: "--dname DATA.SET.NAME --schid 42 --tj JOBA --tjdot 0830 --tjlt 0030 --tjst 1030",
            description: "Update a Dataset Trigger definition DATA.SET.NAME with schid 42 for Triggered job JOBA"
        }
    ],
    type: "command",
    handler: __dirname + "/PutTrigger.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "dataset-name",
            aliases: ["dname"],
            description: "(Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job." +
                "\nNote: For VSAM files, specify the cluster name." +
                "\nLimits: 1 to 44 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "dataset-number",
            aliases: ["dnum"],
            description: "(Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set." +
                "\nLimits: 1 to 8 numeric characters",
            type: "string",
            required: false
        },
        {
            name: "schid",
            description: "(Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled." +
                "\nNote: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work" +
                "\nDefault: 0 (all schedule IDs)" +
                "\nLimits: 1 to 3 numeric characters from 0 through 999",
            type: "string",
            required: false
        },
        {
            name: "triggered-job",
            aliases: ["tj"],
            description: "Specifies the job name that the completion of the triggering dataset triggers." +
                "\nLimits: 1 to 8 alphanumeric characters",
            type: "string",
            required: true
        },
        {
            name: "triggered-job-schid",
            aliases: ["tjs"],
            description: "(Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue." +
                "\nDefault: 0 (no replacement)" +
                "\nLimits: 1 to 3 numeric characters from 0 through 999" +
                "\nNote: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.",
            type: "string",
            required: false
        },
        {
            name: "triggered-job-due-out-time",
            aliases: ["tjdot"],
            description: "(Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments." +
                "\nIf this parameter is used, triggered-job-queue-time must be omitted." +
                "\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10." +
                "\nNote: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.",
            type: "string",
            required: false
        },
        {
            name: "triggered-job-queue-time",
            aliases: ["tjqt"],
            description: "(Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments." +
                "\nIf this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime." +
                "\nDeadline time is calculated as current date/time plus queue time." +
                "\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24." +
                "\nThe mm can be 00 through 59, the highest value being 2400.",
            type: "string",
            required: false
        },
        {
            name: "triggered-job-lead-time",
            aliases: ["tjlt"],
            description: "(Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time." +
                "\nDefault: 0000" +
                "\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24." +
                "\nThe mm can be 00 through 59, the highest value being 2400.",
            type: "string",
            required: false
        },
        {
            name: "triggered-job-submit-time",
            aliases: ["tjst"],
            description: "(Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time." +
                "\nThe triggered-job-submit-time is always rounded down to 15-minute increments." +
                "\nDefault: 0 (no specific submit time requirement)" +
                "\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400." +
                "\nNote: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date." +
                "\n" +
                "\nIf triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PutTrigger.definition.js.map