Documentation/Scripts/Adding Scripts
From ScriptRunner
Revision as of 23:20, 13 July 2020 by Shaun.mccreery (talk | contribs) (Created page with " ''' Documentation :: Scripts:: Adding Scripts''' For a script to be run by ScriptRunner, either manually by a user or as part of a schedule, its location and arguments nee...")
Documentation :: Scripts:: Adding Scripts
For a script to be run by ScriptRunner, either manually by a user or as part of a schedule, its location and arguments need to be defined first. Although we refer to scripts throughout, ScriptRunner can run any desired executable that doesn't need to launch a graphical window.
Adding a New Script
- From the menu, select Manage Scripts.
- Click
.
- The Create Script window should now be shown.
- Name: A descriptive name to give your script to reference it in other areas of ScriptRunner.
- Description: A further description of your script, shown to users when selecting scripts to run.
- Group: When scripts are displayed in ScriptRunner they are often grouped together. This selects the group the script resides within.
- Host: Select the host the script should run on. See Script Hosts for more information.
- Script Locatoin: The full path of the script or application you wish to execute.
- Maximum Return Code: The highest return code allowed to be returned by the script for it to accepted as successfully running. A return code higher than this value will mark the running of the script as 'ERROR' on completion, and trigger notifications of a failure if scheduled.
- Timeout: The amount of time a script can be executing for until a notification is raised to say it has been running too long.
- Enabled: Keep this box checked to ensure the script is visible to users. Disabled scripts will not show on the Run Scripts screen, or in any script selection boxes such as when managing scheduled scripts.
