Revision as of 18:10, 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

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

This will result in a "Create ODB Entry box" pop-up (Figure 3).

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

Figure 3a:
Create Type Integer
Figure 3b:
Create Array Type String
Figure 3c:
Created Keys

The Type of key to be created is selected from the Type drop-down list (Figure 3a). The choices are shown in Table 1.

**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

1. Create a single value or array

Figure 3a shows the creation of a key of type Integer (32-bit). The type "Integer (32-bit)" has been selected from the Type drop-down list (Table 1 above). 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. The 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 type "String" has been selected from the Type drop-down list (Table 1 above). 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.

2. Create a subdirectory or symbolic link

Create a subdirectory key in the same way as a regular key Figure 3a by selecting subdirectory from the Type drop-down list (Table 1 above). Figure 4a shows the creation of a subdirectory Edit on start in the /Experiment directory. The subdirectory is created by pressing the Create button on Figure 4a.

Create a key which is a symbolic link by selecting symbolic link from the Type drop-down list (Table 1 above). Figure 4b shows the creation of an edit-on-start parameter which is a symbolic link called "write data" . The symbolic link is created by pressing the Create button on Figure 4b. The value of this symbolic link is set to the ODB key /logger/write data in Figure 4c. The resulting link is shown in Figure 4d.

Figure 4 Creating subdirectory or symbolic link (click to enlarge thumbnails)

Figure 4a:
Create subdirectory
Figure 4b:
Create symbolic link
Figure 4c: Click on "(empty)" and fill in /logger/write data
Figure 4d: Symbolic link has been created

Delete an ODB key

Figure 5: 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 5).

Search the ODB for a key

Figure 6: ODB Page Find pop-up

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

Create Elog entry

Figure 7: 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 7).

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.

@@ Line 63: / Line 63: @@
 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).
+This will result in a "Create ODB Entry box" pop-up (Figure 3).
-'''Figure 3: Create an ODB Key pop-ups (click a thumbnail to enlarge)'''
+'''Figure 3: Create an ODB Key  (click a thumbnail to enlarge)'''
 <gallery>
 File:odb_page_create.png|Figure 3a:<br> Create Type Integer
@@ Line 106: / Line 106: @@
 == 1. Create a single value or array  ==
-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 3|Figure 3a]] shows the creation of a key of type '''Integer''' (32-bit). The type "Integer (32-bit)"
+has been selected from the ''Type'' drop-down list ([[#Table 1|Table 1]] above).
+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. The 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.
+[[#Figure 3|Figure 3b]] shows the creation of a '''String Array'''. The type "String"
+has been selected from the ''Type'' drop-down list ([[#Table 1|Table 1]] above).
+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.
 == 2. Create a subdirectory or symbolic link  ==
-Create a <span style="color:green">subdirectory</span> [[#Figure 4|Figure 4a]] or a <span style="color:fuchsia">symbolic link</span> (Figure 4b) in the same way as creating a regular key (Figure 3a)
+Create a <span style="color:green">subdirectory</span> key in the same way as a regular key [[#Figure 3|Figure 3a]] by selecting <span style="color:green">subdirectory</span> from the ''Type'' drop-down list ([[#Table 1|Table 1]] above). [[#Figure 4|Figure 4a]] shows the creation of
-by selecting <span style="color:green">subdirectory</span> or <span style="color:fuchsia">symbolic link</span>
+a subdirectory {{Odbpath|path=Edit on start}} in the  {{Odbpath|path=/Experiment}} directory.
-from the ''Type'' drop-down list ([[#Table 1|Table 1]] above).
+The subdirectory is created by pressing the  {{Button|name=Create}} button on Figure 4a.
-A subdirectory "Edit on start" in the  {{Odbpath|path=/Experiment}} directory has been created in Figure 4a.
+Create a key which is a <span style="color:fuchsia">symbolic link</span> by selecting <span style="color:fuchsia">symbolic link</span>  from the ''Type'' drop-down list ([[#Table 1|Table 1]] above).
-An [[Edit-on-start Parameters|edit-on-start parameter]] which is a symbolic link called "write data" is created in Figure 4b. The value of this symbolic link is set to the ODB key {{Odbpath|path=/logger/write data}} in Figure 4c. The resulting link is shown in Figure 4d.
+Figure 4b shows the creation of
+an [[Edit-on-start Parameters|edit-on-start parameter]] which is a symbolic link called "write data" .
+The symbolic link is created by pressing the  {{Button|name=Create}} button on Figure 4b.
+The value of this symbolic link is set to the ODB key {{Odbpath|path=/logger/write data}} in Figure 4c. The resulting link is shown in Figure 4d.
 <div id="Figure 4"></div>
@@ Line 125: / Line 132: @@
 File:odb_create_subdir.png|Figure 4a:<br> Create <span style="color:green">subdirectory</span>
 File: odb_link1.png | Figure 4b: <br> Create <span style="color:fuchsia">symbolic link</span>
-File: odb_link2.png | Figure 4c: Click on "(empty)" and fill in "/logger/write data"
+File: odb_link2.png | Figure 4c: Click on "(empty)" and fill in  {{Odbpath|path=/logger/write data}}
 File: odb_link3.png | Figure 4d: Symbolic link has been created
 </gallery>

ODB Page: Difference between revisions