GitHubContribute in GitHub: Open doc issue|Edit online

Getting started with z/OSMF workflows

IBM z/OSMF provides system management functions in a task-oriented, web-browser-based user interface with integrated user assistance so that you can more easily manage the day-to-day operations and administration of your mainframe z/OS systems.

How to get the workflows to your system

There are many ways of getting the workflows from the repository to your system. If you are using Git on z/OS, you can clone the repository.

Follow the following steps that you can use, if you don't have other tools available. Replace the ${variables} to match your environment.

  1. Get the code from the repository. If you don't have Git, you can download the uko-workflows.pax file by clicking the Download raw file button. Save it to your ${local-workflow-folder}.
  2. The following steps use ssh to create the ${remote-workflow-folder}, upload the pax file to it and then unpax it.
cd ${local-workflow-folder}
ssh ${user}@${remote-server}
mkdir -p ${remote-workflow-folder}
cd ${remote-workflow-folder}
put -r uko-workflows.pax
pax -rvEf uko-workflows.pax

Your files are now ready to be used.

Adjust the workflow properties

The UKO workflows use properties files to populate workflow variables. Therefore, you need to adjust the values in one of the
sample properties files before you run the workflow.

UKO provides the following workflows:

  • uko_install.properties for a complete installation
  • uko_migration.properties for migration only (contains a subset of uko_install.properties)

For more details about the individual workflow files, refer to the Installation chapter.

Create the workflow in z/OSMF

If you are unfamiliar with workflows, you might want to watch this z/OSMF Workflow introduction tutorial

After you are ready and have all properties in place, perform the following steps:

  1. Log on to z/OSMF
  2. Open the Workflows task (not the Workflows Editor). You can find it. For example, by opening the App Center in the bottom left corner of your z/OSMF desktop.
  3. Click the Actions button and select Create Workflow... from the menu.
  4. Specify your Workflow definition file and your Workflow variable input file (properties file) and click Next.
  5. Optionally, adjust the Workflow name and add comments.
  6. If you are going to perform at least some of the workflow steps yourself, you can select the option that is called Assign all steps to owner user ID
  7. Click Finish to create the workflow.

Assign and execute workflow steps

To be able to execute a workflow step, a user must be the owner and one of the assignees of the step.

If you have selected the Assign all steps to owner user ID option, all steps will have been assigned to you. The steps that can be executed will be in state Ready and you can execute them.

If you want to assign steps to other users, or to yourself if you have not selected the Assign all steps to owner user ID option, perform the following steps:

  1. Select the steps that you want to assign.
  2. Click the Actions button and select Assignment And Ownership > Add Assignees... from the context menu.
  3. Add the user ID to be assigned or a group that this user is part of to the Assignees to be added list and click OK.
  4. The user can either select the assigned steps manually or click the Actions button and select Select All Steps Assigned To Me from the context menu.
  5. To accept the assignment, the user needs to click the Actions button and select Accept from the context menu.
  6. If the user is not the owner of the step, they need to select the assigned steps again, click the Actions button and select Assignment And Ownership > Take Ownership... from the context menu.

Now, the step can be executed by clicking the step name and selecting the Perform tab.

For more details about assignment and ownership, refer to the z/OSMF documentation.

Current available workflows

UKO workflows

For the installation of UKO the following workflows must be executed in this recommended order by using a customized uko_install.properties file:

  1. Creation of the required user IDs and groups.
  2. Creation of the required certificates, keyrings, and CA
  3. Creation of the database
  4. Liberty angel process is required before a liberty server can be started.
  5. Configuration of the Liberty server
  6. Agent setup if keys are supposed to be installed on z/OS

For the migration of UKO the following workflows should be executed in this recommended order by using a customized uko_migration.properties file:

  1. UKO database migration
  2. UKO server migration

In addition, the following workflows are available:

CC workflows

  1. ccusers for creating the required user IDs and groups.
  2. cckeyring for creating server related certificates, keyrings and CAs, and optionally client certificates
  3. Liberty angel process is required before a liberty server can be started (not required for CC ACSP)
  4. ccserver workflow provisioning workflow to provision a Liberty server that can be used for CAT, MSDKE, Crypto Connect (not CC ACSP)
  5. provisionAcsp workflow to provision a CC ACSP server

The cc_liberty_install.properties or cc_acsp_install.properties file should be used to define all required workflow variables. The workflows are described in more details as part of the individual installation chapters.