/Customscript ODB tree: Difference between revisions

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See /CustomScript on the ODB keys page for the new documentation about the /CustomScript ODB keys.

@@ Line 1: / Line 1: @@
+The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/reference/reference/odb_keys/#customscript /CustomScript] on the ODB keys page for the new documentation about the /CustomScript ODB keys.
-==== Links ====
-<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
-* [[Online Database]]
-* [[mhttpd]] custom page
-* [[/Script ODB tree]]
-* [[ODB]]
-</div>
-== Purpose  ==
-The optional  <span style="color:purple; font-style:italic">/Customscript</span> ODB tree provides the user with a way to execute a script when a button on a [[mhttpd]] custom page is clicked, including the capability of passing parameters from the ODB to the user-written script. This tree is similar to the [[/Script ODB tree]].
-== Creating the /Customscript tree ==
-The <span style="color:purple; font-style:italic">/Customscript</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">/Customscript</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">/Customscript</span> , then any key <span style="color:purple; font-style:italic">/Customscript/<button name></span> created in this tree will appear as a '''''customscript-button''''' named ''<button name>'' on a [[mhttpd]] custom page that contains suitable code - see [[Custom pages]].
-Each subtree  <span style="color:purple; font-style:italic">/Customscript/<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 ''customscript-button'' is pressed. Any further keys will be passed as arguments to the script. MIDAS symbolic links are permitted.
-== Example /Customscript tree ==
-The example below shows the ODB  <span style="color:purple; font-style:italic">/Customscript/DAC</span> subtree. The presence of the <span style="color:purple; font-style:italic">DAC</span> subtree will cause the system to created a ''customscript-button'' labelled ''DAC'' on a [[mhttpd]] custom page that contains suitable code.
-This is identical to the [[/Script ODB tree#Example /Script tree|Example /Script tree]] except for the tree name (<span style="color:purple; font-style:italic">/Customscript</span> rather than <span style="color:purple; font-style:italic">/Script</span>).
-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 "/customscript/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 ''customscript-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]]

/Customscript ODB tree: Difference between revisions

Latest revision as of 22:00, 30 October 2026

Navigation menu

Search