DocumentationScript
The Script widget can be used to run, show the status, check the history of a script.
To use the script widget a user requires operator role or above.
Settings
Setting | Description |
|---|---|
Script id | The script to use in this widget |
Title | A Title to show on the widget (defaulted to script’s name) |
Show last run status | Flag to show or hide the status of the last script run or run configuration |
Select run configuration to show | Allows users to customize which run configurations appear when showing the script status |
Include full history | Makes the full history of the script accessible from the widget (by clicking on the lightbulb or the title) |
Show latest job output | Shows the output of the latest Job in the widget |
Show code blocks only | Only include <markdown> and <html> tagged blocks in the output of the widget. |
Runnable | Enables running the script from the widget |
Use source file | Enables dropping / selecting source file to attach to script run |
Allow override Run Config | Enables the user to override the defaulte Run Configuration defined in the Widget Settings |
Last Run Status
If Show last run status flag is set to true, the last run of the script is shown with customizable details (Creation time, user and duration) in the widget.
If multiple run configurations are selected, the icon would get the worst case of all runs shown.
Output
If the Show latest job output flag is ticked, the output of the latest run will be shown in the Widget.
Output can be of three types:
Text: Simple text, including the Logs printed on the console when running the script.
HTML formatted text.
Markdown text.
Make sure to mark your output with the respective tags:
<markdown> Your markdown output here </markdown>
<html> Your HTML content here </html>
Text | Html | markdown | |
|---|---|---|---|
script’s main.py |  |  |  |
script’s output |  |  |  |
Widget’s output |  |  |  |
History Dialog
If the Include full history flag is true, clicking on the lightbulb or title will open the following history dialog.
Progress bar
If Show progress bar flag is true, and the script posts its progress information (Scripts), A progress bar is shown to track the progress of the script in the widget that got the job triggered.
Running indicator
If there is a job running currently for the selected script, an indicator will be shown on the right side of the title.
