Creating the workflow definition file

This topic describes the elements that comprise the workflow definition file.

A workflow is defined through a workflow definition file, which consists of one or more XML files and other types of files. Depending on the workflow design, a workflow might consist of just a single workflow definition file, or it might have a primary XML file that references one or more subordinate XML files, XML fragments, and external files. This document uses the term workflow definition file to refer collectively to all of the files that define a given workflow.

As a workflow author, you can create a workflow definition file in XML, in accordance with the schema that is supplied with the Workflows task of z/OSMF. The schema defines the required and optional properties (XML elements and attributes) of a workflow and imposes constraints on the order in which the elements are specified, and on the values that can be specified for each element and attribute.

It is assumed that workflow authors are familiar with the XML specification and coding practices. The following references provide additional helpful information:

Besides XML files, a workflow definition might include external files. That is, apart from XML fragments, the workflow definition can refer to translated text files and velocity template files. These files must be read-accessible by the user creating (importing) the workflow.

You can provide the workflow definition file and any associated files in either a z/OS UNIX file or a z/OS data set. For a z/OS data set, use a sequential data set or a member of a partitioned data set (PDS).

Start of change

Workflow Editor task in z/OSMF

To help you with creating and editing a workflow definition, z/OSMF includes an editor for workflows. You can use the Workflow Editor task to view, create, and modify workflow definitions. The Workflow Editor provides a visual framework for working with the elements of a workflow definition—the steps, variables, and workflow metadata.

The Workflow Editor task:
  • Presents the details of a workflow definition in a graphical user interface (GUI).
  • Provides easy-to-use options for viewing, creating, and modifying a workflow definition.
Using the Workflow Editor task, you can:
  • Select an existing workflow definition file for editing
  • View details about the different sections of a workflow definition
  • Modify the workflow information, steps, and variables sections of the definition, including adding and deleting steps and variable definitions
  • Overwrite the workflow definition with your changes.

To get started with the Workflow Editor task, in the navigation area, select Workflow Editor. More information about the Workflow Editor is provided in the online help.

End of change