/Script ODB tree: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
mNo edit summary
(The midas documentation has moved to https://midas.triumf.ca/docs/)
 
Line 1: Line 1:
{{Pagelinks}}
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/reference/reference/odb_keys/#script /Script] on the ODB keys page and [https://midas.triumf.ca/docs/develop/features/core_system/web/configuring/#script-buttons Script buttons] on the Web interface: configuring page for the new documentation about the /Script ODB keys.
 
==== Links ====
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* [[Online Database]]
* [[mhttpd]] status page
* [[#Script-button|script-button]]
* [[ODB]]
* [[/Customscript ODB tree]]
</div>
 
= Purpose  =
The optional  <span style="color:purple; font-style:italic">/Script</span> ODB tree provides the user with a way to execute a script when a button on the [[mhttpd]] [[Status Page]] is clicked, including the capability of passing parameters from the ODB to the user-written script.
 
 
= Creating the  <span style="color:purple; font-style:italic">/Script</span> tree =
The <span style="color:purple; font-style:italic">/Script</span>  ODB tree is [[ODB#Creating ODB keys|created]] by the user. This tree is optional, and the names of any keys in this tree are chosen by the user.
 
 
=  <span style="color:purple; font-style:italic"><script-name></span> key or subtree =
<div id="Script-button"></div>
Any key created in the <span style="color:purple; font-style:italic">/Script</span> tree will appear as a '''''script-button'''''  <span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;"><script-name></span>
on the default [[mhttpd]] [[Status Page]].
 
;Either
: The key can contain the name and path of the script to be executed when the script-button is pressed, e.g.
      [local:midas:S]>ls /script
      Stop Now      odbedit -c 'stop now'
      Tune X40      /home/midas/perl/tunes.sh tune X40
: In this case, two script-buttons would appear on the [[Status Page]], i.e. <span style="color: #444444; background-color: #CCCCCC;  font-style:italic; font-size: 90; padding:0.25em;padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">Stop Now</span> and <span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">Tune X40</span>,
<br>
; or
: the key may be a '''subtree''', in which case the first key in the subtree must contain the name and path of the script to be
: executed. Any further keys in the subtree contain parameters (which may include links) to be passed as arguments to the script, e.g.
      [local:midas:S]>ls "/script/change mode"
      cmd                            /home/midas/online/perl/change_mode.pl
      include path                    /home/midas/online/perl
      experiment name -> /experiment/name
                                      test_exp
      select mode -> /experiment/edit on start/select mode                   
                                      1h
      mode file tag                  none
:In this case, one script-button would be created, i.e.  <span style="color: #444444; background-color: #CCCCCC; font-style:italic; :font-size: 90; padding:0.25em;padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">change mode</span>. Pressing this button would result in the script "change_mode.pl" executed with the following key contents as parameters, equivalent to the command:
      /home/pol/online/perl/change_mode.pl  /home/pol/online/perl pol 1h mode
 
[[Category:ODB Tree]]

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See /Script on the ODB keys page and Script buttons on the Web interface: configuring page for the new documentation about the /Script ODB keys.

Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=/Script_ODB_tree&oldid=3660"