Skip to content

Commit 4bc8901

Browse files
Amiya-873Amiya-873
authored
Initial commit
0 parents  commit 4bc8901

10 files changed

+168
-0
lines changed

‎.github/workflows/gh-pages-deploy.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Create static site from markdown files using MkDocs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
deploy:
13+
uses: UrbanCode/reusable-workflows/.github/workflows/mkdocs-deploy.yml@main

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
venv

‎.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "plugin-doc-common-config"]
2+
path = plugin-doc-common-config
3+
url = [email protected]:UrbanCode/plugin-doc-common-config.git

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This repository contains documentation for z/OS Rexx Executor plugin for Devops deploy.

‎docs/downloads.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Downloads
2+
3+
---
4+
5+
- [ucd-plugins-zos-rexx-2.1168947.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1168947.zip)
6+
- [ucd-plugins-zos-rexx-2.1168604.zip](https://raw.githubusercontent.com/UrbanCode/IBM-UCD-PLUGINS/main/files/zos-rexx/ucd-plugins-zos-rexx-2.1168604.zip)
7+
- [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)
8+
- [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)
9+
- [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)
10+
- [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)
11+
- [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)
12+
- [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)
13+
- [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)
14+
- [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)
15+
- [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)
16+

‎docs/index.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Overview
2+
3+
---
4+
5+
The zOS Rexx Executor can run REXX statements provided in a dataset or in the plugin step.
6+
7+
Apart from executing a REXX program, this plug-in provides ability to create output properties.
8+
9+
## Compatibility
10+
11+
The plug-in is compatible with:
12+
13+
* UrbanCode Deploy version 7.0.0 or later
14+
* UrbanCode Deploy agents on z/OS
15+
* IBM z/OS version 2.1 or later
16+
* IBM Java 8 or 11
17+
18+
## Available Steps
19+
20+
* Execute a REXX program
21+
22+
## Installation
23+
24+
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).
25+
26+
## History
27+
28+
### Version 2
29+
30+
* Added new checkbox input to show debug logs in case of any unknown failure.
31+
* Output will now show the elapsed time of the REXX program
32+
* New output property RexxReturnCode will store the return code of the REXX program
33+
* Fixes output buffer issue when output has too much data
34+
* Arguments can now be as big as 248 characters
35+
* Fixed issue with work directory during two or more parallel step execution
36+
* Minor improvements in temporary directory creation
37+
* Fixed handling of CLIST error message response from ISPF Gateway
38+
* Changes to run process in Legacy ISPF Gateway
39+
* Improvements in ISPF gateway error handling
40+
* Fixed PH62152 - RcException while allocating temporary datasets
41+
42+
### Version 1
43+
44+
* Initial release

‎docs/steps.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Steps
2+
3+
---
4+
5+
## Process steps in the z/OS Rexx Executor plug-in
6+
7+
### Execute a REXX program
8+
9+
Use this step to execute rexx program
10+
11+
| Name | Type | Description | Required |
12+
|------------------|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
13+
| Source Type | Enumeration: INLINE / DATASET | Source of REXX program | Yes |
14+
| 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 |
15+
| Arguments | String | Specify the arguments(without quotes) to the REXX program | No |
16+
| SYSPROC Datasets | String | Specify fully qualified SYSPROC datasets that the INPUT REXX program may use | No |
17+

‎docs/usage.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Usage
2+
3+
---
4+
5+
The z/OS Rexx Executor plug-in will execute statements provided in a dataset or inline in the plugin step.
6+
7+
Select **Source type** as **DATASET** from the drop-down and
8+
enter the dataset in the **Source Value**.
9+
Fully qualified dataset needs to be enclosed in single quotes.
10+
When the quotes are omitted then, the TSO prefix of the id running the
11+
plugin step is prefixed to the Source Dataset.
12+
13+
(or)
14+
15+
Select **Source type** as **INLINE** from the drop-down and
16+
then in the **Source Value** enter REXX statements beginning with a **/\* REXX \*/** statement.
17+
18+
Arguments can be passed to the REXX program with/without quotes.
19+
However, if there are more than one argument then arguments must be separated by a space.
20+
21+
The **SYSPROC** field allows user to pass datasets containing REXX programs
22+
that will be used by the REXX program run by the plugin step.
23+
Multiple **SYSPROC** datasets can be passed by separating datasets by a comma(,).
24+
25+
### Setting output property
26+
27+
This plugin allows user to set output properties from the REXX program and
28+
later to be used in successive steps of a process.
29+
A user REXX program can simply invoke a call to **SETPROP** with two arguments.
30+
31+
The first argument is output property name and
32+
the second argument is the property value.
33+
34+
> CALL SETPROP propertyName propertyValue
35+
36+
For example, below REXX snippet will set an output property **currentDate** with value of **date** variable
37+
38+
***
39+
/* REXX */
40+
date = DATE('S') /* Returns date in YYYYMMDD format E.g., 20120327 */
41+
CALL SETPROP "currentDate" date
42+
43+
### Setting multi-line output property
44+
45+
To set a multi-line output property, the lines of the property value must be separated
46+
by a delimiter returned by inbuilt program **GETDLMTR**
47+
48+
***
49+
/* REXX */
50+
delimiter = GETDLMTR() /* Return delimiter to separate lines */
51+
lines = "This is first line" || delimiter || "This is second line"
52+
CALL SETPROP "outputLines" lines
53+
54+
Will set property **outputLines** to below value
55+
56+
***
57+
This is first line
58+
This is second line
59+
60+
### Referring properties from successive steps
61+
62+
If the rexx step name is **Run-Rexx-Program** and output property name is **currentDate**
63+
then the output properties can be referred by the successive steps as below
64+
65+
> ${p:Run-Rexx-Program/currentDate}
66+
67+
**Note**
68+
69+
From plugin version 2, an output property __RexxReturnCode__ will store the return/exit code from REXX program.
70+

‎mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
site_name: "z/OS Rexx Executor"
2+
INHERIT: plugin-doc-common-config/base.yml

‎plugin-doc-common-config

0 commit comments

Comments
 (0)