@broadcom/ca7-for-zowe-cli/lib/cli/putJobDefinitions/put/PutSchedule.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.PutScheduleDef = void 0;
exports.PutScheduleDef = {
    name: "schedule",
    aliases: ["s"],
    summary: "Modify schedules for jobs that are run on a date and time basis.",
    description: "Modify schedule parameters",
    examples: [
        {
            options: "--job TESTJOB1 --schid 01 --dscal 03",
            description: "Modify a schedule for job TESTJOB1 with the parameters"
        }
    ],
    type: "command",
    handler: __dirname + "/PutSchedule.handler",
    options: [
        {
            name: "job",
            description: "The name of the job\n\n",
            type: "string",
            required: true
        },
        {
            name: "schid",
            description: "Specifies the numeric schedule ID on which the user wants to perform the specified action.\n" +
                "Limits: 1 to 3 numeric characters from 1 through 999\n\n",
            type: "string",
            required: true
        },
        {
            name: "scal",
            description: "Specifies the override of the default SCAL for this SCHID. Specify scal if you want to override the default scal.\n" +
                "Limits: 2 alphanumeric characters\n\n",
            type: "string"
        },
        {
            name: "default-scal",
            aliases: ["dscal"],
            description: "Specifies the default SCAL for this job. If this is not specified, an LJOB will be issued to fetch the SCAL\n" +
                "Limits: 2 alphanumeric characters\n\n",
            type: "string"
        },
        {
            name: "due-out-time",
            aliases: ["dot"],
            description: "Specifies the due-out time of day for this schedule ID.\n" +
                "Limits: 4 numeric characters that are specified as hhmm\n" +
                "where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.\n\n",
            type: "string"
        },
        {
            name: "lead-time",
            aliases: ["lt"],
            description: "Specifies the due-out time of day for this schedule ID.\n" +
                "Limits: 4 numeric characters that are specified as hhmm\n" +
                "where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.\n\n",
            type: "string"
        },
        {
            name: "submit-time",
            aliases: ["st"],
            description: "Specifies the submit time of day for this schedule ID.\n" +
                "If specified, the job is not submitted before this time.\n" +
                "If the submit time is before deadline start time,\n" +
                "the submit time requirement is automatically satisfied when the job enters the queue.\n" +
                "A submit time of zeros is the same as not specifying it, and no submit time is set up.\n" +
                "Note:If the submit time is after the due-out time, the submit day value is set to the previous day.\n" +
                "Limits: 4 numeric characters that are specified as hhmm\n" +
                "where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.\n\n",
            type: "string"
        },
        {
            name: "daily",
            description: "Specifies that the user wants to define a daily schedule.\n" +
                "Daily means every available processing day as defined by the Base Calendar.\n" +
                "If DAILY is used, the ROLL has no effect.\n" +
                "Limits: One of Y or N\n\n",
            type: "string"
        },
        {
            name: "roll",
            description: "Specifies the action to take when a schedule day falls on a base calendar non available processing day.\n" +
                "This value is not used if the DAILY option is used\n" +
                "If DAILY is used, the ROLL has no effect.\n" +
                "If used, the value must be one of the following values:\n" +
                "B: Roll the schedule back to the previous available processing day in the Base Calendar.\n" +
                "F: Roll forward the schedule to the next available processing day.\n" +
                "N: Do not roll. Schedule day must stand.\n" +
                "D: Do not roll and do not schedule.\n" +
                "Default:D\n\n",
            type: "string"
        },
        {
            name: "index",
            description: "Specifies an adjustment to schedule days.\n" +
                "After you exercise the ROLL option, the schedule is adjusted,\n" +
                "forward for plus or backward for minus, by the number of working days entered.\n" +
                "Limits:4 numeric characters that are specified as Innn where I can be plus (unsigned) or minus (-) and nnn can be 0 to 365 daysUsage:\n" +
                "Use this field with the RDAY field to schedule a job to run three workdays before the 15th of the month:\n" +
                "specify -3 in the INDEX field, X in the MONTHLY field, and 15 in the RDAY field.\n\n",
            type: "string"
        },
        {
            name: "interval",
            description: "Specifies that the job should be repeated (executed more than once) and\n" +
                "specifies the amount of time between each iteration.\n" +
                "If INTERVAL is specified, the SBTM (submit time requirement) and TYPE fields are required.\n" +
                "If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.\n" +
                "Limits:4 numeric characters in hhmm format where hh can be from 0 to 23 and mm can be from 00 to 59\n\n",
            type: "string"
        },
        {
            name: "type",
            description: "Determines how the submit time requirement is calculated for repeating jobs.\n" +
                "A TYPE of CLOCK indicates that the INTERVAL is added to the previous iteration's\n" +
                "submit time requirement to determine the new submit time requirement.\n" +
                "A TYPE of START and END indicates that the INTERVAL is added to the previous iteration's\n" +
                "last (most recent) start and end times,respectively, to determine the new submit time requirement.\n" +
                "TYPE is required if INTERVAL is specified.\n" +
                "TYPE is discarded if INTERVAL is not specifiedLimits:CLOCK, START, or END\n\n",
            type: "string"
        },
        {
            name: "count",
            description: "Specifies the maximum number of times to repeat the job.\n" +
                "COUNT is discarded 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.\n" +
                "If COUNT is not specified, the job repeats until the STOP time is reached." +
                "TYPE is required if INTERVAL is specified. TYPE is discarded if INTERVAL is not specified" +
                "Limits:1 to 4 numeric characters from 0 to 1439. Leading zeros can be discarded.\n\n",
            type: "string"
        },
        {
            name: "weekly",
            description: "Specifies that the user wants to define a weekly schedule.\n" +
                "If WEEKLY is used, the run days of the week must be specified using DAYS field\n" +
                "Limits:Y or N\n\n",
            type: "string"
        },
        {
            name: "days",
            description: "Defines specific days of the week on which to run the job.\n" +
                "as comma separated list of day name abbreviations.\n" +
                "Limits: A comma separated list of Sun,Mon,Tue,Wed,Thu,Fri,Sat\n\n",
            type: "string"
        },
        {
            name: "monthly",
            description: "Specifies that the user wants to define a monthly schedule.\n" +
                "If this field is used, the user can optionally specify on which particular months the job is to run.\n" +
                "If specific months are not specified in the months property, all months are assumed." +
                "Limits: Y or N\n\n",
            type: "string"
        },
        {
            name: "months",
            description: "Defines specific months on which to run the job.\n" +
                "as comma separated list of month name abbreviations.\n" +
                "Limits: A comma separated list of Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec\n\n",
            type: "string"
        },
        {
            name: "weeks-of-month",
            aliases: ["wom"],
            description: "Specifies the weeks of the month to run the job.\n" +
                "The values that are specified can be positive (unsigned), negative (-) or slash (/).\n" +
                "Positive values 1, 2, 3, 4, or 5 are used to indicate the week relative to the beginning of the month.\n" +
                "Negative values -0, -1, and -2 are used to indicate occurrence of week relative to the end of the month.\n" +
                "Slashes indicate the job will not run the following value.\n" +
                "Limits: 1 to 14 numeric characters and required if MONTHLY and DAY-OF-WEEK are used.\n" +
                "The values are separated by comma\n\n",
            type: "string"
        },
        {
            name: "day-of-week",
            aliases: ["dow"],
            description: "Specifies which days of the week to run the job.\n" +
                "If used, each day must be the first three letters of the wanted run days.\n" +
                "If you want to specify multiple days, use a comma separated list for example MON,TUE,FRI.\n" +
                "Limits: A comma separated list of SUN, MON, TUE, WED, THU, FRI, SAT, case insensitive\n\n",
            type: "string"
        },
        {
            name: "relative-day",
            aliases: ["rd"],
            description: "Specifies relative days of the month on which the job is to run. Used with MONTHLY.\n" +
                "A day relative to the beginning or end of the month is specified.\n" +
                "If a positive (unsigned) value is used, the job runs that day relative to the first of the month.\n" +
                "Also, if you have days of the month when this job is not to run,a slash (/) can be used with the unsigned or negative values.\n" +
                "Valid positive values range from 1 to 31.\n" +
                "Valid negative values range from -0 to -30.\n" +
                "Limits:1 to 60 numeric characters, separated by comma.\n" +
                "Note:relative-day(s) represents calendar days, unless the base calendar was generated with OPTIONS=SCHDYONLY,\n" +
                "in which case relative-day(s) represents processing days.\n\n",
            type: "string"
        },
        {
            name: "annual",
            description: "Defines an annual schedule.\n" +
                "Limits: If annual is used, day is required. One of Y, N\n\n",
            type: "string"
        },
        {
            name: "day-of-year",
            aliases: ["doy"],
            description: "Specifies on which days of the annual schedule the user wants to run the job.\n" +
                "Days are entered as 1 through 366 and are prefixed by positive (unsigned) or slash (/) values.\n" +
                "Slash indicates the job will not run this day.\n" +
                "For example, if a job is to run on days 121, 132, 240, and 241, but is not to run on days 122, 242, and 1," +
                "the user would specify: /1,121,/122,132,240,241,/242\n" +
                "Limits: 1 to 55 numeric characters and required if annual is used.\n" +
                "The numbers will be separated by comma\n\n",
            type: "string"
        },
        {
            name: "symmetric",
            description: "Used with the START and SPAN fields, defines a symmetric schedule.\n" +
                "With this option, schedules are defined as beginning on the date specified with\n" +
                "the START field and recurring every nnn days as specified with the SPAN field.\n" +
                "Limits: One of Y, N\n\n",
            type: "string"
        },
        {
            name: "start",
            description: "This field is required when the SYMETRIC option is taken.\n" +
                "Value must be specified as the Julian day of the year on which the symmetric schedule is to begin.\n" +
                "This value should be evaluated yearly before schedule resolution and may need to be changed each year.\n" +
                "If the schedule will be resolved on a July-June basis, the start date must be within\n" +
                "the first of the two years in which the schedule overlaps.\n" +
                "For January-December schedules, it is simply relative to January 1 of the year specified on a RESOLV command.\n" +
                "If the calendar against which this SCHID will be resolved does not have the OPTIONS=SCHDYONLY,\n" +
                "the START day is adjusted each year to maintain the job's symmetric schedule from the job's original specified START day.\n" +
                "If the calendar against which the SCHID will be resolved was generated with overall available processing days only (OPTIONS=SCHDYONLY)\n" +
                "the start date must specify the first day on which the job would actually run.\n" +
                "This requires manually setting (verifying) the START value each year before the RESOLV.\n" +
                "If a nonprocessing day is specified, the start day is the next processing day found in the calendar.\n" +
                "For example, if January 1 is a nonprocessing day and the calendar was generated with OPTIONS=SCHDYONLY,\n" +
                "and 1 is specified as the START day, January 2 is the actual START day (provided it is an available processing day).\n" +
                "SPAN is based from January 2 in this example rather than January 1.\n" +
                "For other types of calendars, the start date is determined at RESOLV time based on the ROLL and INDEX options taken.\n" +
                "Limits: 3 numeric characters specified as Julian day of the year from 1 to 365\n\n",
            type: "string"
        },
        {
            name: "span",
            description: "Used with SYMETRIC and START, defines symmetric schedules.\n" +
                "This field is required if the SYMETRIC option is taken.\n" +
                "When used, specifies the number of days between scheduled processing cycles.\n" +
                "If the calendar against which the SCHID will be resolved was generated with processing days\n" +
                "only (OPTIONS=SCHDYONLY), the SPAN value is specified as the number of available processing days\n" +
                "between and including the next processing date as opposed to the actual number of days.\n" +
                "With this type of calendar, the ROLL and INDEX options serve no practical purpose.\n" +
                "For other calendar types, the SPAN value is specified as the number of calendar days\n" +
                "between processing cycles and the ROLL and INDEX options can be used as necessary.\n" +
                "Limits: 1 to 3 numeric characters from 1 to 255\n\n",
            type: "string"
        }
    ],
    profile: {
        optional: ["ca7"]
    }
};
//# sourceMappingURL=PutSchedule.definition.js.map