@broadcom/ca7-for-zowe-cli/lib/cli/dataset/items/PostDataset.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.PostDatasetDefinition = void 0;
exports.PostDatasetDefinition = {
    name: "post-dataset",
    aliases: ["pds"],
    summary: "Create a new dataset definition for CA7 Instance specified",
    description: "Create a new definition of a dataset",
    examples: [
        {
            options: "--dname DATASET.NAME.TEST --type NORM --gdg N --ca7Id Instance1",
            description: "Create a new dataset named DATASET.NAME.TEST of type NORM and data set is not a generation data group on Instance1"
        }
    ],
    type: "command",
    handler: __dirname + "/PostDataset.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "ca7Id",
            description: "CA7ONL Instance",
            type: "string",
            required: true
        },
        {
            name: "dataset-name",
            aliases: ["dname"],
            description: "Specifies the data set and must be the fully qualified data set name." +
                "\nLimits: 1 to 44 alphanumeric characters" +
                "\nNote: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.",
            type: "string",
            required: true
        },
        {
            name: "type",
            description: "(Optional) Specifies the data set type." +
                "\nValid values are:" +
                "\nNORM = Internal means both the creating-job and using-jobs for this data set are known to CA 7." +
                "\nExternal means the creating-job, using-jobs, or both for this data set are not known to CA 7.PERM = Specifies this data set is always available for inputDefault: NORM" +
                "\nNote: When a data set is marked PERM, no SMF records are captured. PERM means no data set triggering can occur with this type of data set",
            type: "string",
            required: false
        },
        {
            name: "gdg",
            description: "(Optional) Specifies whether this data set is a generation data group." +
                "\nValid values are:" +
                "\nY = The data set is a generation data groupN = The data set is not a generation data groupDefault: N" +
                "\nNote: The specific GDG creations cannot be used for posting requirements or for triggering jobs. Posting and triggering are done based on the creation/updating (SMF 15 record) of any generation of the GDG.",
            type: "string",
            required: false
        },
        {
            name: "smf-feedback-required",
            aliases: ["sfr"],
            description: "(Optional) Specifies whether the interface to System Management Facility (SMF) inserts the values for DSORG, RECFM, LRECL, and BLKSIZE when this data set is next used. Unless the value is reset, this insertion is only done once." +
                "\nValid values are:" +
                "\nY = SMF inserts the values when the data set is next usedN = SMF does not insert the values when the data set is next usedDefault: Y" +
                "\nNote: After the first time the job that creates this data set runs under CA 7, this field is reset to N. If the data set attributes change, this field must be reset to Y. The changed attribute field (that is, DSORG, RECFM) must be zeroed (if numeric) or blanked out. This process causes CA 7 to record the new values when the job is run again.",
            type: "string",
            required: false
        },
        {
            name: "post-at-close-time",
            aliases: ["pact"],
            description: "(Optional) Specifies when to post the creation or update of a data set to the database and queues. This process does not ensure successful step or job termination." +
                "\nValid values are:" +
                "\nY = The action takes place when the SMF data set creation record is received (when the data set is closed)N = Causes triggering or posting action to take place at the job terminationDefault: N",
            type: "string",
            required: false
        },
        {
            name: "device",
            description: "(Optional) Specifies a device type." +
                "\nValid values are:" +
                "\nTAPEDASD",
            type: "string",
            required: false
        },
        {
            name: "dsorg",
            description: "(Optional) Specifies the data set organization. This value is the same as the DSORG specified in the DCB subparameter in the JCL." +
                "\nLimits: 1 to 3 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "recfm",
            description: "(Optional) Specifies the record format of the data set. This value is the same as the RECFM specified in the DCB subparameter in the JCL." +
                "\nLimits: 1 to 5 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "lrecl",
            description: "(Optional) Specifies the logical record length of the data set. This value is the same as the LRECL specified in the DCB subparameter in the JCL." +
                "\nLimits: 1 to 5 numeric characters",
            type: "string",
            required: false
        },
        {
            name: "blksize",
            description: "(Optional) Specifies the block size of the data set. This value is the same as the BLKSIZE specified in the DCB subparameter in the JCL." +
                "\nLimits: 1 to 5 numeric characters",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostDataset.definition.js.map