Creating a workflow

To create a workflow, use the Create Workflow action that is provided in the Workflows table.

1. From the Actions menu, select Create Workflow. The Create Workflow dialog is displayed.
   1. In the Location (system) field, select the system on which the workflow definition file and any related files reside. The Workflows task obtains the workflow files from this system.
      This field is a pull-down list of the z/OS systems that run z/OSMF. The list can include systems from the local sysplex and from remote sysplexes. If the pull-down list includes remote systems, the word -Local is appended to the name of the local system on which z/OSMF is running. Otherwise, if the list contains no remote systems, the word -Local is omitted from the name of the local system.

      For the local sysplex, only the currently logged-in system is included in the list. For a remote sysplex, all host systems that are defined to the Systems table are included in the list. You can view the Systems table in the Systems task.

      You cannot type over the system names. This field defaults to the local z/OS system on which z/OSMF is running.

   2. Select a workflow definition file from the list, or type the name of a workflow definition file that resides on the z/OS system on which z/OSMF is running.
      Observe the following considerations:

      • If the workflow definition file resides in a data set member, enter or select the fully qualified data set name, including the member name. Ensure that this data set is cataloged. It is not necessary to enclose the data set name in single quotation marks; z/OSMF ignores the quotation marks if you include them.
      • If the workflow definition file resides in a z/OS UNIX file, enter or select the fully qualified path name of the file, beginning with the forward slash (/) and including the file name. For example: /usr/lpp/zosmf/samples/workflow_sample_basic.xml.
      If the workflow definition file resides on the local system, you can locate it with a type-ahead search. Begin by clicking the search icon for the input-box. In the path selector window, enter a pattern that is a partial or complete name of a data set, member, or a UNIX file path. To search for a UNIX file, you must enter the path name, beginning with the forward slash (/). Otherwise, the tool attempts to find a matching data set name.

      When you select an object from the type-ahead list, the object populates the workflow definition file input-box.

      The type-ahead list displays a maximum of 100 objects. If more than 100 objects match the pattern, a record at the end of the list indicates that some records are not displayed. To display all objects in the results area, click Display All.

      A step element contains a stepSignature element, which is not supported in a definition file from the remote system.

   3. If a workflow variable input file is available for the workflow, select the workflow variable input file from the list, or type the name of the file as it resides on the z/OSMF host system. If no workflow variable input file is available, leave this field blank.
      Observe the following considerations:

      • Usually, a workflow variable input file is provided by the workflow provider, or is produced as output from another step in the workflow, or from another workflow. To obtain the name of the workflow variable input file, refer to the workflow documentation or contact the workflow provider.
      • If the workflow variable input file resides in a data set member, enter or select the fully qualified data set name, including the member name. Ensure that this data set is cataloged.
      • If the workflow variable input file resides in a z/OS UNIX file, enter or select the fully qualified file path, beginning with the forward slash (/) and including the file name. For example: /usr/lpp/zosmf/samples/workflow_sample_automation_property.txt.
      If the workflow variable input file resides on the local system, you can locate it with a type-ahead search. Begin by clicking the search icon for the input-box. In the path selector window, enter a pattern that is a partial or complete name of a data set, member, or a UNIX file path. To search for a UNIX file, you must enter the path name, beginning with the forward slash (/). Otherwise, the tool attempts to find a matching data set name.

      When you select an object from the type-ahead list, the object populates the workflow variable input file input-box.

      The type-ahead list displays a maximum of 100 objects. If more than 100 objects match the pattern, a record at the end of the list indicates that some records are not displayed. To display all objects in the results area, click Display All.

   4. To continue, click Next.

      If you selected a system in a remote sysplex, z/OSMF checks your access to the remote system. If the remote system is not enabled for single sign-on (SSO), the Remote Server Authentication window is displayed for you to authenticate to the remote system. If so, enter a valid user ID and password or passphrase for the remote system. You can avoid the authentication window by ensuring that the remote system is enabled for single sign-on (SSO) in the z/OSMF Systems task. For more information, see Defining your systems to z/OSMF.

      If z/OSMF detects a conflict in the inputs variables file, a dialog is shown to prompt for a user selection. For more information, see Resolving a conflict in variable definitions.

   5. Complete the following steps:
      1. In the Workflow name field, enter a descriptive name for the workflow. If the workflow definition specifies a default name for the workflow, it is shown here. Otherwise, the Workflows task initializes this field to a predetermined name for the workflow, based on the following convention:

         <workflow-description>–Workflow_<number>

         Where:
         • workflow-description is the description from the workflow definition file.
         • number is the first available number, beginning at 0. If you later delete this workflow, its number can be reused by the Workflows task.
         You can accept this name, or enter a name of your own choosing. The workflow name:

         • Must be unique in the Workflows task.
         • Can contain up to 100 alphanumeric characters (A-Z, a-z, 0-9, #, $, and @).
         • Must not contain the characters for ampersand ('&'), forward slash ('/'), greater than ('>'), or less than ('<').

         The workflow name is not case-sensitive; for example: MyWorkflow and MYWORKFLOW are the same workflow.

      2. In the Owner user ID field, specify the user ID of the person who holds the overall responsibility for completing the workflow. Select a user ID from the list, which contains up to 10 previously specified user IDs. Otherwise, type the user ID as it is defined to your z/OS security management product, such as RACF. A valid user ID consists of 1 to 8 alphanumeric characters (A-Z, a-z, 0-9, #, $, and @).

         This field defaults to your user ID.

      3. In the Archive SAF ID field, you can specify the SAF ID who will own the archived workflow after a workflow is archived to a user specified directory. Select a SAF ID from the list, otherwise, type the SAF ID in the field. A valid ID consists of 1 to 8 alphanumeric characters (A-Z, a-z, 0-9, #, $, and @). The specified SAF ID can be the workflow owner user ID or the group ID with which the workflow owner user ID belongs to.

         This field defaults to the workflow owner user ID.

      4. In the System (where z/OSMF steps will be performed) field, select a target system for creating the workflow. The workflow steps are performed on this system. Any jobs or scripts in the workflow are run on this system. Similarly, any work that you perform manually for the workflow is done on this system.

         This field is a pull-down list of systems that are defined in the z/OSMF Systems task. The list can include systems in the local sysplex and remote sysplexes.

         If you select a system in a remote sysplex:

         • If the system is running z/OSMF, verify that the system is enabled for single sign-on (SSO). Otherwise, the Remote Server Authentication window is displayed for you to authenticate to the remote system when you perform the steps. You can avoid the authentication window by ensuring that the remote system is enabled for single sign-on (SSO) in the z/OSMF Systems task. For more information, see Defining your systems to z/OSMF.
         • If the system is not running z/OSMF, it must be associated with the z/OSMF system for that sysplex. If so, set the z/OSMF system as the host system for the system on which the workflow is to be performed. Similarly, you must ensure that the z/OSMF system in the remote sysplex is enabled for single sign-on. Or, you must be ready to authenticate to the system with a valid user ID and password or passphrase.

         For more information about defining z/OSMF systems and enabling them for single sign-on, see Defining your systems to z/OSMF.

         You cannot type over the system names. The field defaults to the z/OS system on which z/OSMF is running.

      5. In the Comments field, you can enter any information that you want to associate with this action (up to 500 characters). Your comment is added to the existing comments in the workflow history.
      6. Optionally, specify an Access type for the workflow. For more information about access type, see Workflow access type.
      7. If the Save jobs output option is enabled, the workflow automatically saves any job output files that it creates to a user-specified location (a UNIX directory on your system). Use this option if you want to retain the output files, perhaps as a record of the work that is done by the workflow. If this field is preset to a location, you can overwrite the value with a different location, as needed. The specified location must be a valid UNIX file path and directory, beginning with a single forward slash ('/'). For example: /u/IBMUSER/jobFiles.
         Ensure that:

         • File path and directory exist on the system on which the workflow steps are to be performed.
         • Workflow owner user ID has write access to the directory.
         • For the steps that create job output, ensure that the step owner user IDs have write access to the UNIX directory. Otherwise, the steps cannot be performed.

         If the Save jobs output option is not enabled, the workflow does not save its job output files.

      8. Select Open workflow on finish if you want to go to the Steps page for the workflow on completion of create workflow action. Otherwise, clear this option. By default, this option is selected.
      9. Select Assign all steps to owner user ID if you want all of the steps to be assigned to and accepted by you, the workflow owner, on creation of the workflow. Otherwise, leave this checkbox cleared (the default).
      10. Select Delete workflow on completion if you want the workflow to be automatically deleted from the Workflows task when all of its steps are marked complete or skipped. When a workflow is deleted, it no longer appears in the Workflows table. You might use this option to avoid reaching the limit of 200 workflows per system.

          If you want to retain the workflow after it is complete, leave this checkbox cleared (the default). The workflow is retained until you explicitly delete it from the Workflow table.

          Note: A called workflow cannot be deleted until all of its calling workflows are either deleted or archived.
      For your reference, this window includes the following details about the workflow to be created, which z/OSMF obtains from the workflow definition file:

      Description

      Description of the function that the workflow provides.

      Vendor

      Name of the vendor that provided the workflow definition.

      Version

      Version of the workflow definition.

      Is Callable

      Indicates whether the workflow can be called by another workflow, and, if so, the callable range for the workflow. One of the following values is displayed:

      In the same system

      When called by another workflow, one instance of this workflow is used in the local system. If an existing instance of the called workflow is not already active, the Workflows task creates a new instance of the called workflow for the system.

      In the same sysplex

      When called by another workflow, one instance of this workflow is used in the sysplex. If an existing instance of the called workflow is not already active, the Workflows task creates a new instance of the called workflow for the sysplex.

      Cannot be called by another workflow

      This workflow cannot be called by another workflow.

2. Click Finish to create the workflow.