Difference between revisions of "/Script ODB tree"

From MidasWiki
Jump to navigation Jump to search
(Created page with " ==== Links ==== <div style="column-count:3;-moz-column-count:3;-webkit-column-count:3"> * Online Database * mhttpd status page * ODB * </div> == Purpose == Th...")
 
Line 13: Line 13:
  
 
== Creating the /Script tree ==
 
== Creating the /Script tree ==
The <span style="color:purple; font-style:italic">/Script</span>  ODB tree is created by the user.
+
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.
 
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.
Line 21: Line 21:
 
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 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> (of type STRING) 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>.
+
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"
 
  [local:pol:R]/>ls "/script/DAC"

Revision as of 18:01, 30 June 2014


Links

Purpose

The optional /Script 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 /Script ODB tree is created by the user. This tree is optional, and apart from the tree name /Script, names of any keys in this tree are chosen by the user.

If the user creates a new ODB tree named /Script , then any key /Script/<button name> created in this tree will appear as a script-button named <button name> on the default mhttpd status page. Each subtree /Script/<button name>/ 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 /Script/DAC subtree. The presence of the DAC subtree will cause the system to created a script-button labelled DAC on the mhttpd status page.

The first key in the DAC subtree is the key cmd 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 experiment name is a soft-link to the ODB key /experiment/name.

[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