Process Macros › GETSTAT Macro

GETSTAT Macro

The GETSTAT macro discovers the status of a resource or service.

Parameters: GETSTAT Macro

System Name/Version

Identify the system image that owns the resource. If you do not specify an image, then during execution, the macro uses the following values:

• If the macro is associated with a resource definition, the macro uses the image that owns the definition.
• If the macro is not associated with a resource definition (for example, in an EventView rule), the macro uses the active local image.

Note: You can specify a variable name in this field (for example, &VALUE) that resolves if passed as a parameter to this macro when executed.

Resource Class

Specifies the class name of the resource or service for which you require the status. This field can be completed manually, by entering the appropriate valid code, or automatically, by selecting a value from the prompted field value list. The list is displayed by entering ? in the Resource Class field.

Note: You can specify a variable name in this field (for example, &VALUE) that resolves if passed as a parameter to this macro when executed.

Resource Name

Specifies the name of the resource or service for which you want to retrieve the status.

Note: You can specify a variable name in this field (for example, &VALUE) that resolves if passed as a parameter to this macro when executed.

Variable Prefix

Specifies the prefix of the variables that contain the retrieved status information. This prefix enables you to store the status information retrieved at different times in different variables.

The information is retrieved from the &ZRMST prefixed status variables. The retrieved information is stored in a corresponding set of variables, with the ZRMST prefix replaced by the specified prefix, prefix. For example, the information retrieved from the &ZRMSTACTSTAT variable is stored in the &prefixACTSTAT variable.

The prefix must not start with one of the following characters: # or $.

User Keywords

Enables you to store the keyword that is specified in the User Defined Keyword field on the Define Extended Display Attribute panel of a triggered message rule in a resource definition. The keyword is stored in the &prefixUSRKEYW variable.

Example: GETSTAT Macro

In the following example, the GETSTAT macro retrieves the status of the STC class resource TCPA into variables of the form &ZRMST*.

 PROD----- Automation Services : GETSTAT MACRO Parameter Definition ------------
 Command ===>                                                    Function=BROWSE

 .- Getstate Key Definition ---------------------------------------------------.
 |                                                                             |
 |  System Name .............+                                                 |
 |  Version .................+                                                 |
 |  Resource Class...........+ STC                                             |
 |  Resource Name ............ TCPA                                            |
 |                                                                             |
 ’-----------------------------------------------------------------------------’
 .-----------------------------------------------------------------------------.
 |                                                                             |
 |  Variable Prefix........... ZRMST                                           |
 |                                                                             |
 |  User Keywords ............ NO            (YES/NO)                          |
 |                                                                             |
 ’-----------------------------------------------------------------------------’




  F1=Help      F2=Split     F3=Exit
                            F9=Swap