Getting started with IBM Optim Archive for z/OS

New to IBM® Optim Archive for z/OS®? Use the guidance in this topic to help you get started.

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.

Navigating the user interface

When you first log in to the IBM Optim Archive for z/OS web application, you start on the Home screen. From the Home screen, you can navigate to any of the application tools and functions. The Home screen includes quick-link tiles that can take you to the Connectivity interface, the Data explorer, the Flow builder, or the Jobs dashboard. You can also see a list of recent jobs or jump directly to a specific source connection defined in your system.

When you are in the IBM Optim Archive for z/OS web application, you can always navigate to other screens by using the Navigation menu. The navigation menu includes quick links to all of the key tools that make up IBM Optim Archive for z/OS.

Table 1. Navigation menu
Menu option	Description
Home	The Home screen is the starting place for the IBM Optim Archive for z/OS web application.
Connections	Use the Connections interface to view, manage, and create source and target data connections in your IBM Optim Archive for z/OS instance. For details, see .Exploring and defining connections
Data explorer	Use the Data explorer tool to browse and view details of the connected data tables that are loaded into your IBM Optim Archive for z/OS instance. For details, see Exploring data in your IBM Optim Archive for z/OS instance.
Workflow > Flow builder	Use the Flow builder tool to configure, modify, and run IBM Optim Archive for z/OS flows. For details, see Building an IBM Optim Archive for z/OS flow.
Workflow > Relationships	Use the Relationships tool to create and manage relationships between data. For details, see Defining data relationships.
Workflow > Custom formats	Use the Custom formats tool to create and manage custom data masking formats. For details, see Defining custom data masking formats.
Workflow > Compare data	Use the Compare data tool to compare data across different data sets. For details, see Comparing data across sources.
Archives	Use the Archives tool to view and browse the contents of archive files that you have created by using IBM Optim Archive for z/OS flows. For details, see Exploring archives
Extract files	Use the Extract files tool to view and browse the contents of extract files that you have created by using IBM Optim Archive for z/OS flows. For details, see Exploring extracted data.
Jobs	Use the Jobs dashboard to monitor and manage IBM Optim Archive for z/OS jobs. For details, see Viewing job details, logs, and process reports.
Access control	Administrator use only. Use the Access control option to open the Keycloak security administration console. In the console, you can manage users, roles, and permissions for IBM Optim Archive for z/OS. For details, see Managing users and roles.

Using the IBM Optim Archive for z/OS API

The IBM Optim Archive for z/OS API supports the following functions:

Workflow management
Connection and metadata management
Subsetting and masking operations
User and role management

For more information about using the API, see Using the IBM Optim Archive for z/OS REST API.

Defining IBM Optim relationships by using the API

Use the API to define IBM Optim relationships. IBM Optim relationships define logical connections between tables to maintain referential integrity during data extraction and provisioning.

For more information about using the API to define IBM Optim relationships, see Defining data relationships.