Process Macros › SETSTATE Macro

SETSTATE Macro

The SETSTATE macro sets the actual state and the extended display attributes of a resource or service.

Parameters: SETSTATE Macro

• System Name/Version

  Identifies 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 Name

  Specifies the resource or service for which you are setting the state. The value of this field can be a variable whose value is passed to this macro by the process itself.

  This field is mandatory.

  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 of the item named in the Resource Name field.

  Entering a question mark (?) in the Resource Class field displays the Resource Class List panel from which you can select the appropriate class.

  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.

• State

  Specifies the actual state you want to set for the named resource or service.

  This field is mandatory and must contain one of the following (entered either directly or by using a variable):

  • ACTIVE
  • DEGRADED
  • FAILED
  • INACTIVE
  • STARTING
  • STOPPING
  • UNKNOWN

  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.

• Description

  Specifies the free form text that can be used to identify who has set the state or the reason for setting that state. The value in this field is displayed as part of the detailed status information, which is accessed from a monitor.

  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.

• Intensity

  Specifies the intensity of the display text and must be either HIGH or LOW. If no value is set, the default value of LOW is assumed.

• Color

  Specifies the color of the display text and must be one of BLUE, GREEN, PINK, RED, TURQUOISE, WHITE, or YELLOW. If no value is set, the default value of GREEN is assumed.

• Highlight

  Specifies the highlight used for the display text and must be one of BLINK, REVERSE, or NONE. If no value is set, the default value of NONE is assumed.

• Icon Flag

  Specifies whether the extended display color of a resource that is in the worst logical state should be used on an icon.

  If you do not want the icon to use extended display color, specify NO (the default) in this field. For example, if the resource does not require attention, transferring the color to the icon can cause an undesirable change in the icon color.

  If you want the icon to use extended display color, specify YES in this field. This setting also forces the state ranking of the resource to equal that of the FAILED logical state. The icon can thus be forced to display this resource even though it is not in the worst logical state. For example, if you rate the condition of a tape mount request very important, specify YES in the Use on Graphic Monitor? field.

• Text

  Specifies the free form extended status text that overlays the current display.

  If you do not want to change the status display, leave the field blank.

  If you want to reset the status line to normal display, type ##RESET## in this 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.

Example: SETSTATE Macro

In the following example, the SETSTATE macro is used to set the actual state and the extended display according to the parameters passed to the process that contains the macro.

 PROD----- Automation Services : SETSTATE Macro Parameter Definition -----------
 Command ===>                                                    Function=BROWSE

 .- Resource Identification ---------------------------------------------------.
 | System Name ......+                                                         |
 | Version ..........+                                                         |
 | Resource Class ...+ &CLS                                                    |
 | Resource Name ..... &NAME                                                   |
 '-----------------------------------------------------------------------------'
 .- Actual State --------------------------------------------------------------.
 | State ............ &V1      (Active, Inactive, Failed, Degraded,            |
 |                              Starting, Stopping or Unknown)                 |
 | Description ...... &REASON                                                  |
 '-----------------------------------------------------------------------------'
 .- Extended Display ----------------------------------------------------------.
 | Intensity ... LOW        (High or Low)                                      |
 | Color ....... GREEN      (Blue, Green, Pink, Red, Turquoise, White, Yellow) |
 | Highlight ... NONE       (Blink, Reverse or None)                           |
 | Icon Flag ...            (Use Attributes to change Icon color - Yes or No)  |
 |                                                                             |
 | Text ........ &EXTDISP                                                      |
 '-----------------------------------------------------------------------------'
  F1=Help      F2=Split     F3=Exit
                            F9=Swap