Running zCX Workflows

zCX uses z/OSMF workflows provision, deprovision, and otherwise manage zCX instances. The available workflows are:
  • Provisioning Workflow
  • Backup Configuration Workflow
  • Reconfiguration Workflow
  • Restore Configuration Workflow
  • Add Data Disks Workflow
  • Upgrade Workflow
  • Rollback Workflow
  • Deprovisioning Workflow
Diagram of zCX instance lifecycle management using workflows

Workflow variable input properties files

The workflow variables input properties file contains all the variables and corresponding values required to provision an IBM zCX instance. A sample input properties file of workflow variables is provided under ‘Properties Directory’ inside the installation directory.

A z/OS system administrator can copy the sample file in to a read/write directory and modify it with system-specific inputs. The system administrator should consult the z/OS storage administrator, z/OS security administrator, and the z/OS network administrator to provide the proper values.

The workflow variables input properties file is optional, as all the inputs can be added in the z/OSMF provisioning workflow directly. If the variables are manually added to the workflow, they can be saved to a specified directory as a workflow variables input properties file for subsequent use. Descriptions of the variables can be found in this document or by clicking the tool tips icons in z/OSMF.

How to use a zCX workflow

Once logged into z/OSMF, use the following instructions to create and begin any of the workflows. Specific information on each workflow can be found in the respective section of this chapter.
  1. Click Workflows in the left navigation panel.
  2. Click Actions, then Create Workflows.
  3. In the Create Workflows window, provide the path of the workflow you wish to run (the default locations of each workflow are in their respective sections of this chapter).
  4. Provide the path to the workflow variables input properties file, or manually input the values.
  5. Select the system that will provision the zCX instance.
  6. Click Next.
  7. Click Assign all steps to owner user ID at the bottom of the Create Workflow window to give the owner the authority to execute them.
  8. Click Finish.The workflow task UI panel will open, and all the steps will be listed in the panel. Start with step 1 then continue through sequentially. To begin, click a step, then click Actions and select Perform. After step 1, all following steps can be automated by selecting the option to Automatically perform the selected step, and all subsequent automated steps, according to their declared step dependencies, until one of the following occurs:
    • all workflow steps have been completed
    • a non-automated, non-Complete step, is reached, or
    • an error occurs.

Modify the JOB card

When using a zCX workflow, ensure that the SYSOUT class used by your jobs does not purge the job output before z/OSMF can retrieve it. Should this happen, z/OSMF will report that the step failed. Rerunning the step can lead to unpredictable results in that step of the workflow, or in a subsequent step. You can tailor the default JOB card from the Workflows menu by performing the following steps:
  1. Select Actions, then Customize JOB Statement.
  2. Highlight Modify the default JOB statement and select OK.
  3. Ensure that the MSGCLASS specified uses a SYSOUT class that is not quickly purged. Consult the JES system programmer to determine the proper SYSOUT class.
  4. Select OK to save the JOB card.