Using the canvas to define a flow

Edit online

Configure a flow in IBM® Optim Archive for z/OS® by using the flow builder canvas to define the sequential set of nodes (connection, access definition, subset, mask, and target) that make up the end-to-end process of preparing and provisioning data.

Configuring an IBM Optim Archive for z/OS flow involves selecting the data to be extracted, applying optional transformations, and defining how and where the data will be exported.

Important: You cannot use the IBM Optim UI to work with VSAM data sources and targets. You must use the API to work with VSAM data. For information about using the API, see Using the IBM Optim Archive for z/OS REST API.
Who can complete this task?

Administrators or users can create flows. Standard users can only see and work with the flows that they created. Administrators can see and work with all flows in the system, regardless of who created them.

Building a flow

To build a new IBM Optim Archive for z/OS flow, or edit an existing one:

  1. From the navigation menu, click Workflow icon Workflow > Flow builder.
    • Click My flows to view saved flows.
      or
    • Click Nodes to view existing nodes such as connections, archives, access definitions, subsets, masking policies, or targets.
  2. Selected a saved flow from the My flows list, or click New flow to start a new flow.
  3. Drag and drop existing nodes from the Nodes list onto the canvas, or create new nodes as required.
    Nodes must be added to the flow builder canvas in the following order:
    1. Connection

    The source database connection from which IBM Optim Archive for z/OS will extract the data.

    For information about defining a connection, see Creating a connection.

    2. Access definition

    The definition of the specific data to be extracted from the database connection. Access definitions are based on specific source connection nodes.

    For information about defining an access definition, see Creating access definitions.

    3. Subset (optional)

    A subset of data from the access definition that you want to include in your extracted data.

    For information about defining a subset, see Subsetting data (optional).

    4. Masking (optional)

    The set of masking policies that will be applied to the data. Masking ensures that personally identifiable information (PII), and other confidential data are transformed while preserving data integrity and usability.

    For information about defining masking policies, see Applying masking policies.

    5. Target

    The final target location of the extracted and exported data, such as a target database connection or archive.

    For information about defining a target, see Defining a target.

    Note: After you drop a node onto the canvas, the previous node will become locked. This means that it cannot be removed from the canvas unless its dependent nodes are removed first.
  4. Click on any node in the canvas to edit it as needed.
  5. To save progress on your flow at any time, click Save. Saving a flow does not run it as a job; it only saves it as a draft flow.
  6. After building your flow and defining all of your nodes, you are ready to run your flow. A running flow job extracts data from the connection based on the access definition, applies subsetting and masking, and then exports it to the target.

    To run the flow, click Run flow.