Newer version of documentation BMC provides a newer version of the documentation for this version of the product. As a result, BMC no longer accepts comments in this space.BMC recommends upgrading to the latest version of the product. To see documentation for that version, see bao8301.

Using the MV API

This section describes how to use the MV (MainView) API. The MV API includes specific commands, functions and facilities that enable BMC AMI Ops Automation users to access data available on the BMC AMI Ops databus with BMC AMI OpsA EXECs.

Note that the use of this API requires that you are familiar with BMC AMI OpsA IMFEXEC commands and BMC AMI Ops Infrastructuretechnology. The API is a cross-platform product that enables you to access data from BMC AMI Ops Infrastructuretechnology by using BMC AMI OpsA automation techniques.

BMC recommends that you have some knowledge about how to use BMC AMI OpsA EXECs to access array data. See Accessing-array-data-with-BMC-AMI-Ops-Automation-EXECs for more information.

What is the MV API

The MV API provides for a one-way data exchange between BMC AMI Ops-based products (such as BMC AMI Ops Automation for CICS, BMC AMI Ops Automation for z/OS, BMC AMI Ops Automation for IMS and others) and a BMC AMI OpsA REXX or CLIST.

Through the API, BMC AMI OpsA EXECs can explicitly request the data from a BMC AMI Ops product through an EXEC. The MV API enables BMC AMI OpsA to gather data from the BMC AMI Ops databus to flow from any of the BMC AMI Ops products into BMC AMI OpsA.

BMC AMI OpsA EXECs process the BMC AMI Opsdata based on how a BMC AMI Ops view looks during a BMC AMI Ops terminal session, so you see the exact output in an EXEC for a view as you see when it is displayed from a BMC AMI Ops terminal session.

BMC AMI OpsA processes BMC AMI Ops data as an array where data from the  BMC AMI Ops databus (tabular and detail format views) is returned in rows and columns. An array is a table that consists of one or more rows and columns that are given names. A one-to-one relationship exists between the columns of a view and the columns in the resulting array. See Customizing-BMC-AMI-Ops-Infrastructure-views-and-connecting-BBI-SS-PAS-to-a-CAS for more information about the naming conventions for array columns.

Every command described in this section is prefixed by the literal "MV" to avoid naming conflicts with existing IMFEXEC commands. MV is a valid abbreviation in the command syntax for MainView.

BMC recommends that you use the IMFEXEC MV GETDATAN command because it provides the easiest method for accessing the data. The IMFEXEC MV GETDATAN command accesses the array through a REXX EXEC and returns the information in REXX stem variables.

Or you can use the IMFEXEC MV GETDATA command which returns information that you must query with IMFEXEC ARRAY commands. The array is processed one row at a time, retrieving and placing the contents of that row into TSO/E variables that are available to an EXEC. See Accessing-array-data-with-BMC-AMI-Ops-Automation-EXECs.

BMC recommends that you use the commands in the same sequence in your EXECs as they are documented in this section.

This section contains the following topics: 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*