The following sections provide context-sensitive help information related to this feature.
Alert Rules
Use this dialog box to work with custom alert rules. To see the Alert Rule button in the Alerts dialog box, users must have a security association that includes the Administrative Management permission at the CommServe level. For information on security associations, see Security Association Overview.
The following information is displayed:
Alert Rule Name
The name of the alert rule.
Add
Click to create an alert rule.
Edit
Click to edit an alert rule.
Delete
Click to delete an alert rule.
Disable/Enable
Click to disable or enable an alert rule.
Export
Click to export an alert rule.
Import
Click to import an alert rule.
Export Alert Rules
Use this dialog box to export an alert rule.
The following information is displayed:
-
Export
Select the check box next to the alert rule that you want to export.
-
Alert Rule Name
The name of the alert rule.
-
File Name
The name used for the XML file created when the alert rule is exported.
-
Status
Indicates whether the alert rule file was exported. By default, this field is left blank.
Folder
Click Browse to navigate to a folder where you want to save the exported alert rule file.
Export
Click to export the selected alert rules.
Select All
Click to select all of the alert rules for export.
Select None
Click to clear all of the selected alert rules.
Close
Click to close the Export Alert Rules dialog box.
Import Alert Rules
Use this dialog box to import an alert rule file.
The following information is displayed:
-
Alert Rule Name
The name of the alert rule.
-
File Name
The name of the XML file selected for import.
-
Size
Size in bytes of the XML file selected for import.
-
Status
Indicates the status of the imported alert rule file. For example, the status is "Alert rule name already exists" if the file already exists. The status is "Skipped" if you attempt to import an invalid file.
Import
Click to import the selected alert rule file. You can only import one file at a time.
Close
Click to close the Import Alert Rules dialog box.
General Information
Use this page to type a name and description for the alert rule.
Alert Rule Name
Type a name for the alert rule.
Severity
Indicates the severity level of the alert rule. The following severity levels are available:
-
Critical
-
Warning
-
Information (the default value)
Description
Type a brief description for the purpose of the alert rule.
Please Specify SQL File Location or Enter SQL Query
Use this page to add the SQL query for the alert rule.
SQL Query
Type the SQL query to create the alert rule.
Import from File
Click to navigate to a script or text file that contains the SQL query to use for the alert rule.
Manage Inputs
Click to define input parameters for the SQL query.
Insert Variable
Click to add a variable to the query in the SQL Query box.
Manage Inputs
Use this dialog box to manage user input fields attached to the custom alert rule.
Add
Click to add an input.
Remove
Click to remove the selected input.
Clear
Click to clear all of the input.
Move Up
Click to move the selected input up in the sequence if you have more than one input variable. The sequence defined in the left pane of the Manage Input dialog box is the sequence users see in the add alert wizard.
Move Down
Click to move the selected input down in the sequence if you have more than one input variable. The sequence defined in the left pane of the Manage Input dialog box is the sequence users see in the add alert wizard.
Type
The variable type of the input. The available variable types are:
-
string
-
integer
-
boolean
-
date
-
dateTime
-
double
-
float
-
long
-
time
-
short
-
XML
-
Binary
-
File
-
<Other> (the CommServe entity types, for example, ClientEntity)
Display Name
The name users see in the add alert wizard. If a name is not entered, the input variable name is used.
Default
The default value prepopulates the input field in the add alert wizard. If a default value is not set, the input field is blank.
Tooltip
The text users see when they hover over the input name in the add alert wizard.
Control Type
Select the way the input is presented to users in the add alert wizard. For example, select SPINNER if the input should be presented as a spin box.
Add Inputs
Use this dialog box to add a new input to the custom alert rule.
Variable Name
Type a name for the input parameter.
Variable Type
Select a data type for the input parameter
If CV entity variable type is selected in the custom alert rule, a list of that entity is available to users.
Create as list
Select this option to store multiple variable values in a list.
Insert Variable
Use this dialog box to add a variable to the query in the SQL Query box.
Select a variable and click OK.
Please Specify Output Columns
Use this page to define output columns for the query.
The following information is displayed:
-
Column Name
The name of the output column as defined by the query. This field can be modified without changing the query.
-
Data Type
The data type of the output column. This field can be modified by selecting a different data type from the list. The CommServe specific data types (Client, Application Type, Instance, Backup Set, and Subclient) are used to create an alert to filter the entities on which the alert criteria are run.
-
Display Name
By default this field is the same as the Column Name. This field can be modified if required.
-
Filter Support
Selected by default. Selecting this option enables the output column parameter to be used to filter the entities on which to run the alert criteria.
-
Primary Key
Select to use the output column to uniquely identify a row.
-
Column included in Alert
Select to include the information in this column in the alert.
-
Alert Recipient
Select the checkbox for the column that contain the email address to receive the alert notification. Then, the software dynamically sends individual alerts to the email addresses.
Add
Click to add a column.
Edit
Click to edit the details of an output column.
Delete
Click to delete an output column.
Up/Down
Click to move the output column up or down in the sequence.
Refresh
Click to automatically populate the output column table.
Add/Edit Column
Column Name
The name of the column.
Column Datatype
Select a data type for the column.
Column Friendly Name
Type a user friendly name for the Column.
Filter Support
Select this option to enable filtering of entities on which to run the alert criteria when creating an alert.
Primary Key
Select this option to use the column to uniquely identify a row.
Column included in Alert
Select this option to include the column out in the alert.
How Often To Run This Query
Use this page to schedule how often the query should run.
Every
Select this option to run the query every n minutes or n hours.
Daily
Select this option to run the query on a daily basis. Choose the start time and the interval, in days, at which you want the query to repeat.
Weekly
Select this option to run the query on a weekly basis. You can run the query every n number of weeks on the selected days of the week.
Options
Click to select advanced scheduling options. For information on the advanced scheduling options, see Advanced Schedule Options.
Monitor CommCells
Allow CommCell association at alert level
The option to allow users to select the CommCells associated with the alert when the alert rule is used in the Alert Wizard. If this option is selected, the Entities Selection page is available in the Alert Wizard. If this option is cleared, the Entities Selection page is not available in the Alert Wizard.
List of available entities
If the Allow CommCell association at alert level option is cleared, select the CommCells to associate with the alert rule.
Security Details
Use this page to select which users can use the custom alert rule to create an alert in the Alert Wizard.
User and Group Names
Displays the names of the users and user groups who can use this alert rule to create an alert.
Add
Click to select which users and user groups can use the custom alert rule to create an alert in the Alert Wizard.
Remove
Click to remove the selected user or user group.
Capability
Displays the capabilities that you can provide to the selected user or user group.
Save As Script
Click to open the Save As Script dialog, which allows you to save this operation and the selected options as a script file (in XML format). The script can later be executed from the Command Line Interface using qoperation execute command.
When you save an operation as a script, each option in the dialog will have a corresponding XML parameter in the script file. When executing the script, you can modify the value for any of these XML parameters as needed.
For information on the Save As Script feature, see Save as Script Overview.
Finish
Click to create the custom alert rule.