Create a workflow instance in z/OSMF using a USS file
Usage
zowe zos-workflows create workflow-from-uss-file <workflowName> [options]
Positional Arguments
workflowName
(string)
- Name of the workflow instance to create
Required Options
Options
--variables-input-file
| --vif
(string)
- Specifies an optional properties file that you can use to pre-specify values
for one or more of the variables that are defined in the workflow definition
file.
--variables
| --vs
(string)
- Includes a list of variables for the workflow. The variables that you specify
here take precedence over the variables that are specified in the workflow
variable input file.
--assign-to-owner
| --ato
(boolean)
- Indicates whether the workflow steps are assigned to the workflow owner.
--access-type
| --at
(string)
Specifies the access type for the workflow. Public, Restricted or Private.
Allowed values: Public, Restricted, Private
--delete-completed
| --dc
(boolean)
- Whether the successfully completed jobs to be deleted from the JES spool.
--overwrite
| --ov
(boolean)
- Replaces an existing workflow with a new workflow.
Zosmf Connection Options
--host
| -H
(string)
- The z/OSMF server host name.
--port
| -P
(number)
The z/OSMF server port.
Default value: 443
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
--reject-unauthorized
| --ru
(boolean)
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
Profile Options
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
--response-format-type
| --rft
(string)
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
Create a workflow with name "testworkflow" using uss file
"/path/workflow.xml" containing workflow definition, on system "TESTM1" with
owner "OTHERID" and delete workflow with the same name if it already exist in
z/OSMF:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "OTHERID" --overwrite
Create a workflow with name "testworkflow" using uss file
"/path/workflow.xml" containing workflow definition, on system "TESTM1" with
owner "MYSYSID" and delete successfully completed jobs:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "MYSYSID" --delete-completed
Create a workflow with name "testworkflow" using uss file
"/path/workflow.xml" containing workflow definition, on system "TESTM1" with
owner "MYSYSID" and with variable values in the member PROPERTIES of data set
TESTID.DATA:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "MYSYSID" --variables-input-file TESTID.DATA(PROPERTIES)
Create a workflow with name "testworkflow" using uss file
"/path/workflow.xml" containing workflow definition, on system "TESTM1" with
owner "MYSYSID" and with variable DUMMYVAR value DUMMYVAL and assign it to the
owner:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --variables DUMMYVAR=DUMMYVAL --owner "MYSYSID" --assign-to-owner