Run Script task

The Run Script task allows you to run a Kiwi Syslog Server Run-Script.

Any Run Script task can be scheduled to occur over any interval or at any date and time desired, at application/service start-up or shutdown.

Whether a Run Script task is scheduled or not, it consists of the following two parts:

Run Script Options:

Script file name

The script file is a standard text file that contains the script commands. The file name can have any extension, but .txt is used by default for ease of editing with Notepad.

Script description

This field can contain any descriptive text you like. Its purpose is to briefly describe the function of the script

Script Language

Windows Script provides two script engines, Visual Basic® Scripting Edition and Microsoft JScript®

VBScript - A variation of Visual Basic or VBA (Visual Basic for Applications) used in MS Word and Excel. This language is easy to learn and has a rich feature set.

JScript - A variation of Java Script used in web pages. If you are familiar with Java Script then this may be your language of choice.

Both languages offer similar functionality and speed, so the choice on which to use is up to personal preference. However we have found through our tests that if your script is performing mainly string manipulation then JScript appears to be faster in most cases.

More info on VBScript can be found at:

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/script56/html/vtoriVBScript.asp

More info on JScript can be found at:

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/script56/html/js56jsoriJScript.asp

It is also possible to add additional scripting languages such as Perl or Python.

To do this you will need to install the Active Scripting engines for any new languages that you want to script in.

For information on using PerlScript please visit:

http://www.activestate.com/Products/ActivePerl

For information on using Python please visit:

http://www.activestate.com/Products/ActivePython

To download and for further information on ActiveScriptRuby please visit:

http://arton.hp.infoseek.co.jp/index.html

Field Read/Write permissions

For reasons of security and speed, access to the message/scripting variables can be restricted. Each time a script is run, the message fields are copied to the script variables and back again upon completion of the script. Because the copying takes time and uses CPU cycles, limiting the read/write access to only the variables you want to use will improve the speed of the program.

When you enable read access for a group of fields, their values will copied into the script variables and will readable from within the script.

When you enable write access for a group of fields, their values will copied from the script variables and will replace the equivalent program fields.

The fields are divided into groups based on the likelihood of usage within a script.

More details on each of the fields can be found here

Run Script Notification:

E-mail format:

The Run Script report can be generated and sent in either HTML or plain-text format.

Send Run Script Notification Report by e-mail:

If selected, an e-mail containing the Run Script report will be sent to the e-mail address specified in the "Recipient(s)" field.

Recipient(s):

Comma or semi-colon delimited list of e-mail addresses, which are to receive copies of the Run Script report.

Send Run Script Notification Report to disk:

If selected, an file containing the Run Script report will be sent to disk using the file name and path specified.