Use the Manage Inputs button to add user input fields to an alert rule. When the alert rule is used to create an alert, users define the alert criteria in the input fields. For example, to allow users to define the number of files that can fail before an alert is triggered, add a "Number of Files Failed" input. For information on the add alert wizard, see Creating Alerts Using Custom Alert Rules.
Before You Begin
Create an alert rule. See Creating an Alert Rule.
Procedure
-
In the alert rule wizard on the Please Specify SQL File Location or Enter SQL Query page, click Manage Inputs.
-
Do one of the following:
-
Create a new input.
-
In the Manage Inputs dialog box, click Add.
-
In the Add Inputs dialog box, type a variable name for the input parameter.
The variable name cannot contain spaces.
-
Select a variable type.
Select an "entity" variable type to have a list of that entity available to users in the Alert Criteria section of the add alert wizard. For example, select WorkflowEntity as the variable type to have a list of workflows available.
-
Optional: Select Create as list to store multiple variable values in a list.
-
Click OK to add the input to the left pane of the Manage Inputs dialog box.
-
-
Select an existing input.
-
-
In the right pane of the Manage Inputs dialog box, verify the input type and, if needed, update it by selecting a new value from the Type list.
Select <Other...> to change the type to an "entity" variable type, for example, ClientEntity.
-
In the Display Name box, enter a name.
This is the name users see in the add alert wizard. If a name is not entered, the input variable name is used.
-
In the Default box, enter a value.
The default value prepopulates the input field in the add alert wizard. If a default value is not set, the input field is blank.
Notes
-
The default value for boolean input types must be entered as either true or false.
-
If values are added to the Possible Values box, only those values may be used for the Default box.
-
-
Optional: In the Tooltip box, enter the text users see when they hover over the input name in the add alert wizard.
-
From the Control Type list, select a value to define how the input field appears to users in the add alert wizard.
Note: The LISTBOX and CHECKBOX control types affect the alert notification. Use these control types to send one alert notification each time the condition is met even if multiple objects meet the condition. For example, there is a list box where users pick multiple clients. If n number of clients meet the condition, one email is sent with a list of clients, not one email per client.
The Control Type list changes depending on the input type:
Type
Control Type
string
TEXTBOX, MULTILINE, DROPDOWN, RADIOBUTTON, CHECKBOX, LISTBOX
integer
TEXTBOX, DROPDOWN, RADIOBUTTON, CHECKBOX, LISTBOX, SPINNER
double, float, long, short
TEXTBOX, DROPDOWN, RADIOBUTTON, CHECKBOX, LISTBOX
boolean
CHECKBOX
date
CALENDAR, DROPDOWN, RADIOBUTTON, CHECKBOX, LISTBOX
dateTime
DATETIME_PICKER, DROPDOWN, RADIOBUTTON, CHECKBOX, LISTBOX
time
TIME_PICKER, DROPDOWN, RADIOBUTTON, CHECKBOX, LISTBOX
XML
TEXTBOX, MULTILINE
Binary
TEXTBOX
<Other>
DROPDOWN
-
Select Optional, Required, or Read Only.
Required fields are marked with an asterisk in the add alert wizard.
-
In the Possible Values box, enter values to define the data for the following control types:
-
DROPDOWN: The possible values are listed inside the drop-down box. Users are limited to these values in the add alert wizard.
-
RADIOBUTTON: The possible values are used as labels for the radio buttons.
-
CHECKBOX: The possible values are used as labels for the check boxes. In the add alert wizard, users can select multiple possible values if Create as list was selected when the input was first added. Users can select one of the possible values if Create as list was not selected.
-
-
Click OK.
The input is automatically declared and appears in the Insert Variable dialog box.