The External Process Alert runs a third-party executable program or script with any required parameters. If an Alerting Credential is not defined, the Alert will use the current Windows account assigned to the ipMonitor Service.

The External Process Alert:

• Supports setting Environment Variable names and values that may be read by the executable file when it is started.
• Supports using a Credential to transmit account and password information.
• Supports passing Alert Tokens on the command line to control execution of the executable/batch file/script.
• Requires Administrator privileges to configure.

Use the External Process Alert to:

• Restart failed applications.
• Perform diagnostics.
• Back-up files.
• Execute scripts.
• Pass Failure and Recovery messages on the command line to the executable file, batch file or script.

Top of page

The Alert Parameters dialog box is used to specify the name of the executable file to run, the local or UNC path to the file and the startup directory where the executable will run.

Executable Name
Enter the file name of the application being executed. If the Alert is to call a script, enter the name of the interpreter for the type of script in question. For example, if calling a Windows Script Host script, enter: cscript.exe. The name of the script itself can then be passed as a parameter in the Failure Command Line or Recovery Command Line fields.

Directory
Enter the Local or UNC Path to the file:

• An example of a valid UNC Path is: \\ServerName\ShareName\
• An example of a Local Path is: C:\Windows\

Startup Directory
The Startup Directory is the directory where the third party executable will run.

Even though the file or script is physically located in another directory, the Startup Directory's security permissions control the behavior of the third party executable or script.

The Startup Directory must be a Fully Qualified Local File Path to the executable:

• An example of a fully qualified local file path is: C:\scripts\

Note: Any Command Line Parameters being passed must relate to the Startup Directory where the script/executable is launched, rather than to the directory where the script/executable is located.

Credential for Alerting
The External Process Alert supports using a Credential to transmit account and password information when executing an Alert. The Credential used will need to allow the following Usage Restriction:

• Windows Impersonation to start an external process

To assign a Credential:

• Click the Select button to pop up the Credentials for Alerting dialog
• Select an existing Credential from the Windows category
• To create a new Credential, click the New Credential button to start the Wizard

Note: For detailed information regarding configuration options for the External Process Alert, refer to Credentials for Alerting :: External Process.

Note: For more information regarding Credentials, refer to the section titled About Credentials.

Set Environmental Variables
When enabled, you can set Environmental Variables for use with the External Process Alert by configuring the Variable Name and Variable Value fields.

Variable Name
You can configure the External Process Alert to use an Environment Variable with the executable or script being run. To enter the name of the Environment Variable, click the Enable button.

Variable Value
Enter the expected value of the Environment Variable when the executable or script completes successfully. Multiple Environment Variables can be configured by pressing the And... button.

Note: Environment Variables allow for greater flexibility in the information that can be passed, especially when the content must contain special characters (quotations, less than or greater than symbols, etc.) or file paths.

In the Windows NT, 2000, XP and 2003 Operating Systems, Environment Variables are grouped internally into four categories:

1. SYSTEM Variables define the behavior of the global operating system environment. These apply to all users of the machine and are recorded in the Registry at: HKLM\System\CurrentControlSet\Control\Session Manager\Environment.
2. PROCESS Variables define the environment in which a process executes. These apply to the current process, and may be passed on to child processed. PROCESS variables are not stored in the Registry.
3. USER Variables are only available when the user is logged on to the machine. Local variables set in the HKEY_CURRENT_USER hive are valid only for the current user. These are recorded in the Registry at HKCU\Environment.
4. VOLATILE Variables are created during logon script execution. These apply to the current logon session and are recorded in the Registry at HKCU\VolatileEnvironment.

Note: ipMonitor is able to set only PROCESS Environment Variables to launch a script or executable via the External Process Monitor or External Process Alert.

Top of page

The External Process Alert can be configured to pass Failure Messages on the command line to the executable file, batch file or script using text and ipMonitor Alert Tokens.

Send Failure Notifications
If enabled, ipMonitor will process Failure Alerts by executing the specified application or script.

Failure Command Line
ipMonitor will execute the Alert, passing the parameters defined here to the executable or script. Text, numerical data and ipMonitor Alert Tokens are all valid content entries.

Token List
Click the Token List button to place a Token between alphanumeric characters, words, or sentences. When a Token is found, it is replaced with dynamic content.

Note: Refer to Alert Tokens for more information.

Top of page

The External Process Alert can be configured to pass Recovery Messages on the command line to the executable file, batch file or script using text and ipMonitor Alert Tokens.

Send Recovery Notifications
If enabled, ipMonitor will process Recovery Alerts by executing the specified application or script.

Recovery Command Line
ipMonitor will execute the Alert, passing the parameters defined here to the executable or script. Text, numerical data and ipMonitor Alert Tokens are all valid content entries.

Token List
Click the Token List button to place a Token between alphanumeric characters, words, or sentences. When a Token is found, it is replaced with dynamic content.

Note: Refer to Alert Tokens for more information.

Top of page

The External Process Alert can be identified within a Profile's Alerts List by the green arrow icon: .

The External Process Alert can be scheduled based on a weeklong calendar. For more information, refer to the section titled Scheduling Alerts.

For information regarding escalated (ordered) alerting, refer to Alert Escalation.

Top of page