@broadcom/ca7-for-zowe-cli/lib/cli/commands/items/PostRun_1.definition.js

CA 7 Workload Automation Plug-in for Zowe CLI

"use strict";
/*
* Copyright (c) 2025 Broadcom.  All Rights Reserved.  The term
* "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
*
* This software and all information contained therein is
* confidential and proprietary and shall not be duplicated,
* used, disclosed, or disseminated in any way except as
* authorized by the applicable license agreement, without the
* express written permission of Broadcom.  All authorized
* reproductions must be marked with this language.
*
* EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
* THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
* SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
* LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
* FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
* BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
* DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
* INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
* INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
* EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.PostRun_1Definition = void 0;
exports.PostRun_1Definition = {
    name: "run_1",
    aliases: ["run1"],
    summary: "Issue RUN command for DEFAULT_INSTANCE",
    description: "The RUN top line command forces immediate scheduling of a job without verifying the availability\n" +
        "of any input requirements or performing the updates that typically follow successful job completion.\n" +
        "The RUN command is similar to the DEMAND command.\n" +
        "When DEMAND is used, input requirement checking is performed and database updating is done upon completion of the job.\n" +
        "When RUN is used, no requirement posting or job triggering occurs.",
    examples: [
        {
            options: "--job AJOB",
            description: "Forces immediate scheduling of a job AJOB on default instance"
        }
    ],
    type: "command",
    handler: __dirname + "/PostRun_1.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "key",
            description: "The command transaction key",
            type: "string",
            required: false
        },
        {
            name: "job",
            description: "Identifies the job to submit." +
                "\nThe value must be a job name." +
                "\nIf the job has not been defined in the database," +
                "\nthis name must also match the member name for the JCL unless the job is defined in the database." +
                "\nSee also JCLID. JOB and JOBL are mutually exclusive." +
                "\nLimits:" +
                "\n1 to 8 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "jobl",
            description: "Identifies the job to submit." +
                "\nThe value must be a long job name." +
                "\nIf the job has not been defined in the database, use JOB instead." +
                "\nSee also JCLID. JOB and JOBL are mutually exclusive." +
                "\nLimits:" +
                "\n1 to 64 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "arfset",
            description: "(Optional) Identifies the ARF set name that is used for this run of the job." +
                "\nIf **NONE** is specified, no ARF processing is performed for this run of the job." +
                "\nLimits:" +
                "\n1 to 8 alphanumeric characters or **NONE**",
            type: "string",
            required: false
        },
        {
            name: "class",
            description: "(Optional) Specifies the workload balancing class for resource checking." +
                "\nLimits:" +
                "\n1 alphanumeric character",
            type: "string",
            required: false
        },
        {
            name: "dotm",
            description: "(Optional) Specifies a due-out time-of-day for the job. If omitted, the current time (when command is processed) plus the lead time is used." +
                "\nFormat:     hhmm" +
                "\n    Defines the time-of-day where hh is the hours (0 through 24) and mm is minutes (00 through 59)." +
                "\nYou can omit leading zeros." +
                "\n",
            type: "string",
            required: false
        },
        {
            name: "exec",
            description: "(Optional) Specifies whether to execute the job (YES/NO)." +
                "\nIf NO (N) is used, the job does not run but shows a normal completion as if it did run." +
                "\nThe value that is specified here overrides the value that is coded on the job definition EXEC field." +
                "\nDefault:" +
                "\nThe job definition panel EXEC value if job defined to CA WA CA 7 Edition; otherwise YES.",
            type: "string",
            required: false
        },
        {
            name: "jclid",
            description: "(Optional) Defines the JCL data set that contains the execution JCL to be submitted." +
                "\nIf used, the value must be a numeric INDEX associated with the wanted JCL data set" +
                "\n(on the JCL statement in the initialization file). If the job is defined in the database," +
                "\nthe value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels." +
                "\nThis field or the JCLLIB field is required if the job is not defined in the database." +
                "\nJCLID and JCLLIB are mutually exclusive." +
                "\nNote:" +
                "\nAttempts to run cross-platform jobs that are not defined to the database fail because they are treated as regular CPU jobs when processed." +
                "\n Limits:" +
                "\n1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved." +
                "\n Required:" +
                "\n No, unless job is not defined in database",
            type: "string",
            required: false
        },
        {
            name: "jcllib",
            description: "(Optional) Defines the JCL data set that contains the execution JCL to be submitted." +
                "\nIf used, the value must be a symbolic INDEX associated with the wanted JCL data set" +
                "\n(on the JCL statement in the initialization file)." +
                "\nIf the job is defined in the database, the value must be the same as the value on the DB.1 panel" +
                "\nor the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels." +
                "\nThis field or the JCLID field is required if the job is not defined in the database." +
                "\nJCLID and JCLLIB are mutually exclusive." +
                "\nNote:" +
                "\nAttempts to run cross-platform jobs that are not defined to the database fail because they are treated as regular CPU jobs when processed.Limits:" +
                "\n2 to 16 alphanumeric characters beginning with ampersand (&)" +
                "\n Required:" +
                "\n No, unless job is not defined in database" +
                "\nNote:" +
                "\nA dynamic allocation failure on a JCL data set specified by JCLLIB causes the job to enter the request queue in SKELETON status. ",
            type: "string",
            required: false
        },
        {
            name: "late",
            description: "(Optional) Specifies whether notification occurs when the job becomes late." +
                "\nSpecify YES (Y) to make the job eligible to be marked LATE." +
                "\nIf NO (N) is used, the job is never marked LATE." +
                "\nThe value that is specified here overrides the value that is coded on the job definition PROMPTS field.",
            type: "string",
            required: false
        },
        {
            name: "leadtm",
            description: "(Optional) Specifies the lead (processing) time that is required for the job to run. If omitted, 1 hour is used." +
                "\nFormat:    hhmm" +
                "\n    Defines the time where hh is hours (0 through 23) and mm is minutes (00 through 59)." +
                "\nYou can omit leading zeros.",
            type: "string",
            required: false
        },
        {
            name: "mainid",
            description: "(Optional) Specifies the MAINID, as defined in the initialization file CPU statement, to which the job is redirected. The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:    ALL" +
                "\n    Specifies all CPUs are acceptable for executing the job.    SYn" +
                "\n    n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.    /SYn" +
                "\n    n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.    -SYn" +
                "\n    n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.Limits:" +
                "\nInvalid with cross-platform jobs",
            type: "string",
            required: false
        },
        {
            name: "rms",
            description: "(Optional) Specifies whether CA WA CA 7 Edition inserts the CA WA Restart_XXX Option RMS step." +
                "\nSpecify YES (Y) to insert the step with the CA WA Restart_XXX Option processing code of P." +
                "\nEnter NO (N) to indicate that the RMS step is not inserted." +
                "\nThe value that is specified here overrides the value that is coded on the job definition INSERT-RMS field." +
                "\nDefault: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO." +
                "\nLimits:" +
                "\nInvalid for cross-platform jobs." +
                "\nNote: For more information, see [Interface with CA WA Restart_XXX Option for z/OS Schedulers](https://docops.ca.com/ca-workload-automation-ca-7-edition/12-0/en/configuring/interfaces/interfaces-with-other-products/interface-with-ca-wa-restart-option-for-z-os-schedulers/) ",
            type: "string",
            required: false
        },
        {
            name: "schid",
            description: "(Optional) Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands." +
                "\nIf used, the value must be a schedule ID number." +
                "\nDefault: 1" +
                "\nLimits:" +
                "\n1 to 3 numeric characters from 1 through 999" +
                "\nRequired:" +
                "\n No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)",
            type: "string",
            required: false
        },
        {
            name: "time",
            description: "(Optional) Establishes a submit time-of-day requirement for the job." +
                "\nFormat:    hhmm" +
                "\n    Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59)." +
                "\n    Leading zeros are not required.",
            type: "string",
            required: false
        },
        {
            name: "type",
            description: "(Optional) Indicates that the job is being scheduled for rerun." +
                "\nThe value must be specified as shown." +
                "\nTYPE=RES is optional." +
                "\nIf used, a restart requirement is placed on the job, and the job has to be manually restarted.",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostRun_1.definition.js.map