@broadcom/ca7-for-zowe-cli/lib/Constants.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.Constants = void 0;
class Constants {
}
exports.Constants = Constants;
Constants.URI_COMMANDS = "/commands/";
Constants.URI_JOBDEF = "/job/definition/";
Constants.URI_JOBINSTANCE = "/job/instance/";
Constants.URI_JOBHISTORY = "/job/history/";
Constants.URI_RESOURCEDEF = "/resource/";
Constants.URI_DATASET = "/dataset/definition/";
Constants.URI_AGENT_CRED = "/agent-credentials/";
Constants.URI_AGENT = "/agent/";
Constants.URI_CA7_INSTANCE = "/ca7-instance/";
/**
 * Prefix for environmental variable settings used by Imperative
 * @static
 * @memberof Constants
 */
Constants.ENV_PREFIX = "CA7_PLUGIN";
/**
 * Display Display name
 * @static
 * @memberof Constants
 */
Constants.DISPLAY_NAME = "CA7 Plugin";
/**
 * Description of PLUGIN SUMMARY
 * @static
 * @memberof Constants
 */
Constants.PLUGIN_SUMMARY = "CA7 Plugin for ZOWE CLI";
/**
 * Description of product
 * @static
 * @memberof Constants
 */
Constants.DESCRIPTION = "Welcome to the CA 7 Zowe CLI!";
/**
 * Home directory
 * @static
 * @memberof Constants
 */
Constants.HOME_DIR = "~/.ca7_plugin";
Constants.CLI_JOB_ARFSET = {
    name: "arfset",
    aliases: ["as"],
    description: "arfset={arfsetname|**NONE**}\n\n" +
        "Defines the ARF set name that is used for this run of the job.\n" +
        "If you specify **NONE**, no ARF processing is performed for this run of the job.\n\n" +
        "Limits: 1 to 8 alphanumeric characters or **NONE**",
    type: "string"
};
Constants.CLI_JOB_CC = {
    name: "cc",
    description: "cc=1234\n\n" +
        "Defines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully.\n\n" +
        "If specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database. RO is required when CC is specified.\n\n" +
        "Default: The job definition panel COND-CODE value when the job is defined to CA WA CA 7 Edition; otherwise 0.\n" +
        "Limits: 1 to 4 numeric characters from 0 to 4095. Invalid with agent jobs.",
    type: "string"
};
Constants.CLI_JOB_COUNT = {
    name: "count",
    description: "count=nnnn\n\n" +
        "Defines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified.\n\n" +
        "Default: None. The job continues repeating until the STOP time is reached.\n" +
        "Limits: 1 to 4 numeric characters from 0 to 1439. The leading zeros can be discarded.",
    type: "string"
};
Constants.CLI_JOB_CLASS = {
    name: "class",
    description: "class=n\n\n" +
        "Defines the workload balancing class for resource checking.\n\n" +
        "Limits: 1 alphanumeric character",
    type: "string"
};
Constants.CLI_JOB_DATE = {
    name: "date",
    description: "date={+nn|yyddd}\n\n" +
        "Defines due-out and submit dates.\n" +
        "Limits: If used, specify DOTM or TIME.\n" +
        "+nn\n\n" +
        "Defines the number of days after the current date.\n" +
        "Limits: 1 to 2 numeric characters from 1 to 99\n" +
        "yyddd\n\n" +
        "Defines the Julian date to run the job.",
    type: "string"
};
Constants.CLI_JOB_DEPJOB = {
    name: "depjob",
    aliases: ["dj"],
    description: "depjob=jobname2\n\n" +
        "Defines a single predecessor job that must complete while the demanded job is waiting.\n" +
        "Limits: 1 to 8 alphanumeric characters",
    type: "string"
};
Constants.CLI_JOB_DOTM = {
    name: "dotm",
    description: "dotm=hhmm\n\n" +
        "Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).\n" +
        "If 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.\n\n" +
        "If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.\n\n" +
        "Limits:  hh= 2 numeric characters from 0 to 24\n" +
        "mm= 2 numeric characters from 00 to 59\n\n" +
        "Required: No (unless DATE is used, if so, DOTM or TIME must be specified)",
    type: "string"
};
Constants.CLI_JOB_EXEC = {
    name: "exec",
    aliases: ["e"],
    description: "exec={NO|YES}\n\n" +
        "Specifies whether to execute the job (YES/NO).\n" +
        "If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.\n\n" +
        "Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.",
    type: "string"
};
Constants.CLI_JOB_INTERVAL = {
    name: "interval",
    aliases: ["i"],
    description: "interval=hhmm\n\n" +
        "Identifies that the job is repeated (executed more than once) and defines the amount of time between each iteration.\n\n" +
        "If INTERVAL is specified, the TIME and TYPE keywords are required. If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.\n\n" +
        "Limits: hh=2 numeric characters from 0 to 23\n" +
        "mm=2 numeric characters from 00 to 59",
    type: "string"
};
Constants.CLI_JOB_JCLID = {
    name: "jclid",
    aliases: ["ji"],
    description: "jclid=10\n\n" +
        "Defines the JCL data set that contains the execution JCL to be submitted.\n\n" +
        "If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).\n\n" +
        "If the job is defined in the database, the 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." +
        "This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive." +
        "Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.",
    type: "string",
    conflictsWith: ["jcllib"]
};
Constants.CLI_JOB_JCLLIB = {
    name: "jcllib",
    aliases: ["jl"],
    description: "jcllib=&SPECIAL\n\n" +
        "Defines the JCL data set that contains the execution JCL to be submitted.\n\n" +
        "If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).\n\n" +
        "If the job is defined in the database, the 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." +
        "This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive." +
        "Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)",
    type: "string"
};
Constants.CLI_JOB_LATE = {
    name: "late",
    description: "late={NO|YES}\n\n" +
        "Specifies whether a notification occurs when the job becomes late.\n" +
        "Specify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.",
    type: "string"
};
Constants.CLI_JOB_LEADTM = {
    name: "leadtm",
    aliases: ["lt"],
    description: "leadtm={0100|hhmm}\n\n" +
        "Specifies the lead (processing) time that is required for the job to run.\n" +
        "If omitted, 1 hour is used" +
        "Format: hhmm\n" +
        "Limits: hh= 2 numeric characters from 0 to 24\n" +
        "mm= 2 numeric characters from 00 to 59" +
        "You can omit leading zeros.",
    type: "string"
};
Constants.CLI_JOB_MAINID = {
    name: "mainid",
    aliases: ["mi"],
    description: "mainid={ALL|SYn|/SYn|-SYn}\n\n" +
        "Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.\n" +
        "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:\n\n" +
        "ALL\n" +
        "Specifies all CPUs are acceptable for executing the job.\n\n" +
        "SYn\n" +
        "n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.\n\n" +
        "/SYn\n" +
        "n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.\n\n" +
        "-SYn\n" +
        "n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.\n\n" +
        "Limits: Invalid for internal cross-platform jobs.",
    type: "string"
};
Constants.CLI_JOB_PRTY = {
    name: "prty",
    description: "prty=nnn\n" +
        "Defines the initial workload balancing priority\n\n" +
        "Limits: 1-3 numeric (1-255).",
    type: "string"
};
Constants.CLI_JOB_RMS = {
    name: "rms",
    description: "rms={NO|YES}\n\n" +
        "Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart_XXX Option for z/OS Schedulers RMS step.\n\n" +
        "Specify 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 that the RMS step is not inserted.\n\n" +
        "The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.\n" +
        "Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.\n" +
        "Limits: Invalid for internal cross-platform jobs.",
    type: "string"
};
Constants.CLI_JOB_RO = {
    name: "ro",
    description: "ro={EQ|LT|GT|GE|LE|NE|#S|IG|0}\n\n" +
        "Specifies the relational operator of the condition code (CC) or if the step level #SCC statements are being used in the JCL of the job.\n\n" +
        "EQ\n" +
        "Equal to\n\n" +
        "LT\n" +
        "Less than\n\n" +
        "GT\n" +
        "Greater than\n\n" +
        "GE\n" +
        "Greater than or equal to\n\n" +
        "LE\n" +
        "Less than or equal to\n\n" +
        "NE\n" +
        "Not equal to\n\n" +
        "#S\n" +
        "Step condition code tests to be made based on a #SCC statement.\n\n" +
        "IG\n" +
        "No evaluation of the job is done. CA WA CA 7 Edition always assumes that the job completes successfully, regardless of condition codes, abend codes, or run-time JCL errors.\n\n" +
        "Limits: Invalid with agent jobs.",
    type: "string",
};
Constants.CLI_JOB_SCHID = {
    name: "schid",
    aliases: ["si"],
    description: "schid={1|nnn}\n\n" +
        "Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.\n\n" +
        "Default: 1\n" +
        "Limits: 1 to 3 numeric characters from 1 to 999 (See Note)\n\n" +
        "No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)",
    type: "string"
};
Constants.CLI_JOB_SET = {
    name: "set",
    description: "set={NDB|NTR|SKP}\n\n" +
        "Specifies skip the next scheduled cycle for the job (SKP), disable triggering (NTR), or bypass the database updating at the job completion.\n\n" +
        "SKP\n" +
        "Specifies this run of the job takes the place of the next scheduled run. This value has the same effect as entering NXTCYC,SET=SKP. It is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used. This parameter is invalid if the job has no schedule. SET=SKP has no impact on repeating jobs that are already in the queues.\n\n" +
        "NTR\n" +
        "Specifies normal triggering is disabled only for this run of the job.\n\n" +
        "NDB\n" +
        "Allows a job to bypass all load processing at the job completion, but allows other processing to proceed typically.",
    type: "string"
};
Constants.CLI_JOB_STOP = {
    name: "stop",
    description: "stop=hhmm\n\n" +
        "Defines the clock time after which the job is not repeated. STOP is ignored if INTERVAL is not specified.\n\n" +
        "Default: 1439 minutes (24 hours minus 1 minute) after the submit time\n" +
        "Limits: hh=1 through 2 numeric characters from 0 to 23\n" +
        "mm=2 numeric characters from 00 to 59",
    type: "string"
};
Constants.CLI_JOB_TIME = {
    name: "time",
    description: "time={hhmm|+hhmm}\n\n" +
        "Establishes a submit time-of-day requirement for the job.\n\n" +
        "Format: 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\n\n",
    type: "string"
};
Constants.CLI_JOB_TYPE = {
    name: "type",
    description: "type={CLOCK|END|RES|START}\n\n" +
        "Indicates that the job is being scheduled for rerun.\n" +
        "The value must be specified as shown.\n\n" +
        "TYPE=RES is optional." +
        "If used, a restart requirement is placed on the job, and the job has to be manually restarted." +
        "Limits: RES, CLOCK, START, or END",
    type: "string"
};
Constants.CLI_JOB_WLBCLASS = {
    name: "wlbclass",
    aliases: ["wc"],
    description: "class=x\n\n" +
        "Defines the workload balancing class for resource checking.\n\n" +
        "Limits: 1 alphanumeric character",
    type: "string"
};
Constants.CLI_JOB_INBOXNOD = {
    name: "inboxnod",
    aliases: ["ibn"],
    description: "inboxnod=MYWEBNOD" +
        "The  Web Service node where events associated with the job are to be delivered.\n\n" +
        "Limits: 1 to 8 alphanumeric characters",
    type: "string"
};
Constants.CLI_JOB_RMTJOB = {
    name: "rmtjob",
    description: "example: RMT_JOB\n\n" +
        "Names the job in the remote scheduler that is required by the job specified in the JOB field.\n" +
        "Limits: RMTJOB should accept up to 64 characters\n" +
        "valid characters are a-z, A-Z, 0-9, period (.), underscore (_), hyphen (-),\n" +
        "colon (:), and pound (#); do not include embedded spaces or tabs.\n",
    type: "string"
};
Constants.CLI_JOB_RMTSCHD = {
    name: "rmtschd",
    description: "example: AP1\n\n" +
        "Names the remote scheduler where the predecessor job runs.\n" +
        "Before adding this requirement, the remote scheduler must be defined.\n" +
        "The remote scheduler defined as type LOCAL cannot be specified.\n" +
        "Limits: 1 to 3 alphanumeric characters; generic specification not supported.",
    type: "string"
};
//# sourceMappingURL=Constants.js.map