Difference between revisions of "/Elog ODB tree"

From MidasWiki
Jump to navigation Jump to search
m
Line 9: Line 9:
  
 
= Creating the <span style="color: purple; font-style:italic;">/Elog</span> tree =
 
= Creating the <span style="color: purple; font-style:italic;">/Elog</span> tree =
The  {{Odbpath|path=/Elog}} tree is created automatically when the <span style="color: #444444; background-color: #CCCCCC; font-style:italic;  
+
The  {{Odbpath|path=/Elog}} tree is created automatically the first time the <span style="color: #444444; background-color: #CCCCCC; font-style:italic;  
 
font-size: 90; padding:0.25em;
 
font-size: 90; padding:0.25em;
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">ELOG</span> button on the mhttpd [[Status Page]].  
+
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">ELOG</span> button on the mhttpd [[Status Page]] is pressed.
  
 
= Purpose  =
 
= Purpose  =
The ODB /Elog tree contains the information necessary to run the Elog (Electronic Logbook), which is implemented through [[Mhttpd]].
+
The ODB <span style="color: purple; font-style:italic;">/Elog</span> tree contains the information necessary to run the Elog (Electronic Logbook), which is implemented through [[Mhttpd]]. By default, the '''internal''' elog is created. If an '''external''' elog is required, it must be set up to run on a port, and the file elogd.cfg created.
 +
See [https://midas.psi.ch/elog/adminguide.html#config ELOG Administrators Guide].
  
 +
= Location of ELOG Files =
 +
By default, elog files are written into the directory path given by the ODB key
 +
[[Keys in the ODB /Logger tree#Data Dir|/Logger/Data dir]].
 +
 +
This location can be changed by use of the ODB Key [[Keys in the ODB /Logger tree#Elog Dir|/Logger/Elog dir]]. This key is optional and doesn't appear by default in the /<span style="color: purple; font-style:italic;">/Logger</span> tree, but can be created by the user if desired. If this key is present, the location of the Internal Electronic logbook (Elog) files is reassigned to the defined path.
 +
 +
If using an '''External''' Elog, the location of the files are given by the key 
  
  
 
== Examples ==
 
== Examples ==
When initially created, the <span style="color: purple;">''/Experiment''</span> tree contains the following keys:
+
=== Example 1 ===
 +
When initially created (see [[#Creating the /Elog tree#above]] the <span style="color: purple;">''/Experiment''</span> tree contains the following keys:
 
  [local:midas:S]/>ls -lrt /elog
 
  [local:midas:S]/>ls -lrt /elog
  
Key name                        Type    #Val  Size  Last Opn Mode Value
+
Key name                        Type    #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
+
---------------------------------------------------------------------------
Elog                            DIR
+
Elog                            DIR
 
     Display run number          BOOL    1    4    17m  0  RWD  y
 
     Display run number          BOOL    1    4    17m  0  RWD  y
 
     Allow delete                BOOL    1    4    17m  0  RWD  n
 
     Allow delete                BOOL    1    4    17m  0  RWD  n
Line 32: Line 41:
 
                                         [2]            7d
 
                                         [2]            7d
 
    
 
    
 +
=== Example 2 ===
 +
Creating a New message (by clicking on 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;">New</span>  button
 +
on the [[Elog Page]] results in the full /Elog tree being created, i.e.
 +
 +
[local:test:S]/>ls -lrt /elog
 +
Key name                        Type    #Val  Size  Last Opn Mode Value
 +
---------------------------------------------------------------------------
 +
Elog                            DIR
 +
    Display run number          BOOL    1    4    13m  0  RWD  y
 +
    Allow delete                BOOL    1    4    13m  0  RWD  n
 +
    Buttons                    STRING  3    32    13m  0  RWD
 +
                                        [0]            8h
 +
                                        [1]            24h
 +
                                        [2]            7d
 +
    Types                      STRING  20    32    9m  0  RWD
 +
                                        [0]            Routine
 +
                                        [1]            Shift summary
 +
                                        [2]            Minor error
 +
                                        [3]            Severe error
 +
                                        [4]            Fix
 +
                                        [5]            Question
 +
                                        [6]            Info
 +
                                        [7]            Modification
 +
                                        [8]            Reply
 +
                                        [9]            Alarm
 +
                                        [10]            Test
 +
                                        [11]            Other
 +
                                        [12]
 +
                                        [13]
 +
                                        [14]
 +
                                        [15]
 +
                                        [16]
 +
                                        [17]
 +
                                        [18]
 +
                                        [19]
 +
    Systems                    STRING  20    32    9m  0  RWD
 +
                                        [0]            General
 +
                                        [1]            DAQ
 +
                                        [2]            Detector
 +
                                        [3]            Electronics
 +
                                        [4]            Target
 +
                                        [5]            Beamline
 +
                                        [6]
 +
                                        [7]
 +
                                        [8]
 +
                                        [9]
 +
                                        [10]
 +
                                        [11]
 +
                                        [12]
 +
                                        [13]
 +
                                        [14]
 +
                                        [15]
 +
                                        [16]
 +
                                        [17]
 +
                                        [18]
 +
                                        [19]
 +
    Host name                  STRING  1    256  9m  0  RWD  dasdevpc2.triumf.ca
 +
 +
=== Example 3 ===
 +
The user can optionally add keys so that email is sent to users when messages with particular Type or System are created, e.g.
 +
 +
    Email Severe error          STRING  1    32    57s  0  RWD  midas@triumf.ca
 +
    Email DAQ                  STRING  1    32    28s  0  RWD  abe.triumf.ca, cal@triumf.ca
 +
    SMTP host                  STRING  1    32    53m  0  RWD  localhost
 +
 +
=== Example 4 ===
 +
If running an '''External''' elog, the following keys will be added
 +
 +
    Url                        STRING  1    64    >99d 0  RWD  http://isdaq60.triumf.ca:8089/BNMRonline/
 +
    Logbook Dir                STRING  1    64    >99d 0  RWD  /data1/elog/logbook/
 +
 +
 +
== Keys in <span style="color: purple;">''/Elog''</span> tree==
 +
 +
The keys in the ODB <span style="color: purple;">''/Elog tree''</span>
 +
are described in the following sections.
 +
 +
=== <span style="color: purple;">''Display Run number ''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' BOOL
 +
* '''Default:'''  y
 +
</div>
 +
This key in the [[#top|/Elog tree]] enables/disables displaying the run number in the elog entry. Set to 'y' when the tree is created.
 +
 +
<br>
 +
--------
 +
<br>
 +
 +
=== <span style="color: purple;">''Allow delete ''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' BOOL
 +
* '''Default:'''  n
 +
</div>
 +
This key in the [[#top|/Elog tree]] enables/disables deleting an elog entry. Set to 'n' when the tree is created.
 +
 +
<br>
 +
--------
 +
<br>
 +
 +
=== <span style="color: purple;">''Buttons''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING ARRAY
 +
* '''Default:'''  8h 24h 7d
 +
</div>
 +
This key in the [[#top|/Elog tree]] causes buttons to be created on the [[Elog Page]] to permits the user to easily recall Elog messages for up to four possible time spans. The example above shows that all messages in the last 8 hours, 24 hours, or 7 days can be recalled by pressing the appropriate button.
 +
<br>
 +
--------
 +
<br>
 +
 +
 +
=== <span style="color: purple;">''Types''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING ARRAY
 +
* '''Default:'''  Routine,Shift summary,Minor error,Severe error,Fix,Question,Info,Modification,Reply,Alarm,Test,Other
 +
</div>
 +
This key in the [[#top|/Elog tree]] causes a drop-down list of message '''Types''' to be created on the [[Elog Page]]. The user must select one of these message '''Types''' when he/she creates a message. The message types can be customized, or more can be added, by editing the <span style="color: purple;">''Types''</span> key.
 +
 +
<br>
 +
--------
 +
<br>
 +
 +
=== <span style="color: purple;">''Systems''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING ARRAY
 +
* '''Default:'''    General,DAQ,Detector,Electronics,Target,Beamline
 +
</div>
 +
This key in the [[#top|/Elog tree]] causes a drop-down list of '''Systems''' to be created on the [[Elog Page]]. The user must select one of these '''Systems''' when he/she creates a message. The '''Systems''' can be customized, or more can be added, by editing the <span style="color: purple;">''Systems''</span> key.
 +
 +
<br>
 +
--------
 +
<br>
 +
 +
=== <span style="color: purple;">''Host name''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING
 +
* '''Default:'''  e.g. myhost.triumf.ca
 +
</div>
 +
This key in the [[#top|/Elog tree]] contains the name of the host machine. It is created and filled automatically when the elog tree is created.
 +
<br>
 +
--------
 +
<br>
 +
 +
=== <span style="color: purple;">''SMTP host''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING
 +
* '''Default:'''  localhost
 +
</div>
 +
This optional key in the [[#top|/Elog tree]] contains the name of the SMTP host machine for sending out email. It must be created and filled by the user if any email is to be sent out apprising user(s) of new Elog messages.
 +
<br>
 +
--------
 +
<br>
 +
 +
=== <span style="color: purple;">''Email [XXX]''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING
 +
* '''Default:'''  email address(es) of user(s)
 +
</div>
 +
These optional keys in the [[#top|/Elog tree]] are created if email is to be sent out when a new ELOG message for a particular '''Type''' or '''System''' is created.  The '''Type''' or '''System''' name must appear in the [[#Type|Type]] or [[#System|System]] array defined by the keys
 +
 +
For example, if keys "Email Severe error" and "Email DAQ" are created
 +
containing suitable email addresses  (as in [[#Example 3|example 3]]) , email containing the new elog entry will be sent to the appropriate address(es) automatically if the new message is of either Type="Severe error" or System="DAQ".
 +
 +
 +
<br>
 +
--------
 +
<br>
 +
 +
=== <span style="color: purple;">''Url''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING
 +
* '''Default:''' 
 +
</div>
 +
This optional key in the [[#top|/Elog tree]] contains the URL of the host machine that is running the '''External''' elog. It is created and filled by the user (see [[#Example 4|example 4]]).
 +
 +
If using an '''Internal''' Elog, this key is not present.
 +
 +
 +
<br>
 +
--------
 +
<br>
 +
 +
=== <span style="color: purple;">''Logbook Dir''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING
 +
* '''Default:''' 
 +
</div>
 +
This optional key in the [[#top|/Elog tree]] contains the path of a directory to contain the elog files when running the '''External''' elog. It is created and filled by the user (see [[#Example 4|example 4]]).
  
 +
If using an '''Internal''' Elog, this key is not present.
  
 +
 +
<br>
 +
--------
 +
<br>
  
  
 
[[Category:ODB Tree]]
 
[[Category:ODB Tree]]

Revision as of 17:04, 24 June 2015


Links

Creating the /Elog tree

The /Elog tree is created automatically the first time the ELOG button on the mhttpd Status Page is pressed.

Purpose

The ODB /Elog tree contains the information necessary to run the Elog (Electronic Logbook), which is implemented through Mhttpd. By default, the internal elog is created. If an external elog is required, it must be set up to run on a port, and the file elogd.cfg created. See ELOG Administrators Guide.

Location of ELOG Files

By default, elog files are written into the directory path given by the ODB key /Logger/Data dir.

This location can be changed by use of the ODB Key /Logger/Elog dir. This key is optional and doesn't appear by default in the //Logger tree, but can be created by the user if desired. If this key is present, the location of the Internal Electronic logbook (Elog) files is reassigned to the defined path.

If using an External Elog, the location of the files are given by the key


Examples

Example 1

When initially created (see #Creating the /Elog tree#above the /Experiment tree contains the following keys:

[local:midas:S]/>ls -lrt /elog
Key name                        Type    #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
Elog                            DIR
   Display run number          BOOL    1     4     17m  0   RWD  y
   Allow delete                BOOL    1     4     17m  0   RWD  n
   Buttons                     STRING  3     32    17m  0   RWD
                                       [0]             8h
                                       [1]             24h
                                       [2]             7d
  

Example 2

Creating a New message (by clicking on the New button on the Elog Page results in the full /Elog tree being created, i.e.

[local:test:S]/>ls -lrt /elog
Key name                        Type    #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
Elog                            DIR
   Display run number          BOOL    1     4     13m  0   RWD  y
   Allow delete                BOOL    1     4     13m  0   RWD  n
   Buttons                     STRING  3     32    13m  0   RWD
                                       [0]             8h
                                       [1]             24h
                                       [2]             7d
   Types                       STRING  20    32    9m   0   RWD
                                       [0]             Routine
                                       [1]             Shift summary
                                       [2]             Minor error
                                       [3]             Severe error
                                       [4]             Fix
                                       [5]             Question
                                       [6]             Info
                                       [7]             Modification
                                       [8]             Reply
                                       [9]             Alarm
                                       [10]            Test
                                       [11]            Other
                                       [12]
                                       [13]
                                       [14]
                                       [15]
                                       [16]
                                       [17]
                                       [18]
                                       [19]
   Systems                     STRING  20    32    9m   0   RWD
                                       [0]             General
                                       [1]             DAQ
                                       [2]             Detector
                                       [3]             Electronics
                                       [4]             Target
                                       [5]             Beamline
                                       [6]
                                       [7]
                                       [8]
                                       [9]
                                       [10]
                                       [11]
                                       [12]
                                       [13]
                                       [14]
                                       [15]
                                       [16]
                                       [17]
                                       [18]
                                       [19]
   Host name                   STRING  1     256   9m   0   RWD  dasdevpc2.triumf.ca

Example 3

The user can optionally add keys so that email is sent to users when messages with particular Type or System are created, e.g.

   Email Severe error          STRING  1     32    57s  0   RWD  midas@triumf.ca
   Email DAQ                   STRING  1     32    28s  0   RWD  abe.triumf.ca, cal@triumf.ca
   SMTP host                   STRING  1     32    53m  0   RWD  localhost

Example 4

If running an External elog, the following keys will be added

   Url                         STRING  1     64    >99d 0   RWD  http://isdaq60.triumf.ca:8089/BNMRonline/
   Logbook Dir                 STRING  1     64    >99d 0   RWD  /data1/elog/logbook/


Keys in /Elog tree

The keys in the ODB /Elog tree are described in the following sections.

Display Run number

  • Type: BOOL
  • Default: y

This key in the /Elog tree enables/disables displaying the run number in the elog entry. Set to 'y' when the tree is created.




Allow delete

  • Type: BOOL
  • Default: n

This key in the /Elog tree enables/disables deleting an elog entry. Set to 'n' when the tree is created.




Buttons

  • Type: STRING ARRAY
  • Default: 8h 24h 7d

This key in the /Elog tree causes buttons to be created on the Elog Page to permits the user to easily recall Elog messages for up to four possible time spans. The example above shows that all messages in the last 8 hours, 24 hours, or 7 days can be recalled by pressing the appropriate button.




Types

  • Type: STRING ARRAY
  • Default: Routine,Shift summary,Minor error,Severe error,Fix,Question,Info,Modification,Reply,Alarm,Test,Other

This key in the /Elog tree causes a drop-down list of message Types to be created on the Elog Page. The user must select one of these message Types when he/she creates a message. The message types can be customized, or more can be added, by editing the Types key.




Systems

  • Type: STRING ARRAY
  • Default: General,DAQ,Detector,Electronics,Target,Beamline

This key in the /Elog tree causes a drop-down list of Systems to be created on the Elog Page. The user must select one of these Systems when he/she creates a message. The Systems can be customized, or more can be added, by editing the Systems key.




Host name

  • Type: STRING
  • Default: e.g. myhost.triumf.ca

This key in the /Elog tree contains the name of the host machine. It is created and filled automatically when the elog tree is created.



SMTP host

  • Type: STRING
  • Default: localhost

This optional key in the /Elog tree contains the name of the SMTP host machine for sending out email. It must be created and filled by the user if any email is to be sent out apprising user(s) of new Elog messages.



Email [XXX]

  • Type: STRING
  • Default: email address(es) of user(s)

These optional keys in the /Elog tree are created if email is to be sent out when a new ELOG message for a particular Type or System is created. The Type or System name must appear in the Type or System array defined by the keys

For example, if keys "Email Severe error" and "Email DAQ" are created containing suitable email addresses (as in example 3) , email containing the new elog entry will be sent to the appropriate address(es) automatically if the new message is of either Type="Severe error" or System="DAQ".





Url

  • Type: STRING
  • Default:

This optional key in the /Elog tree contains the URL of the host machine that is running the External elog. It is created and filled by the user (see example 4).

If using an Internal Elog, this key is not present.





Logbook Dir

  • Type: STRING
  • Default:

This optional key in the /Elog tree contains the path of a directory to contain the elog files when running the External elog. It is created and filled by the user (see example 4).

If using an Internal Elog, this key is not present.