The Compuware Topaz API provides users with methods to programmatically access and perform operations on datasets and perform JES operations, as well as launch and communicate with their own z/OS programs.

IZOSHost

IZOSHost is the starting point for all z/OS related functions.

When writing Java Applications or plug-ins not running in a Topaz Workbench installation, instances of IZOSHost can be created using the HostFactory class.

When writing plug-ins running in a Topaz Workbench installation, instances of IZOSHost for hosts defined in the Topaz Workbench client can be retrieved using the HostManager class from the com.compuware.api.topaz.eclipse plug-in.

Dataset API

The Compuware Topaz API provides users with methods to programmatically access and perform actions on datasets and generation data groups. The following dataset types are supported:
  • Sequential
  • Partitioned
  • VSAM
The following actions are provided regarding datasets:
  • Allocate a partitioned or sequential dataset
  • Delete a partitioned, sequential, migrated or VSAM dataset
  • Create or delete a PDS member
  • Obtain dataset and PDS member objects by name/pattern and type
  • Read the content of a sequential dataset or a PDS member
  • Write content to a sequential dataset or a PDS member
  • Obtain the characteristics of a dataset or the statistics of a PDS member
  • Recall a migrated dataset
  • Define a generation data group
  • Obtain generation dataset objects from generation data groups
  • Copy a PDS member
See IZOSHostConnection, IDataSet and IDataSetCommandProvider for more information.

JES API

The Compuware Topaz API provides users with methods to programmatically perform JES actions. The following actions are provided regarding JES:
  • Submit JCL
  • Track a job's status
  • Obtain job objects by job name and/or owner filters
  • Obtain execution and queue data of jobs
  • Obtain sysout data definition (DD) objects of jobs
  • Read the JES output of a job
  • Read the contents of a DD of a job
  • Read the contents of the currently active system log
  • Read the contents of any available system log
  • Cancel a job
See IZOSHostConnection, IJESCommandProvider and JobOutputReader for more information.

z/OS User Program API

The Compuware Topaz API provides users with methods to programmatically launch and communicate with their own z/OS programs. The following actions are provided regarding z/OS user programs:
  • Launch a z/OS user program
  • Write/read user-defined data to/from the z/OS user program
  • Be notified of when the z/OS user program has ended
See IZOSUserProgramConnection for more information.

TSO Command API

The Compuware Topaz API provides users with methods to programmatically submit TSO commands The following actions are provided regarding TSO commands
  • Execute a TSO command
See ITSOCommandProvider for more information.
Packages 
Package Description
com.compuware.api.topaz
Provides exceptions that are applicable to all of the Topaz API.
com.compuware.api.topaz.hostconnections
Provides interfaces and exceptions related to host connections.
com.compuware.api.topaz.hostconnections.zos
Provides interfaces related to z/OS host connections.
com.compuware.api.topaz.hostcredentials
Provides interfaces and exceptions related to host credentials.
com.compuware.api.topaz.hostcredentials.zos
Provides classes and exceptions related to z/OS host credentials.
com.compuware.api.topaz.hostresources
Provides classes and exceptions related to host resources.
com.compuware.api.topaz.hostresources.zos
Provides classes and exceptions related to z/OS host resources.
com.compuware.api.topaz.hosts
Provides classes related to hosts.
com.compuware.api.topaz.hosts.zos
Provides classes and exceptions related to z/OS hosts.
com.compuware.api.topaz.jes
Provides classes and exceptions related to JES.
com.compuware.api.topaz.tso
Provides interfaces related to TSO