Alarm Conditions specify the events that you might want to know about and manage as soon as they occur, such as if a Host or Solution is unresponsive. Genesys software contains predefined Alarm Conditions, or you can create your own.
Alarm Conditions work with the following Scripts:
- Alarm Detection Scripts, which identify what system variables the Management Layer must monitor to trigger an alarm.
- Alarm Reaction Scripts, which identify what the Management Layer must do when alarms occur in, or are cleared from, the system. Alarm Reaction Scripts that identify what happens when alarms are cleared are referred to as alarm Clearance Scripts.
To create an Alarm Condition script, see Scripts. To associate Alarm Detection and Alarm Reaction Scripts with Alarm Conditions, specify them in the tabs of the Alarm Condition.
The Alarm Conditions list shows the Alarm Conditions that are in your environment. It is sorted in a hierarchy by tenants, configuration units, sites, and folders. To view objects by a particular hierarchy, select the hierarchy type in the drop-down menu above the list.
Configuration Manager respects tenancy permission settings. You can access only those objects that you have been granted permissions and privileges to access.
You can filter the contents of this list in two ways:
- Type the name or partial name of an object in the Quick Filter field.
- Click the cube icon to open the Tenant Directory filter panel. In this panel, click the Tenant that you want to select. Use the Quick Filter field in this panel to filter the Tenant list.
To select or de-select multiple objects at once, click Select.
To create a new Alarm Condition object, click New. To view or edit details of an existing object, click the name of the object, or click the check box beside an object and click Edit. To delete one or more objects, click the check box beside the object(s) in the list and click Delete. You can also delete individual objects by clicking on the object and then clicking Delete. Otherwise, click More to perform the following tasks:
- Clone—Copy an Alarm Condition.
- Move To—Move an Alarm Condition to another hierarchical structure.
- Enable or disable Alarm Conditions
- Create a folder, configuration unit, or site. See Object Hierarchy for more information.
Creating Alarm Condition Objects
- Click New.
- Enter the following information. For some fields, you can either enter the name of a value or click the
Browse button to select a value from a list:
- Name—The name of the Alarm Condition. You must specify a value for this property and that value must be unique within the Configuration Database.
- Description—A brief description of the Alarm Condition.
- Category—The category of the Alarm Condition: Critical, Major, or Minor. You must specify a value for this property.
- Detect Script—The Script that describes the logic applied to detect the alarm.
- Cancel Timeout—The amount of time, in seconds, that the Alarm Condition is registered in the Log Database, unless another event cancels it or a user clears it. When this timeout expires, the Alarm Condition is unconditionally cleared.
- Detect Log Event ID—The identifier of the event that triggers the alarm. You must specify a value for this property.
- Detect Selection—The mode for event selection that the Management Layer uses for Alarm Condition analysis. The modes are as follows:
- Select By Any—The specified event from any application results in an alarm.
- Select By Application—The specified event from a selected application results in an alarm. Select this option to display the Application field. Click the Browse icon to select an item from a list, or type the name or partial name of the item in the Quick Filter field. The list is populated with Application objects that are stored in Configuration Server.
- Select By Application Type—The specified event from a selected application type results in an alarm. Select this option to display the Type field. Click the drop-down button to select an item from the list. The list is populated with Application objects that have defined subtypes.
- Cancel Log Event ID—The identifier of the event that triggers clearance of the alarm. For alarm clearance, the Management Layer uses the event from the same application(s) as specified for the detect event for this Alarm Condition.
- Tenant—In a multi-tenant environment, the Tenant to which this object belongs. This value is automatically set to the Tenant that was specified in the Tenant Directory field in the object list.
- State Enabled—If selected, indicates that the object is in regular operating condition and can be used without any restrictions.
- Click Save.
Once the object has been created, you can edit the object and click the Reaction Scripts or Clearance Scripts tabs to assign scripts to the Alarm Condition. See Scripts for more information.
Testing Alarm Conditions
- In the Alarm Conditions list, click the check box beside one or more Alarm Conditions that you want to test.
- Click More and select Activate Alarm.
- The Alarm Condition activates. Go to the System Dashboard to view the Alarm and clear it.
Genesys provides the predefined Alarm Conditions listed in the following table. If required, you can further configure these conditions to meet your requirements.
|Application Failure||Reports that the specified application has either terminated or stopped responding.|
|Connection Failure||Reports that the specified connection between any two applications has been lost.|
|CTI Link Failure||Reports that the connection between the specified T-Server and its switch has been lost.|
|Host Inaccessible||Reports that the Management Layer cannot contact the Local Control Agent (LCA) on the host where Genesys daemon applications are running. LCA is not started, or it is listening on a port other than the one specified in the configuration. A condition of Host Inaccessible is also referred to as being Down.|
|Licensing Error||Reports that a licensing error has occurred.|
|Service Unavailable||Reports that a Genesys component cannot provide service for some internal reasons.|
|Host Unavailable||Reports that a host where Genesys daemon applications are running is unavailable (turned off).|
|Host Unreachable||Reports that the Management Layer cannot reach the host where Genesys daemon applications are running (no route to the host).|
|Unplanned Solution Status Change||Reports that the status of a Solution has changed from Started to Pending, but without any requests to stop the Solution. This may indicate a failure of one of the Solution components.|
|Message Server Loss of Database Connection||Reports that Message Server has lost connection to the Centralized Log Database.|
For more information about predefined Alarm Conditions, see the Management Layer User's Guide.
You can customize the Subject line and body of an Alarm Reaction email by creating a template, using plain text, and any of the following reserved variables that represent the specific information about the alarm:
|$REACT_NAME||The name of the Alarm Reaction.|
|$COND_ID||The Alarm Condition ID.|
|$COND_NAME||The name of the Alarm Condition.|
|$COND_CTGR||The category of the Alarm Condition.|
|$APP_ID||The Application ID.|
|$APP_NAME||The name of the Application.|
|$APP_TYPE||The Application type.|
|$MSG_ID||The Message ID.|
|$MSG_DESCR||The text of the Message.|
|$$||The dollar sign character ($).|
You can then use this Alarm Reaction script as often as appropriate. For each use, the email text is automatically customized for the specific situation.
An example Alarm Reaction email uses the following template:
$COND_ID detected in $APP_NAME
CPU Overload has been detected by Genesys Solution Management Layer for Host1.
Alarm Reaction: $REACT_NAME
In the following scenario, the system detects that a CPU overload has occurred in the Solution Control Server, an alarm is triggered, and the following email is sent in response. Note how the variable names have been replaced with actual values that are appropriate to the alarm scenario.:
CPU_overload detected in Solution_Control_Server_760
CPU Overload has been detected by Genesys Solution Management Layer for Host1.
Alarm Reaction: cpu_overload_mail