Documentation forKiwi Syslog Server

Create a scheduled task to run a script

This documentation is for legacy Kiwi Syslog Server versions 9.8.3 and older.

Create a Run Script task to run a script. You can schedule the task to run at regular intervals.

For information about writing scripts to use with Kiwi Syslog Server, see Scripting resources.

  1. From the Kiwi Syslog Service Manager, choose File > Setup.

  2. In the left pane of the Setup dialog, right-click Schedules and select Add new schedule.

  3. Replace the default name with a descriptive name.

  4. As the Task Type, select Run Program.
  5. As the Task Trigger, specify when you want the archive task to run:
    • To schedule the task, select On a schedule. Then specify the start date, frequency, end date, and any exceptions on the Schedule tab.
    • To run the task each time you start or stop the Kiwi Syslog Server application or service, select On app/service startup or On app/service shutdown.

  6. On the Program Options tab, complete the following fields:

    Script file name

    Enter the path and file name of an existing script file or of the file to be created.
    Script description Describe the purpose or function of the script.
    Script language

    Select the scripting language.

    Windows Script provides two script engine languages, Visual Basic Scripting Edition and Microsoft JScript.

    Both languages offer similar functionality and speed, so the choice on which to use is up to personal preference. However, SolarWinds recommends the use of JScript if your script is performing mainly string manipulation. JScript appears to perform faster during string manipulation in most cases.

    It is also possible to use additional scripting languages, such as Perl or Python. To use one of the following languages, you must install the Active Scripting engine for that language:

    • PerlScript
    • Python

      Python extensions for Microsoft Windows includes access to the Win32 API. For more information see the Python for Windows Extension website (© 2018 Python Software Foundation, available at https://pypi.org/, obtained on December 20, 2018).

      Disclaimer: Please note, any content posted herein is provided as a suggestion or recommendation to you for your internal use. This is not part of the SolarWinds software or documentation that you purchased from SolarWinds, and the information set forth herein may come from third parties. Your organization should internally review and assess to what extent, if any, such custom scripts or recommendations will be incorporated into your environment. You elect to use third party content at your own risk, and you will be solely responsible for the incorporation of the same, if any.

    • RubyScript
    Field Read/Write permissions

    Select the groups of fields that Kiwi Syslog Server can access:

    • When you grant read access to a group of fields, their values are copied into the script variables and are readable from within the script.
    • When you grant write access to a group of fields, their values are copied from the script variables and will replace the equivalent program fields.

    Each time a script runs, the available message fields are copied to the script variables and back again upon completion of the script. The copying takes time and uses CPU cycles. To improve script performance, SolarWinds recommends granting read and write access only to the variables used in the script.

    For more information about the fields in each group, see Script variables.

  7. To email or save the report generated each time the clean-up task runs, select one or more options on the Run Program Notification tab.

    • To email the report to multiple recipients, separate the list of email addresses by commas or semicolons.
    • If you save the report to a file, insert date and time variables in the file name to ensure that it is unique. If the file name is not unique, Kiwi Syslog Server overwrites the existing file when it creates a new file.
  8. Click Apply to save your changes.