Configuring an Alarm Detection

Create an Alarm Detection configuration by clicking the New Configuration button in the upper left part of the Desktop window, and then selecting Alarm Detection from the menu.

The Alarm Detection

Select the Workflow Alarm Value Names option to define a variable you can use in the APL code, see the APL Reference Guide.

Adding an Alarm Condition

At the bottom of the Alarm Detection configuration, click the Add button. The Add Alarm Condition dialog box opens.

The Add Alarm Condition

Select a condition in the Alarm Condition drop-down list.

Alarm Conditions

The Alarm conditions enable you to define specific situations or events for which you want the system to produce an alarm. You configure a condition to produce an alarm whenever a certain behavior occurs, within specific limits.

The Alarm Conditions that you can choose from are:

• Host Statistic Value
• Pico Instance Statistic Value

• System Event

• Unreachable Execution Context

• Workflow Alarm Value

• Workflow Execution Time

• Workflow Group Execution Time

• Workflow Throughput

Host Statistic Value

The Host Statistic Value condition enables you to setup an Alarm Detection for the various statistic values by host.

The Host Statistic Value condition

Pico Instance Statistic Value

The Pico Instance Statistic Value condition enables you to setup an Alarm Detection for the various statistic values by pico instances.

The Pico Instance Statistic Value condition

System Event

The System Event condition enables you to setup an Alarm Detection for the various Event types.

The System Event condition

Unreachable Execution Context

The Unreachable Execution Context condition enables you to setup an Alarm Detection base on selected Pico Instance, except platform.

The Unreachable Execution Context condition

Workflow Alarm Value

The Workflow Alarm Value condition is a customizable alarm condition. It enables you to have the Alarm Detection watch over a variable that you create and assign through the APL code. To apply the Workflow Alarm Condition use the following guidelines:

1. Create a variable. 

2. Assign the variable with a value.

3. Setup the Workflow Alarm Value condition.

To create a variable name:

1. From the Edit menu in the Alarm Detection configuration menu, select Workflow Alarm Value Names. The Workflow Alarm Value dialog box opens.

2. Click the Add button and enter a variable name, e g CountBillingFiles. 

3. Click OK and then close the Workflow Alarm Value dialog box.

To define the Value field:

In the APL code, include the command dispatchAlarmValue. For example:

consume { 
	dispatchAlarmValue
	("CountBillingFiles",1);
	udrRoute(input);
}

To configure the Workflow Alarm Value Condition:

1.   At the bottom of the Alarm Detection configuration, click  Add ; the Add Alarm Condition dialog box opens.
   
2.   From the Alarm Condition drop-down list select  Workflow Alarm Value .
   
3.   From the Value  drop-down list, select the name of the variable that you created.
   
4.   Click  Browse... to select the Workflow that the Alarm Detection should guard.
   
5.   Configure the Limits according to the description of The Workflow Alarm Value and click  OK .

The Workflow Alarm Value configuration

Workflow Execution Time

The Workflow Execution Time condition enables you to generate an alarm whenever the execution time of a particular, or all workflows, exceed or fall below the time limit that you specify.

The Workflow Execution Time configuration

Workflow Group Execution Time

The Workflow Group Execution Time alarm condition enables you to generate an alarm whenever the execution time of a workflow group exceeds or falls below the time limit that you specify.

The Workflow Group Execution Time configuration

Workflow Throughput

The Workflow Throughput alarm condition enables you to create an alarm if the volume-per-time processing rate of a particular workflow exceeds, or falls below, the throughput limit that you specify.

The Workflow Throughput configuration