ODB Page: 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/)
Tag: Replaced
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Pagelinks}}
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/reference/reference/web_pages/#odb-page ODB page] in Built-in web pages and [https://midas.triumf.ca/docs/develop/features/core_system/odb/#web-interface Web interface] in ODB: overview for the new documentation about the ODB web page.
 
= Links =
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* [[Mhttpd|mhttpd MIDAS web server]]
* [[Status Page]]
* [[Message Page]]
* [[ODB Page]]
* [[Programs Page]]
* [[Alarms Page]]
* [[MSCB Page]]
* [[History Page]]
* [[Custom Page]]
* [[Sequencer Page]]
* [[odbedit]]
</div>
 
= 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 =
Click image(s) to enlarge
<br>
[[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
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]]).
 
;Note
:If "ODB" button is not present on the Status Page, it may have been [[Status Page#page-switch-buttons|suppressed]].
 
 
<div style="clear: both"></div>
 
= Browse the ODB =
<div id="Figure 2"></div>
[[File:odb_page_list.png|thumb|left|Figure 2: ODB Page Listing]]
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>.  
 
 
<br clear=all>
 
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.
 
 
= Create a key =
<div id="Figure 3"></div>
'''Click to enlarge thumbnails'''
<gallery>
File:odb_page_create.png|Figure 3a:<br> Create a key
File:odb_create_subdir.png|Figure 3b:<br> Create a <span style="color:green">subdirectory</span>
File:odb_link1.png|Figure 3c:<br> Create a <span style="color:fuchsia">symbolic link</span>
</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"
|+ '''Table 1:  ODB Key Types'''
|-
| colspan="2" rowspan="1" style="vertical-align: top; background-color: lightgrey; font-weight: bold;" | Key Types
|-
| Integer(32-bit)
| Float (4 bytes)
|-
| String
| Multi-line String
|-
| <span style="color:green;font-weight:bold">Subdirectory</span>
| Byte
|-
| Signed byte
| Character (8-bit)
|-
| Word (16-bit)
| Short integer(16-bit)
|-
| Double Word (32-bit)
| Boolean
|-
| Double float(8 Bytes)
| <span style="color:fuchsia; font-weight:bold">Symbolic link</span>
|}
<br clear=all>
= Delete a key =
 
<div id="Figure 4"></div>
[[File:odb_page_delete.png|thumb|left|Figure 4: ODB page Delete a key]]
The user can delete a key in a tree or subtree by clicking the  {{Button|name=Delete}}
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 =
[[File:odb_page_find.png|thumb|left|Figure 5: ODB Page Find pop-up]]
Click on the {{Button|name=Find}}
button. A pop-up (Figure 5) appears in which the user types the relevant information.
 
 
 
<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
{{Button|name=Create Elog from this page}}
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:Web server mhttpd]]
[[Category:ODB]]

Latest revision as of 22:01, 30 October 2026

The midas documentation has moved. See ODB page in Built-in web pages and Web interface in ODB: overview for the new documentation about the ODB web page.

Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=ODB_Page&oldid=3784"