Difference between revisions of "ODB Page"

From MidasWiki
Jump to navigation Jump to search
Line 18: Line 18:
 
= Purpose =
 
= Purpose =
 
The purpose of the [[mhttpd]] ODB page is to allow the user to browse, search and edit the ODB of an experiment.  
 
The purpose of the [[mhttpd]] ODB page is to allow the user to browse, search and edit the ODB of an experiment.  
This gives a graphical alternative to using the ODB editor [[odbedit]].
+
This gives a user-friendly graphical alternative to the ODB editor [[odbedit]].
 +
 
  
 
= Access the ODB page =
 
= Access the ODB page =
Click image(s) to enlarge
+
''' Click image to enlarge'''
<br>
+
 
 
[[File:odb_page.png|thumb|left|Figure 1: ODB Page example]]
 
[[File:odb_page.png|thumb|left|Figure 1: ODB Page example]]
 +
 
The ODB Page is accessed from the [[Status Page]] (or one of the other Pages) by clicking on the  
 
The ODB Page is accessed from the [[Status Page]] (or one of the other Pages) by clicking on the  
 
menu-button{{Button|name=ODB}}.
 
menu-button{{Button|name=ODB}}.
  
 
The top level ODB trees will be visible as key-links (i.e.links to a key) ([[#Example ODB Page|Figure 1]]).  
 
The top level ODB trees will be visible as key-links (i.e.links to a key) ([[#Example ODB Page|Figure 1]]).  
 +
The ODB Page is largely self-explanatory. However, a brief description of its functionality and [[#Limitations|limitations]] is given below.
  
 
;Note
 
;Note
Line 37: Line 40:
 
= Browse the ODB =
 
= Browse the ODB =
 
<div id="Figure 2"></div>
 
<div id="Figure 2"></div>
[[File:odb_page_list.png|thumb|left|Figure 2: ODB Page Listing]]
+
{|  style="text-align: left; width: 100%; background-color: rgb(255, 255, 255);" border="0" cellpadding="2" cellspacing="2"
By clicking on the key-links on the ODB page ([[#Example ODB Page|Figure 1]]), the user can browse the various subtrees. By clicking on the "+" link adjacent to the "Value" heading ([[#Figure 2|Figure 2]]) , the type and size of the keys are shown. This is equivalent to the [[odbedit]] commands <span style="color:saddlebrown; ">ls</span> and <span style="color:saddlebrown;">ls -l</span>.
+
|+ '''Click on a thumbnail to enlarge'''
 +
|-
 +
| [[File:odb_page_list.png|thumb|left|Figure 2a: ODB Page Listing]]
 +
| [[File:odb_page_list2.png|thumb|left|Figure 2b: Expanded ODB Page Listing]]
 +
|}
 +
<br clear=all>  
  
 +
By clicking on the key-links on the ODB page ([[#Example ODB Page|Figure 1]]), the user can browse the various subtrees ([[#Figure 2|Figure 2a]]). By clicking on the "+" link adjacent to the "Value" heading ([[#Figure 2|Figure 2b]]) , the type and size of the keys are shown. This is equivalent to the [[odbedit]] commands <span style="color:saddlebrown; ">ls</span> and <span style="color:saddlebrown;">ls -l</span>.
  
<br clear=all>
+
= Change the value of an ODB key =
  
By clicking on a key, the user can change the value (unless password-protected or the key is write-protected - see [[Security]]). If web access is restricted, the user will be asked for a password the first time he/she attempts to edit a value.  
+
By clicking on a Key Value link ([[#Figure 2|Figure 2]]), the user can change the value (unless password-protected or the key is write-protected - see [[Security]]). If web access is restricted, the user will be asked for a password the first time he/she attempts to edit a value.  
  
  
= Create a key =
+
= Create an ODB key =
 
<div id="Figure 3"></div>
 
<div id="Figure 3"></div>
'''Click to enlarge thumbnails'''
+
 
 +
The user can create a new ODB key in a tree or subtree  using the [[ODB Page]] by
 +
# entering the appropriate directory (see [[#Browse the ODB]])
 +
# clicking the <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;">Create</span> button ([[#Figure 2|Figure 2]]).
 +
 
 +
This will result in a "Create ODB Entry box" pop-up (Figures 3a,3b,3d,3e).
 +
 
 +
'''Figure 3: Create an ODB Key pop-ups (click a thumbnail to enlarge)'''
 
<gallery>
 
<gallery>
File:odb_page_create.png|Figure 3a:<br> Create a key
+
File:odb_page_create.png|Figure 3a:<br> Type Integer
File:odb_create_subdir.png|Figure 3b:<br> Create a <span style="color:green">subdirectory</span>
+
File:odb_array_create1.png|Figure 3b:<br> Array  Type String
File:odb_link1.png|Figure 3c:<br> Create a <span style="color:fuchsia">symbolic link</span>
+
File:odb_array_create2.png|Figure 3c:<br> Created Keys
 +
File:odb_create_subdir.png|Figure 3d:<br> Create <span style="color:green">subdirectory</span>
 +
File:odb_link1.png|Figure 3e:<br> Create <span style="color:fuchsia">symbolic link</span>
 
</gallery>
 
</gallery>
The user can create a new key in a tree or subtree  on the ODB Page by clicking the  {{Button|name=Create}}
 
button. The '''Type''' of key to be created is selected from the drop-down list ([[#Figure 3|Figure 3]]). The choices are shown in Table 1. 
 
;Note
 
: {{Button|name=Create}} allows you to create a <span style="color:green">subdirectory</span> (Figure 3b) or a <span style="color:fuchsia">symbolic link</span> (Figure 3c) as well as a regular key (Figure 3a).
 
  
{|  style="text-align: left; width: 25%; background-color: rgb(grey); font-size:75%" border="1" cellpadding="1" cellspacing="1"  
+
 
 +
The '''Type''' of key to be created is selected from the ''Type'' drop-down list (Figure 3a). The choices are shown in Table 1 below.  Figure 3a shows the creation of a key of type '''Integer''' (32-bit). The name of the key "Number of cycles" has been filled in using the ''Name'' box. This key is not an array so the ''Array Size'' box has the default (1). The ''String size'' box will be ignored since this is a Integer key. This key is created by pressing the  {{Button|name=Create}} button on Figure 3a.  The value of the key will be set to 0 when created. This has been changed to 10 in Figure 3c by clicking on the Key Value link .
 +
 
 +
Figure 3b shows the creation of a '''String Array'''. The ''Array size'' and ''String size'' boxes are set with the desired parameters. After pressing the {{Button|name=Create}} button on Figure 3b, the resulting array is shown in Figure 3c. The values of the array elements are set to "Empty" when created. The array values can be set by clicking on the  Key Value links.
 +
 +
<div id="Table 1"></div>
 +
{|  style="text-align: centre; width: 50%; background-color: rgb(grey); font-size:75%" border="1" cellpadding="1" cellspacing="1"  
 
|+ '''Table 1:  ODB Key Types'''
 
|+ '''Table 1:  ODB Key Types'''
 
|-
 
|-
Line 86: Line 107:
 
|}
 
|}
 
<br clear=all>  
 
<br clear=all>  
= Delete a key =
+
 
 +
== Create a subdirectory or symbolic link  ==
 +
 
 +
You can create a <span style="color:green">subdirectory</span> [[#Figure 3|Figure 3d]] or a <span style="color:fuchsia">symbolic link</span> (Figure 3e) in the same way as creating a regular key (Figure 3a)
 +
by selecting <span style="color:green">subdirectory</span> or <span style="color:fuchsia">symbolic link</span>
 +
from the ''Type'' drop-down list ([[#Table 1|Table 1]] above).
 +
 
 +
 
 +
= Delete an ODB key =
  
 
<div id="Figure 4"></div>
 
<div id="Figure 4"></div>

Revision as of 17:45, 9 July 2015


Links

Purpose

The purpose of the mhttpd ODB page is to allow the user to browse, search and edit the ODB of an experiment. This gives a user-friendly graphical alternative to the ODB editor odbedit.


Access the ODB page

Click image to enlarge

Figure 1: ODB Page example

The ODB Page is accessed from the Status Page (or one of the other Pages) by clicking on the menu-button ODB.

The top level ODB trees will be visible as key-links (i.e.links to a key) (Figure 1). The ODB Page is largely self-explanatory. However, a brief description of its functionality and limitations is given below.

Note
If "ODB" button is not present on the Status Page, it may have been suppressed.


Browse the ODB

Click on a thumbnail to enlarge
Figure 2a: ODB Page Listing
Figure 2b: Expanded ODB Page Listing


By clicking on the key-links on the ODB page (Figure 1), the user can browse the various subtrees (Figure 2a). By clicking on the "+" link adjacent to the "Value" heading (Figure 2b) , the type and size of the keys are shown. This is equivalent to the odbedit commands ls and ls -l.

Change the value of an ODB key

By clicking on a Key Value link (Figure 2), the user can change the value (unless password-protected or the key is write-protected - see Security). If web access is restricted, the user will be asked for a password the first time he/she attempts to edit a value.


Create an ODB key

The user can create a new ODB key in a tree or subtree using the ODB Page by

  1. entering the appropriate directory (see #Browse the ODB)
  2. clicking the Create button (Figure 2).

This will result in a "Create ODB Entry box" pop-up (Figures 3a,3b,3d,3e).

Figure 3: Create an ODB Key pop-ups (click a thumbnail to enlarge)


The Type of key to be created is selected from the Type drop-down list (Figure 3a). The choices are shown in Table 1 below. Figure 3a shows the creation of a key of type Integer (32-bit). The name of the key "Number of cycles" has been filled in using the Name box. This key is not an array so the Array Size box has the default (1). The String size box will be ignored since this is a Integer key. This key is created by pressing the Create button on Figure 3a. The value of the key will be set to 0 when created. This has been changed to 10 in Figure 3c by clicking on the Key Value link .

Figure 3b shows the creation of a String Array. The Array size and String size boxes are set with the desired parameters. After pressing the Create button on Figure 3b, the resulting array is shown in Figure 3c. The values of the array elements are set to "Empty" when created. The array values can be set by clicking on the Key Value links.

Table 1: ODB Key Types
Key Types
Integer(32-bit) Float (4 bytes)
String Multi-line String
Subdirectory Byte
Signed byte Character (8-bit)
Word (16-bit) Short integer(16-bit)
Double Word (32-bit) Boolean
Double float(8 Bytes) Symbolic link


Create a subdirectory or symbolic link

You can create a subdirectory Figure 3d or a symbolic link (Figure 3e) in the same way as creating a regular key (Figure 3a) by selecting subdirectory or symbolic link from the Type drop-down list (Table 1 above).


Delete an ODB key

Figure 4: ODB page Delete a key

The user can delete a key in a tree or subtree by clicking the Delete button. The user selects which to delete from a list of the keys in the subtree (e.g. Figure 4).



Search the ODB for a key

Figure 5: ODB Page Find pop-up

Click on the Find button. A pop-up (Figure 5) appears in which the user types the relevant information.



Create Elog entry

Figure 6: ODB Page Elog pop-up

An elog entry can be created easily from the ODB page by clicking the

Create Elog from this page button. A pop-up will appear for the user to fill in (Figure 6).


Limitations

The ODB Page editor supports a subset of the functionality of odbedit. For example, the ODB Page editor does not support re-ordering or renaming ODB keys. For full editing capabilities odbedit must be used.