Network Eagle Checks

Script Check

General information

This check can execute a user-defined script (usually, VB Script or Java Script), where the user can define his own script code to perform some checks or even operations. It is up to the user to decide what situation is bad and what situation is good. You should specify its startup function. This function will be called each time the check starts and the result of this function will be the result of the check. If it returns false, null, undefined etc., the check is considered failed, otherwise the check is considered successful.

Please, note that we cannot control your script and you can block the checking process in your script alert. You can use UI windows if you want and block the check by waiting for a response from the user. In other words, the script is a program and we are not responsible for any errors in your scripts.

Use the toolbar at the top of the script settings area to access special functions. You can load/save scripts perform standard clipboard operations and specify the font of the script editor (the selected font will be restored in future sessions). The Check Script button in the right part of the toolbar allows you to check the script syntax according to the chosen script language.

Status Conditions

Successful - The main user-defined function of the script check returns the result which is true. Generally, it is either true or not zero.

Failed - The main user-defined function of the script check returns the result which is false. Generally, it can be either an undefined value or zero.

Check Settings

Besides the standard properties, you should specify the following parameters for this check:

See the picture below.

Note: You can use system environment variables in the script source field. Each time before the script is executed, these environment variables will be set to their real values. Environment variables must be written in the following form: %PATH%. Also, you can use the named properties in the script source. With the help of the named properties, you can access internal properties of checks.

You can include external script files stored in your file system into the script source. To include an external file, you should use a string of the following format: %include: file-path-to-include%

See Also

About Checks