/Script ODB tree: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
(The midas documentation has moved to https://midas.triumf.ca/docs/)
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
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
* [[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 /Script tree ==
The <span style="color:purple; font-style:italic">/Script</span>  ODB tree is created by the user. This tree is optional, and apart from the tree name <span style="color:purple; font-style:italic">/Script</span>,  names of any keys in this tree are chosen by the user.
 
If the user [[ODB#Creating ODB keys|creates a new ODB tree]] named <span style="color:purple; font-style:italic">/Script</span> , then any key <span style="color:purple; font-style:italic">/Script/<button name></span> created in this tree will appear as a '''''script-button''''' named ''<button name>'' on the default [[mhttpd]] status page. Each subtree  <span style="color:purple; font-style:italic">/Script/<button name>/</span> should contain at least one key which contains the path and name of the script. This key should be the first in the list of keys in the subtree, and will be used to execute the script when the ''script-button'' is pressed. Any further keys will be passed as arguments to the script. MIDAS symbolic links are permitted.
 
== Example /Script tree ==
 
The example below shows the ODB <span style="color:purple; font-style:italic">/Script/DAC</span> subtree. The presence of the <span style="color:purple; font-style:italic">DAC</span> subtree will cause the system to created a ''script-button'' labelled ''DAC'' on the [[mhttpd]] status page.
 
The first key in the <span style="color:purple; font-style:italic">DAC</span> subtree is the key <span style="color:purple; font-style:italic">cmd</span> which contains the name and path of the script to be executed (in this case, a perl script). This script is located on the local host computer on which the experiment is running. The subsequent keys are parameters input to the script. The key <span style="color:purple; font-style:italic">experiment name</span> is a soft-link to the ODB key  <span style="color:purple; font-style:italic">/experiment/name</span>.
 
[local:pol:R]/>ls "/script/DAC"
cmd                            /home/pol/online/perl/change_mode.pl
include path                    /home/pol/online/perl
experiment name -> /experiment/name
                                pol
select mode                    1h
mode file tag                  none
[local:pol:R]/> 
 
When the ''script-button'' "DAC" is pressed, the script "change_mode.pl" will be 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"