UNPKG

@broadcom/ca7-for-zowe-cli

Version:

CA 7 Workload Automation Plug-in for Zowe CLI

994 lines 34.6 kB
"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.PostJobInstanceListCustom_1Definition = void 0; exports.PostJobInstanceListCustom_1Definition = { name: "list-custom_1", aliases: ["lc1"], summary: "Retrieves information about active jobs using a custom set of columns for DEFAULT_INSTANCE", description: "Displays information about jobs in the active workload.", examples: [ { options: "--ca7no 7777 --db CA7DB --jobname TESTCA7", description: "List a CA 7 job (7777) information which resided in CA7DB database " } ], type: "command", handler: __dirname + "/PostJobInstanceListCustom_1.handler", profile: { optional: ["ca7"] }, options: [ { name: "ca7no", description: "The CA 7 job number", type: "string", required: false }, { name: "jobname", aliases: ["jn"], description: "The CA 7 job name", type: "string", required: false }, { name: "databasename", aliases: ["db"], description: "The CA 7 database name", type: "string", required: false }, { name: "job", description: "The job name for this job in the active workload, 8 CHAR", type: "boolean", required: false }, { name: "queueName", description: "The name of the queue in which this job is currently located. Values are: 1=pre-processing; 2=request;3=ready; 4=active; 5=post-processing; 6=prior-run, CHAR 16", type: "boolean", required: false }, { name: "ca7#", description: "The job number for this job in the active workload", type: "boolean", required: false }, { name: "status", description: "The job status" + "\nFor more information about possible values refer to the LQ command." + "\nNote:" + "\nThis service determines values of status in much the same way as values are determined" + "\n for the JOB STATUS column of the LQ command." + "\nThe �LATE� value is an exception." + "\nUnlike the LQ command, this service will only evaluate and report late conditions when" + "\nnone of the other conditions are detected." + "\nFor example, the LQ command output may report a status value of �LATE�" + "\neven if the job is actually waiting for virtual resources." + "\nIn such a case, this service will report �W-RSRC�.", type: "boolean", required: false }, { name: "entryMode", description: "Identifies how the job was brought into the queue." + "\nThe possible values are the following:" + "\nARFJ" + "\n Indicates an ARF recovery job." + "\nAUTO" + "\n Indicates a triggered job." + "\nDEMD" + "\n Indicates a demanded job." + "\nEXTL" + "\n Indicates a job that is submitted external to CA WA CA 7 Edition" + "\nLOAD" + "\n Indicates a job to be loaded (brought in by the LOAD command)." + "\nPS" + "\n Indicates a job that the Personal Scheduling System submitted." + "\nRPET" + "\n Indicates a repeated job." + "\nRUN" + "\n Indicates a job that is brought in by the RUN command." + "\nSSCN" + "\n Indicates a job that is brought in by schedule scan." + "\nXDEM" + "\n Indicates a job brought in by the DEMAND command from an XPS client." + "\nXPS" + "\n Indicates a job brought in from an XPS client using the RUN command with the REF option." + "\nXRUN" + "\n Indicates a job brought in from an XPS client using the RUN command." + "\n", type: "boolean", required: false }, { name: "abended", description: "Y if job abended, N if not, 1 CHAR", type: "boolean", required: false }, { name: "agentIntervention", aliases: ["age"], description: "Y if INTERVENTION REQUIRED condition exists for this agent job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "agentJobNumber", aliases: ["age"], description: "The job number/PID for this agent job, 28 CHAR", type: "boolean", required: false }, { name: "agentName", description: "The name of the agent where this job will execute, 16 CHAR", type: "boolean", required: false }, { name: "agentStatus", aliases: ["age"], description: "The status for this agent job, 40 CHAR", type: "boolean", required: false }, { name: "agentStatusData", aliases: ["age"], description: "Y if status data is available for this agent job,N if not, 1 CHAR", type: "boolean", required: false }, { name: "agentSubmitted", aliases: ["age"], description: "Y if agent job has been submitted to the agent, N if not, 1 CHAR", type: "boolean", required: false }, { name: "agentType", description: "Agent job type, zero if this is not an agent job, INTEGER", type: "boolean", required: false }, { name: "agentUser", description: "The userid with which this agent job will execute, 120 CHAR", type: "boolean", required: false }, { name: "ajbBuildError", aliases: ["ajb"], description: "Y if an error occurred while building an XPJOB job AJB or an agent job AFM, N if not, 1 CHAR", type: "boolean", required: false }, { name: "arf", description: "Y if this job is monitored by ARF, N if not", type: "boolean", required: false }, { name: "arfAttachErr", aliases: ["arf"], description: "Y if this job had an ARF attach error, N if not, 1 CHAR", type: "boolean", required: false }, { name: "arfCompMatched", aliases: ["arf"], description: "Set to Y if an ARF JOB completion rule matched for this job, 1 CHAR", type: "boolean", required: false }, { name: "arfDate", description: "Y if the job uses ARF. CA recommends using column ARF instead of this column, 1 CHAR", type: "boolean", required: false }, { name: "arfErrorCond", aliases: ["arf"], description: "Set to Y if there was an error during ARF condition detection, N if not, 1 CHAR", type: "boolean", required: false }, { name: "arfjJob", description: "Y if job is an ARF recovery job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "arfJobComplete", aliases: ["arf"], description: "Set to Y if this job's completion has been posted to ARF, N if not, 1 CHAR", type: "boolean", required: false }, { name: "arfRecovery", aliases: ["arf"], description: "Y if job is in ARF recovery, N if not, 1 CHAR", type: "boolean", required: false }, { name: "arfRecoveryErr", aliases: ["arf"], description: "Y if this job had an error in ARF recovery, N if not, 1 CHAR", type: "boolean", required: false }, { name: "arfset", description: "The collection of ARF definitions that apply to this job, 8 CHAR", type: "boolean", required: false }, { name: "arfTime", description: "The date and time that the ARFSET was attached to this job, DATE/TIME", type: "boolean", required: false }, { name: "autofDone", description: "Y if job performed AUTO F, N if not, 1 CHAR", type: "boolean", required: false }, { name: "ca11JesNode", aliases: ["ca1"], description: "The JES node where this job executes, 8 CHAR", type: "boolean", required: false }, { name: "ca11RestartStep", aliases: ["ca1"], description: "The relative CA 11 restart step number, INTEGER", type: "boolean", required: false }, { name: "ca11RmsCc", description: "The CA 11 U11RMS step condition code, INTEGER", type: "boolean", required: false }, { name: "ca11Subsystem", aliases: ["ca1"], description: "The CA 11 subsystem name", type: "boolean", required: false }, { name: "ca7System", description: "The user-defined application system associated with this job, 8 CHAR", type: "boolean", required: false }, { name: "compCode", description: "The job completion code in number format, INTEGER", type: "boolean", required: false }, { name: "cpmJfm", description: "Y if JFM is used to track CPM, N if not, 1 CHAR", type: "boolean", required: false }, { name: "cpuTableIndex", aliases: ["cpu"], description: "Index to the CPU Table entry, SMALLINT", type: "boolean", required: false }, { name: "cputime", description: "This Job's average CPU time, PACKED", type: "boolean", required: false }, { name: "currStepNum", aliases: ["cur"], description: "The number of the step that is currently executing, INTEGER", type: "boolean", required: false }, { name: "defNotFound", aliases: ["def"], description: "Y if job defintion not found on database, N if not found, 1 CHAR", type: "boolean", required: false }, { name: "doNotPrompt", aliases: ["doN"], description: "Y if prompts are bypassed for the job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "drclass", description: "The job's disaster recovery class, 8 CHAR", type: "boolean", required: false }, { name: "drmode", description: "Y if this job entered the queues when disaster recovery mode was active, N if not, 1 CHAR", type: "boolean", required: false }, { name: "dueOutExists", aliases: ["due"], description: "Determines if a zero value in DUE_OUT_TIME indicates midnight (Y) or no due out time (N), 1 CHAR", type: "boolean", required: false }, { name: "dueOutTime", aliases: ["due"], description: "The date and time this job is expected to complete, DATE/TIME", type: "boolean", required: false }, { name: "dupJob", description: "Y if a job with the same name is waiting on this job to complete, N if not, 1 CHAR", type: "boolean", required: false }, { name: "dupJobWait", aliases: ["dup"], description: "Y if this job is waiting on a job with the same name to complete, N if not, 1 CHAR", type: "boolean", required: false }, { name: "elapsedTime", aliases: ["ela"], description: "This Job's average elapsed time, PACKED", type: "boolean", required: false }, { name: "endTime", description: "The date and time this job ended, DATE/TIME", type: "boolean", required: false }, { name: "executable", aliases: ["exe"], description: "Y if job is executable, N if not, 1 CHAR", type: "boolean", required: false }, { name: "express", description: "Y if submission of this job has been expedited by use of the SUBMIT,EXPRESS=YES command, N if not, 1 CHAR", type: "boolean", required: false }, { name: "externalInput", aliases: ["ext"], description: "Y if we job has external input, N if not, 1 CHAR", type: "boolean", required: false }, { name: "externalJob", aliases: ["ext"], description: "Y if this is an externally tracked job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "externalSatisfied", aliases: ["ext"], description: "The number of satisfied external requirements for this job, INTEGER", type: "boolean", required: false }, { name: "externalTotal", aliases: ["ext"], description: " The total number of external requirements for this job, INTEGER", type: "boolean", required: false }, { name: "forcedComplete", aliases: ["for"], description: "Y if job was force completed, N if not, 1 CHAR", type: "boolean", required: false }, { name: "forcedSubmit", aliases: ["for"], description: "Y if all input requirements have been marked as satisfied by use of the SUBMIT command, N if not, 1 CHAR", type: "boolean", required: false }, { name: "fromXpRequest", aliases: ["fro"], description: "Y if scheduling request for this job came from an XPS client, N if not, 1 CHAR", type: "boolean", required: false }, { name: "hasCa11", description: "Y if job has a CA11 segment, N if not, 1 CHAR", type: "boolean", required: false }, { name: "hasCpuTime", aliases: ["has"], description: "Y if we have non-zero CPU time for this job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "hasJo", description: "Y if the JCL or PARM DATA contains a #JO card, N if not, 1 CHAR", type: "boolean", required: false }, { name: "hasStepTime", aliases: ["has"], description: "Y if job has non-zero step CPU time, N if not, 1 CHAR", type: "boolean", required: false }, { name: "held", description: "Y if job is held, N if not, 1 CHAR", type: "boolean", required: false }, { name: "heldByJob", description: "Y if job was held on entry to the queues, N if not, 1 CHAR", type: "boolean", required: false }, { name: "heldSkeleton", aliases: ["hel"], description: "Y if job is held and in skeleton status, N if not, 1 CHAR", type: "boolean", required: false }, { name: "skeleton", description: "Y if job is in skeleton status, N if not, 1 CHAR", type: "boolean", required: false }, { name: "holdOnEntry", aliases: ["hol"], description: "Y if job marked HOLD=YES, N if not, 1 CHAR", type: "boolean", required: false }, { name: "hostName", description: "The SMF Id of the system where this is executing, 8 CHAR", type: "boolean", required: false }, { name: "inCpmFlow", description: "Y if job is part of a CPM flow, N if not, 1 CHAR", type: "boolean", required: false }, { name: "insertRms", description: "Y if an RMS step will be inserted into this job's JCL, N if not, 1 CHAR", type: "boolean", required: false }, { name: "jclAllocErr", aliases: ["jcl"], description: "Y if JCL or PARM DATA library could not be allocated, N if not, 1 CHAR", type: "boolean", required: false }, { name: "jclCount", description: " The number of non-# records in the JCL or PARM DATA members associated with this job, INTEGER", type: "boolean", required: false }, { name: "jclError", description: "Y if job marked with JCL error, N if not, 1 CHAR", type: "boolean", required: false }, { name: "jclFromAltlib", aliases: ["jcl"], description: "Y if JCL or PARM DATA was retrieved from an alternate library, N if not, 1 CHAR", type: "boolean", required: false }, { name: "jclLibrary", aliases: ["jcl"], description: "Contains either a 3 digit JCL index value or a JCL variable beginning with an ampersand, 16 CHAR", type: "boolean", required: false }, { name: "jesHi", description: "JES supports ID > 99999, 1 CHAR", type: "boolean", required: false }, { name: "loadOnly", description: "Y if this is a LOAD only job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "loadStepDone", aliases: ["loa"], description: "Y if LOAD step ran OK for this job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "locked", description: "Y if job is locked, N if not, 1 CHAR", type: "boolean", required: false }, { name: "longName", description: "An alias name for this job. This name may be used by scheduling engines on other platforms, such as AutoSys, 64 CHAR", type: "boolean", required: false }, { name: "lterm", description: "Logical terminal name from job definition, 8 CHAR", type: "boolean", required: false }, { name: "mainid", description: "If positive, the CPU number on which the job may execute. If negative, the CPU number on which the job may not execute, INTEGER", type: "boolean", required: false }, { name: "maint", description: "Y if job ignores requirements, N if not, 1 CHAR", type: "boolean", required: false }, { name: "manualRequeue", aliases: ["man"], description: " Y if job has been re-queued to REQUEST queue, N if not, 1 CHAR", type: "boolean", required: false }, { name: "memberName", aliases: ["mem"], description: "The JCL or PARM DATA library member name, 8 CHAR", type: "boolean", required: false }, { name: "mustStartExists", aliases: ["mus"], description: "Determines if a zero value in MUST_START_TIME indicates midnight (Y) or no deadline time (N), 1 CHAR", type: "boolean", required: false }, { name: "needsAutof", aliases: ["nee"], description: "Y if a job changed and requires 'F' in CA11, N if not, 1 CHAR", type: "boolean", required: false }, { name: "nextRunReq", aliases: ["nex"], description: "Y if job has temporary requirements for the next execution, N if not, 1 CHAR", type: "boolean", required: false }, { name: "nodeFailed", aliases: ["nod"], description: "Y if this is an XPJOB job and at the time of it last submit its node was down, N if not, 1 CHAR", type: "boolean", required: false }, { name: "nodeOffline", aliases: ["nod"], description: "Y if this is an XPJOB job and at the time of its last submit its node was offline, N if not, 1 CHAR", type: "boolean", required: false }, { name: "nodeStopped", aliases: ["nod"], description: "Y if this is an XPJOB job and at the time of it last submit its node was stopped, N if not, 1 CHAR", type: "boolean", required: false }, { name: "noUserId", description: "Y if there is not a valid security id for this job, N if there is, 1 CHAR", type: "boolean", required: false }, { name: "noXpsiParmlib", aliases: ["noX"], description: "Y if this is an XPJOB job and has no PARMLIB, N if not, 1 CHAR", type: "boolean", required: false }, { name: "noXpsiXpsparm", aliases: ["noX"], description: "Y if this is an XPJOB job and has no PARM, N if not, 1 CHAR", type: "boolean", required: false }, { name: "override", description: "Y if JCL/PARM DATA override is required, N if not, 1 CHAR", type: "boolean", required: false }, { name: "overrideApplied", aliases: ["ove"], description: "Y if JCL overrides have been applied for this job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "prompt", description: "Y if job should have LATE PROMPTS, N if not, 1 CHAR", type: "boolean", required: false }, { name: "promptAck", description: "Y if user has acknowledged the prompt, N if not, 1 CHAR", type: "boolean", required: false }, { name: "prompted", description: "Y if user has been prompted, N if not, 1 CHAR", type: "boolean", required: false }, { name: "qjclUpdated", aliases: ["qjc"], description: "Y if JCL or PARM DATA updated through QJCL, N if not, 1 CHAR", type: "boolean", required: false }, { name: "queueJcl", description: "Y if a QJCL command is in progress for this job N if not", type: "boolean", required: false }, { name: "repeatCount", aliases: ["rep"], description: "The number of times to repeat this job, INTEGER", type: "boolean", required: false }, { name: "repeatDiff", aliases: ["rep"], description: "The difference between the original dueout time and the original submit time, used by repeating jobs. The value is in minutes, INTEGER", type: "boolean", required: false }, { name: "repeatInterval", aliases: ["rep"], description: "The interval between repetitions of the job, PACKED", type: "boolean", required: false }, { name: "repeatLeadTime", aliases: ["rep"], description: "The lead time for this repeat job. This is the amount of time to ensure it completes before it due out time, PACKED", type: "boolean", required: false }, { name: "repeatStopExists", aliases: ["rep"], description: "Determines if a zero value in REPEAT_STOP_TIME indicates midnight (Y) or no repeat stop time (N), 1 CHAR", type: "boolean", required: false }, { name: "repeatStopTime", aliases: ["rep"], description: "The date and time on or after which a repeating job will not be repeated, DATE/TIME", type: "boolean", required: false }, { name: "repeatType", aliases: ["rep"], description: "The type of repeat job. This field determines how the submit time requierement is calculated for repeating jobs, 1 CHAR", type: "boolean", required: false }, { name: "restartStep", aliases: ["res"], description: "The step name in which the job was restarted, 8 CHAR", type: "boolean", required: false }, { name: "retainJcl", description: "Y if JCL or XPJOB information will be retained in the prior run queue, N if not, 1 CHAR", type: "boolean", required: false }, { name: "rqmtCount", description: "The master requirement count for this job. The number includes unsatisfied requirements, submit time, and other reasons preventing the job from being submitted, INTEGER", type: "boolean", required: false }, { name: "schdAdjusted", aliases: ["sch"], description: "Y if job's schedule has been adjusted, N if not, 1 CHAR", type: "boolean", required: false }, { name: "nosecurity", aliases: ["nos"], description: "Y if there was an error retrieving security data,N if no, 1 CHAR", type: "boolean", required: false }, { name: "setNdb", description: "Y if job will bypass LOAD processing at completion and not update the database, N if not, 1 CHAR", type: "boolean", required: false }, { name: "smfNeeded", description: "Y if SMF feedback is needed for this job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "startTime", description: "The date and time this job started executing on its most recent submission, DATE/TIME", type: "boolean", required: false }, { name: "submitted", description: "Y if this job has been submitted to the host, N if not, 1 CHAR", type: "boolean", required: false }, { name: "submitTime", aliases: ["sub"], description: "The date and time this job was submitted, DATE/TIME", type: "boolean", required: false }, { name: "triggered", description: "Y if job triggered by another job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "uid", description: "The CA 7 internal user security designation, INTEGER", type: "boolean", required: false }, { name: "verify", description: "Y if job has a manual verification requirement, N if not, 1 CHAR", type: "boolean", required: false }, { name: "waitSubmitTime", aliases: ["wai"], description: "Y if this job has a submit time requirement, N if not, 1 CHAR", type: "boolean", required: false }, { name: "xpAltNode", description: "The alternate node where this XPJOB job was routed, CHAR 64", type: "boolean", required: false }, { name: "xpPrimaryNode", aliases: ["xpP"], description: "The primary node associated with this XPJOB job, CHAR 64", type: "boolean", required: false }, { name: "xpsJob", description: "Y if this is an XPJOB job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "xpStatus", description: "The status of the node associated with this XPJOB job. A: Active F: Failed CCI send O: Offline S:Stopped, 1 CHAR", type: "boolean", required: false }, { name: "xtrackerInact", aliases: ["xtr"], description: "Y if at time of submission, the XTRACKER task is not active for an XPJOB job or IAS is not active for an agent job, N if not, 1 CHAR", type: "boolean", required: false }, { name: "xplatNode", description: "Cross platform long node name, 64 CHAR", type: "boolean", required: false }, { name: "responseError", aliases: ["res"], description: "Response Error", type: "boolean", required: false }, { name: "ca11FailingStep#", aliases: ["ca1"], description: "CA 11 Failing Step Number, INTEGER", type: "boolean", required: false }, { name: "completeOk", aliases: ["com"], description: "Y if job completed normally, N if not, 1 CHAR", type: "boolean", required: false }, { name: "jes#", description: "The JES job number for this job. A value of -1 indicates *NA*, INTEGER", type: "boolean", required: false }, { name: "needsLoad", description: " Y if LOAD processing will be done for this job, Nif not, 1 CHAR", type: "boolean", required: false }, { name: "deadline", description: "The date and time a job must be started by in order to meet its due out time, DATE/TIME", type: "boolean", required: false }, { name: "jclfrom254", aliases: ["jcl"], description: "Y if JCL or XPJOB information will be retained in the prior run queue, N if not, 1 CHAR", type: "boolean", required: false }, { name: "prose#", description: "Number of the prose text associated with this job, or zero, INTEGER", type: "boolean", required: false }, { name: "scheduleId", aliases: ["sch"], description: "The schedule id for this execution, INTEGER", type: "boolean", required: false }, { name: "triggeringJob#", aliases: ["tri"], description: "The CA 7 internal job number of the job that triggered this job or job that created the data set that triggered this job, INTEGER", type: "boolean", required: false }, { name: "triggers", description: "Y if job can trigger other jobs, N if not, 1 CHAR", type: "boolean", required: false } ] }; //# sourceMappingURL=PostJobInstanceListCustom_1.definition.js.map