STATDEF (Status definitions)

A status definition identifies a user-program that is to be called by CICSPlex® SM at specific intervals.

To display information about existing status definitions, issue the command:

   STATDEF [statdef]

where statdef is the specific or generic name of a status definition. If you omit this parameter, the resulting view, illustrated in Figure 44, includes information about all existing status definitions within the current context.

Figure 44. The STATDEF view
 27FEB2005  16:17:25 ----------- INFORMATION DISPLAY ---------------------------
 COMMAND  ===>                                                 SCROLL ===> PAGE
 CURR WIN ===> 1        ALT WIN ===>
  W1 =STATDEF===========EYUPLX01=EYUPLX01=27FEB2005==16:17:25=CPSM==============
 CMD Name     Program  Intvl Action   Description
 --- -------- -------- ----- -------- -----------------------------
     EYURST06 DB2STATE    60          SSet - Probe for DB2 Appl
 
 

Action commands

Table 29 summarizes the action commands you can use with the STATDEF view.

Table 29. STATDEF view action commands
Primary command Line command Description
n/a ADD Add an association between a status definition and an analysis group, as described in topic Adding a status definition to an analysis group.
n/a BRO Browse a status definition in the data repository.

The format of the resulting panel is similar to that shown in Figure 45. The panel fields are not modifiable.

CREate CRE Create a status definition and add it to the data repository, as described in topic Creating a status definition.

When you use the primary command CREate, some fields in the new view may contain values supplied by CICSPlex SM; you may change these values. When you enter the line command CRE next to the name of a status definition, fields in the new view contain values to be modelled (from the existing status definition).

n/a INS Install a status definition in a CICS® system or CICS system group, as described in topic Installing a status definition.
n/a MAP Display a visual map of real-time analysis definitions using the specified definition as a starting point.
n/a REM Remove a status definition from the data repository.
TEMPMP cmasid n/a Change the temporary maintenance point CMAS to a specific CMAS or display a selection list based on a generic CMAS ID.
n/a UPD Update a status definition in the data repository.

The format of the resulting panel is similar to the panel shown in Figure 45. You can modify the contents of any field in the panel except Name.

Hyperlink fields

There are no hyperlink fields on the STATDEF view.

Creating a status definition

Figure 45 shows the format of the panel produced when you use the create primary (CREate) or line (CRE) action command from the STATDEF view.

Figure 45. Creating a status definition
  --------------------- Create Status Definition for EYUPLX01 ------------------
 COMMAND ==>
 
  Name               ===> EYURST06
  Description        ===> SSet - Probe for DB2 Appl
 
  Program Name       ===> DB2STATE     Name of Status Program
  Call Interval      ===> 60           Interval Between Calls in Seconds
  Action Name        ===>              Action Definition Name or Generic
  User ID            ===>              User ID for Task
  Transaction ID     ===>              Transaction ID for Task
 
                          VLS    LS    LW    HW    HS   VHS
 Entry Intervals     ===> 0005  0005  0005  0005  0005  0005
 Exit  Intervals     ===> 0002  0003  0001  0001  0003  0002
 
 Press Enter to create the Status Definition.
 Type END or CANCEL to cancel without creating.

Provide the following information, as appropriate.

Name
Specify a 1- to 8-character name for the status definition. The name can contain alphabetic, numeric, or national characters. However, the first character must be alphabetic,
Description
(Optional.) Specify a 1- to 30-character description of the definition.
Program Name
(Optional.) Specify the name of the user-written program that is to return information to CICSPlex SM.

If the program is to return status information about multiple conditions and you can create one status definition for each condition, where:

(For more information about writing programs to monitor status, see Appendix A. Customizing programs that monitor status.)

Call Interval
Specify the interval, in seconds, between calls to the status program. The value must be between 1 and 86400.
Action Name
Enter the specific or generic name of an action definition to be used if the STATDEF enters the True state. If you specify a generic value, a list of valid action definitions is displayed.
User Id
(For CICS/ESA 4.1 only. Optional.) Specify the ID of the user (defined to your external security manager) that is to be associated with the CICS status probe task running in the MAS.
Transaction Id
(Optional.) Specify the transaction identifier under which the status program is to execute in the target CICS system.
Entry Intervals
Specify the number of consecutive Call Frequency intervals, within each severity level, that must result in a true condition before this definition is considered true.
Exit Intervals
Specify the number of consecutive Call Frequency intervals, within each severity level, that must result in a false condition before this definition is considered false.

Press Enter to add the status definition to the data repository.

Adding a status definition to an analysis group

Figure 46 illustrates the panel produced when you use the add (ADD) line action command from the STATDEF view.

Figure 46. Adding a status definition to an analysis group
 ---------------------- Add STATDEF to Analysis Group for EYUPLX01-------------
 COMMAND  ===>
 
  Status Definition          EYURST06
  Description                SSet - Probe for DB2 Appl
 
   Analysis Group       ===> EYURTG10     Analysis Group or Generic
   Active Period        ===> PRIME        Period Name or Generic
 
Press Enter to add Status Definition to Analysis Group.
Type END or CANCEL to cancel without adding.

Provide the following information:

Analysis Group
Enter the specific or generic name of an analysis group with which this definition is to be associated. If you specify a generic value, a list of valid analysis groups is displayed.
Active Period
(Optional) Enter the specific or generic name of a period definition that identifies the range of hours during which the status definition is to be active. If you specify a generic value, a list of valid period definitions is displayed.

If the name you specify is not an existing period definition, you can create that period definition later. If you leave this field blank, the status definition remains active for as long as the CICS system is running or until you discard it.

Press Enter to add the status definition to the designated analysis group in the data repository.

Installing a status definition

You can install a status definition in one or more active CICS systems that are within the CICSplex identified as the context.

Notes:
  1. The RTA status probe program must be available for execution prior to installation of a status definition.
  2. A status definition can be automatically installed in a CICS system when that system starts. For this to occur, associate the definition with an analysis group. Then associate that group with an analysis specification that is defined to the CICS system.

Figure 47 illustrates the panel produced when you use the install (INS) line action command from the STATDEF view.

Figure 47. Installing a status definition
 ----------------------- Install STATDEF for EYUPLX01 --------------------------
 COMMAND  ===>
 
  Name            EYURST06
  Description     SSet - Probe for DB2 Appl
 
  Type            STATDEF
 
  Scope           ===>              CICS System, System Group, or Generic
  Active Period   ===>              Blank, PERIODEF, or Generic
 
 Press Enter to install Status Definition.
 Type END or CANCEL to cancel without installing.

Provide the following information:

Scope
Enter the specific or generic name of a CICS system or CICS system group into which the definition is to be installed. The CICS system or CICS system group must be within the CICSplex identified as the current context. If you specify a generic value, a list of valid CICS systems and CICS system groups is displayed.
Active Period
(Optional) Enter the specific or generic name of an existing period definition that identifies the range of hours during which the status definition is to be active. If you specify a generic value, a list of valid period definitions is displayed.

Press Enter to install the definition in the designated CICS systems.

For an installation to succeed, the CICS system must be running and real-time analysis must be active. The status definition becomes active either:

The status definition remains active as long as the CICS system is running, until you discard it, or until the time designated by an associated period definition is reached.

To discard a status definition installed in a CICS system, use the RTAACTV view as described in Table 3.

[[ Contents Previous Page | Next Page Index ]]