@broadcom/ca7-for-zowe-cli/lib/cli/commands/items/PostJclovrd.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.PostJclovrdDefinition = void 0;
exports.PostJclovrdDefinition = {
    name: "jclovrd",
    aliases: ["jcd"],
    summary: "Issue JCLOVRD command for CA 7 instance specified in path",
    description: "The JCLOVRD command establishes or satisfies JCL override requirements.\n" +
        "This command is primarily used when the CPU job does not have a permanent JCL override requirement assigned.\n" +
        "The CPU job for which the JCL override is being established (or satisfied) must be in the request queue.\n" +
        "If you are using CA Workload Automation CA 7 Edition to insert IBM WLM scheduling environment keywords on JOB statements,\n" +
        "you can use the JCLOVRD command to suppress or allow SCHENV= keyword insertion.\n" +
        "This function is available as the J value for FILL FUNCTION on the QM.1 panel.\n" +
        "The function can also be accomplished with the QM.2 and QM.3 panels.",
    examples: [
        {
            options: "--ca7Id Instance1 --ca7# 29",
            description: "Establishes or satisfies JCL override requirements for CA7 number 29 on Instance1"
        }
    ],
    type: "command",
    handler: __dirname + "/PostJclovrd.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "ca7Id",
            description: "CA7ONL Instance",
            type: "string",
            required: true
        },
        {
            name: "ca7Id",
            description: "CA7ONL Instance",
            type: "string",
            required: true
        },
        {
            name: "key",
            description: "The command transaction key",
            type: "string",
            required: false
        },
        {
            name: "ca7#",
            description: "Defines the CA 7 job number of the job in the request queue for which to establish or remove the override requirement." +
                "\nLimits:" +
                "\n1 to 4 numeric characters",
            type: "string",
            required: false
        },
        {
            name: "set",
            description: "Specifies to establish or satisfy JCL override requirements." +
                "\nWhen a job fails with a JCL error, the JCL override requirement is automatically set to ON when the job returns to the request queue." +
                "\nThe JCL override must be set to OFF before the job can be submitted again." +
                "\n    ON" +
                "\n    Establishes a JCL override requirement for the specified job." +
                "\nThe SET=ON option is used for jobs in the request queue to indicate that an override is needed before execution is to occur." +
                "\n    OFF" +
                "\nSatisfies a JCL override requirement for the specified job.      The SET=OFF option indicates that a previously defined need (requirement) for overrides has been satisfied and execution can be safely attempted." +
                "\n     When a JCL override requirement is set to OFF," +
                "\n    that requirement no longer appears on a requirements list for the job" +
                "\n When a REPL is done from the QM.5 panel, the JCL override requirement is automatically set to OFF." +
                "\n    WLM" +
                "\nSets job to allow the insertion of SCHENV= keyword on the JOB statement at submission time when these conditions are true:" +
                "\n    The scheduling environment insertion feature is activated." +
                "\n    A scheduling Environment VRM definition is attached to the job (or SCHENV global default)." +
                "\n    NOWLM" +
                "\nSets job to suppress the insertion of a SCHENV= keyword on the JOB statement at submission time even when one is typically associated with the job." +
                "\nThis option can be used when the validation of an associated IBM WLM scheduling environment has failed causing the job to be requeued (see Browse message SSM0-42)." +
                "\nFSetting the NOWLM option lets you submit the job without SCHENV= keyword insertion." +
                "\n",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostJclovrd.definition.js.map