Previous Topic: Guidelines for Using the OPSLOG Browse Test Data Results PanelNext Topic: Using the AOF Test CMD Panel


Overview of AOF Test Panels for Different Rule Types

When the AOF places you in the rule test environment, the actual panel you see depends upon the type of rule you selected for testing. For example, if you select a command rule to test, the AOF displays the AOF Test CMD panel. If you select an OMEGAMON rule, the AOF displays the AOF Test OMG panel.

When you enter data into an AOF test panel, the AOF tries to match the information you specified on the panel to the enabled rules of the AOF. The AOF displays the test results in the bottom part of the AOF test panel. Once you see the results, you can press PF3 to terminate the rule test session. If you want to continue testing, you can change some of the field data and press Enter again. For more information about viewing test results, see Guidelines for Using the OPSLOG Browse Test Data Results Panel in this chapter.

Although there is a different panel for each type of AOF rule, they are very similar. In fact, many of the same fields appear on all of the AOF test panels.

When you select an API rule for testing, the AOF displays the AOF Test API panel, specific for each type of API event. For more information about how to write AOF API rules and how API rules are processed, see the AOF Rules User Guide.

The following sections describe how to use the AOF test panels for each rule type. Each section includes a sample panel and descriptions of all the fields that are unique to the panel. For descriptions of the fields that are common to many or all of the panels, see Common AOF Test Panel Fields in this chapter.

Using the AOF Test API Common Panel

The AOF Test API Common panel lets you test those variables that are common to all API event notifications.

Use this panel if you do not know which application is using the API or if a currently unsupported application is using the API.

The following example shows a sample AOF Test API Common panel:

AOF Test API Common ----- CA11 --- OPSVIEW --- 10:05:27 26MAY2014 COLS 001 059 REXX Trace ==> N Live Commands ==> NO API Id ==> *_________ Application ==> ________ Version ==> ________ Level ==> ________ User ==> ________ Color ==> ________ Text ==> _______________________________________________________________ ________________________________________________________________________________ ________________________________________________________________________________ _________________________________ Time Event ID ----+----1----+----2----+----3----+----4----+----5----+---- ******** ********** ********** TOP OF MESSAGES ******************************* 10:05:27 TEST.APICM ENABLE TEST.APICMN 10:05:27 TEST.APICM ENABLE TEST.APICMN 10:05:27 NONE OPG3900O RULE TEST.APICMN FOR API * NOW E ******** ********** ********* BOTTOM OF MESSAGES ******************************

Fields on the AOF Test API Common Panel

The following fields are available on the AOF Test API Common panel.

The name of the corresponding REXX variable is listed in parentheses alongside each field.

API Id (API.ID)

Identifies the event.

Application (API.APPLICATION)

Specifies the name of the application that sends the data to CA OPS/MVS.

Color (API.COLOR)

Identifies the binary value of the color of the API.TEXT that is used in the OPSLOG.

Values: 0—Default , 1—Green , 2— Blue, 3—Red, 4—White, 5—Pink, 6—Yellow, 7—Turquoise

Level (API.LEVEL)

A one- to eight-character string that the application provides. This variable lets the application differentiate between multiple copies of the application that are executing on the same system, where possible. Otherwise, the application can provide information through this variable.

Text (API.TEXT)

Provides a readable explanation of the event in the OPSLOG.

The OPSLOG displays the first 128 characters of data from this variable.

User (API.USER)

Provides communication between rules that execute for the same API event. This 8-byte variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Version (API.VERSION)

A one- to eight-character string provided by the application to identify the version of the application that generated the API event.

Note: For descriptions of fields that are common to many or all of the AOF test panels, see Common AOF Test Panel Fields.

Using the AOF Test API CA WA ESP Panel

When you select an API CA WA ESP rule for testing, the AOF displays the AOF Test API CA WA ESP panel. The panel prompts you for information about the API rule that you want to test.

All field values on the AOF Test API CA WA ESP panel are available to AOF API rules as special variables. For example, API.TEXT is an AOF special variable that corresponds to the Text field on the AOF Test API panel. All variables, except User and Color, are read-only. If a rule changes User or Color, the AOF Test CA WA ESP panel reflects the change at the end of the rule test.

The following example shows a sample AOF Test API CA WA ESP panel:

AOF Test API CA WA ESP -- CA11 --- OPSVIEW --- 10:44:30 04AUG2014 COLS 001 059 REXX Trace ==> N Live Commands ==> NO API Id ==> CAESP00001 Application ==> ESMCAESP Version ==> __________ Level ==> ________ User ==> __________ Color ==> _ Text ==> __________________________________________________________________ _______________________________________________________________________________ Place cursor here and hit Enter to see entire Text field Time Event ID ----+----1----+----2----+----3----+----4----+----5----+---- ******** ********** ********** TOP OF MESSAGES ******************************* 10:44:30 TEST.APIES ENABLE TEST.APIESP 10:44:30 TEST.APIES ENABLE TEST.APIESP 10:44:30 NONE OPG3900O RULE TEST.APIESP FOR API CAESP00001 NOW E ******** ********** ********* BOTTOM OF MESSAGES ******************************

Fields on the AOF Test API CA WA ESP Panel

The following fields are available on the AOF Test API CA WA ESP panel.

The name of the corresponding REXX variable is listed in parentheses next to each field.

API Id (API.ID)

Identifies the event. The API ID for CA WA ESP is CAESP00001.

Application (API.APPLICATION)

Identifies the name of the application that sends the data to CA OPS/MVS. This value is always ESMCAESP.

Color (API.COLOR)

Identifies the binary value of the color of the API.TEXT that is used in the OPSLOG.

Values:

0—Default

1—Green

2— Blue

3—Red

4—White

5—Pink

6—Yellow

7—Turquoise

Level (API.LEVEL)

A one- to eight-character string that the application provides. This variable lets the application differentiate between multiple copies of the application that are executing on the same system, where possible. Otherwise, the application can provide information through this variable.

Text (API.TEXT)

Specifies the message that CA WA ESP sends. The message can include quotes, special characters, and CA WA ESP Edition variables. The AOF Test API CA WA ESP panel displays only 145 characters of the message. Use the Point-and-Shoot field “Place cursor here and hit Enter to see entire Text field” to edit the entire Text field in a separate panel.

Limits: 1 to 4095 characters.

Note: Text longer than 4095 characters is shortened automatically.

The OPSLOG displays the first 128 characters of data from this variable.

Place cursor here and hit Enter to see entire Text field

Identifies the Point-and-Shoot field that opens the panel that contains the entire API.TEXT field. This field is 4095 characters long.

User (API.USER)

Provides communication between rules that execute for the same API event. This 8-byte variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Version (API.VERSION)

Identifies the version of the application that generated the API event with a one- to eight-character string that the application itself provides.

Note: For descriptions of fields that are common to many AOF test panels, see Common AOF Test Panel Fields.

Using the AOF Test API WA ESP Text Panel

The “Place cursor here and hit Enter to see entire Text field” Point-and-Shoot opens the AOF Test API CA WA ESP Text panel that contains the long version of API.TEXT.

The following example shows a sample AOF Test API CA WA ESP Text panel:

AOF Test API CA WA ESP Text -------------------------------- Row 1 to 19 of 52 **************************** AOF Test CA WA ESP Text *************************** ________________________________________________________________________________ ________________________________________________________________________________ ________________________________________________________________________________ ________________________________________________________________________________ ________________________________________________________________________________ Command ===> __________________________________________________ Scroll ===> PAGE

Note: You can update one or more lines and press Enter to save the changes. To clear the AOF Test CA WA ESP Text field, use the CLEAR primary command.

Using the AOF Test API CA WA SE Panel

When you select an API CA Workload Automation SE rule for testing, the AOF displays the AOF Test API CA WA SE panel. The panel prompts you for information about the API rule that you want to test.

All field values on the AOF Test API CA WA SE panel are available to AOF API rules as special variables. For example, API.TEXT is an AOF special variable that corresponds to the Text field on the AOF Test API panel. All variables, except User and Color, are read-only. If a rule changes User or Color, the AOF Test CA WA SE panel reflects the change at the end of the rule test.

The following example shows a sample AOF Test API CA WA SE panel:

AOF Test API CA WA SE --- CA11 --- OPSVIEW --- 04:57:51 22AUG2014 COLS 001 059 REXX Trace ==> N Live Commands ==> NO API Id ==> CA7MSG Application ==> CA7 Version ==> 11.3 Level ==> ________ User ==> Color ==> _ Text ==> _____________________________________________________________ ______________________________________________________________________________ ______________________________________________________________________________ ______________________________________ Time Event ID ----+----1----+----2----+----3----+----4----+----5----+---- ******** ********** ********** TOP OF MESSAGES ******************************* 04:36:06 TEST.APICA ENABLE TEST.APICA7 04:36:06 TEST.APICA ENABLE TEST.APICA7 04:36:06 NONE OPG3900O RULE TEST.APICA7 FOR API CA7MSG NOW E ******** ********** ********* BOTTOM OF MESSAGES ****************************** Command ===> Scroll ===> PAGE

Fields on the AOF Test API CA WA SE Panel

The following fields are available on the AOF Test API CA WA SE panel.

The name of the corresponding REXX variable is listed in parentheses alongside each field.

API Id (API.ID)

Identifies the event. The API ID for CA Workload Automation SE is CA7MSG.

Application (API.APPLICATION)

Specifies the name of the application that sends the data to CA OPS/MVS. This value is always CA7.

Color (API.COLOR)

Identifies the binary value of the color of the API.TEXT that is used in the OPSLOG.

Values: 0—Default , 1—Green , 2— Blue, 3—Red, 4—White, 5—Pink, 6—Yellow, 7—Turquoise

Level (API.LEVEL)

A one- to eight-character string that the application provides. This variable lets the application differentiate between multiple copies of the application that are executing on the same system, where possible. Otherwise, the application can provide information through this variable.

Values: CA71, CA72, CA73, CA74, CA75, CA76, CA77, CA78

Text (API.TEXT)

Provides a readable explanation of the event in the OPSLOG.

The OPSLOG displays the first 128 characters of data from this variable.

User (API.USER)

Provides communication between rules that execute for the same API event. This 8-byte variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Version (API.VERSION)

A one- to eight-character string provided by the application to identify the version of the application that generated the API event.

Note: For descriptions of fields that are common to many or all of the AOF test panels, see Common AOF Test Panel Fields.

Using the the AOF Test API Insight IQ Panel

When you select an API Insight IQ rule for testing, the AOF displays the AOF Test API Insight IQ panel. The panel prompts you for information about the API rule you want to test.

All field values on the AOF Test API Insight IQ panel are available to AOF API rules as special variables. For example, API.TEXT is an AOF special variable that corresponds to the Text field on the AOF Test API panel. All variables, except User and Color, are read-only. If a rule makes a change to User or Color, the AOF Test API Insight IQ panel will reflect the change at the end of the rule test. For more information about variables, see the AOF Rules User Guide.

The following example shows a sample AOF Test API Insight IQ panel:

AOF Test API Insight IQ - CA11 --- OPSVIEW --- 08:07:30 22APR2014 COLS 001 070 REXX Trace ==> N Live Commands ==> NO Version: 18.0 API Id: IQREQUEST7 Application: INSIGHT Text: INSIGHT: REQUEST SENT. Level ==> ________ User ==> ________ Request ==> ________ DB2 Subsys ==> ____ Owner ==> ________ System ==> ____ Auth. Id ==> ________ Date ==> __________ Plan Name ==> ________ Time ==> _______________ Connection ==> ________ Corr. Id ==> ____________ ACE ==> ________ Color ==> _ Output ==> _______________________________________________________________ ________________________________________________________________________________ ________________________________________________________________________________ ________________________________ Time ----+----1----+----2----+----3----+----4----+----5----+----6----+----7 08:07:30 INSIGHT: REQUEST SENT. ***************************** BOTTOM OF MESSAGES ******************************

Fields on the AOF Test API Insight IQ Panel

The following fields are unique to the AOF Test API IQ panel:

ACE

Specifies the thread ACE for thread-based requests.

API Id

Identifies the event. IQ is always the prefix.

Application

Specifies the name of the application sending the data to CA OPS/MVS. This value is always INSIGHT.

Auth. Id

Specifies the authorization ID for thread-based requests.

Color

Identifies the binary value of the color of the API.TEXT that is used in the OPSLOG.

Values: 0—Default , 1—Green , 2— Blue, 3—Red, 4—White, 5—Pink, 6—Yellow, 7—Turquoise

Connection

Specifies the connection for thread-based requests.

Corr. Id

Specifies the correlation ID for thread-based requests.

Date

Specifies the date in the following format: YYYY-MM-DD.

DB2 Subsys

Specifies the DB2 subsystem name.

Level

A 1- to 8-character string provided by the application. One intended purpose of this variable is to allow the application to differentiate between multiple copies of the application executing on the same system, if it is possible to do so. Otherwise, the application may or may not provide information in this variable.

Output

Specifies the line from the request.

Owner

Specifies the owner of the request.

Plan Name

Specifies the plan name for thread-based requests.

Request

Specifies the name of the request.

System

Specifies the name of the system.

Text

Identifies the request that was sent. In the OPSLOG, this message appears in the color that was specified. Value: INSIGHT: REQUEST reqname SENT.

Time

Specifies the time in the following format: HH.MM.SS.TTTTTT.

User

An 8-byte variable providing communication between rules that execute for the same API event. The variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Version

Indicates the version of CA SYSVIEW for DPM that you are using.

Note: For descriptions of fields that are common to many or all of the AOF test panels, see Common AOF Test Panel Fields.

Using the AOF Test API Insight IDB Panel

When you select an API Insight IDB rule for testing, the AOF displays the AOF Test API Insight IDB panel. The panel prompts you for information about the API rule you want to test.

All field values on the AOF Test API Insight IDB panel are available to AOF API rules as special variables. For example, API.TEXT is an AOF special variable that corresponds to the Text field on the AOF Test API panel. All variables, except User and Color, are read-only. If a rule makes a change to User or Color, the AOF Test API IDB panel will reflect the change at the end of the rule test. For more information about variables, see the AOF Rules User Guide.

The following example shows a sample AOF Test API Insight IDB panel:

AOF Test API Insight IDB - CA11 --- OPSVIEW --- 07:37:50 22APR2014 COLS 001 070 REXX Trace ==> N Live Commands ==> NO Version: 18.0 API Id: IDBDB11SSI Application: INSIGHT Level ==> ________ User ==> ________ Color ==> _ Token ==> ________ DB2 Subsys ==> ____ Type ==> __ Job Name ==> ________ System ==> ____ Severity ==> _ Auth. Id ==> ________ DC ASID ==> ____ Status ==> _ Plan Name ==> ________ BP Name ==> ______ Subtype ==> _ DS Group ==> ________ GBP Name ==> _______ Value ==> ____ DB Name ==> ________ Pageset ==> ________ Connection ==> ________ Corr. Id ==> ________ ACE ==> ________ Date, Time ==> 2014-01-01-12.42.10.232123 Text ==> _______________________________________________________________ ________________ Time ----+----1----+----2----+----3----+----4----+----5----+----6----+----7 07:37:50 INSIGHT: REQUEST SENT. 07:45:34 ENABLE TEST.APIIDB 07:45:34 OPG3900O RULE TEST.APIIDB FOR API IDBDB11SSI NOW ENABLED ******** ******************** BOTTOM OF MESSAGES ******************************

Fields on the AOF Test API Insight IDB Panel

The following fields are unique to the AOF Test API IDB panel:

ACE

Specifies the thread ACE for thread-based exceptions.

API Id

Identifies the event.

Value: IDB_db2subsys_type_severity. IDB is always the prefix. The following list describes the values:

db2subsys

Identifies the DB2 subsystem.

type

Identifies one of the following exception types:

SS—Subsystem

AP—Application

DB—Database

SQ—SQL

IQ—External/IQL

severity

Identifies the severity of the exception. The following values are valid:

C—Critical

W—Warning

I—Informational

Application

Specifies the name of the application sending the data to CA OPS/MVS. This value is always INSIGHT.

Auth. Id

Specifies the authorization ID for thread-based exceptions.

BP Name

Contains the &BPNAME exception variable, when &BPNAME is available in the exception message. &BPNAME represents the buffer pool name where the buffer pool exception occurred.

Color

Identifies the binary value of the color of the API.TEXT that is used in the OPSLOG.

Values: 0—Default , 1—Green , 2— Blue, 3—Red, 4—White, 5—Pink, 6—Yellow, 7—Turquoise

Connection

Specifies the connection for thread-based exceptions.

Corr. Id

Specifies the correlation ID for thread-based exceptions.

Date, Time

Specifies the date and time in the following format: YYYY-MM-DD-HH.MM.SS.TTTTTT.

DB2 Subsys

Specifies the DB2 subsystem name where the exception occurred.

DB Name

Contains the &DBNAMEX exception variable, when &DBNAMEX is available in the exception message. &DBNAMEX represents the name of the database where the exception occurred.

DC ASID

Specifies the address space ID of the data collector.

DS Group

Specifies the data sharing group where the exception occurred.

GBP Name

Contains the &BPNAME exception variable, when &BPNAME is available in the exception message. &BPNAME represents the group buffer pool name where the group buffer pool exception occurred.

Note: The &BPNAME exception variable applies for buffer pools and group buffer pools.

Job Name

Specifies the jobname of the data collector.

Level

A 1- to 8-character string provided by the application. One intended purpose of this variable is to allow the application to differentiate between multiple copies of the application executing on the same system, if it is possible to do so. Otherwise, the application may or may not provide information in this variable.

Pageset

Contains the &PAGESET exception variable, when &PAGESET is available in the exception message. &PAGESET represents the pageset name where the database exception occurred.

Plan Name

Specifies the plan name for thread-based exceptions.

Severity

Specifies the severity of the exception. Values: INFORMATIONAL|WARNING|CRITICAL

Status

Specifies the status of the exception. Values: BEGAN|ENDED|PEAKED|DIMINISHED

Subtype

Specifies the pool subtype. Values: BPOOL|GBPOOL

System

Specifies the name of the system where the exception occurred.

Text

Specifies the text of the exception message. In the OPSLOG, this message appears in the color that was specified in the exception definition.

Type

Specifies the type of exception. Values: SUBSYSTEM|APPLICATION|DATABASE|SQL|EXTERNAL/IQL

Token

Specifies a unique value for the instance of an exception for a data collector.

Note: This value is not unique to the LPAR. To create LPAR unique value, use this value with the API.DCASID variable.

User

An 8-byte variable providing communication between rules that execute for the same API event. The variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Version

Indicates the version of CA SYSVIEW for DPM that you are using.

Value

Contains the &VALUEXX exception variable, when &VALUEXX is available in the exception message.

Note: For descriptions of fields that are common to many or all of the AOF test panels, see Common AOF Test Panel Fields.

Using AOF Test API SYSVIEW Panels

This section describes those elements of the testing procedure that are common to all API SYSVIEW rules. Fields that are unique to individual API SYSVIEW rules are described in sections of their own.

When you select an API SYSVIEW rule for testing, the AOF displays the AOF Test API Version List panel. The panel prompts you for information about the version of SYSVIEW that you want to test.

The following example shows a sample AOF Test API Event Version List panel:

AOF Test API Event Version List Row 1 to 9 of 9 Use S in the SEL column to select version or enter the END command to return. Sel CA SYSVIEW MVS _ 13.9 _ 13.7 _ 13.5 _ 13.0 _ 12.7 _ 12.5 _ 12.0 _ 11.6 _ 11.5 *************** Bottom of data ****************

Follow these steps to test an API SYSVIEW rule:

  1. Select the version that you want to test from the list. The relevant AOF Test API SYSVIEW panel appears.
  2. Enter the END command or PF3 to cancel the test and go back to the AOF TEST - Rule List panel.

All field values on the AOF Test API SYSVIEW panel are available to AOF API rules as special variables. For example, API.TEXT is an AOF special variable that corresponds to the Text field on the AOF Test API panel. All variables, except User and Color, are read-only. If a rule makes a change to User or Color, the AOF Test SYSVIEW MVS panel reflects the change at the end of the rule test. The field numbers on a panel can differ from version to version.

Note: For more information about variables, see the AOF Rules User Guide.

Fields on the AOF Test API SYSVIEW CICS Panel

The following example shows a sample AOF Test API SYSVIEW CICS panel for the latest version of CA SYSVIEW:

AOF Test API SYSVIEW CICS CA11 --- OPSVIEW --- 08:53:19 16MAY2014 COLS 001 059 REXX Trace ==> N Live Commands ==> NO API Id ==> CAGSVY0001 Application: SYSVIEW Version: 13.9 Level ==> ________ Color ==> _ Group ==> ________ User ==> ________ Status ==> ________ Name ==> ________ Value ==> ____________ Description ==> ________ Resource 1 ==> ________ Elapsed ==> ________ Resource 2 ==> ________ Text ==> ________ ________ ________ ________ ________ ________ ________ __ ____________ __ ________ __ ________ ________ ________ ________ ____ ________ ____ ________ Time Event ID ----+----1----+----2----+----3----+----4----+----5----+---- ******** ********** ********** TOP OF MESSAGES ******************************* 08:53:19 TEST.APICI ENABLE TEST.APICICS1 08:53:19 TEST.APICI ENABLE TEST.APICICS1 08:53:19 NONE OPG3900O RULE TEST.APICICS1 FOR API CAGSVY0001 NOW E ******** ********** ********* BOTTOM OF MESSAGES ******************************

The following fields are unique to the AOF Test API SYSVIEW CICS panel.

The name of the corresponding REXX variable is listed in parentheses alongside each field.

API Id (API.ID)

Identifies the event. The API ID for SYSVIEW CICS is CAGSVY0001.

Application (API.APPLICATION)

Specifies the name of the application that sends the data to CA OPS/MVS. This value is always SYSVIEW.

Color (API.COLOR)

Identifies the binary value of the color of the API.TEXT that is used in the OPSLOG.

Values: 0—Default , 1—Green , 2— Blue, 3—Red, 4—White, 5—Pink, 6—Yellow, 7—Turquoise

Description (API.DESCRIPTION)

Specifies the variable metric description.

Elapsed (API.ELAPSED)

Specifies the time that has elapsed since the last notification.

Group (API.GROUP)

Specifies the variable metric group name.

Level (API.LEVEL)

A one- to eight-character string that the application provides. This variable lets the application differentiate between multiple copies of the application that are executing on the same system, where possible. Otherwise, the application can provide information through this variable.

Name (API.NAME)

Specifies the variable metric name.

Resource 1 (API.RSCE1)

Specifies associated resource 1.

Resource 2 (API.RSCE2)

Specifies associated resource 2.

Status (API.STATUS)

Specifies the current status.

Text (API.TEXT)

Provides a readable explanation of the event in the OPSLOG.

The OPSLOG displays the first 128 characters of data from this variable.

Note: For a detailed description, see the associated help panel.

User (API.USER)

Provides communication between rules that execute for the same API event. This 8-byte variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Value (API.VALUE)

Specifies the current value.

Version (API.VERSION)

Specifies the version of SYSVIEW.

Fields on the AOF Test API SYSVIEW IMS Panel

The following example shows a sample AOF Test API SYSVIEW IMS panel for the latest version of CA SYSVIEW:

AOF Test API SYSVIEW IMS CA11 --- OPSVIEW --- 09:54:09 26MAY2014 COLS 001 059 REXX Trace ==> N Live Commands ==> NO API Id ==> CAGSVP0001 Application: SYSVIEW Version: 13.9 Level ==> ________ Color ==> _ Group ==> ________ User ==> ________ Status ==> ________ Name ==> ________ Value ==> ________ Description ==> ________ IMS Id ==> ____ Elapsed ==> ________ Resource ==> ________ Text ==> ________ ________ ____ ________ ________ ________ ________ ________ ________ ____________ ________ ________ ______ Time Event ID ----+----1----+----2----+----3----+----4----+----5----+---- 09:54:09 ENABLE QA.APIIMS1 09:54:09 ENABLE QA APIIMS1 09:54:09 OP63900O RULE QA.APIIMS1 FOR API CAGSVP0001 NOW ENABLED ********* ********** ********* BOTTOM OF MESSAGES ******************************

The following fields are unique to the AOF Test API SYSVIEW IMS panel.

The name of the corresponding REXX variable is listed in parentheses alongside each field.

API Id (API.ID)

Identifies the event. The API ID for SYSVIEW IMS is CAGSVP0001.

Application (API.APPLICATION)

Specifies the name of the application that sends the data to CA OPS/MVS. This value is always SYSVIEW.

Color (API.COLOR)

Identifies the binary value of the color of the API.TEXT that is used in the OPSLOG.

Values: 0—Default , 1—Green , 2— Blue, 3—Red, 4—White, 5—Pink, 6—Yellow, 7—Turquoise

Description (API.DESCRIPTION)

Specifies the variable metric description.

Elapsed (API.ELAPSED)

Specifies the time that has elapsed since the last notification.

Group (API.GROUP)

Specifies the variable metric group name.

IMS Id (API.IMSID)

Specifies the IMS subsystem ID.

Level (API.LEVEL)

A one- to eight-character string that the application provides. This variable lets the application differentiate between multiple copies of the application that are executing on the same system, where possible. Otherwise, the application can provide information through this variable.

Name (API.NAME)

Specifies the variable metric name.

Resource (API.RESOURCE)

Specifies associated resource.

Status (API.STATUS)

Specifies the current status.

Text (API.TEXT)

Provides a readable explanation of the event in the OPSLOG.

The OPSLOG displays the first 128 characters of data from this variable.

Note: For a detailed description, see the associated help panel.

User (API.USER)

Provides communication between rules that execute for the same API event. This 8-byte variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Value (API.VALUE)

Specifies the current value.

Version (API.VERSION)

Specifies the version of SYSVIEW.

Fields on the AOF Test API SYSVIEW MQ Panel

The following example shows a sample AOF Test API SYSVIEW MQ panel for the latest version of CA SYSVIEW:

AOF Test API SYSVIEW MQ CA11 --- OPSVIEW --- 09:22:39 04JUN2014 COLS 001 070 Command ===> Scroll ===> PAGE REXX Trace ==> N Live Commands ==> NO API Id ==> CAGSVS0001 Application: SYSVIEW Version: 13.9 Level ==> Color ==> Group ==> User ==> Status ==> Name ==> Value ==> Description ==> Queue Mgr ==> Elapsed ==> Resource ==> Text ==> Time ----+----1----+----2----+----3----+----4----+----5----+----6----+----7 ******** ********************* TOP OF MESSAGES ******************************* 09:22:39 ENABLE RULE.APIMQ1 09:22:39 OPO3900O RULE RULE.APIMQ1 FOR API CAGSVS0001 NOW ENABLED ******** ******************** BOTTOM OF MESSAGES ******************************

The following fields are unique to the AOF Test API SYSVIEW MQ panel.

The name of the corresponding REXX variable is listed in parentheses alongside each field.

API Id (API.ID)

Identifies the event. The API ID for SYSVIEW MQ is CAGSVS0001.

Application (API.APPLICATION)

Specifies the name of the application that sends the data to CA OPS/MVS. This value is always SYSVIEW.

Color (API.COLOR)

Identifies the binary value of the color of the API.TEXT that is used in the OPSLOG.

Values: 0—Default , 1—Green , 2— Blue, 3—Red, 4—White, 5—Pink, 6—Yellow, 7—Turquoise

Description (API.DESCRIPTION)*

Specifies the description in parmlib (variable) (version 13.5 or earlier) or in the variable metric description (version 13.7 or later).

Elapsed (API.ELAPSED)**

Specifies the time that has elapsed since the last notification.

Group (API.GROUP)

Specifies the variable metric group name.

Level (API.LEVEL)

Specifies the Service Pack/Build.

Name (API.NAME)

Specifies the variable metric name.

Queue Mgr (API.QMGR)

Specifies the MQ Queue Manager.

Resource (API.RESOURCE)

Specifies the associated resource.

Status (API.STATUS)

Specifies the current status.

Text (API.TEXT)

Specifies the exception metric text.

User (API.USER)

Provides communication between rules that execute for the same API event. This 8-byte variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Value (API.VALUE)

Specifies the current value.

Version (API.VERSION)

Indicates the version of CA SYSVIEW that you are using.

* - variable available in CA SYSVIEW version 12.5 and later

** - variable available in CA SYSVIEW version 13.5 and later

Fields on the AOF Test API SYSVIEW MVS Panel

The following example shows a sample AOF Test API SYSVIEW MVS panel for the latest version of CA SYSVIEW:

AOF Test API SYSVIEW MVS- CA11 --- OPSVIEW --- 04:51:23 14MAY2014 COLS 001 059 REXX Trace ==> N Live Commands ==> NO API Id ==> CAGSVX0001 Application: SYSVIEW Version: 13.9 Level ==> ________ Color ==> _ Group ==> ________ User ==> ________ Status ==> ________ Name ==> ________ Value ==> ________ Description ==> ________ Resource ==> ________ Elapsed ==> ________ ASID ==> ________ Job Id ==> ________ Text ==> ________ ________ ________ ________ ________ ________ ________ ________ ________ ________ ____________ ________ ________ ______ Time Event ID ----+----1----+----2----+----3----+----4----+----5----+---- ******** ********** ********** TOP OF MESSAGES ******************************* 04:51:23 TEST.APIMV ENABLE TEST.APIMVS3 04:51:23 TEST.APIMV ENABLE TEST.APIMVS3 04:51:23 NONE OPG3900O RULE TEST.APIMVS3 FOR API CAGSVX0001 NOW E ******** ********** ********* BOTTOM OF MESSAGES ******************************

The following fields are unique to the AOF Test API SYSVIEW MVS panel.

The name of the corresponding REXX variable is listed in parentheses alongside each field.

API Id (API.ID)

Identifies the event. The API ID for SYSVIEW MVS events is CAGSVX0001.

Application (API.APPLICATION)

Specifies the name of the application that sends data to CA OPS/MVS. This value is always SYSVIEW.

ASID (API.ASID)

Provides the ASID.

Color (API.COLOR)

Identifies the binary value of the color of the API.TEXT that is used in the OPSLOG.

Values: 0—Default , 1—Green , 2— Blue, 3—Red, 4—White, 5—Pink, 6—Yellow, 7—Turquoise

Description (API.DESCRIPTION)

Specifies the variable metric description.

Elapsed (API.ELAPSED)

Specifies the elapsed time since the last notification.

Group (API.GROUP)

Specifies the variable metric group name.

Job Id (API.JOBID)

Provides the JES job ID.

Level (API.LEVEL)

A one- to eight-character string that the application provides. This variable lets the application differentiate between multiple copies of the application that are executing on the same system, where possible. Otherwise, the application can provide information through this variable.

Name (API.NAME)

Specifies the variable metric name.

Resource (API.RESOURCE)

Specifies the associated resource.

Status (API.STATUS)

Specifies the current status.

Text (API.TEXT)

Provides a readable explanation of the event in the OPSLOG.

The OPSLOG displays the first 128 characters of data from this variable.

Note: For a detailed description, see the associated help panel.

User (API.USER)

Provides communication between rules that execute for the same API event. This 8-byte variable can contain any installation data that these rules require and can store a character string that the OPSLOG Browse can display.

Value (API.VALUE)

Specifies the current value.

Version (API.VERSION)

Specifies the version number of SYSVIEW.

Fields on the AOF Test API SYSVIEW TCP/IP Panel

The following example shows a sample AOF Test API SYSVIEW TCP/IP panel for the latest version of CA SYSVIEW:

AOF Test API SYSVIEW TCP/IP - CA11 - OPSVIEW - 09:22:39 04JUN2014 COLS 001 070 Command ===> Scroll ===> PAGE REXX Trace ==> N Live Commands ==> NO API Id ==> CAGSVN0001 Application: SYSVIEW Version: 13.9 Level ==> Color ==> Group ==> User ==> Status ==> Name ==> Value ==> Description ==> TCP/IP Id ==> Elapsed ==> Resource ==> Text ==> Time ----+----1----+----2----+----3----+----4----+----5----+----6----+----7 ******** ********************* TOP OF MESSAGES ******************************* 09:22:39 ENABLE RULE.APITCPIP 09:22:39 OPO3900O RULE RULE.APITCPIP FOR API CAGSVN0001 NOW ENABLED ******** ******************** BOTTOM OF MESSAGES ******************************

The following fields are unique to the AOF Test API SYSVIEW TCP/IP panel.

The name of the corresponding REXX variable is listed in parentheses alongside each field.

API Id (API.ID)

Identifies the event. The API ID for SYSVIEW TCP/IP events is CAGSVN0001.

Application (API.APPLICATION)

Specifies the name of the application that sends the data to CA OPS/MVS. This value is always SYSVIEW.

Color (API.COLOR)

Identifies the binary value of the color of the API.TEXT that is used in the OPSLOG.

Values: 0—Default , 1—Green , 2— Blue, 3—Red, 4—White, 5—Pink, 6—Yellow, 7—Turquoise

Description (API.DESCRIPTION)*

Specifies the description in parmlib (variable) (version 13.5 or earlier) or in the variable metric description (version 13.7 or later).

Elapsed (API.ELAPSED)**

Specifies the time that has elapsed since the last notification.

Group (API.GROUP)

Specifies the variable metric group name.

Level (API.LEVEL)

A one- to eight-character string that the application provides. This variable lets the application differentiate between multiple copies of the application that are executing on the same system, where possible. Otherwise, the application can provide information through this variable.

Name (API.NAME)

Specifies the variable metric name.

Resource (API.RESOURCE)

Specifies associated resource.

Status (API.STATUS)

Specifies the current status.

TCP/IP Id (API.TCPID)

Indicates the TCP/IP jobname of a stack.

Text (API.TEXT)

Provides a readable explanation of the event in the OPSLOG.

The OPSLOG displays the first 128 characters of data from this variable.

Note: For a detailed description, see the associated help panel.

User (API.USER)

An 8-byte variable that provides communication between rules that execute for the same API event. The variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Value (API.VALUE)

Specifies the current value.

Version API.VERSION

Indicates the version of CA SYSVIEW that you are using.

* - variable available in CA SYSVIEW version 12.5 and later

** - variable available in CA SYSVIEW version 13.5 and later

Note: For descriptions of fields that are common to many or all of the AOF test panels, see Common AOF Test Panel Fields. The content of the panel and the structure of the Text variable can differ depending on the version of CA SYSVIEW. For descriptions of fields that are available for different versions of CA SYSVIEW MVS events, see the CA SYSVIEW Performance Management Administration Guide.