AlmColor

Description: This statement changes the alarm message colors as displayed by AlmList, and sets the descriptor text for the alarm level.

Returns: Nothing

Usage: Script or Steady State

Format: AlmColor(Level, Description, NormalF, NormalB, ActiveF, ActiveB, AckF, AckB, DisableF, DisableB)

Parameters: Level { numeric } { required } { no default: }

Any numeric expression specifying the alarm level. The alarm level is generally used to assign a priority to the alarm message. The valid alarm levels are 0 to 15 inclusive. The defaults for the Level descriptions are:

Level	Meaning
0	Information
1	Caution
2	Warning
3	CRITICAL
4	Urgent
5	Urgent
6	Urgent
7	Urgent
8	Urgent
9	Urgent
10	Urgent
11	Urgent
12	Urgent
13	Urgent
14	Urgent
15	Urgent

Description { text } { required } { no default: }

A text expression giving the description of the alarm level (e.g. Critical, Warning, Urgent, etc.).

NormalF { numeric } { required } { no default: }

Any numeric expression giving the number for the foreground color for the alarm normal message.

NormalB { numeric } { required } { no default: }

Any numeric expression giving the number for the background color for the alarm normal message.

ActiveF { numeric } { required } { no default: }

Any numeric expression giving the number for the foreground color for the alarm message when the alarm is triggered.

ActiveB { numeric } { required } { no default: }

Any numeric expression giving the number for the background color for the alarm message when the alarm is triggered.

AckF { numeric } { required } { no default: }

Any numeric expression giving the number for the foreground color for the alarm message when the alarm is acknowledged.

AckB { numeric } { required } { no default: }

Any numeric expression giving the number for the background color for the alarm message when the alarm is acknowledged.

DisableF { numeric } { required } { no default: }

Any numeric expression giving the number for the foreground color for the alarm message when the alarm is disabled.

DisableB { numeric } { required } { no default: }

Any numeric expression giving the number for the background color for the alarm message when the alarm is disabled.

Comments: If the AlmColor statement is not used, the default values for level description and colors are used. The default values for alarm colors for all levels are:

Parameter	Color Index	Color
NormalF	12	Light red
NormalB	0	Black
ActiveF	10	Light green
ActiveB	0	Black
AckF	14	Yellow
AckB	0	Black
DisableF	11	Light cyan
DisableB	0	Black

Example:

AlmColor(7 { Priority level },

"Meltdown" { Level name },

12 { Lt red }, 0 { Black } { Normal },

10 { Lt green }, 0 { Black } { Active },

14 { Yellow }, 0 { Black } { Acknowledged },

0 { Black }, 4 { Dk red } { Disabled });

The example above sets the priority level name for priority level 7 to "Meltdown", and changes the colors for disabled alarms to black foreground with red background.