RTADEF (Analysis definitions)

An analysis definition identifies the evaluations to be performed on a periodic basis and the actions to be taken should a notifiable condition occur. Examples of how to use this view can be found in Example tasks: real-time analysis.

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

   RTADEF [rtadef]

where rtadef is the specific or generic name of an analysis definition. If you omit this parameter, the resulting view, illustrated in Figure 20, includes information about all analysis definitions for the CICSplex identified as the context.

Figure 20. The RTADEF view
 27FEB2005  21:02:48 ----------- INFORMATION DISPLAY ---------------------------
 COMMAND  ===>                                                 SCROLL ===> PAGE
 CURR WIN ===> 1        ALT WIN ===>
  W1 =RTADEF============EYUPLX01=EYUPLX01=27FEB2005==21:02:48=CPSM=========10===
 CMD Name     Intv Action   Description
 --- -------- ---- -------- ------------------------------
     EYURTDLC   60 EYURTALC SSet - License
     EYURTD01  300 EYURTA01 SSet - All connections
     EYURTD02  300 EYURTA02 SSet - All DFHCSD files
     EYURTD16  300 EYURTA16 SSet - Empty files
     EYURTD17  300 EYURTA17 SSet - DBCTL at maxthreads
     EYURTD18  300 EYURTA18 SSet - DTR not set correctly
     EYURTD19  300 EYURTA19 SSet - Monitoring inactive
     EYURTD20  300 EYURTA20 SSet - DSA free space %
     EYURTD21  300 EYURTA21 SSet - Outstanding EVENTs
     EYURTD22  300 EYURTA22 SSet - Dumps suppressed
 

Action commands

Table 13 summarizes the action commands you can use with the RTADEF view.

Table 13. RTADEF view action commands
Primary command Line command Description
n/a ADD Add an association between an analysis definition and an analysis group, as described in topic Adding an association to an analysis group.
n/a AIN Install an analysis definition in an analysis point specification, as described in topic Installing an analysis definition into an analysis point specification.
n/a BRO Browse an analysis definition in the data repository.

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

CREate CRE Create an analysis definition and add it to the data repository, as described in Creating an analysis 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 an analysis definition, fields in the new view contain values to be modelled (from the existing analysis definition).

n/a INS Install an analysis definition in a CICS® system or CICS system group, as described in topic Installing an analysis 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 an analysis 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 an analysis definition in the data repository.

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

Hyperlink fields

There are no hyperlink fields on the RTADEF view.

Creating an analysis definition

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

Figure 21. Creating an analysis definition
 --------------------- Create Analysis Definition for EYUPLX01 ----------------
 COMMAND ==>
 
  Name             ===> EYURTD01
  Description      ===>
  Perform Ops      ===> NO  Perform EVALDEF operations changes (YES, NO, ALWAYS)
  Sample Interval  ===> 60  Interval between samples in seconds (1-86400)
  Action Name      ===>     Action definition name or generic
 
                         VLS    LS    LW    HW    HS   VHS
 Entry Intervals   ===> 5     5     5     5     5     5
 Exit  Intervals   ===> 2     3     1     1     1     1
 
 Evaluation expression:
 ===> EYURTE01
 ===>
 ===>
 ===>
 ===>
 ===>
 ===>
 
 Press Enter to create the Analysis 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 analysis 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.
Perform Ops
Specify YES, NO or ALWAYS to indicate whether any resource modifications are to be performed when the condition or conditions being analyzed are true.

Start of changeResource modifications are defined as part of the evaluation definitions (EVALDEFs) associated with this analysis definition (RTADEF).

YES
CICSPlex SM attempts to perform the modification when the condition described by its evaluation definition is true. CICSPlex SM attempts to perform the requested modification only once. If the modification is not successful for any reason (for example, the resource is in use or is not available, or a CICS or CICSPlex SM error occurred when the modification was requested), it is not retried. If the condition generates a CICSPlex SM event, and the modification cannot be made, the event remains displayed on the EVENT view.
NO
The modification is not performed.
ALWAYS
CICSPlex SM attempts to perform the modification when the condition described by the evaluation definition is true.
  • If the modification executes without a CICS Start of changeexception conditionEnd of change or CICSPlex SM error, and the condition generates a CICSPlex SM event, the event is cancelled. If the modification does not cause the condition to become false for any other reason (for example, the resource is in use or is not available, or the modification was not designed to modify the resource to cause a false condition), it is retried. The retry will occur at the next analysis interval, and will continue until the condition described by the evaluation definition is false.
  • If the modification executes with a CICS Start of changeexception conditionEnd of change or CICSPlex SM error, it is not retried. If the condition generates a CICSPlex SM event and the modification cannot be made, the event remains displayed on the EVENT view.
Notes:
  1. Start of changeWhen the ALWAYS option is set, the Exit Intervals option is ignored.End of change
  2. The ALWAYS option should be used where the modification string includes an expression that will cause the evaluated condition to become false, for example:
                    Resource table: LOCTRAN           
                    Evaluation    : STATUS NE ENABLED 
                    Modification  : STATUS=ENABLED                                      
    ALWAYS would work well with this example because the modification will cause the evaluation to become false. ALWAYS should not be used if that is not the case for example:
                   Resource table: LOCTRAN           
                   Evaluation    : STATUS NE ENABLED 
                   Modification  : PRIORITY=255      
    ALWAYS would not work well with this example because the modification will not cause the evaluation to become false.
  3. The actions requested in an action definition (such as events or external messages) are always performed, regardless of whether any resource modification is requested.
End of change
Sample Interval
Indicate, in seconds, the interval between samples of the specific conditions being evaluated. The definition names specified in the Evaluation Expression field identify the conditions. The value must be between 1 and 86400.
Action Name
Enter the specific or generic name of an action definition that is to be associated with this definition. An action definition, as described on topic ACTNDEF (Action definitions), indicates what is to happen when the condition or conditions being analyzed are true. If you specify a generic value, a list of valid action definitions is displayed.

If the action definition cannot be located when this analysis definition is installed in a CICS system and the designated condition or conditions become true, only CICSPlex SM event notification will occur.

Entry Intervals
Indicate the number of consecutive evaluation time periods, for each severity level, during which the designated condition or conditions must be true before any action is taken. The value must be between 1 and 9999.
Exit Intervals
Indicate the number of consecutive evaluation time periods, for each severity level, during which the designated condition or conditions must be false before any action is taken. The value must be between 1 and 9999.
Evaluation Expression
Start of changeIdentify the evaluation definition that is to be analyzed.End of change

Press Enter to add this analysis definition to the data repository.

Adding an association to an analysis group

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

Figure 22. Associating an analysis definition and an analysis group
 ------------------ Add RTADEF to Analysis Group for EYUPLX01 -----------------
 COMMAND  ===>
 
  Name                       EYURTD01
  Description                Sample definition
 
  Analysis Group       ===> EYURTG01      Analysis Group or Generic
  Active Period        ===> PRIME         Period Name or Generic
 
Press Enter to add RTADEF 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 existing analysis group. 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 analysis 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 analysis definition remains active for as long as the CICS system is running or until you discard it.

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

If the appropriate analysis group does not currently exist, you must first create the group, as described in topic Creating an analysis group. Then you can add the definition to that group, using either this action command or the action command described in topic Adding a definition to an analysis group.

To remove a definition from an analysis group, see topic Action commands.

Installing an analysis definition

You can install an analysis definition for one or more active CICS systems that are within the CICSplex identified as the context.

An analysis definition can be automatically installed for 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 23 illustrates the panel produced when you use the install (INS) line action command from the RTADEF view.

Figure 23. Installing an analysis definition
 ------------------------ Install RTADEF for EYUPLX01 --------------------------
 COMMAND  ===>
 
  Name            EYURTD01
  Description     SSet - All connections
 
  Type            RTADEF
 
  Scope           ===>              CICS System, System Group, or Generic
  Active Period   ===>              Blank, PERIODEF, or Generic
 
 Press Enter to install Analysis 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 for 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 analysis 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. Additionally, associated evaluation definitions must refer to resource tables that are supported in the target CICS system. If CICSPlex SM detects otherwise, it issues a message indicating that the definitions are not installed in those systems that do not support the specified resource table.

The analysis definition becomes active either:

The analysis 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 an analysis definition installed in a CICS system, use the RTAACTV view as described in Table 3.

Installing an analysis definition into an analysis point specification

Figure 24 illustrates the panel produced when you use the install (AIN) line action command from the RTADEF view.

Figure 24. Installing an analysis definition into an analysis point specification
 ---------------------------- Install RTADEF for EYUPLX01 ----------------------
 COMMAND  ===>
 
  Name                 EYURTD01
  Description          SSet - All connections
 
  Type                 RTADEF
 
  AP Spec Name    ===>              Active Analysis Point Spec or Generic
  Scope           ===>              CICS System, System Group, or Generic
 
 Press Enter to install Analysis Definition.
 Type END or CANCEL to cancel without installing.

Provide the following information:

AP Spec Name
Enter the specific or generic name of an analysis point specification to which this definition is to be added. If you specify a generic value, a list of valid analysis point specifications is displayed.
Scope
(Optional.) Enter the specific or generic name of a CICS system or CICS system group that is to be evaluated by the analysis point specification when processing analysis definitions. If you specify a generic value, a list of valid CICS systems and CICS system groups is displayed. If you leave this field blank, all CICS systems in the CICSplex are evaluated.

Press Enter to install the analysis definition into the analysis point specification.

If an analysis definition is associated with an evaluation definition that refers to a resource table that is not supported in the target CICS system, CICSPlex SM issues a message indicating that the definitions are not installed because the resource is not supported.

[[ Contents Previous Page | Next Page Index ]]