@broadcom/ca7-for-zowe-cli/lib/cli/commands/cmds/Post.definition.js

CA 7 Workload Automation Plug-in for Zowe CLI

"use strict";
/*
* Copyright © 202X Broadcom Inc. and/or its subsidiaries
* © 202X Broadcom Inc and/or its subsidiaries; All rights reserved
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.PostDefinition = void 0;
const Constants_1 = require("../../../Constants");
exports.PostDefinition = {
    name: "post",
    aliases: ["po"],
    summary: "Posts the requirement for a job",
    description: "The POST command indicates to the CA Workload Automation CA 7 Edition" +
        "system that a preexecution requirement for a job in the request queue is satisfied",
    examples: [
        {
            options: "--ca7num 0016",
            description: "The requirement for ca7 number 0016 in the request queue is satisfied"
        }
    ],
    type: "command",
    handler: __dirname + "/Post.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "ca7num",
            description: "ca7num=0016\n\n" +
                "Indicates the job number in up to four digits, for which requirements are posted.",
            type: "string",
            required: true
        },
        {
            name: "usr",
            description: "example: USER WILL CALL TO RELEASE\n" +
                "(Optional) Identifies a user-defined description of a requirement to post as satisfied.\n" +
                "Mutually exclusive with DEPJOB and DSN.\n" +
                "When used, must match the text that is used to define the requirement on the DB.6 panel or with the ADDRQ command.\n\n" +
                "Limits: 1 to 36 alphanumeric characters",
            type: "string"
        },
        {
            name: "depjob",
            description: "example: PAYJOB\n" +
                "(Optional) Identifies a predecessor job dependency requirement to post as satisfied.\n" +
                "Value must be a specific job name.\n" +
                "Mutually exclusive with DSN and USR.\n\n" +
                "In normal situations, CA WA CA 7 Edition automatically posts this type of requirement when the predecessor job completes its execution successfully.\n" +
                "A manual posting is only necessary if a job defined as a requirement was not to be run,\n" +
                "or ran unsuccessfully and a successor job is to be run.The DEPJOB must be posted if it is not currently defined to CA WA CA 7 Edition\n" +
                "(an external job).\n" +
                "Limits: 1 to 8 alphanumeric characters",
            type: "string"
        },
        {
            name: "dsn",
            description: "example: CA7.DSN1\n" +
                "(Optional) Identifies a data set requirement to post as satisfied.\n" +
                "Value can be a specific data set name or a CA WA CA 7 Edition data set number.\n" +
                "If you are using a number, only the number can be specified without the DS prefix.\n\n" +
                "Mutually exclusive with DEPJOB and USR.\n" +
                "dsname\n" +
                "Indicates a specific data set name.\n" +
                "Limits: 1 to 44 alphanumeric characters\n" +
                "dsnumber\n" +
                "Indicates a specific data set number. \n" +
                "Limits: 1 to 8 numeric characters",
            type: "string"
        },
        {
            name: "internal",
            description: "example: YES\n" +
                "(Optional) Valid only with DSN to indicate that the data set being posted is internal to the CA WA CA 7 Edition workload.\n" +
                "YES is the only acceptable value.\n" +
                "Mutually exclusive with USR, DEPJOB, and PREQ.\n" +
                "In normal situations, CA WA CA 7 Edition automatically posts requirements for internal data sets.\n" +
                "Limits: YES is the only acceptable value.",
            type: "string"
        },
        {
            name: "preq",
            description: "example: (17,19,20,32)\n" +
                "(Optional) Valid only with DSN to identify up to 11 numeric values to include\n" +
                "with other CA WA CA 7 Edition log data logged as a result of the POST command being issued.\n" +
                "Mutually exclusive with USR, DEPJOB, and INTERNAL.\n" +
                "Code values in sublist form, within parentheses.\n" +
                "You can code up to 11 values that are separated by commas between the parentheses.\n" +
                "Each value cannot exceed 4 numeric digits.\n" +
                "This optional field can be useful for logging any meaningful numbers, such as batch numbers, which can later be reviewed in the log data set.",
            type: "string"
        },
        Constants_1.Constants.CLI_JOB_RMTJOB,
        Constants_1.Constants.CLI_JOB_RMTSCHD
    ]
};
//# sourceMappingURL=Post.definition.js.map