@broadcom/ca7-for-zowe-cli/lib/cli/commands/items/PostDemandh_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.PostDemandh_1Definition = void 0;
exports.PostDemandh_1Definition = {
    name: "demandh_1",
    aliases: ["deh1"],
    summary: "Issue DEMANDH command for DEFAULT_INSTANCE",
    description: "The DEMANDH command indicates that the demanded job is placed on hold in the CA Workload Automation CA 7® Edition request queue.",
    examples: [
        {
            options: "--ca7Id Instance1 --job PAYROLL",
            description: "Hold the demanded job PAYROLL to CA 7 on Instance1"
        }
    ],
    type: "command",
    handler: __dirname + "/PostDemandh_1.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "key",
            description: "The command transaction key",
            type: "string",
            required: false
        },
        {
            name: "job",
            description: "Defines the name of the job being demanded." +
                "\nThe demanded jobs are placed in the request queue and assigned a unique CA 7 job number." +
                "\nJOB and JOBL are mutually exclusive" +
                "\nLimits:" +
                "\n 1 to 8 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "jobl",
            description: "(Optional) Defines the long name of the job being demanded. The demanded jobs are placed in the request queue and assigned a unique CA 7 job number." +
                "\nJOB and JOBL are mutually exclusive" +
                "\nLimits:" +
                "\n 1 to 64 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "arfset",
            description: "(Optional)Defines the ARF set name that is used for this run of the job." +
                "\n you specify **NONE**, no ARF processing is performed for this run of the job" +
                "\nLimits:" +
                "\n 1 to 4 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "cc",
            description: "(Optional)Defines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully." +
                "\nIf specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database." +
                "\nRO is required when CC is specified" +
                "\nLimits:" +
                "\n 1 to 4 numeric characters(0-4095)",
            type: "string",
            required: false
        },
        {
            name: "class",
            description: "(Optional)Defines the workload balancing class for resource checking,  " +
                "\nLimits:" +
                "\n 1 alphanumeric character",
            type: "string",
            required: false
        },
        {
            name: "count",
            description: "Defines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified." +
                "\n If both COUNT and STOP are specified, the job stops repeating when the COUNT reaches zero or the STOP time is reached, whichever comes first." +
                "\nDefault: None. The job continues repeating until the STOP time is reached" +
                "\nLimits:" +
                "\n 1 to 4 numeric characters(0-1439)",
            type: "string",
            required: false
        },
        {
            name: "date",
            description: "(Optional)Defines due-out and submit dates." +
                "\nLimits:" +
                "\n If used, specify DOTM or TIME." +
                "\n+nn" +
                "\nDefines the number of days after the current date." +
                "\nLimits:" +
                "\n 1 to 2 numeric characters from 1 to 99" +
                "\nyyddd" +
                "\nDefines the Julian date to run the job.",
            type: "string",
            required: false
        },
        {
            name: "depjob",
            description: "(Optional)Defines a single predecessor job that must complete while the demanded job is waiting." +
                "\nLimits:" +
                "\n 1 to 8 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "dotm",
            description: "(Optional)Defines the due-out time-of-day for the job in hours (hh) and minutes (mm)." +
                "\nIf omitted, the current time (when the DEMAND was processed) plus the lead time is assumed." +
                "\nIf DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day." +
                "\nIf DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM." +
                "\nDefault: Current time, hhmm",
            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: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES," +
                "\nValues:YES|Y, NO|N",
            type: "string",
            required: false
        },
        {
            name: "interval",
            description: "(Optional)Identifies that the job is repeated (executed more than once) and defines the amount of time between each iteration." +
                "\nIf INTERVAL is specified, the TIME and TYPE keywords are required." +
                "\nIf both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours." +
                "\nFor information about how the deadline, due-out, and submit times are calculated for repeating jobs, see the Usage Notes." +
                "\nDefault: None. The job is not repeated." +
                "\nLimits:" +
                "\n hh=1 through 2 numeric charact,  hhmm",
            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 (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 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" +
                "\nLimits:" +
                "\n 1 to 3 numeric characters(1-999)",
            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 (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" +
                "\n or 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. JCLID 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" +
                "\n1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.",
            type: "string",
            required: false
        },
        {
            name: "late",
            description: "(Optional)Specifies whether a 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," +
                "\nValues:YES|Y, NO|N",
            type: "string",
            required: false
        },
        {
            name: "leadtm",
            description: "(Optional)Defines the amount of elapsed time that is required to process the job." +
                "\nIndicates in hours (hh) and minutes (mm) the elapsed time." +
                "\nThe maximum value that you can specify is 2400." +
                "\nDefault: 1 hour" +
                "\nLimits:" +
                "\n hh= 1 through 2 numeric characters from 0 to 24" +
                "\nmm= 2 numeric characters from 00 to 59",
            type: "string",
            required: false
        },
        {
            name: "mainid",
            description: "(Optional)Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job." +
                "\nThe value that is specified here overrides the value that is coded on the job definition MAINID field." +
                "\nAlso, the SASSXX05 user exit does not override this value." +
                "\nThe name must be one of the following values:    ALL Specifies all CPUs are acceptable for executing the job." +
                "\nSYn n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7." +
                "\n/SYn n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7." +
                "\n-SYn n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7." +
                "\nLimits:" +
                "\n Invalid for internal cross-platform jobs.",
            type: "string",
            required: false
        },
        {
            name: "prty",
            description: "(Optional)Defines the initial workload balancing priority," +
                "\n  1-3 numeric (1-255)",
            type: "string",
            required: false
        },
        {
            name: "rms",
            description: "(Optional)Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart_XXX Option for z/OS Schedulers RMS step." +
                "\nSpecify YES (Y) to insert the step with the CA Workload Automation Restart_XXX Option for z/OS Schedulers processing code of P.Enter NO (N) to indicate do not insert of the RMS step." +
                "\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:" +
                "\n Invalid for internal cross-platform jobs" +
                "\n,  Values: YES|Y, NO|N",
            type: "string",
            required: false
        },
        {
            name: "ro",
            description: "(Optional)Specifies the relational operator of the condition code (CC) or" +
                "\nif the step level #SCC statements are being used in the JCL of the job." +
                "\nIf specified, this RO overrides the RO defined for the job in the CA WA CA 7 Edition database." +
                "\nThe following values are valid:" +
                "\n    EQ : Equal to" +
                "\n    LT : Less than" +
                "\n    GT : Greater than" +
                "\n    GE : Greater than or equal to" +
                "\n    LE : Less than or equal to" +
                "\n    NE : Not equal to" +
                "\n    #S : Step condition code tests to be made based on a #SCC statement." +
                "\n    IG : No evaluation of the job is done." +
                "\nCA WA CA 7 Edition always assumes that the job completes successfully, regardless of condition codes, abend codes, or run-time JCL errors." +
                "\n0: No condition code test is made." +
                "\nDefault: The job definition panel RO value if the job is defined to CA WA CA 7 Edition; otherwise 0." +
                "\nLimits:" +
                "\n" +
                "\n Invalid with agent jobs.",
            type: "string",
            required: false
        },
        {
            name: "schid",
            description: "Defines the schedule ID within the job's total schedule definition to use for this run." +
                "\nIf omitted, SCHID=1 is assumed unless the job exists in the CA WA CA 7 Edition database and has an associated schedule." +
                "\nIn this case, the first SCHID defined in the schedule member is assumed." +
                "\nDefault: 1, " +
                "\nLimits:" +
                "\n 1 to 3 numeric characters from 1 to 999 (See Note)" +
                "\nNote: If the SCHEDULE statement in the initialization file specifies SCHID=YES, this parameter is required. ",
            type: "string",
            required: false
        },
        {
            name: "set",
            description: "(Optional)Specifies skip the next scheduled cycle for the job (SKP)," +
                "\ndisable triggering (NTR), or bypass the database updating at the job completion." +
                "\n    SKP" +
                "\n    Specifies this run of the job takes the place of the next scheduled run." +
                "\nThis value has the same effect as entering NXTCYC,SET=SKP." +
                "\nIt is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used." +
                "\nThis parameter is invalid if the job has no schedule." +
                "\nSET=SKP has no impact on repeating jobs that are already in the queues." +
                "\nNTR Specifies normal triggering is disabled only for this run of the job." +
                "\nNDB Allows a job to bypass all load processing at the job completion," +
                "\n but allows other processing to proceed typically." +
                "\n    Note: Data set triggering is still in effect." +
                "\n, SKP|NTR|NDB",
            type: "string",
            required: false
        },
        {
            name: "stop",
            description: "(Optional)Defines the clock time after which the job is not repeated." +
                "\nSTOP is ignored if INTERVAL is not specified." +
                "\nIf both COUNT and STOP are specified, the job stops repeating when either the COUNT reaches zero or the STOP time is reached, whichever comes first." +
                "\nIf the STOP time is less than the submit time, the stop date is assumed to be the following day." +
                "\nDefault:" +
                "\n1439 minutes (24 hours minus 1 minute) after the submit time" +
                "\nLimits:" +
                "\n" +
                "\nhh=1 through 2 numeric characters from 0 to 23" +
                "\nmm=2 numeric characters from 00 to 59",
            type: "string",
            required: false
        },
        {
            name: "time",
            description: "(Optional)Defines a submit time-of-day requirement for the job." +
                "\nIf the format is used with a +, the submit time is calculated from the current time, adding the specified number of hours and minutes." +
                "\nIf the + is used, the DATE keyword must be omitted." +
                "\nLimits:" +
                "\n" +
                "\n+ is optional" +
                "\nhh= 1 through 2 numeric characters from 0 to 23" +
                "\nmm= 2 numeric characters from 00 to 59" +
                "\nRequired:" +
                "\n " +
                "\nNo (unless DATE is used, if so, specify DOTM or TIME (hhmm format). Also required if TYPE=CLOCK is specified.",
            type: "string",
            required: false
        },
        {
            name: "type",
            description: "(Optional)TYPE=RES specifies the job is being scheduled in restart/rerun status." +
                "\nTYPE=CLOCK, START, or END controls how the submit time requirement is calculated for repeating jobs." +
                "\n" +
                "\nWhen TYPE=RES the job is put into the request queue with a restart requirement." +
                "\nThe job is not submitted before the CA WA CA 7 Edition restart is done." +
                "\nThe output networks are scheduled, but input requirements checking is bypassed." +
                "\nTYPE=CLOCK, START, or END is ignored if INTERVAL is not specified." +
                "\nWith TYPE=CLOCK, the interval is added to the previous iteration's submit time requirement to determine the new submit time requirement." +
                "\nWith TYPE=START and END the interval is added to the previous iteration's last (most recent) start and end time," +
                "\nrespectively, to determine the new submit time requirement. TYPE is required when INTERVAL is specified." +
                "\nLimits:" +
                "\n" +
                "\nRES, CLOCK, START, or END",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostDemandh_1.definition.js.map