diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..c2811c2 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,11 @@ +# Home + +* [z/OS Dataset Writer](zos-dataset-writer) +* [z/OS External Artifact Repository](zos-external-artifact-download) +* [z/OS FTP Utility](zos-ftp) +* [z/OS File Source Config](zos-file-source-config) +* [z/OS Management Facility](zosmf) +* [z/OS Multi Generate Artifact Information](zos-multi-generate-artifact-info) +* [z/OS USS Utility](zos-uss-utility) +* [z/OS Utility](zos-utility) +* [z/OS Rexx Executor](zos-rexx) \ No newline at end of file diff --git a/docs/assets/images/deploy.png b/docs/assets/images/deploy.png new file mode 100644 index 0000000..798a196 Binary files /dev/null and b/docs/assets/images/deploy.png differ diff --git a/docs/zos-dataset-writer/downloads.md b/docs/zos-dataset-writer/downloads.md new file mode 100644 index 0000000..dfe1aaa --- /dev/null +++ b/docs/zos-dataset-writer/downloads.md @@ -0,0 +1,11 @@ +# Downloads + +To download the plug-in, click the following version-specific links. + +- [ucd-plugins-zos-dataset-writer-4.1162523.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-dataset-writer/ucd-plugins-zos-dataset-writer-4.1162523.zip) +- [ucd-plugins-zos-dataset-writer-4.1138411.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-dataset-writer/ucd-plugins-zos-dataset-writer-4.1138411.zip) +- [ucd-plugins-zos-dataset-writer-4.1134355.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-dataset-writer/ucd-plugins-zos-dataset-writer-4.1134355.zip) +- [ucd-plugins-zos-dataset-writer-4.1134053.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-dataset-writer/ucd-plugins-zos-dataset-writer-4.1134053.zip) +- [ucd-plugins-zos-dataset-writer-3.1133866.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-dataset-writer/ucd-plugins-zos-dataset-writer-3.1133866.zip) +- [ucd-plugins-zos-dataset-writer-2.1132365.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-dataset-writer/ucd-plugins-zos-dataset-writer-2.1132365.zip) +- [ucd-plugins-zos-dataset-writer-1.1125890.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-dataset-writer/ucd-plugins-zos-dataset-writer-1.1125890.zip) \ No newline at end of file diff --git a/docs/zos-dataset-writer/index.md b/docs/zos-dataset-writer/index.md new file mode 100644 index 0000000..49d7778 --- /dev/null +++ b/docs/zos-dataset-writer/index.md @@ -0,0 +1,48 @@ +# Overview + +The z/OS Dataset Writer plug-in copies text, dataset, or USS file to a mainframe dataset. + +Apart from copying content to a mainframe dataset, this plug-in provides the following features: + +* Allocates a new output dataset with the required parameter. +* Deletes the existing output dataset to create a new one with desired parameters. + +## Compatibility + +The plug-in is compatible with: + +* UrbanCode Deploy version 7.0.0 or later +* UrbanCode Deploy agents on z/OS +* IBM z/OS version 2.1 or later +* IBM Java 8 or 11 + +## Installation + +No special steps are required for installation. See [Installing plug-ins in UrbanCode products](https://community.ibm.com/community/user/wasdevops/blogs/laurel-dickson-bull1/2022/06/13/install-plugins). + +## History + +### Version 4 + +* Enhancement to accept multiple datasets or files as input +* Minor Improvements +* Fixed security issue CVE-2021-29425 +* Fixed Jettison Vulnerability + +### Version 3 + +!!! Note + while upgrading plugin from older versions to version 3 + Sequential output dataset must be enclosed in single quotes for a fully qualified dataset. + If the single quotation marks are omitted, the user’s dataset prefix from the TSO profile is + automatically appended to the front of the dataset name. + +* Enhancement to accept source as PDS member or sequential dataset or USS File + +### Version 2 + +* Fixed issue with GDG version creation + +### Version 1 + +* Initial release \ No newline at end of file diff --git a/docs/zos-dataset-writer/media/dataset_writer_new_02a.jpg b/docs/zos-dataset-writer/media/dataset_writer_new_02a.jpg new file mode 100644 index 0000000..eedecd3 Binary files /dev/null and b/docs/zos-dataset-writer/media/dataset_writer_new_02a.jpg differ diff --git a/docs/zos-dataset-writer/media/dataset_writer_new_02b.jpg b/docs/zos-dataset-writer/media/dataset_writer_new_02b.jpg new file mode 100644 index 0000000..de5c788 Binary files /dev/null and b/docs/zos-dataset-writer/media/dataset_writer_new_02b.jpg differ diff --git a/docs/zos-dataset-writer/media/dataset_writer_new_03a.jpg b/docs/zos-dataset-writer/media/dataset_writer_new_03a.jpg new file mode 100644 index 0000000..272d38e Binary files /dev/null and b/docs/zos-dataset-writer/media/dataset_writer_new_03a.jpg differ diff --git a/docs/zos-dataset-writer/media/dataset_writer_new_03b.jpg b/docs/zos-dataset-writer/media/dataset_writer_new_03b.jpg new file mode 100644 index 0000000..f40abd3 Binary files /dev/null and b/docs/zos-dataset-writer/media/dataset_writer_new_03b.jpg differ diff --git a/docs/zos-dataset-writer/media/picture1.png b/docs/zos-dataset-writer/media/picture1.png new file mode 100644 index 0000000..ecab46d Binary files /dev/null and b/docs/zos-dataset-writer/media/picture1.png differ diff --git a/docs/zos-dataset-writer/media/zos-dataset-writer-plugin.png b/docs/zos-dataset-writer/media/zos-dataset-writer-plugin.png new file mode 100644 index 0000000..0d16bb6 Binary files /dev/null and b/docs/zos-dataset-writer/media/zos-dataset-writer-plugin.png differ diff --git a/docs/zos-dataset-writer/steps.md b/docs/zos-dataset-writer/steps.md new file mode 100644 index 0000000..6147858 --- /dev/null +++ b/docs/zos-dataset-writer/steps.md @@ -0,0 +1,26 @@ +# Steps + +## Write to Sequential Dataset + +Use this step to write input text to a sequential dataset. + +!!! Note + To create a GDG version add (+1) along with GDG base. + An output property `DatasetName` will contain the actual GDG version dataset name that is created and can be referred in successive steps of the process. + +| Name | Type | Description | Required | +|--------------------------|-----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| Source Type | Enumeration: TEXT / DATASET / FILE / ${p?:dataset.writer.source.type} | Source of data for writing into Output sequential dataset. Select DATASET to write from a PDS member or sequential dataset, FILE to write from a USS file, or TEXT to write text to output sequential dataset. | Yes | +| Source Value | String | Text or PDS member or Sequential Dataset or USS File to be written into a Sequential dataset. If the single quotation marks are omitted, the user’s data set prefix from the TSO profile is automatically appended to the front of the data set name. Add encoding of USS File after a comma(,). For example – /path/to/file,UTF-8. If no file encoding is specified, file is considered to be in IBM-1047 encoding. Multiple files or datasets can be passed separated by a newline. | Yes | +| Dataset Name | String | Name of a sequential dataset to write input text. | Yes | +| Append | Boolean | Select to append input text in the data set. | No | +| Allocate Data Set | String | Specify `TRUE` to allocate a sequential data set with passed parameters. | No | +| Delete Existing Data Set | String | Specify `TRUE` to delete the sequential data set if already exist before allocation. | No | +| Volume Serial | String | Leave blank to use the system default volume. | No | +| Space Units | Enumeration: TRACKS / CYLINDERS | Specify the dataset space units. For example, Tracks or Cylinders | Yes | +| Average Record Unit | Enumeration: – – – / K / M / U | Select a unit to use when allocating average record length. The unit **U** specifies single-record units (bytes). **K** specifies thousand-record units (kilobytes). **M** specifies million-record units (megabytes). (- – -) specifies the system default value. | No | +| Primary Quantity | String | Specify the primary quantity in average record units. | Yes | +| Secondary Quantity | String | Specify the secondary quantity in average record units. | Yes | +| Record Format | Enumeration: FB / F / VB / V / FBA / VBA / FBM / FM / VBM / VM | Specify the record format. | Yes | +| Record Length | String | Specify the record length. | Yes | +| Block Size | String | Specify the number of bytes of data to place in each block, based on the record length. | Yes | diff --git a/docs/zos-dataset-writer/usage.md b/docs/zos-dataset-writer/usage.md new file mode 100644 index 0000000..7a44479 --- /dev/null +++ b/docs/zos-dataset-writer/usage.md @@ -0,0 +1,38 @@ +# Usage + +## Copy text to a dataset + +Select Source Type as TEXT from the drop-down and a JCL SYSIN content can be passed as text input in Source value. Refer to the below screenshot: + +[![](media/picture1.png?resize=320%2C130)](media/picture1.png) + +Third input Dataset Name can either be a Sequential dataset name as below MY.SEQ.DATASET or could be a user-defined property say ```${p:sequential.dataset.name}```. The `sequential.dataset.name` property needs to be defined with a sequential dataset name for writing the input text. + +[![](media/zos-dataset-writer-plugin.png?resize=420%2C445)](media/zos-dataset-writer-plugin.png) + +Select checkbox **Append** to append input text data after the existing data in a given dataset. By default, **Append** is unchecked and writes the input text newly in a given dataset. + +The **Allocate Data Set** and **Delete Existing Data Set** values are set to `TRUE` by default. As the name suggests, setting input **Allocate Data Set** to `TRUE` will give you an option to decide and set the parameters of a sequential dataset to be created. If **Allocate Data Set** is `FALSE`, the plug-in step assumes that the dataset exists and writes the input text to the dataset. + +Input **Delete Existing Data Set** comes into action only when **Allocate Data Set** is set to `TRUE` and deletes the existing dataset. Set to **Allocate Data Set** to `TRUE` to allocate a new dataset with passed parameters and write the input text to a sequential dataset. + +The remaining inputs in the step are to set parameters like DCB and Space etc., for a sequential dataset and are applicable only if **Allocate Data Set** is `TRUE`. + +## Copy file data to a dataset + +Select **Source Type** as `FILE` from the drop-down and pass the file path as input in **Source value**. Refer to the below screenshot: +![dataset_writer_new_02a.jpg](media/dataset_writer_new_02a.jpg) + +By default, the plugin assumes the USS file to be in IBM-1047 encoding. However, encoding can be passed along with a file path separated by a comma (,) as shown in the screenshot below +![dataset_writer_new_02b.jpg](media/dataset_writer_new_02b.jpg) +The plugin step copies the data in the USS file to the Sequential dataset. + +## Copying PDS member or Sequential dataset data to another dataset + +Select **Source Type** as `DATASET` from the drop-down and pass the PDS member or Sequential dataset name as input in **Source value**. Refer to the below screenshots: +![dataset_writer_new_03a.jpg](media/dataset_writer_new_03a.jpg) + +For Sequential dataset as input +![dataset_writer_new_03b.jpg](media/dataset_writer_new_03b.jpg) + +The plugin step copies the data from a PDS member or input Sequential dataset to the Output Sequential dataset. diff --git a/docs/zos-external-artifact-download/downloads.md b/docs/zos-external-artifact-download/downloads.md new file mode 100644 index 0000000..52f56b0 --- /dev/null +++ b/docs/zos-external-artifact-download/downloads.md @@ -0,0 +1,15 @@ +# Downloads + +To download the plug-in, click the following version-specific links. + +- [ucd-ExtArtRepo-10.1162509.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOS-external-artifact-download/ucd-ExtArtRepo-10.1162509.zip) +- [ucd-ExtArtRepo-10.1152827.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOS-external-artifact-download/ucd-ExtArtRepo-10.1152827.zip) +- [ucd-ExtArtRepo-9.1140093.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOS-external-artifact-download/ucd-ExtArtRepo-9.1140093.zip) +- [ExtArtRepo-8.1101664.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOS-external-artifact-download/ExtArtRepo-8.1101664.zip) +- [ExtArtRepo-7.1073614.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOS-external-artifact-download/ExtArtRepo-7.1073614.zip) +- [ExtArtRepo-7.1064504.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOS-external-artifact-download/ExtArtRepo-7.1064504.zip) +- [ExtArtRepo-6.1062664.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOS-external-artifact-download/ExtArtRepo-6.1062664.zip) +- [ExtArtRepo-5.1057222.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOS-external-artifact-download/ExtArtRepo-5.1057222.zip) +- [ExtArtRepo-4.1052576.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOS-external-artifact-download/ExtArtRepo-4.1052576.zip) +- [ExtArtRepo-2.1039791.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOS-external-artifact-download/ExtArtRepo-2.1039791.zip) +- [ExtArtRepo-1.1033763.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOS-external-artifact-download/ExtArtRepo-1.1033763.zip) diff --git a/docs/zos-external-artifact-download/index.md b/docs/zos-external-artifact-download/index.md new file mode 100644 index 0000000..2bb8499 --- /dev/null +++ b/docs/zos-external-artifact-download/index.md @@ -0,0 +1,61 @@ +# Overview + +The External Artifact Repository plug-in automates the downloading of IBM z/OS artifacts from a [Nexus](https://www.sonatype.com/product-nexus-repository) or [JFrog Artifactory](https://jfrog.com/artifactory/) repository. + +## Step palette + +To access this plug-in in the palette, click **Repositories** > **Artifact** > **zOS ExternalArtifactsDownload**. + +## Compatibility + +This plug-in requires 7.0.4 or later of UrbanCode Deploy. + +## Installation + +No special steps are required for installation. See [Installing plug-ins in UrbanCode](https://community.ibm.com/community/user/wasdevops/blogs/laurel-dickson-bull1/2022/06/13/install-plugins "Installing plug-ins in UrbanCode"). + +## History + +### Version 10 + +Added support to handle AT_TLS configuration for external repository servers +Fixed Jettison Vulnerability + +### Version 9 + +Minor Improvements and upgraded log4j + +### Version 8 + +Added support to run with insecure connection + +### Version 7 + +* Added support to run this from non zOS agent +* Minor improvements for new package format + +### Version 6 + +Added support to run this from non zOS agent + +### Version 5 + +Enhancement to extract files for package format v2 + +### Version 4 + +Implemented the proxy changes for artifactory server + +### Version 3 + +Implemented the api key changes for artifactory server + +### Version 2 + +PH20336 – Fixed the default value for extRepoURL and changed the plugin to fail when it is not able to download artifacts + +### Version 1 + +Initial release. + +Plugin is used to download artifacts from external repository like NEXUS/ARTIFACTORY then we can use Deploy Data Sets step for zOS deployment. diff --git a/docs/zos-external-artifact-download/steps.md b/docs/zos-external-artifact-download/steps.md new file mode 100644 index 0000000..5750052 --- /dev/null +++ b/docs/zos-external-artifact-download/steps.md @@ -0,0 +1,21 @@ +# Steps + +## Download Artifacts + +Download a z/OS package from an external artifact repository. The repository can be either a Nexus or Artifactory repository. + + +| Name | Type | Description | Required | +|---------------------|---------|--------------------------------------------------------------------------------------------------|----------| +| Repository URL | String | The URL of the repository. | Yes | +| User Name | String | The user name used to authenticate with the repository. | Yes | +| Repository Password | String | The password used to authenticate with the repository. | Yes | +| Artifactory api key | Boolean | Check this box to use API key authentication with artifact repository. Does not work with Nexus. | No | +| Artifactory api key | String | The api key used to authenticate with the artifactory repository. | No | + +!!! Warning + Review with your security admins before allowing insecure connection. On default, it is disabled. + +!!! Note + * Select Proxy checkbox to enable proxy connection to artifactory using passed Proxy Host and Port. Proxy does not work for Nexus. + * When USE_ATTLS property is set to TRUE, plugin will not handle encryption and will rely on server AT_TLS to encrypt the network communication with external repository. Default is FALSE. \ No newline at end of file diff --git a/docs/zos-external-artifact-download/usage.md b/docs/zos-external-artifact-download/usage.md new file mode 100644 index 0000000..c0f47a5 --- /dev/null +++ b/docs/zos-external-artifact-download/usage.md @@ -0,0 +1,5 @@ +# Usage + +Use this plug-in to automate downloading of z/OS artifacts from a Nexus Artifactory or JFrog repository to z/OS. The artifacts can then be deployed using the [Deploy Data Sets](../zos-utility/steps.md#deploy-data-sets) step of the [zOS Utility](https://urbancode.github.io/IBM-UCx-PLUGIN-DOCS/UCD/zos-deploy/) plug-in. +To create the z/OS component version, use the **buztool.sh** command from job control language (JCL) or from the z/OS UNIX System Services command line. You must specify the **-ar** parameter on the command. This parameter provides details about the artifactory needed to upload artifacts. The link from the external artifact repository is stored as a component version property, named **extRepoURL**. The property is used to download the artifacts. +For additional information, see [Creating z/OS component versions](https://www.ibm.com/support/knowledgecenter/en/SS4GSP_7.0.4/com.ibm.udeploy.doc/topics/zos_runtools.html) in the product documentation. diff --git a/docs/zos-file-source-config/README.md b/docs/zos-file-source-config/README.md new file mode 100644 index 0000000..be6a85d --- /dev/null +++ b/docs/zos-file-source-config/README.md @@ -0,0 +1,13 @@ + +# z/OS File Source Config + +The z/OS File Source Config plug-in automates uploading data sets, UNIX files and generic artifacts from a z/OS system into a component version. New component versions are created based on the input [ship list](http://www.ibm.com/support/knowledgecenter/SS4GSP_6.2.2/com.ibm.udeploy.doc/topics/zos_shiplistfiles.html). The  z/OS File Source Config plug-in provides a Web UI to run the version import commands from the the z/OS deployment tools. + +**Platform Support:** This plug-in is supported to run on z/OS. + +**Pre-requisite:** This plug-in requires UrbanCode Deploy 6.2.2 or later. The UrbanCode Deploy z/OS deployment tools must be installed to the version import agent. + + +| Back to ... | | Latest Version || +|:-----------------------------:|:------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------:| :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [7.1131549](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOSFileSourceConfig/ucd-zOSFileSourceConfig-7.1131549.zip) |[Downloads](downloads.md)| diff --git a/docs/zos-file-source-config/downloads.md b/docs/zos-file-source-config/downloads.md new file mode 100644 index 0000000..ca0f044 --- /dev/null +++ b/docs/zos-file-source-config/downloads.md @@ -0,0 +1,15 @@ + +# z/OS File Source Config - Downloads + +To download the plug-in, click the following version-specific links. +- [ucd-zOSFileSourceConfig-7.1131549.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOSFileSourceConfig/ucd-zOSFileSourceConfig-7.1131549.zip) +- [ucd-zOSFileSourceConfig-6.1128334.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOSFileSourceConfig/ucd-zOSFileSourceConfig-6.1128334.zip) +- [zOSFileSourceConfig-5.1109122.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOSFileSourceConfig/zOSFileSourceConfig-5.1109122.zip) +- [zOSFileSourceConfig-4.1100666.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOSFileSourceConfig/zOSFileSourceConfig-4.1100666.zip) +- [zOSFileSourceConfig-4.1026775.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOSFileSourceConfig/zOSFileSourceConfig-4.1026775.zip) +- [zOSFileSourceConfig-2.917658.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOSFileSourceConfig/zOSFileSourceConfig-2.917658.zip) +- [zOSFileSourceConfig-1.839698.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOSFileSourceConfig/zOSFileSourceConfig-1.839698.zip) + +| Back to ... | | Latest Version | z/OS File Source Config | +|:-----------------------------:|:------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [7.1131549](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zOSFileSourceConfig/ucd-zOSFileSourceConfig-7.1131549.zip) | [Readme](README.md) | diff --git a/docs/zos-ftp/README.md b/docs/zos-ftp/README.md new file mode 100644 index 0000000..6383fc8 --- /dev/null +++ b/docs/zos-ftp/README.md @@ -0,0 +1,8 @@ + +# z/OS FTP Utility + +The zOS FTP plug-in automates the importing of hierarchical file system (HFS) artifacts from another z/OS logical partition (LPAR). + +| Back to ... | | Latest Version |||| +|:-----------------------------:|:------------------------------:|:-----------------------------------------------------------------------------------------------------------------:| :---: | :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [1.1100685](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-ftp/zos-ftp-1.1100685.zip) |[Overview](overview.md)|[Steps](steps.md)|[Downloads](downloads.md)| diff --git a/docs/zos-ftp/downloads.md b/docs/zos-ftp/downloads.md new file mode 100644 index 0000000..925c473 --- /dev/null +++ b/docs/zos-ftp/downloads.md @@ -0,0 +1,11 @@ + +# z/OS FTP Utility - Downloads + +To download the plug-in, click the following version-specific links. + +- [zos-ftp-1.1100685.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-ftp/zos-ftp-1.1100685.zip) +- [zos-ftp-1.1061959.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-ftp/zos-ftp-1.1061959.zip) + +| Back to ... | | Latest Version | z/OS FTP Utility ||| +|:-----------------------------:|:------------------------------:|:-----------------------------------------------------------------------------------------------------------------:|:-------------------:| :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [1.1100685](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-ftp/zos-ftp-1.1100685.zip) | [Readme](README.md) |[Overview](overview.md)|[Steps](steps.md)| diff --git a/docs/zos-ftp/overview.md b/docs/zos-ftp/overview.md new file mode 100644 index 0000000..d03844e --- /dev/null +++ b/docs/zos-ftp/overview.md @@ -0,0 +1,36 @@ + +# z/OS FTP Utility - Overview + +The zOS FTP plug-in includes a step related to import hierarchical file system(HFS) artifacts from another z/OS logical partition (LPAR). + +This plug-in includes one step: + +* FTP Artifacts + + +### Step palette + +To access this plug-in in the palette, click **Utilities** > **zOS FTP**. + +### Compatibility + +This plug-in requires IBM UrbanCode Deploy version 6.0.1 or later. + +The steps in this plug-in run on any agents that the IBM UrbanCode Deploy server supports. + +### Installation + +No special steps are required for installation. See [Installing plug-ins in UrbanCode products](https://community.ibm.com/community/user/wasdevops/blogs/laurel-dickson-bull1/2022/06/13/install-plugins). + +### History + +### Version 1 + +* Initial release + + + + +| Back to ... | | Latest Version | z/OS FTP Utility ||| +|:-----------------------------:|:------------------------------:|:-----------------------------------------------------------------------------------------------------------------:|:-------------------:| :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [1.1100685](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-ftp/zos-ftp-1.1100685.zip) | [Readme](README.md) |[Steps](steps.md)|[Downloads](downloads.md)| diff --git a/docs/zos-ftp/steps.md b/docs/zos-ftp/steps.md new file mode 100644 index 0000000..4f40fbc --- /dev/null +++ b/docs/zos-ftp/steps.md @@ -0,0 +1,24 @@ + +# z/OS FTP Utility - Steps + +### Process steps in the zOS FTP Utility plug-in + +* [FTP Artifacts](#ftp-artifacts) + + +# FTP Artifacts + +Load artifacts from a remote repository using FTP. + + +| Name | Type | Description | Required | +|------------------|--------|---------------------------------------------------------------------------------------------------------------------|----------| +| Directory Offset | String | The working directory to use when running the command. This directory is relative to the current working directory. | Yes | + + + + + +| Back to ... | | Latest Version | z/OS FTP Utility ||| +|:-----------------------------:|:------------------------------:|:-----------------------------------------------------------------------------------------------------------------:|:-------------------:| :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [1.1100685](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-ftp/zos-ftp-1.1100685.zip) | [Readme](README.md) |[Overview](overview.md)|[Downloads](downloads.md)| diff --git a/docs/zos-multi-generate-artifact-info/README.md b/docs/zos-multi-generate-artifact-info/README.md new file mode 100644 index 0000000..74610d6 --- /dev/null +++ b/docs/zos-multi-generate-artifact-info/README.md @@ -0,0 +1,11 @@ +# z/OS Multi Generate Artifact Information + + + +The z/OS Multi Generate Artifact Information plug-in scans version artifacts and generates text based on a template. +The output text can be used as an input property to subsequent steps. Use this plug-in to process data sets or members in a component version. You can also use the [Generate Multiple Artifact Information](steps.md#generate-multiple-artifact-information) step to select a set of artifacts to process by applying filters on data set names, member names, deployment types, and custom properties on each output property. + + +| Back to ... | | Latest Version | | | | | +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------:|:-----------------:|:-----------------:|:-------------------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [8.1164047](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-8.1164047.zip) | [Overview](overview.md) | [Steps](steps.md) | [Usage](usage.md) | [Downloads](downloads.md) | diff --git a/docs/zos-multi-generate-artifact-info/downloads.md b/docs/zos-multi-generate-artifact-info/downloads.md new file mode 100644 index 0000000..855a88f --- /dev/null +++ b/docs/zos-multi-generate-artifact-info/downloads.md @@ -0,0 +1,26 @@ +# z/OS Multi Generate Artifact Information - Downloads + +To download the plug-in, click the following version-specific links. + +- [ucd-plugins-zos-multi-generate-artifact-info-8.1164047.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-8.1164047.zip) +- [ucd-plugins-zos-multi-generate-artifact-info-8.1162447.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-8.1162447.zip) +- [ucd-plugins-zos-multi-generate-artifact-info-8.1162244.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-8.1162244.zip) +- [ucd-plugins-zos-multi-generate-artifact-info-8.1158586.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-8.1158586.zip) +- [ucd-plugins-zos-multi-generate-artifact-info-8.1158293.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-8.1158293.zip) +- [ucd-plugins-zos-multi-generate-artifact-info-7.1157847.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-7.1157847.zip) +- [ucd-plugins-zos-multi-generate-artifact-info-7.1150817.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-7.1150817.zip) +- [ucd-plugins-zos-multi-generate-artifact-info-7.1150795.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-7.1150795.zip) +- [ucd-plugins-zos-multi-generate-artifact-info-6.1150110.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-6.1150110.zip) +- [ucd-plugins-zos-multi-generate-artifact-info-6.1132902.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-6.1132902.zip) +- [ucd-plugins-zos-multi-generate-artifact-info-6.1132811.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-6.1132811.zip) +- [ucd-plugins-zos-multi-generate-artifact-info-5.1126660.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-5.1126660.zip) +- [plugins-zos-multi-generate-artifact-info-5.1121469.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/plugins-zos-multi-generate-artifact-info-5.1121469.zip) +- [plugins-zos-multi-generate-artifact-info-4.1100684.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/plugins-zos-multi-generate-artifact-info-4.1100684.zip) +- [plugins-zos-multi-generate-artifact-info-4.1090470.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/plugins-zos-multi-generate-artifact-info-4.1090470.zip) +- [plugins-zos-multi-generate-artifact-info-3.1064503.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/plugins-zos-multi-generate-artifact-info-3.1064503.zip) +- [plugins-zos-multi-generate-artifact-info-2.1062700.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/plugins-zos-multi-generate-artifact-info-2.1062700.zip) +- [plugins-zos-multi-generate-artifact-info-1.1056678.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/plugins-zos-multi-generate-artifact-info-1.1056678.zip) + +| Back to ... | | Latest Version | z/OS Multi Generate Artifact Information | | | | +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------:|:-----------------------:|:-----------------:|:-----------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [8.1164047](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-8.1164047.zip) | [Readme](README.md) | [Overview](overview.md) | [Steps](steps.md) | [Usage](usage.md) | diff --git a/docs/zos-multi-generate-artifact-info/media/zos_example_cics.jpg b/docs/zos-multi-generate-artifact-info/media/zos_example_cics.jpg new file mode 100644 index 0000000..8ef895e Binary files /dev/null and b/docs/zos-multi-generate-artifact-info/media/zos_example_cics.jpg differ diff --git a/docs/zos-multi-generate-artifact-info/media/zos_example_containers.jpg b/docs/zos-multi-generate-artifact-info/media/zos_example_containers.jpg new file mode 100644 index 0000000..9eb79d0 Binary files /dev/null and b/docs/zos-multi-generate-artifact-info/media/zos_example_containers.jpg differ diff --git a/docs/zos-multi-generate-artifact-info/media/zos_example_output_cics.jpg b/docs/zos-multi-generate-artifact-info/media/zos_example_output_cics.jpg new file mode 100644 index 0000000..7f736b9 Binary files /dev/null and b/docs/zos-multi-generate-artifact-info/media/zos_example_output_cics.jpg differ diff --git a/docs/zos-multi-generate-artifact-info/media/zos_example_output_dbrm.jpg b/docs/zos-multi-generate-artifact-info/media/zos_example_output_dbrm.jpg new file mode 100644 index 0000000..aafab7d Binary files /dev/null and b/docs/zos-multi-generate-artifact-info/media/zos_example_output_dbrm.jpg differ diff --git a/docs/zos-multi-generate-artifact-info/overview.md b/docs/zos-multi-generate-artifact-info/overview.md new file mode 100644 index 0000000..477cd59 --- /dev/null +++ b/docs/zos-multi-generate-artifact-info/overview.md @@ -0,0 +1,74 @@ +# z/OS Multi Generate Artifact Information - Overview + + + +The z/OS Multi Generate Artifact Information plug-in scans version artifacts and generates text based on a template. You can use the generated output text as input to subsequent steps. The plug-in processes data sets and members in a component version. + +This plug-in is an extension of the z/OS Utility plug-in for generating artifact information. The z/OS Multiple Generate Artifact Information plug-in have additional features given below. + +* Ability to set multiple templates to multiple properties +* Ability to generate multiple properties using one step + +This plug-in contains one step: + +* Generate Multiple Artifact Information + +Use the Generate Multiple Artifact Information step to select a set of artifacts to process by applying filters on data set names, member names, deployment types, and custom properties for each output property. + +## Compatibility + +This plug-in requires UrbanCode Deploy version 6.1.1 or later and an UrbanCode Deploy agent on z/OS. + +This plug-in works with IBM z/OS version 1.9 or later. + +## Step palette + +To access this plug-in in the palette, click **Utilities** > **zOS Multi Generate Artifact Information**. + +## Installation + +This plug-in is installed when installing IBM UrbanCode Deploy. When new plug-in versions are available, follow the [installation instructions](https://community.ibm.com/community/user/wasdevops/blogs/laurel-dickson-bull1/2022/06/13/install-plugins "Installing plug-ins in UrbanCode Deploy") to update the plug-in. + +## History + +### Version 8 + +* Added support for Directory/File and Generic artifacts +* Added check for Target Dataset Filter to allow only dataset or member loop types +* Removed Jettison Library with vulnerability +* Removed unused libraries from plugin to reduce overall plugin size +* Fixed stream error and minor improvements + +### Version 7 + +* Added new loop type to delete PDS member excluding missing PDS members +* Fixed issue when backup is disabled during deployment +* Minor improvements + +### Version 6 + +* Minor improvements in plugin name and description +* PH46505 Fixed issue with filtering containers mapped to same Target PDS in Generate Artifact step +* Fixed issue with deleted containers for generating artifact information + +### Version 5 + +* Delete and Update/Create Deploy-Action types on same container/PDS is made possible +* Added input to filter based on artifact created or updated + +### Version 4 + +* Added support to optionally ignore unresolved properties + +### Version 3 + +* Added support to run in non zOS environment as well + +### Version 1 + +* Initial release + + +| Back to ... | | Latest Version | z/OS Multi Generate Artifact Information | | | | +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------:|:-----------------:|:-----------------:|:-------------------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [8.1164047](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-8.1164047.zip) | [Readme](README.md) | [Steps](steps.md) | [Usage](usage.md) | [Downloads](downloads.md) | diff --git a/docs/zos-multi-generate-artifact-info/steps.md b/docs/zos-multi-generate-artifact-info/steps.md new file mode 100644 index 0000000..bf35cb5 --- /dev/null +++ b/docs/zos-multi-generate-artifact-info/steps.md @@ -0,0 +1,32 @@ +# z/OS Multi Generate Artifact Information - Process Steps + + +* [Generate Multiple Artifact Information](#generate-multiple-artifact-information) + +> **Note:** +> --------- +>* Deployment Action filter is applicable only if **Backup** is enabled in [Deploy Data Sets](../zos-utility/steps.md#deploy-data-sets) step +>* Deployment Action filter is applicable only for loop types **Sequential Datasets** or **PDS Members** +>* Target Dataset Name filter is applicable for only **Dataset/PDS Member** loop types + +## Generate Multiple Artifact Information + +Generate multiple text information for selected version artifacts. The information is sent to the output properties for use by later steps. + + +| Name | Type | Description | Required | Property Name | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------| +| Container Name Filter JSON | String | The filter to limit Source datasets in template for an output property. Specify the filter as a Java regular expression matching which must begin and end with a forward slash (/). For example, /.\*LOAD/ matches any text that ends with LOAD. If the filter is not a regular expression, exact matching is used. | No | srcDatasetName | +| Custom Properties Filter JSON | String | The filter to limit Custom properties in the template for an output property. Specify each filter in the format: propertyName=valueFilter and separate each filter with a newline character. A property without a value selects all artifacts related to the specified property. Java regular expression matching is used if the filter begins and ends with a forward slash (/). For example, developer=/M.\*/ matches artifacts for the developer property where the value of the property starts with M. | No | custProperties | +| Deploy Type Filter JSON | String | The filter to limit Deploy Types in template for an output property. Specify the filter as a Java regular expression matching which must begin and end with a forward slash (/). For example, specify /.\*SRC.\*/ to match any text that contains SRC. If the filter is not a regular expression, exact matching is used. | No | deployTypeName | +| Deployment action Filter JSON | String | The filter to limit target datasets and members based on type of deployment action performed. Possible action values are ‘created’ or ‘updated’. For example: If the action value is set to ‘created’ then artifacts which are newly created in target environment are selected. Note: Action values are case insensitive. If value is empty or no value is passed then both ‘created’ and ‘updated’ artifacts are selected. | No | deployAction | +| For Each | Enumeration:
1) PDS member
2) PDS
3) Sequential Dataset
4) Deleted PDS member
5) Deleted PDS member - excluding missing members
6) Deleted PDS
7) Deleted sequential Dataset
8) Directory
9) File
10) Deleted File
11) Generic Artifact Group
12) Generic Artifact
| Generate information for each of the selected artifact type. | Yes | loopType | +| Order By | Enumeration:
ASC
DESC
SHIPLIST | Order by Ascending,Descending, or Shiplist order. | Yes | orderBy | +| Resource Name Filter JSON | String | The filter to limit PDS Members in template for an output property. Specify the filter as a Java regular expression matching which must begin and end with a forward slash(/). For example, /PGM.\*/ matches any text that starts with PGM. If the filter is not a regular expression, exact matching is used. | No | memberName | +| Target Data Set Name Filter JSON | String | The filter to limit Target datasets in template for an output property. Specify the filter as a Java regular expression matching which must begin and end with a forward slash(/). For example, /.\*LOAD/ matches any text that ends with LOAD. If the filter is not a regular expression, exact matching is used. | No | datasetName | +| Template JSON | String | Define template for each output property to generate customized text. Subsequent steps can access the customized text with ``${p:Step-Name/output-property-name}``. For example: if the step name is ‘Bind Card Generator’ and output property is ‘CicsBindText’ then the property can be referred in subsequent steps as ``${p:Bind Card Generator/CicsBindText}``. Add separators like comma or newline using character ‘,’ or ‘\n’ in the template as needed.
Use ``${propname}`` to access custom properties.
The following built-in properties are available:
``${sourceDataset}`` for the source dataset name
``${dataset}`` for the target dataset name
``${member}`` for the member name
``${deployType}`` for the deployment type
``${artifactGroup}`` for the generic artifact group name
``${artifact}`` for the generic artifact name
``${directory}`` for the source directory name
``${file}`` for the file name
``${inputsUrl}`` for the url of the inputs
All property names are case-sensitive. Do not use the built-in names for custom properties. | Yes | templateText | + + +| Back to ... | | Latest Version | z/OS Multi Generate Artifact Information | | | | +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------:|:-----------------------:|:-----------------:|:-------------------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [8.1164047](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-8.1164047.zip) | [Readme](README.md) | [Overview](overview.md) | [Usage](usage.md) | [Downloads](downloads.md) | diff --git a/docs/zos-multi-generate-artifact-info/usage.md b/docs/zos-multi-generate-artifact-info/usage.md new file mode 100644 index 0000000..7674b9f --- /dev/null +++ b/docs/zos-multi-generate-artifact-info/usage.md @@ -0,0 +1,61 @@ +# z/OS Multi Generate Artifact Information - Usage + +Use the Generate Multiple Artifact Information plug-in to generate one or more multiple properties from z/OS artifacts. The plug-in extracts data based on filters. + +## Example + +This examples demonstrates using the plug-in to extract data based on filters to generate multiple templates in JSON format. The example is based on the version and containers shown below. + +![](media/zos_example_containers.jpg?resize=640%2C189) + +The sample JSON contains two templates assigned to properties Prop-DBRM and Prop-CICS. + +``` +{ + "Prop-DBRM" : " BIND (${member}) LIBRARY(${dataset}) \n" , + "Prop-CICS" : " CEMT SET PROGRAM(${member}) NEWC \n" +} + +``` + +* Prop-DBRM contains each members bind statements for DB2 Binding process +* Prop-CICS contains RDO commands to set the latest copy of program in CICS + +There is a CICS program under the COBOL container with name the CARP001 as shown below. + +![](media/zos_example_cics.jpg?resize=602%2C436) + +To filter COBOL and DBRM containers, the JSON template in Container filter JSON can be defined as: + +``` +{ + "Prop-CICS" : "/.*COBOL/", + "Prop-DBRM" : "/.*DBRM/" +} +``` + +To filter member/resource name under the above container, the JSON template in Resource filter JSON can be defined as: + +``` +{ + "Prop-CICS": "CARP001" +} +``` + + +After the plug-in step completes, the following output is received. Please note that in addition to Prop-CICS and Prop-DBRM, we generate an additional count (Prop-CICS-count and Prop-DBRM-count) that can be used with a “switch” step in the component process to decide whether to do a bind or not. + +![](media/zos_example_output_cics.jpg?resize=602%2C35) + +![](media/zos_example_output_dbrm.jpg?resize=602%2C68) + +Similarly, you can deploy and custom property filters to create a template with only selected elements. + +Watch video in link below on how to migrate from regular generate artifact information step to multi artifact information step – + +[Multi Generate Artifact Information Plugin](https://community.ibm.com/community/user/wasdevops/viewdocument/ucd-zos-11-multi-generate-arti?CommunityKey=9adfe6b6-2e23-4895-8b27-38b93b5e152c&tab=librarydocuments) + + +| Back to ... | | Latest Version | z/OS Multi Generate Artifact Information | | | | +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------:|:-----------------------:|:-----------------:|:-------------------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [8.1164047](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-multi-generate-artifact-info/ucd-plugins-zos-multi-generate-artifact-info-8.1164047.zip) | [Readme](README.md) | [Overview](overview.md) | [Steps](steps.md) | [Downloads](downloads.md) | diff --git a/docs/zos-rexx/README.md b/docs/zos-rexx/README.md new file mode 100644 index 0000000..7356604 --- /dev/null +++ b/docs/zos-rexx/README.md @@ -0,0 +1,25 @@ +# zOS Rexx Executor + +--- + +The zOS Rexx Executor can run REXX statements provided in a dataset or in the plugin step. + +Apart from executing a REXX program, this plug-in provides ability to create output properties. + +## Compatibility + +The plug-in is compatible with: + +* UrbanCode Deploy version 7.0.0 or later +* UrbanCode Deploy agents on z/OS +* IBM z/OS version 2.1 or later +* IBM Java 8 or 11 + +## Available Steps + +* Execute a REXX program + + +| Back to ... | | Latest Version | z/OS Rexx Executor | | | | | +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------:|:-------------------:|:-----------------------:|:-----------------:|:-----------------:|--------------------------| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [2.1164401](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1164401.zip) | [Readme](README.md) | [Overview](overview.md) | [Steps](steps.md) | [Usage](usage.md) | [download](downloads.md) | \ No newline at end of file diff --git a/docs/zos-rexx/downloads.md b/docs/zos-rexx/downloads.md new file mode 100644 index 0000000..3e5d3bc --- /dev/null +++ b/docs/zos-rexx/downloads.md @@ -0,0 +1,18 @@ +# z/OS Rexx Executor - Downloads + +--- + +- [ucd-plugins-zos-rexx-2.1164401.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1164401.zip) +- [ucd-plugins-zos-rexx-2.1164307.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1164307.zip) +- [ucd-plugins-zos-rexx-2.1161998.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1161998.zip) +- [ucd-plugins-zos-rexx-2.1161121.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1161121.zip) +- [ucd-plugins-zos-rexx-2.1161042.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1161042.zip) +- [ucd-plugins-zos-rexx-2.1159387.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1159387.zip) +- [ucd-plugins-zos-rexx-2.1158244.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1158244.zip) +- [ucd-plugins-zos-rexx-2.1154680.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1154680.zip) +- [ucd-plugins-zos-rexx-1.1152822.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-1.1152822.zip) + + +| Back to ... | | Latest Version | z/OS Rexx Executor | | | | +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------:|:-------------------:|:-----------------------:|:-----------------:|:-----------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [2.1164401](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1164401.zip) | [Readme](README.md) | [Overview](overview.md) | [Steps](steps.md) | [Usage](usage.md) | diff --git a/docs/zos-rexx/overview.md b/docs/zos-rexx/overview.md new file mode 100644 index 0000000..af22045 --- /dev/null +++ b/docs/zos-rexx/overview.md @@ -0,0 +1,31 @@ +# z/OS Rexx Executor - Overview + +--- + +The z/OS Rexx Executor plug-in allows one to execute REXX statements provided in a zOS Dataset or Inline in the plugin. + +## Installation + +No special steps are required for installation. See [Installing plug-ins in UrbanCode products](https://community.ibm.com/community/user/wasdevops/blogs/laurel-dickson-bull1/2022/06/13/install-plugins). + +## History + +### Version 2 + +* Added new checkbox input to show debug logs in case of any unknown failure. +* Output will now show the elapsed time of the REXX program +* New output property RexxReturnCode will store the return code of the REXX program +* Fixes output buffer issue when output has too much data +* Arguments can now be as big as 248 characters +* Fixed issue with work directory during two or more parallel step execution +* Minor improvements in temporary directory creation +* Fixed handling of CLIST error message response from ISPF Gateway +* Changes to run process in Legacy ISPF Gateway + +### Version 1 + +* Initial release + +| Back to ... | | Latest Version | z/OS Rexx Executor | | | | +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------:|:-------------------:|:-----------------:|:-----------------:|:-------------------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [2.1164401](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1164401.zip) | [Readme](README.md) | [Steps](steps.md) | [Usage](usage.md) | [Downloads](downloads.md) | \ No newline at end of file diff --git a/docs/zos-rexx/steps.md b/docs/zos-rexx/steps.md new file mode 100644 index 0000000..0b18ef0 --- /dev/null +++ b/docs/zos-rexx/steps.md @@ -0,0 +1,20 @@ +# z/OS Rexx Executor - Steps + +--- + +## Process steps in the z/OS Rexx Executor plug-in + +### Execute a REXX program + +Use this step to execute rexx program + +| Name | Type | Description | Required | +|------------------|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| Source Type | Enumeration: INLINE / DATASET | Source of REXX program | Yes | +| Source Value | String | Text or PDS member or Sequential Dataset that has REXX program. If the single quotation marks are omitted, the user's data set prefix from the TSO profile is prefixed to the front of the data set name. | Yes | +| Arguments | String | Specify the arguments(without quotes) to the REXX program | No | +| SYSPROC Datasets | String | Specify fully qualified SYSPROC datasets that the INPUT REXX program may use | No | + +| Back to ... | | Latest Version | z/OS Rexx Executor | | | | +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------:|:-------------------:|:-----------------------:|:-----------------:|:-------------------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [2.1164401](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1164401.zip) | [Readme](README.md) | [Overview](overview.md) | [Usage](usage.md) | [Downloads](downloads.md) | diff --git a/docs/zos-rexx/usage.md b/docs/zos-rexx/usage.md new file mode 100644 index 0000000..7a2767d --- /dev/null +++ b/docs/zos-rexx/usage.md @@ -0,0 +1,74 @@ +# z/OS Rexx Executor - Usage + +--- + +The z/OS Rexx Executor plug-in will execute statements provided in a dataset or inline in the plugin step. + +Select **Source type** as **DATASET** from the drop-down and +enter the dataset in the **Source Value**. +Fully qualified dataset needs to be enclosed in single quotes. +When the quotes are omitted then, the TSO prefix of the id running the +plugin step is prefixed to the Source Dataset. + +(or) + +Select **Source type** as **INLINE** from the drop-down and +then in the **Source Value** enter REXX statements beginning with a **/\* REXX \*/** statement. + +Arguments can be passed to the REXX program with/without quotes. +However, if there are more than one argument then arguments must be separated by a space. + +The **SYSPROC** field allows user to pass datasets containing REXX programs +that will be used by the REXX program run by the plugin step. +Multiple **SYSPROC** datasets can be passed by separating datasets by a comma(,). + +### Setting output property + +This plugin allows user to set output properties from the REXX program and +later to be used in successive steps of a process. +A user REXX program can simply invoke a call to **SETPROP** with two arguments. + +The first argument is output property name and +the second argument is the property value. + +> CALL SETPROP propertyName propertyValue + +For example, below REXX snippet will set an output property **currentDate** with value of **date** variable + +*** + /* REXX */ + date = DATE('S') /* Returns date in YYYYMMDD format E.g., 20120327 */ + CALL SETPROP "currentDate" date + +### Setting multi-line output property + +To set a multi-line output property, the lines of the property value must be separated +by a delimiter returned by inbuilt program **GETDLMTR** + +*** + /* REXX */ + delimiter = GETDLMTR() /* Return delimiter to separate lines */ + lines = "This is first line" || delimiter || "This is second line" + CALL SETPROP "outputLines" lines + +Will set property **outputLines** to below value + +*** + This is first line + This is second line + +### Referring properties from successive steps + +If the rexx step name is **Run-Rexx-Program** and output property name is **currentDate** +then the output properties can be referred by the successive steps as below + +> ${p:Run-Rexx-Program/currentDate} + +**Note** + +From plugin version 2, an output property __RexxReturnCode__ will store the return/exit code from REXX program. + + +| Back to ... | | Latest Version | z/OS Rexx Executor | | | | +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------:|:-------------------:|:-----------------------:|:-----------------:|:-------------------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [2.1164401](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1164401.zip) | [Readme](README.md) | [Overview](overview.md) | [Steps](steps.md) | [Downloads](downloads.md) | diff --git a/docs/zos-uss-utility/README.md b/docs/zos-uss-utility/README.md new file mode 100644 index 0000000..cabfc4e --- /dev/null +++ b/docs/zos-uss-utility/README.md @@ -0,0 +1,8 @@ + +# z/OS USS Utility + +The z/OS USS Utility plug-in automates working with USS files on the z/OS operating system. This plug-in supports working with the IBM z/OS version 2.2 and later and requires UrbanCode Deploy agent on the z/OS server. + +| Back to ... | | Latest Version ||||| +|:-----------------------------:|:------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------:| :---: | :---: | :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [1.1162235](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-replacetokens-uss/ucd-plugins-zos-replacetokens-uss-1.1162235.zip) |[Overview](overview.md)|[Usage](usage.md)|[Steps](steps.md)|[Downloads](downloads.md)| diff --git a/docs/zos-uss-utility/downloads.md b/docs/zos-uss-utility/downloads.md new file mode 100644 index 0000000..880b7ea --- /dev/null +++ b/docs/zos-uss-utility/downloads.md @@ -0,0 +1,12 @@ + +# z/OS USS Utility - Downloads +To download the plug-in, click the following version-specific links. + +- [ucd-plugins-zos-replacetokens-uss-1.1162235.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-replacetokens-uss/ucd-plugins-zos-replacetokens-uss-1.1162235.zip) +- [ucd-plugins-zos-replacetokens-uss-1.1127592.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-replacetokens-uss/ucd-plugins-zos-replacetokens-uss-1.1127592.zip) +- [plugins-zos-replacetokens-uss-1.1060863.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-replacetokens-uss/plugins-zos-replacetokens-uss-1.1060863.zip) +- [plugins-zos-replacetokens-uss-1.1058213.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-replacetokens-uss/plugins-zos-replacetokens-uss-1.1058213.zip) + +| Back to ... | | Latest Version | z/OS USS Utility |||| +|:-----------------------------:|:------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------:| :---: | :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [1.1162235](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-replacetokens-uss/ucd-plugins-zos-replacetokens-uss-1.1162235.zip) | [Readme](README.md) |[Overview](overview.md)|[Usage](usage.md)|[Steps](steps.md)| diff --git a/docs/zos-uss-utility/overview.md b/docs/zos-uss-utility/overview.md new file mode 100644 index 0000000..0d22a10 --- /dev/null +++ b/docs/zos-uss-utility/overview.md @@ -0,0 +1,28 @@ + +# z/OS USS Utility - Overview + +The z/OS USS Utility plug-in automates the manipulation of files and directories. This plug-in runs on an z/OS Mainframe System supported by the IBM UrbanCode Deploy agent. + +### Compatibility + +* IBM UrbanCode Deploy version 6.2.1 or later +* IBM UrbanCode Deploy agents on z/OS +* IBM z/OS version 1.9 or later + +### Installation + +No special steps are required for installation. See [Installing plug-ins in UrbanCode products](https://community.ibm.com/community/user/wasdevops/blogs/laurel-dickson-bull1/2022/06/13/install-plugins). + +### History + +#### Version 1.0 + +* Initial release +* Fixed FileNotFound exception for replace token properties file +* Removed unused log4j jar file +* Removed Jettison Library with vulnerability + + +| Back to ... | | Latest Version | z/OS USS Utility |||| +|:-----------------------------:|:------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------:| :---: | :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [1.1162235](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-replacetokens-uss/ucd-plugins-zos-replacetokens-uss-1.1162235.zip) | [Readme](README.md) |[Usage](usage.md)|[Steps](steps.md)|[Downloads](downloads.md)| diff --git a/docs/zos-uss-utility/steps.md b/docs/zos-uss-utility/steps.md new file mode 100644 index 0000000..264873a --- /dev/null +++ b/docs/zos-uss-utility/steps.md @@ -0,0 +1,31 @@ + +# z/OS USS Utility - Process Steps + + +* [Replace Tokens USS](#replace-tokens-uss) + + +Replace Tokens USS +------------------ + +Replace tokens in files using properties. + + +| Name | Type | Description | Required | Property Name | +|-----------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------| +| Custom Encoding | String | Specify a character encoding to use. If blank, the replacement file is created with the local character encoding of the agent. Example encodings: UTF-8, US-ASCII, UCS-2, JIS X 0201, UTF-16, UTF-16LE, EUC. | No | customEncoding | +| Directory Offset | String | The directory relative to the current working directory that contains the files to operate on. | No | dir | +| End Token Delimiter | String | The end delimiter character used to identify tokens. | No | endDelimiter | +| Exclude Files | String | A list of patterns, separated by commas or spaces, that describe the files to exclude. New lines will be replaced with commas. | No | excludes | +| Explicit Tokens | String | A list, separated by newline characters, of explicit tokens to replace in the form of @token@->value or token->value. For example: if you specify @mytoken@->new\_value, the step replaces @mytoken@ with new\_value. The token delimiter and property prefix settings do not apply. If you specified a value in the Property List field, the explicit tokens are added as additional values to replace, and override any properties that have the same name. You cannot use regular expressions. | No | explicitTokens | +| Include Files | String | A list of patterns, separated by commas or spaces, that describe the files to include. New lines will be replaced with commas. | Yes | includes | +| Property File Name | String | The name of the file used to store the replacement name-value pairs. You can use an existing file. If the file does not exist, it is created and then removed when the step completes. | No | propFile | +| Property List | String | The property used to determine the tokens to replace in the target file. For example, if you specify ``${p:environment/allProperties}`` the names of all component environment properties are used as tokens and the property values as the replacements. Similarly, ``${p:component/allProperties}``,``${p:environment/allProperties}`` all components and component environment properties are used as tokens. The values specified on Start Token Delimiter and Property Prefix propeties apply. For example, if you specify @ for the start and end token delimiters and a property named token1 exists, the step searches for @token1@ to replace. | No | envPropValues | +| Property Prefix | String | Specify a prefix to use to determine which properties are included in token replacement. Leave blank to include all properties. | No | propertyPrefix | +| Start Token Delimiter | String | The start delimiter character used to identify tokens. | No | startDelimiter | + + + +| Back to ... | | Latest Version | z/OS USS Utility |||| +|:-----------------------------:|:------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------:| :---: | :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [1.1162235](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-replacetokens-uss/ucd-plugins-zos-replacetokens-uss-1.1162235.zip) | [Readme](README.md) |[Overview](overview.md)|[Usage](usage.md)|[Downloads](downloads.md)| diff --git a/docs/zos-uss-utility/usage.md b/docs/zos-uss-utility/usage.md new file mode 100644 index 0000000..260761e --- /dev/null +++ b/docs/zos-uss-utility/usage.md @@ -0,0 +1,27 @@ + +# z/OS USS Utility - Usage + +The z/OS USS plug-in contains the following step: + +* Replace Tokens USS + +You can use the Replace Tokens step to replace values in USS files: + +* Explicit replacement – Use the **Explicit Tokens** property to specify a list of token-value pairs. +* Replacement by using a property list – Use existing property names as tokens by specifying properties in the **Property List** property. +* Replacement by using a property file – Use the **Property File Name** property to specify a file name. + +When specifying a property file, the property file is modified when the step runs. Delimiters and prefixes are added to tokens that match tokens in the target files. To ensure repeatable behaviour, download the property file to the agent computer each time before running the **Replace Tokens USS** step. + +To replace tokens in multiple files, specify the file names in the **Include Files** property. + +### **Step palette** + +To access this plug-in in the palette, click **Utilities > zOS USS Utility**. + +Click the **Steps** tab for details about each of the step properties. + + +| Back to ... | | Latest Version | z/OS USS Utility |||| +|:-----------------------------:|:------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------:| :---: | :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [1.1162235](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-replacetokens-uss/ucd-plugins-zos-replacetokens-uss-1.1162235.zip) | [Readme](README.md) |[Overview](overview.md)|[Steps](steps.md)|[Downloads](downloads.md)| diff --git a/docs/downloads.md b/docs/zos-utility/downloads.md similarity index 99% rename from docs/downloads.md rename to docs/zos-utility/downloads.md index 92140eb..f7d2a75 100644 --- a/docs/downloads.md +++ b/docs/zos-utility/downloads.md @@ -1,4 +1,3 @@ - # Downloads To download the plug-in, click the following version-specific links. diff --git a/docs/index.md b/docs/zos-utility/index.md similarity index 51% rename from docs/index.md rename to docs/zos-utility/index.md index ea7d254..3034e7a 100644 --- a/docs/index.md +++ b/docs/zos-utility/index.md @@ -182,4 +182,168 @@ No special steps are required for installation. See [Installing plug-ins in Urba ### Version 60 -* Enhancements and bug fixes for HFS deployment and rollback – APAR PH42431 \ No newline at end of file +* Enhancements and bug fixes for HFS deployment and rollback – APAR PH42431 + +### Version 59.1126010 + +* Fixed HFS untar issue for Ant version upgrade + +### Version 59.1125740 + +* Fixed APAR-PH41930 Parsing return codes from ISPF gateway has been enhanced + +### Version 59.1125359 + +* Fixed Page End statement in submit job step to display after output + +### Version 59.1125062 + +* Fixed APAR PH41991 added support for JOBRC parameter in submit job step + +### Version 59.1125008 + +* Changed Prevent Risky Rollback input in Rollback step from check-box to Drop-Down + +### Version 58.1122539 + +* Added support to run Wait For Job step using Agent Id or Impersonation Id + +### Version 57.1121803 + +* Reformatted checkaccess error message + +### Version 57.1121798 + +* Fixed PH39119 – Rollback step failing with version not deployed error after a failed deployment + +### Version 57.1121666 + +* Added support for submitting job using Agent Id or Impersonation Id + +### Version 56.1102074 + +* Fixed newline character parsing in Generate artifact template input + +### Version 56.1100633 + +* Fixed PH35042 – Fixed Array index Out Of Bound failure + +### Version 56.1098848 + +* Fixed PH34874 – Fixed the issue of ISPF command executions reported as success when it is a failure + +### Version 56 + +* Deploy datasets – now accepts DUMMY in pdsmapping target. ++ Input in pds mapping field can be of the format src.dataset,DUMMY + +### Version 55 + +* Added hidden input to pass Binder API Path for RUNTIME delta deployment to add to LIBPATH. (APAR PH31349) +* Added check box to print debug logs for Deploy and Rollback steps +* Added check box to print each job output in a new page in submit job plugin step (Needs Java 8) + +### Version 54 + +* Ported following steps to run from a non-zOS agent as well ++ Submit job ++ Wait for job +* Moved FTP plugin step into a new plugin ( https://urbancode.github.io/IBM-UCx-PLUGIN-DOCS/UCD/zos-ftp/ ) +* Added permission checks for ISPF work directory and file +* Fixed incompatible code with Java 7 (Earlier versions of this plugin required Java 8. Based on a request, we ported the plugins to run with Java 7 & 8 as well. +* Enhancement on runtime delta deployment +* Fixed exception for HFS deployment and Rollback with new Ant version (That was introduced in UCD 7.1.0.1) +* Minor bug fixes in HFS deployment / Rollback operations + +### Version 53 + +* Enhancement for Partial Deployment based on Container Filter +* Fixed exception for HFS Deployment with previous HFS version (PH27636) + +### Version 52 + +* PH24188 – Fixed deployment freeze for large component version +* Support for copyTypes with package format v2 +* Enhancement to ignore unresolved properties in generate artifacts information step + +### **Note:** From version 51, groovy string methods are not interpreted in Template input since the code is rewritten in Java. + +### Version 51 + +* Rewriting Generate Version Artifact Information groovy program in Java. +* Fixed null pointer exception error when deployType filter is applied to resource with no deployType +* Fixed null pointer exception error when regular expression is used in deployType +* PH23624 – Fixed NoClassDef error for submit job step using passcode authentication + +### Version 50 + +* Rewriting Replace Tokens MVS plugin from Groovy to Java for performance improvement + +### Version 49 + +* Submit Job groovy plugin rewritten in Java +* Added functionality to delete all contents in the target HFS folder and then deploy the artifacts from UCD version +* Added functionality to determine the toolkit version and call appropriate methods and fixed an issue with rollback for deleted HFS files +* Required Java 8 or above from this plugin version + +### Version 48 + +* PH11769- Fix for replace tokens with EAV VTOC volumes & improved performance for new package format + +### Version 46 + +* Added functionality for the new package format deploy + +### Version 45 + +* Fixing CVE:CVE-2019-4233 + +### Version 44 + +* Allowing mutiple source and multiple target directories to deploy instead of one HFS Target directory. NOTE: UrbanCode Deploy server 7.0.3 and the same level of the agent are required for using this HFS feature. + +### Version 41 + +* Updated Deploy Data Sets step to support runtime delta deploy. NOTE: UrbanCode Deploy server 7.0.2 and the same level of the agent is required for using this runtime delta deploy feature. + +### Version 39.1001623 + +* PH03567 To fix the issue of environment properties getting trimmed in Replace Tokens MVS step +* PH03684 To fix the issue when a REXX/ISPF process that gives out more than 2000+ lines are run from UCD, the response never comes back to the server + +### Version 39.992980 + +* PH01955 Fixed the issue with deploy datasets failing when we use \* with an add and delete of same PDS +* PH01081 Fixed the issue with class not found for JES logger + +### Version 27.864857 + +Added support for encrypted input and output properties. Updated Replace Tokens MVS step to preserve ISPF statistics. Fixed bugs. + +### Version 26.813109 + +Updated Generate Artifact Information step to support order by. + +### Version 24.800369 + +Version 24 includes the following updates: + +* A fix for a problem that is related to replacing tokens in VB data sets. +* The Rollback Data Sets step was updated to prevent risky rollbacks. + +### Version 22.787240 + +Fixes APAR PI57417. Plug-in now checks the agent settings for acceptance of self-signed certificates. + +### Version 17.692574 + +This release includes the following updates: + +* A fix for an issue where the deployment data set and rollback data set unnecessarily requires data set ALTER privilege. +* The Generate Artifact Information step now supports sequential data sets and data set deletion. +* The Generate Artifact Information step now includes an option to mark the step as failed when no result is generated. +* A count output property now stores the number of artifacts generated. +* The Replace Tokens MVS step now allows updates to a data set that is opened by other readers. The step uses DISP=SHR to open the data set for output. +* The Submit Job step now supports a default job statement. +* Updated help for steps. +* A fix for an issue where the Submit Job step did not use PassTicket authentication. diff --git a/docs/media/deploy-zos.png b/docs/zos-utility/media/deploy-zos.png similarity index 100% rename from docs/media/deploy-zos.png rename to docs/zos-utility/media/deploy-zos.png diff --git a/docs/media/deploy-zos2.png b/docs/zos-utility/media/deploy-zos2.png similarity index 100% rename from docs/media/deploy-zos2.png rename to docs/zos-utility/media/deploy-zos2.png diff --git a/docs/media/deploy-zos3.png b/docs/zos-utility/media/deploy-zos3.png similarity index 100% rename from docs/media/deploy-zos3.png rename to docs/zos-utility/media/deploy-zos3.png diff --git a/docs/media/operational-component-process-for-rollback-with-template.png b/docs/zos-utility/media/operational-component-process-for-rollback-with-template.png similarity index 100% rename from docs/media/operational-component-process-for-rollback-with-template.png rename to docs/zos-utility/media/operational-component-process-for-rollback-with-template.png diff --git a/docs/media/properties-for-run-uninstall-application-process.png b/docs/zos-utility/media/properties-for-run-uninstall-application-process.png similarity index 100% rename from docs/media/properties-for-run-uninstall-application-process.png rename to docs/zos-utility/media/properties-for-run-uninstall-application-process.png diff --git a/docs/media/redundant_versions.gif b/docs/zos-utility/media/redundant_versions.gif similarity index 100% rename from docs/media/redundant_versions.gif rename to docs/zos-utility/media/redundant_versions.gif diff --git a/docs/media/remove-version-from-inventory-app-process.png b/docs/zos-utility/media/remove-version-from-inventory-app-process.png similarity index 100% rename from docs/media/remove-version-from-inventory-app-process.png rename to docs/zos-utility/media/remove-version-from-inventory-app-process.png diff --git a/docs/media/rollback-zos.png b/docs/zos-utility/media/rollback-zos.png similarity index 100% rename from docs/media/rollback-zos.png rename to docs/zos-utility/media/rollback-zos.png diff --git a/docs/media/rollback-zos2.png b/docs/zos-utility/media/rollback-zos2.png similarity index 100% rename from docs/media/rollback-zos2.png rename to docs/zos-utility/media/rollback-zos2.png diff --git a/docs/media/set-status-to-success-step.png b/docs/zos-utility/media/set-status-to-success-step.png similarity index 100% rename from docs/media/set-status-to-success-step.png rename to docs/zos-utility/media/set-status-to-success-step.png diff --git a/docs/media/submit_job_template.gif b/docs/zos-utility/media/submit_job_template.gif similarity index 100% rename from docs/media/submit_job_template.gif rename to docs/zos-utility/media/submit_job_template.gif diff --git a/docs/media/submit_job_wait.gif b/docs/zos-utility/media/submit_job_wait.gif similarity index 100% rename from docs/media/submit_job_wait.gif rename to docs/zos-utility/media/submit_job_wait.gif diff --git a/docs/media/zos_check.png b/docs/zos-utility/media/zos_check.png similarity index 100% rename from docs/media/zos_check.png rename to docs/zos-utility/media/zos_check.png diff --git a/docs/media/zos_cics_1.png b/docs/zos-utility/media/zos_cics_1.png similarity index 100% rename from docs/media/zos_cics_1.png rename to docs/zos-utility/media/zos_cics_1.png diff --git a/docs/media/zos_cics_2.png b/docs/zos-utility/media/zos_cics_2.png similarity index 100% rename from docs/media/zos_cics_2.png rename to docs/zos-utility/media/zos_cics_2.png diff --git a/docs/media/zos_cics_3.png b/docs/zos-utility/media/zos_cics_3.png similarity index 100% rename from docs/media/zos_cics_3.png rename to docs/zos-utility/media/zos_cics_3.png diff --git a/docs/media/zos_cics_4.png b/docs/zos-utility/media/zos_cics_4.png similarity index 100% rename from docs/media/zos_cics_4.png rename to docs/zos-utility/media/zos_cics_4.png diff --git a/docs/media/zos_genjobparams.png b/docs/zos-utility/media/zos_genjobparams.png similarity index 100% rename from docs/media/zos_genjobparams.png rename to docs/zos-utility/media/zos_genjobparams.png diff --git a/docs/media/zos_multiplejobs.png b/docs/zos-utility/media/zos_multiplejobs.png similarity index 100% rename from docs/media/zos_multiplejobs.png rename to docs/zos-utility/media/zos_multiplejobs.png diff --git a/docs/media/zos_multipleproc.png b/docs/zos-utility/media/zos_multipleproc.png similarity index 100% rename from docs/media/zos_multipleproc.png rename to docs/zos-utility/media/zos_multipleproc.png diff --git a/docs/media/zos_mvs_2.png b/docs/zos-utility/media/zos_mvs_2.png similarity index 100% rename from docs/media/zos_mvs_2.png rename to docs/zos-utility/media/zos_mvs_2.png diff --git a/docs/media/zos_props_1.png b/docs/zos-utility/media/zos_props_1.png similarity index 100% rename from docs/media/zos_props_1.png rename to docs/zos-utility/media/zos_props_1.png diff --git a/docs/media/zos_props_2.png b/docs/zos-utility/media/zos_props_2.png similarity index 100% rename from docs/media/zos_props_2.png rename to docs/zos-utility/media/zos_props_2.png diff --git a/docs/media/zos_props_3.png b/docs/zos-utility/media/zos_props_3.png similarity index 100% rename from docs/media/zos_props_3.png rename to docs/zos-utility/media/zos_props_3.png diff --git a/docs/media/zos_props_4.png b/docs/zos-utility/media/zos_props_4.png similarity index 100% rename from docs/media/zos_props_4.png rename to docs/zos-utility/media/zos_props_4.png diff --git a/docs/media/zos_props_5.png b/docs/zos-utility/media/zos_props_5.png similarity index 100% rename from docs/media/zos_props_5.png rename to docs/zos-utility/media/zos_props_5.png diff --git a/docs/steps.md b/docs/zos-utility/steps.md similarity index 99% rename from docs/steps.md rename to docs/zos-utility/steps.md index f05c4ba..073b6cb 100644 --- a/docs/steps.md +++ b/docs/zos-utility/steps.md @@ -4,9 +4,9 @@ Allocate a non-SMS-managed data set. -!!! note - To create a GDG version add (+1) along with GDG base. An output property **DatasetName** will contain the actual GDG version dataset name that is created and can be referred in successive steps of the process. - +!!! Note + To create a GDG version add (+1) along with GDG base. + An output property `DatasetName` will contain the actual GDG version dataset name that is created and can be referred in successive steps of the process. | Name | Type | Description | Required | |--------------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| @@ -116,14 +116,13 @@ Load artifacts from a remote repository using FTP. ## Generate Artifact Information -**Note:** - -* Deployment Action filter is applicable only if **Backup** is enabled in [Deploy Data Sets](../zos-deploy/steps.md#deploy-data-sets) step -* Deployment Action filter is applicable only for loop types **Sequential Datasets** or **PDS Members** -* Target Dataset Name filter is applicable for only **Dataset/PDS Member** loop types -* From version 51, groovy string methods are not interpreted in Template input since the code is rewritten in Java. +> **Note:** +> --------- +>* Deployment Action filter is applicable only if **Backup** is enabled in [Deploy Data Sets](/steps.md#deploy-data-sets) step +>* Deployment Action filter is applicable only for loop types **Sequential Datasets** or **PDS Members** +>* Target Dataset Name filter is applicable for only **Dataset/PDS Member** loop types -Generate text information for selected version artifacts. The information is sent to the text output property for use by later steps. Check out our new plugin to generate multiple templates using a single step +Generate text information for selected version artifacts. The information is sent to the text output property for use by later steps. **Note:** From version 51, groovy string methods are not interpreted in Template input since the code is rewritten in Java. Use our new plugin to generate multiple templates using a single step | Name | Type | Description | Required | |------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| @@ -317,4 +316,4 @@ Restored datasets from backup taken during deployment | Temporary DSN Prefix | String | Specify a DSN prefix to be used to create temporary data sets. The default value is the BUZ_TMP_DSN_PREFIX environment variable. If a value is not provided, the prefix in the agent user’s profile or the agent user’s ID is used. | No | | Version Name | String | Version Name | Yes | | Component Name | String | Component Name | Yes | -| Resource Id | String | Resource Id | Yes | \ No newline at end of file +| Resource Id | String | Resource Id | Yes | diff --git a/docs/troubleshooting.md b/docs/zos-utility/troubleshooting.md similarity index 93% rename from docs/troubleshooting.md rename to docs/zos-utility/troubleshooting.md index 4f849bc..aa89006 100644 --- a/docs/troubleshooting.md +++ b/docs/zos-utility/troubleshooting.md @@ -1,6 +1,4 @@ -# Troubleshooting - - +# z/OS Utility - Troubleshooting ## Copy Artifacts step limitation @@ -12,4 +10,4 @@ If you use the Run TSO or ISPF Command step to run a TSO command, the return cod ## Repository field for Copy Artifacts and FTP Artifacts steps -The local repository referred to in the Copy Artifacts and FTP Artifacts steps is not the Codestation repository, but rather the z/OS deployment tools artifact repository. You specify this directory when you install the z/OS deployment tools. By default, the artifact repository is the following directory: *agent\_installation\_directory*/var/repository. To learn more, see [Completing the installation of the z/OS deployment tools](http://www-01.ibm.com/support/knowledgecenter/SS4GSP_6.2.1/com.ibm.udeploy.doc/topics/zos_installing_finish.html?lang=en). \ No newline at end of file +The local repository referred to in the Copy Artifacts and FTP Artifacts steps is not the Codestation repository, but rather the z/OS deployment tools artifact repository. You specify this directory when you install the z/OS deployment tools. By default, the artifact repository is the following directory: *agent\_installation\_directory*/var/repository. To learn more, see [Completing the installation of the z/OS deployment tools](http://www-01.ibm.com/support/knowledgecenter/SS4GSP_6.2.1/com.ibm.udeploy.doc/topics/zos_installing_finish.html?lang=en). diff --git a/docs/deployment-rollback-design/deploy-rollback.md b/docs/zos-utility/usage-pages/deploy-rollback.md similarity index 96% rename from docs/deployment-rollback-design/deploy-rollback.md rename to docs/zos-utility/usage-pages/deploy-rollback.md index a10602d..5ccf221 100644 --- a/docs/deployment-rollback-design/deploy-rollback.md +++ b/docs/zos-utility/usage-pages/deploy-rollback.md @@ -2,7 +2,7 @@ --- -This page covers below sections +## This page covers below sections * [Deploy a component version to z/OS platform](deploy-rollback.md#deploy-a-component-version-to-zos-platform) * [Component process setup for deploying component version](deploy-rollback.md#component-process-setup-for-deploying-component-version) @@ -33,7 +33,7 @@ Post-processing steps can be added as per the requirement after [Deploy Data set * [Replace Token MVS](../steps.md#replace-tokens-mvs) step to replace tokens in dataset/member * [CICS New Copy](../../CICS/steps.md#new-copy-resources) step and so on. -If external repository (Artifactory or Nexus) is used to store zOS Component version, Use [Download Artifacts for zOS External Repo](../../zOS-external-artifact-download/steps.md#download-artifacts) step to download version artifacts from the external repository. +If external repository (Artifactory or Nexus) is used to store zOS Component version, Use [Download Artifacts for zOS External Repo](../../zos-external-artifact-download/steps.md#download-artifacts) step to download version artifacts from the external repository. Component process design will be as below. [![deploy-zos2](../media/deploy-zos2.png)](../media/deploy-zos2.png) @@ -83,3 +83,7 @@ __Component Inventory Update__ step must be the last step in the application pro Application process design will be as below. [![rollback-zos2](../media/rollback-zos2.png)](../media/rollback-zos2.png) + +| Back to ... | +|----------------------| +| [Usage](../usage.md) | diff --git a/docs/deployment-rollback-design/rollback-with-template.md b/docs/zos-utility/usage-pages/rollback-with-template.md similarity index 97% rename from docs/deployment-rollback-design/rollback-with-template.md rename to docs/zos-utility/usage-pages/rollback-with-template.md index e563c09..58da528 100644 --- a/docs/deployment-rollback-design/rollback-with-template.md +++ b/docs/zos-utility/usage-pages/rollback-with-template.md @@ -1,6 +1,6 @@ # Rollback for z/OS component version with application template -This page covers below sections +## This page covers below sections - [Rollback for z/OS component version with application template](#rollback-for-zos-component-version-with-application-template) - [This page covers below sections](#this-page-covers-below-sections) @@ -70,3 +70,7 @@ Create a new process in the application template. Add **Uninstall Multiple Compo To rollback Z Artifacts, run [Rollback Z Artifacts process](#application-template-process-for-rollback) to run all the rollback steps under component process. The Component process triggers [Remove Version From Inventory process](#application-template-process-for-uninstall) only when artifacts are rolled back and all the steps ran successfully. + +| Back to ... | +|----------------------| +| [Usage](../usage.md) | diff --git a/docs/usage.md b/docs/zos-utility/usage.md similarity index 89% rename from docs/usage.md rename to docs/zos-utility/usage.md index 8614627..237e4bd 100644 --- a/docs/usage.md +++ b/docs/zos-utility/usage.md @@ -1,27 +1,5 @@ # Usage -The following pages provide usage information about this plug-in: - -* [Deployment and Rollback for z/OS component version](deployment-rollback-design/deploy-rollback.md#deployment-and-rollback-for-zos-component-version) - * [Deploy a component version to z/OS platform](deployment-rollback-design/deploy-rollback.md#deploy-a-component-version-to-zos-platform) - * [Component process setup for deploying component version](deployment-rollback-design/deploy-rollback.md#component-process-setup-for-deploying-component-version) - * [Application process setup for deploying component version](deployment-rollback-design/deploy-rollback.md#application-process-setup-for-deploying-component-version) - * [Rollback a component version from z/OS platform](deployment-rollback-design/deploy-rollback.md#rollback-a-component-version-from-zos-platform) - * [Component process setup for rolling back a component version](deployment-rollback-design/deploy-rollback.md#component-process-setup-for-rolling-back-a-component-version) - * [Application process setup for rolling back a component version](deployment-rollback-design/deploy-rollback.md#application-process-setup-for-rolling-back-a-component-version) -* [Rollback for z/OS component version with application template](deployment-rollback-design/rollback-with-template.md#rollback-for-zos-component-version-with-application-template) -* [Deploying by using the Job Monitor](#deploying-by-using-the-job-monitor) -* [Submitting a JCL job and then checking for status](#submitting-a-jcl-job-and-then-checking-for-status) -* [Submitting a JCL job from a template](#submitting-jcl-jobs-from-a-template) -* [MVS component template](#mvs-component-template) -* [Managing redundant versions](#managing-redundant-versions) - * [Remove Redundant Versions](#remove-redundant-versions) - * [Ignoring High Level Qualifiers](#ignoring-high-level-qualifiers) -* [Running MVS system commands](#running-mvs-system-commands) -* [Using custom properties in deployments](#using-custom-properties-in-deployments) -* [Deploying data sets and running CICS commands](#deploying-data-sets-and-running-cics-commands) -* [Deploying HFS files](#deploying-hfs-files) - ## Running MVS system commands The Run MVS Command step uses the Java programming interface with the System Display and Search Facility (SDSF) to run MVS system commands on the agent. To use the Run MVS Command step, you must work with your system administrator to configure security properly for the agent user account. In the following examples, protecting resources by setting the universal access authority (UACC) to NONE might prevent all users, except users with explicit permission, from accessing the protected command. @@ -263,4 +241,4 @@ The process runs the following steps in order: 2. The Shell step represents other processing steps to take while the JCL job runs. 3. The [Wait For Job](https://urbancode.github.io/IBM-UCx-PLUGIN-DOCS/UCD/zos-deploy/steps.html) step stops processing until the JCL job completes. -[![submit_job_wait](media/submit_job_wait.gif)](media/submit_job_wait.gif) \ No newline at end of file +[![submit_job_wait](media/submit_job_wait.gif)](media/submit_job_wait.gif) diff --git a/docs/zosmf/README.md b/docs/zosmf/README.md new file mode 100644 index 0000000..c92ee92 --- /dev/null +++ b/docs/zosmf/README.md @@ -0,0 +1,24 @@ + +# z/OS Management Facility + +The z/OS Management Facility (zOSMF) plug-in provides functions to discover software instances provisioned by [z/OSMF Cloud Provisioning](https://www.ibm.com/systems/z/os/zos/features/zosmf/) or [z/OS Provisioning Toolkit](https://developer.ibm.com/mainframe/products/zospt/). + +The zOS Management Facility plug-in includes steps to create and manage z/OSMF workflows and software service templates. + +**Platform Support:** + +* z/OSMF Cloud Provisioning is available on z/OS V2R2 (PTF UI42847, UI46543), V2R1 (PTF UI43814) and later +* This plug-in requires UrbanCode Deploy 6.2.0 or later.Specific resource icons for z/OS software instances are used in UrbanCode Deploy 6.2.6 and later + + +### Available Steps + +Create Workflow: Create a workflow. + +Start Workflow: Start a workflow. + +Run Published Software Service Template: Define input properties for the Run Published Software Service template. + +| Back to ... || Latest Version ||||| +|:-----------------------------:|:------------------------------:| :---: | :---: | :---: | :----: |:-------------------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) |[15.1153789](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/ucd-zosmf-15.1153789.zip)|[Overview](overview.md)|[Usage](usage.md)|[Steps](steps.md)|[Downloads](downloads.md)| diff --git a/docs/zosmf/downloads.md b/docs/zosmf/downloads.md new file mode 100644 index 0000000..cb5b195 --- /dev/null +++ b/docs/zosmf/downloads.md @@ -0,0 +1,22 @@ + +# z/OS Management Facility - Downloads + +To download the plug-in, click the following links. +- [ucd-zosmf-15.1153789.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/ucd-zosmf-15.1153789.zip) +- [zosmf-14.1098512.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-14.1098512.zip) +- [zosmf-14.1041082.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-14.1041082.zip) +- [zosmf-13.1038208.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-13.1038208.zip) +- [zosmf-12.1027701.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-12.1027701.zip) +- [zosmf-11.1026878.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-11.1026878.zip) +- [zosmf-10.1013524.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-10.1013524.zip) +- [zosmf-9.1009235.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-9.1009235.zip) +- [zosmf-8.1007345.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-8.1007345.zip) +- [zosmf-8.973157.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-8.973157.zip) +- [zosmf-7.944531.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-7.944531.zip) +- [zosmf-6.934842.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-6.934842.zip) +- [zosmf-5.868918.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-5.868918.zip) +- [zosmf-4.839888.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/zosmf-4.839888.zip) + +| Back to ... || Latest Version | z/OS Management Facility |||| +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------:| :---: | :---: | :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [15.1153789](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/ucd-zosmf-15.1153789.zip) |[Readme](README.md)|[Overview](overview.md)|[Usage](usage.md)|[Steps](steps.md)| diff --git a/docs/zosmf/media/agent-property.jpg b/docs/zosmf/media/agent-property.jpg new file mode 100644 index 0000000..65ffe2f Binary files /dev/null and b/docs/zosmf/media/agent-property.jpg differ diff --git a/docs/zosmf/media/zosmf-discover-step-1.jpg b/docs/zosmf/media/zosmf-discover-step-1.jpg new file mode 100644 index 0000000..7c13e08 Binary files /dev/null and b/docs/zosmf/media/zosmf-discover-step-1.jpg differ diff --git a/docs/zosmf/media/zosmf-discover-step-2.jpg b/docs/zosmf/media/zosmf-discover-step-2.jpg new file mode 100644 index 0000000..f720c08 Binary files /dev/null and b/docs/zosmf/media/zosmf-discover-step-2.jpg differ diff --git a/docs/zosmf/media/zosmf-discover-with-parameter.jpg b/docs/zosmf/media/zosmf-discover-with-parameter.jpg new file mode 100644 index 0000000..71b3a44 Binary files /dev/null and b/docs/zosmf/media/zosmf-discover-with-parameter.jpg differ diff --git a/docs/zosmf/media/zosmf-instance-properties.jpg b/docs/zosmf/media/zosmf-instance-properties.jpg new file mode 100644 index 0000000..bbad0b3 Binary files /dev/null and b/docs/zosmf/media/zosmf-instance-properties.jpg differ diff --git a/docs/zosmf/media/zosmf-property-reference.jpg b/docs/zosmf/media/zosmf-property-reference.jpg new file mode 100644 index 0000000..a3c3444 Binary files /dev/null and b/docs/zosmf/media/zosmf-property-reference.jpg differ diff --git a/docs/zosmf/media/zosmf-provision-and-discover-process.jpg b/docs/zosmf/media/zosmf-provision-and-discover-process.jpg new file mode 100644 index 0000000..99b12fd Binary files /dev/null and b/docs/zosmf/media/zosmf-provision-and-discover-process.jpg differ diff --git a/docs/zosmf/media/zosmf-provision-and-discover-result.jpg b/docs/zosmf/media/zosmf-provision-and-discover-result.jpg new file mode 100644 index 0000000..32f17ca Binary files /dev/null and b/docs/zosmf/media/zosmf-provision-and-discover-result.jpg differ diff --git a/docs/zosmf/media/zosmf-provision-before.jpg b/docs/zosmf/media/zosmf-provision-before.jpg new file mode 100644 index 0000000..2675ddc Binary files /dev/null and b/docs/zosmf/media/zosmf-provision-before.jpg differ diff --git a/docs/zosmf/media/zosmf-run-published-software-service-template.jpg b/docs/zosmf/media/zosmf-run-published-software-service-template.jpg new file mode 100644 index 0000000..5d74bf2 Binary files /dev/null and b/docs/zosmf/media/zosmf-run-published-software-service-template.jpg differ diff --git a/docs/zosmf/overview.md b/docs/zosmf/overview.md new file mode 100644 index 0000000..cff5281 --- /dev/null +++ b/docs/zosmf/overview.md @@ -0,0 +1,72 @@ + +# z/OS Management Facility - Overview + +The z/OS Management Facility (zOSMF) plug-in provides functions to discover software instances provisioned by[z/OSMFCloud Provisioning](https://www.ibm.com/systems/z/os/zos/features/zosmf/)or[z/OS Provisioning Toolkit](https://developer.ibm.com/mainframe/products/zospt/). A collection of resources are created inthe resource tree torepresent thesoftware instances such as CICS regions, WebSphere Liberty profile, MQ queues, and DB2 databases. + +## Discovering resources + +Discovering resources takes less time than manually creating resources to match the sub systems. For additional information about discovering resources, see the following topics: + +* [Discovering Mainframe Software Services Instances](usage.md#discovering-mainframe-software-services-instances) +* [Provisioning and Discovering Mainframe Software Services Instances](usage.md#provisioning-discovering-mainframe-software-services-instances) + +## Steps and Roles + +This plug-in includes the following steps: + +* [Create Workflow](steps.md#create-workflow) +* [Start Workflow](steps.md#start-workflow) +* [Run Published Software Service Template](steps.md#run-published-software-service-template) +* [Software Services Instance Discovery](steps.md#software-services-instance-discovery) +* [zOSMF Cloud Provisioning Discovery](steps.md#zosmf-cloud-provisioning-discovery) + +The following roles are added by this plug-in. + +* [zOSMFService](steps.md#zosmfservice-role) +* [zOSMFSoftwareInstance](steps.md#zosmfsoftwareinstance-role) + +### Step palette + +To access this plug-in in the palette, click **Utilities** > **zOS Utility** > **zOSMF**. + +### Compatibility + +The steps in this plug-in run on the following platforms. + +* This plug-in is supported to run on z/OS 2.2 or later. +* This plug-in requires UrbanCode Deploy 6.2.0 or later.Specific resource icons for z/OS software instances are used in UrbanCode Deploy 6.2.6 and later + +### Prerequisites + +* Only software instances provisioned using z/OSMF Cloud Provisioning orz/OS Provisioning Toolkit can be discovered. +* z/OSMF must be started and permission must be setup to allow access to the REST API +* The user ID used to run discovery must have proper permission to access the software instance. + +### Installation + +No special steps are required for installation. See [Installing plug-ins in UrbanCode products](https://community.ibm.com/community/user/wasdevops/blogs/laurel-dickson-bull1/2022/06/13/install-plugins). + +### History + +#### Version 15.1153789 includes the following updates + +* Fixes Groovy compilation issue on Groovy-3.0.x. + +#### Version 6.934842 includes the following updates + +* Added zOSMF discovery feature. The plug-in is now able to discover software instances provisioned by zOSMF Cloud Provisioning or zOS Provisioning Toolkit. A set of resources representing the software instances are automatically created as the result of the discovery. +* Added a new step to Run Published Software Service Template. + +#### Version 5.868918 includes the following updates + +* Enhanced Start Workflow step to store job logs to output properties. + +#### Version 4.839888 includes the following updates + +* Fixed a problem in Start Workflow step that Perform Subsequent parameter does not work. +* Fixed a problem in Start Workflow step that partially completed workflow gives a step failure. +* Enhanced Start Workflow step to display job logs. + +| Back to ... | | Latest Version | z/OS Management Facility |||| +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------:| :---: | :----: |:-------------------------:| +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [15.1153789](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/ucd-zosmf-15.1153789) | [Readme](README.md) | [Usage](usage.md) | [Steps](steps.md) | [Downloads](downloads.md)| diff --git a/docs/zosmf/steps.md b/docs/zosmf/steps.md new file mode 100644 index 0000000..fd64d43 --- /dev/null +++ b/docs/zosmf/steps.md @@ -0,0 +1,147 @@ + +# z/OS Management Facility - Process Steps + +- [z/OS Management Facility - Process Steps](#zos-management-facility---process-steps) + - [Steps](#steps) + - [Create Workflow](#create-workflow) + - [Run Published Software Service Template](#run-published-software-service-template) + - [Software Services Instance Discovery](#software-services-instance-discovery) + - [Start Workflow](#start-workflow) + - [zOSMF Cloud Provisioning Discovery](#zosmf-cloud-provisioning-discovery) + - [Roles in the zOSMF plug-in](#roles-in-the-zosmf-plug-in) + - [zOSMFService Role](#zosmfservice-role) + - [zOSMFSoftwareInstance Role](#zosmfsoftwareinstance-role) + +## Steps + +### Create Workflow + +Use this step to create a workflow. + +| Name | Type | Description | Required | +|----------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| Assign To Owner | Boolean | Indicates whether the workflow steps are assigned to the workflow owner when the workflow is created. If this property is set to true steps are assigned to the user ID that is specified on the property owner. If this property is set to false, the workflow steps are left unassigned when the workflow is created. The default is true. | No | +| Comments | String | Specifies any information that you want to associate with the creation of this workflow. The comment can contain up to 500 characters. This information is recorded in the workflow history. | No | +| Generate Unique Name | Boolean | Indicates whether to append a timestamp to the workflow name. Adding a timestamp ensures the workflow name is unique name. The default is true. | No | +| Owner | String | The user ID of the workflow owner. This user can perform the workflow steps or delegate the steps to other users. Specify a valid user ID that is defined to your z/OS security management product installation, such as RACF. A valid user ID consists of one to eight alphanumeric characters (A-Z, a-z, 0-9, #, $, and @). | Yes | +| Print REST call in log | Boolean | Indicates if REST call requests and responses are written to the log file. The default is not to write REST calls into the log file. | No | +| Resolve Global Conflict By Using | String | On creation of the workflow, z/OSMF determines whether any of the variables that are supplied in this request (through the variable input file or variables array) would conflict with existing global variables in the Workflows task. In such cases, this property specifies which version of the variable is used, as follows: When set to input, the global variable conflicts are overridden by the variables in specified input file. The global variable value is updated with the input variable value. Use caution with this setting; your selection will affect any other workflows that refer to the same global variable. When set to global, or omitted, the variable value supplied with the request (through the variable input file or variables array) is ignored and the current global value is used. The default is global. | No | +| System | String | The nickname of the system on which the workflow is to be performed. The nickname is a unique name for the system to differentiate it from existing systems that have the same system and sysplex name. The nickname is 1-40 characters long. Valid characters are alphanumeric characters (A-Z, a-z, and 0-9), hyphens (-), and special characters ($ \_ # @). Nicknames are case sensitive, for example SYSTEM1 and System1 are unique values. | Yes | +| Variable Input File | String | The name of an optional properties file that contains values for one or more of the variables that are defined in the workflow definition file. If the workflow variable input file resides in a data set member, specify the fully qualified data set name including the member name. Ensure that the specified data set is cataloged. If the workflow variable input file resides in a z/OS UNIX file, specify the fully qualified path name of the file beginning with the forward slash (/) and including the file name. See the zOSMF documetation, for the format of the variable input file. | No | +| Variables | String | A list of one or more variables for this workflow. The variables specified on this property has precedence over the variables that are specified in the workflow variable input file. Specify this property as an array of name-value objects. | No | +| Workflow Definition File | String | Location of the workflow definition file, which is the primary XML file for the workflow definition. If the workflow definition file resides in a data set member, specify the fully qualified data set name including the member name. Ensure that the data set is cataloged.If the workflow definition file resides in a z/OS UNIX file, specify the fully qualified path name of the file beginning with the forward slash (/) and including the file name. For example: /usr/lpp/zosmf/V2R1/samples/workflow\_sample\_automation.xml. | Yes | +| Workflow Name | String | A unique name for the workflow up to 100 characters. The name cannot contain the following symbols: less-than (<), greater-than (>), or ampersand (&). Each workflow name must be unique. | Yes | + +### Run Published Software Service Template + +Use this step to define the input properties for the Run Published Software Service template. + +| Name | Type | Description | Required | +|-------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| Account Info | String | The account information to use in the JCL JOB statement. The default is the account information that is associated with the resource pool for the tenant. | No | +| Domain Name | String | The domain name for the specified template. This property is required if the user has consumer authorization to more than one domain with the template name. | No | +| Input Variables | String | A list of variable each separated by a new line. Specify each variable in the following format: name=value. | No | +| Job Owner | String | The job owner user ID whose jobs are being queried; the default is the z/OS user ID. The value is folded to uppercase. The value cannot exceed eight characters. | No | +| Job Prefix | String | The prefix to add to the job name prefix. The default value is an asterick(\*). The value is folded to uppercase. The value cannot exceed eight characters. | No | +| Max Lines | String | The maximum number of records to display for each output data set. Specify 0 to display the full content. The default value is 1000. | No | +| Output DDName Filter | String | A list of one or more output ddname filters. Separate multiple filters with new lines. The asterick (\*) and question mark (?) wildcards are supported. | No | +| Print Job Log | Boolean | Indicates if information is written to the job log file. All jobs submitted during the workflow execution time are fetched including jobs which are not submitted by the workflow. To avoid showing jobs not submitted by the workflow, you may configure z/OSMF workflow to use a unique job name and then use the Job Filter to exclude other jobs. | No | +| Print REST log | Boolean | Indicates if REST call requests and responses are written to the log file. The default is no. | No | +| Systems Nicknames | String | Each string is the nickname of the system upon which to provision the software service defined by the template. The field is required if the resource pool associated with the tenant used for this operation is not set up to automatically select a system. Only one nickname is allowed. If the field is provided it is validated. | No | +| Template Name | String | The name of the software services template to run. | Yes | +| Tenant Name | String | The name of the tenant for the specified template. This property is required if the user has consumer authorization to more than one tenant in the same domain that contains the template name. | No | +| Timeout | String | The number of seconds to wait. The default value is 120. | No | +| User Data | String | User data that is passed into the software services registry. Can be specified only if user-data-id is provided. | No | +| User Data ID | String | The ID for the user data specified with user-data. Passed into the software services registry. | No | +| Wait For Provision | Boolean | Indicates to wait for the provision to complete. The default is to wait for the provision to complete. If this property is not enabled, the value on the Timeout property is ignored. | No | +| Write Job Log to Output | Boolean | If checked, the job log is stored to step output property. The Resource Role property name is zosmf.workflowJoblog. | No | + +### Software Services Instance Discovery + +Use this step to discover all the software instances. Also use to create resources for each software instance under a root resource, apply the correct role, and set the properties. + +| Name | Type | Description | Required | +|------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------|----------| +| Query Parameters | String | A list of one or more query variables. Check the z/OSMF List the software services instances REST API for a list of valid query parameters | No | +| Resource | String | The Resource to configure. | No | +| zOSMF URL | String | The URL to access the zOSMF REST API. | No | +| zOSMF User | String | The zOSMF user to use. | No | +| zOSMF User | String | The zOSMF password to use. | No | + +### Start Workflow + +Use this step to start a workflow. + +| Name | Type | Description | Required | +|---------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| Job Owner | String | The user ID of the job owner whose jobs are being queried. The default is the z/OS user ID. The value is folded to uppercase. The value cannot exceed eight characters. | No | +| Job Prefix | String | The value to add as a prefix to the job name. The defaults is and askrick(\*). The value is folded to uppercase. The value cannot exceed eight characters. | No | +| Max Lines | String | The maximum number of records to be displayed for each output data set. Specify 0 to display the full content. The default is 1000. | No | +| Notification URL | String | A notification URL containing up to 2000 characters. Depending on the requirements of your application, you might want to receive a notification when the automated step or steps reach an end state, such as completion or failure. For example, if the application includes a servlet that is to be given control on completion of the automated steps, you can optionally specify a notification URL to be posted when automation ends. See the zOSMF online document for more details. | No | +| Output DDName Filter | String | One or more output ddname filters. Separate multiple filters with new lines. Wildcard \* and ? are supported. | No | +| Perform Subsequent | Boolean | If the workflow contains any subsequent automated steps, this property indicates whether z/OSMF is to perform the steps. If you set this property to true z/OSMF attempts to perform the automated steps. If you set this property to false, z/OSMF attempts to perform the specified step only. The default is true. | No | +| Print Job Log | Boolean | Indicates to print the Job log file. All jobs submitted during the workflow execution time are fetched including jobs which are not submitted by the workflow. To avoid showing jobs not submitted by the workflow, you may configure z/OSMF workflow to use a unique job name and then use the Job Filter to exclude other jobs. | No | +| Print REST log | Boolean | Indicates to write REST call requests and responses to the log. The default is no. | No | +| Resolve Conflict By Using | String | Indicates how variable conflicts are to be handled when the Workflows task reads in the output file from a step that runs a REXX exec or UNIX shell script. The following values are valid for this parameter: outputFileValue, existingValue, and leaveConflict. Specify the outputFileValue value to allow the output file values to override the existing values. This setting applies to instance variables only. Global variables are not overridden by variables in the output file. The existingValue value indicate that existing variables values instead of the output file values. The leaveConflict value indicates that the automation is stopped and the user must resolve the conflict manually. The default value is outputFileValue. | No | +| Step Name | String | The name of the step at which automation is to begin. If this property is omitted, automation processing begins with the first step in the workflow. | No | +| Timeout | String | The timeout value in seconds for a wait. The default is 120 seconds.. | No | +| Wait For Workflow | Boolean | Indicates whether to wait for the workflow to complete. The amount of time to wait is specifiedin the Timeout property. If not on, the value on the Timeout property is ignored. | No | +| Workflow Key | String | The workflow key of the workflow to be started. | Yes | +| Write Job Log to Output | Boolean | Indicates if the job log file is stored based on the zosmf.workflowJoblog step output property. The default is no. | No | + +### zOSMF Cloud Provisioning Discovery + +Use this step to discover if the zOSMF service is available by checking the URL specified in zosmf.url agent property. If it is available, the zOSMFService role is assigned to the resource and the properties are set. + +| Name | Type | Description | Required | +|----------|--------|---------------------------------------|----------| +| zOSMFURL | String | The URL to access the zOSMF REST API. | No | +| sysUser | String | The user to use. | No | +| Resource | String | The resource to configure. | No | + +## Roles in the zOSMF plug-in + +The plug-in adds these roles automatically to resources. You cannot add these roles manually. + +- [zOSMFService](#zosmfservice-role) +- [zOSMFSoftwareInstance](#zosmfsoftwareinstance-role) + +### zOSMFService Role + +Role for resources that represent zOSMF Service. + +| Name | Type | Description | +|--------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| zOS Version | String | The z/OS operating system level. The Resource Role property name is zosmf.zos\_version. | +| zOSMF API Version | String | The version of the z/OSMF information retrieval service and the JSON object structure used for this request. The version sequence starts at 1, and is incremented if the service or the JSON structure changes. The Resource Role property name is zosmf.api\_version. | +| zOSMF Full Version | String | The z/OSMF version qualified by a service level. The Resource Role property name is zosmf.zosmf\_full\_version. | +| zOSMF Hostname | String | The hostname or the IP address of the z/OS system on which z/OSMF is installed. The Resource Role property name is zosmf.zosmf\_hostname. | +| zOSMF Password | Password | The zOSMF password associate with the specified user. | +| zOSMF Port | String | The port number for SSL encrypted traffic for the active instance of z/OSMF on the z/OS system. The Resource Role property name is zosmf.zosmf\_port. | +| zOSMF Query | String | A list of one or more query variables. Check the z/OSMF List the software services instances REST API for a list of valid query parameters. The Resource Role property name is zosmf.query. | +| zOSMF SAF Realm | String | The realm associated with the system on which z/OSMF is installed. Usually, this is the sysplex name. The Resource Role property name is zosmf.zosmf\_saf\_realm. | +| zOSMF URL | String | The URL to access the zOSMF REST API. The Resource Role property name is zosmf.url. | +| zOSMF User | String | The zOSMF user to use. The Resource Role property name is zosmf.user. | +| zOSMF Version | String | The z/OSMF level. The Resource Role property name is zosmf.zosmf\_version. | + +### zOSMFSoftwareInstance Role + +Role for resources that represent a software instance. + +| Name | Type | Description | +|-------------------|--------|-------------------------------------------------------------------------------------------------------------------------------| +| Created By | String | The user ID that created the object. | +| Created On | String | The time the object was created. The time is in the ISO8601 format. The Resource Role property name is instance.created-time. | +| Domain Name | String | The name of the domain. The Resource Role property name is instance.domain-name. | +| External Name | String | The external name of the software services instance. The Resource Role property name is instance.external-name. | +| Last Action Name | String | The name of the last action that was performed. The Resource Role property name is instance.last-action-name. | +| Last Action State | String | The state of the last action that was performed. The Resource Role property name is instance.last-action-state. | +| Object ID | String | The object ID for the software services instance. The Resource Role property name is instance.object-id. | +| Object Name | String | The object name for the software services instance. The Resource Role property name is instance.object-name. | +| State | String | The current state of the software. The Resource Role property name is instance.state. | +| Tenant Name | String | The name of the tenant. The Resource Role property name is instance.tenant-name. | +| Type | String | The type of software instance. | + +| Back to ... || Latest Version | z/OS Management Facility |||| +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------:| :---: | :---: | :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [15.1153789](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/ucd-zosmf-15.1153789.zip) |[Readme](README.md)|[Overview](overview.md)|[Usage](usage.md)|[Downloads](downloads.md)| diff --git a/docs/zosmf/usage.md b/docs/zosmf/usage.md new file mode 100644 index 0000000..f2fef85 --- /dev/null +++ b/docs/zosmf/usage.md @@ -0,0 +1,104 @@ + +# z/OS Management Facility - Usage + +## The following pages provide usage information about this plug-in + +[Discovering Mainframe Software Services Instances](#discovering-mainframe-software-services-instances) +[Provisioning and Discovering Mainframe Software Services Instances](#provisioning-and-discovering-mainframe-software-services-instances) + +## Discovering Mainframe Software Services Instances + +* [Before you begin](#before-you-begin-discovering-mainframe-software-services-instances) +* [Discovering Software Services Instances](#discovering-mainframe-software-services-instances) +* [Software Services Instances Resources](#software-services-instances-resources) + +### Before you begin discovering Mainframe Software Services Instances + +* Install the current version of the z/OS Management Facility plug-in. +* Install an UrbanCode Deploy agent on theLPAR where z/OSMF is running. +* Verify that the Cloud Provisioning function in z/OSMF is installed and software services instances have already been provisioned. + +### Discovering Software Services Instances + +On theIBM UrbanCode Deployserver user interface, click**Resources** > **Agents**. Open the z/OS agent to be used to run discovery. Add an agent property named **zosmf.url** and set the value to the URL of z/OSMF. For example: `https://localhost/zosmf` . + +[![](media/agent-property.jpg)](media/agent-property.jpg) + +Create a top-level resource group and add the agent as an agent resource under the top-level resource group. Wait for a few seconds and refresh the Resource Tree.Eventually, another resource is displayed under the agent resource. This resource is named zOSMFService. + +[![](media/zosmf-discover-step-1.jpg)](media/zosmf-discover-step-1.jpg) + +Open zOSMFService resource and click **Configuration**>**Basic Settings**. The resource has the zOSMFServicerole, which includes several properties that are related to z/OSMF. In the**Role Propertiestable**, specify the user ID and password to be used to run discovery and click **Save**. + +**Note:** The ID is an MVS user ID with proper permissions setup. To ensure the user ID is working properly, use it to log into the z/OSMF web interface and list the software services instances. + +[![](zosmf-specify-userid-password.jpg)](media/zosmf-specify-userid-password.jpg) + +Go back to the Resource Tree view, click the**Actions**button that is associated with the zOSMFServiceresource, and then click**Configure using Software Services Instance Discovery**. The discovery step runs. A log displays to show progress.When the discovery process completes, close the log window, and refresh the resource tree.Resources that represent the software services instancesare displayed in the resource tree. Thenew resources are organized in structure `plex\system\software type\instance name`. + +[![](media/zosmf-discover-step-2.jpg)](media/zosmf-discover-step-2.jpg) + +### Software Services Instances Resources + +You may add components to the resources and add these resources to an environment to start application deployment. The resource properties contain information of the instance which can be used in a deploy process. The properties are retrieved from the z/OSMF software services instance variables. + +[![](media/zosmf-instance-properties.jpg)](media/zosmf-instance-properties.jpg) + +**Tips:** Sometimes the name of the property is not what is expected by the deploy process. You can define the expected property name in the top-level folder and have it reference the value of an instanceproperty. See following graphic for an example. + +[![](media/zosmf-property-reference.jpg)](media/zosmf-property-reference.jpg) + +## Provisioning and Discovering Mainframe Software Services Instances + +Software services instances discovery can be run manually from the resource tree and automatically in an UrbanCode Deployprocess. This document describes a use case where a software instance is provisioned and discovered in a singleautomated UrbanCode Deploy process. + +* [Before you begin](#before-you-begin) +* [Create a generic process](#create-a-generic-process) +* [Run the process](#run-the-process) +* [Next steps](#next-step) + +### Before you begin + +* Install the current z/OS Management Facility plug-in. +* Install an UrbanCode Deploy agent on theLPAR where z/OSMF is running. +* Verify that the Cloud Provisioning function in z/OSMF is installed anda Published Software Service template is ready to run + +### Create a generic process + +Create a generic process using two steps. + +[![](media/zosmf-provision-and-discover-process.jpg)](media/zosmf-provision-and-discover-process.jpg) + +The first step is a **Run Published Software Service Template** step. The following example runs the CICS53 template to provision a new CICS region. The template is available from [z/OS Provisioning Toolkit](https://developer.ibm.com/mainframe/products/zospt/) + +[![](media/zosmf-run-published-software-service-template.jpg)](media/zosmf-run-published-software-service-template.jpg) + +The second step is a**Software Services Instance Discovery** step. The **Query Parameters** fieldis set to **object-name = ``${p:provision/zosmf.instanceName}``** so that it will only discover the instance provisioned by the previous step. **``${p:provision/zosmf.instanceName}``** is a reference to the provisioned instance name from the previous step. + +[![](media/zosmf-discover-with-parameter.jpg)](media/zosmf-discover-with-parameter.jpg) + +### Run the process + +Create a top-level resource group. Add following properties to the group and set the appropriate values for connecting to z/OSMF. + +* zosmf.password +* zosmf.url +* zosmf.user + +Add the z/OS agent tobe used to the group and run the process on the agent resource. + +[![](media/zosmf-provision-before.jpg)](media/zosmf-provision-before.jpg) + +After the process completes, refresh the resource tree.Resources that represent the provisioned CICS region are displayed in the resource tree. + +[![](media/zosmf-provision-and-discover-result.jpg)](media/zosmf-provision-and-discover-result.jpg) + +### Next step + +You can now provision a software services instanceand have the resources automatically created in UrbanCode Deploy to represent the subsystem. You can use the resource or you can further enhance theautomation. For example you can map a component to the resource, createenvironment and start initial deployments. + +**Note:**If you prefer to usez/OSPTto provision software, you can replace the **Run Published Software Service Template** step with a **Shell** step and input the corresponding z/OSPT commands. You will need to parse the z/OSPT output to find the name of the instance. + +| Back to ... || Latest Version | z/OS Management Facility |||| +|:-----------------------------:|:------------------------------:|:-------------------------------------------------------------------------------------------------------------------:| :---: | :---: | :---: | :---: | +| [All Plugins](../../index.md) | [Deploy Plugins](../README.md) | [15.1153789](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zosmf/ucd-zosmf-15.1153789.zip) |[Readme](README.md)|[Overview](overview.md)|[Steps](steps.md)|[Downloads](downloads.md)| diff --git a/mkdocs.yml b/mkdocs.yml index bad1c17..357175e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,13 +1,15 @@ -site_name: z/OS Utility plugin +site_name: IBM DevOps Deploy Plugins theme: name: material language: en font: false + favicon: assets/images/deploy.png + logo: assets/images/deploy.png features: - navigation.top - navigation.tabs - - navigation.tabs.sticky + - navigation.sections - toc.integrate palette: - media: "(prefers-color-scheme: light)" @@ -15,7 +17,7 @@ theme: toggle: icon: material/brightness-7 name: Switch to dark mode - primary: white + primary: blue accent: blue - media: "(prefers-color-scheme: dark)" @@ -23,7 +25,7 @@ theme: toggle: icon: material/brightness-4 name: Switch to light mode - primary: black + primary: indigo accent: blue markdown_extensions: - admonition \ No newline at end of file