ODB Page: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 27: Line 27:
<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
<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;">ODB</span>.
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">ODB</span>.
The top level ODB trees will be visible as links ([[#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]]).


<div style="clear: both"></div>
<div style="clear: both"></div>
more test




<br clear=all>
= 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]]
[[File:odb_page_list.png|thumb|left|Figure 2: ODB Page Listing]]
By clicking on the links on the ODB page (e.g. [[#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 "ls" and "ls -l".  
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 "ls" and "ls -l".  




Line 53: Line 49:
The user can create a new key in a tree or subtree by clicking the  
The user can create a new key in a tree or subtree by clicking the  
<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
<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
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">Create</span> button. The '''Type''' of key to be created is selected from the drop-down list ([[#Figure 3|Figure 3]]). The choices are:
 
{|  style="text-align: left; width: 25%; background-color: rgb(grey); font-size:75%" border="1" cellpadding="1" cellspacing="1"  
 
 
The type of key is selected from the drop-down list ([[#Figure 3|Figure 3]]). The choices are
{|  style="text-align: left; width: 25%; background-color: rgb(grey);" border="3" cellpadding="2" cellspacing="2"
 
|-
|-
| colspan="1" rowspan="1" style="vertical-align: top; background-color: lightgrey; font-weight: bold;" | Key Types
| colspan="2" rowspan="1" style="vertical-align: top; background-color: lightgrey; font-weight: bold;" | Key Types
|-
|-
| Integer(32-bit)
| Integer(32-bit)
|-
| Float (4 bytes)
| Float (4 bytes)
|-  
|-  
| String
| String
|-
| Multi-line String
| Multi-line String
|-  
|-  
| Subdirectory
| Subdirectory
|-
| Byte
| Byte
|-  
|-  
| Signed byte
| Signed byte
|-
| Character (8-bit)
| Character (8-bit)
|-  
|-  
| Word (16-bit)
| Word (16-bit)
|-
| Short integer(16-bit)
| Short integer(16-bit)
|-  
|-  
| Double Word (32-bit)
| Double Word (32-bit)
|-
| Boolean
| Boolean
|-  
|-  
| Double float(8 Bytes)
| Double float(8 Bytes)
|-
| Symbolic link
| Symbolic link
|}
|}
 
<br clear=all>
= Delete a key =
= Delete a key =


Line 98: Line 82:
The user can delete a key in a tree or subtree by clicking the  
The user can delete a key in a tree or subtree by clicking the  
<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
<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;">Delete</span> button
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">Delete</span> button. The user selects which to delete from a list of the keys in the subtree (e.g. Figure 4).
 




<br clear=all>
= Search the ODB for a key =
= Search the ODB for a key =
[[File:odb_page_find.png|thumb|left|Figure 5: ODB Page Find pop-up]]
Click on the  
Click on the  
<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
<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;">Find</span>.
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">Find</span>
button. The following pop-up appears in which the user types the relevant information.
button. A pop-up (Figure 5) appears in which the user types the relevant information.


<div id="Figure 5"></div>
[[File:odb_page+find.png|ODB Page "Find" pop-up]]




= Edit the ODB ==
<br clear=all>
 
= Create Elog entry =
[[File:odb_page_elog.png|thumb|left|Figure 6: ODB Page Elog pop-up]]
An elog entry can be created easily from the ODB page by 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 Elog from this page</span> button. A pop-up will appear for the user to fill in (Figure 6).
 
<br clear=all>
 
= 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. 
 
[[Category:mhttpd]]

Revision as of 12:42, 8 August 2014

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 graphical alternative to using the ODB editor odbedit.

Access the ODB page

Figure 1: ODB Page example

The ODB Page is accessed from the Status Page (or any 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).


Browse the ODB

Figure 2: ODB Page Listing

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



Edit a key

By clicking on a key, the user can change the value (unless the user does not have write access, see Security, or the key is write-protected).

Create a key

Figure 3: ODB page Create a key

The user can create a new key in a tree or subtree by clicking the Create button. The Type of key to be created is selected from the drop-down list (Figure 3). The choices are:

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


Delete a 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.