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