Difference between revisions of "/History ODB tree"

From MidasWiki
Jump to navigation Jump to search
Line 19: Line 19:
 
== Example of /History tree ==
 
== Example of /History tree ==
  
The system created the following /History tree using the  [[/Equipment ODB tree#Example of /Equipment tree|/Equipment/INFO tree]]. The history tags above are derived from the variable Names in the [[/Equipment ODB tree#Example Settings subtree|Settings subtree]].
+
The system created the following /History tree using the  [[/Equipment ODB tree#Example of /Equipment tree|/Equipment/INFO tree]]. The history tags are derived from the variable "Names" (if present) in the [[/Equipment ODB tree#Example Settings subtree|Settings subtree]].  [[History System#History drivers|MIDAS-history]] is selected.  
  
[local:pol:S]/History>ls -lr
+
[local:pol:S]/History>ls -lr
Key name                        Type    #Val  Size  Last Opn Mode Value
+
Key name                        Type    #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
+
---------------------------------------------------------------------------
History                        DIR
+
History                        DIR
 
     LoggerHistoryChannel        STRING  1    32    24h  0  RWD
 
     LoggerHistoryChannel        STRING  1    32    24h  0  RWD
 
     DisableTags                BOOL    1    4    1h  0  RWD  n
 
     DisableTags                BOOL    1    4    1h  0  RWD  n
Line 108: Line 108:
 
</div>  
 
</div>  
  
This key in the [[#top|/History ODB tree]] selects the '''channel''' in the [[Keys in the ODB /Logger/History subtree|/Logger/History subtree]] to be used for saving the History data.
+
This key in the [[#top|/History ODB tree]] selects the '''channel''' ( or [[Keys in the ODB /Logger/History subtree#Example|''<history-logging-channel>'']] ) in the [[Keys in the ODB /Logger/History subtree|/Logger/History subtree]] to be used for saving the History data.
See also [[History System#Three ways history saved|History System]]. If  <span style="color:purple; font-style:italic">LoggerHistoryChannel</span> is blank, the first  
+
This <history-logging-channel> determines the  [[History System#History drivers|history driver]] to be used for saving the history data, selected by the contents of the  <span style="color:purple; font-style:italic">Type</span> key in the [[Keys in the ODB /Logger/History subtree|/Logger/History/<history-channel>/ subtree]].  
 +
 
 +
If  <span style="color:purple; font-style:italic">LoggerHistoryChannel</span> is blank, the first  
 
[[Keys in the ODB /Logger/History subtree|active channel]] will be used.
 
[[Keys in the ODB /Logger/History subtree|active channel]] will be used.
  
Line 119: Line 121:
 
</div>  
 
</div>  
  
This key is only used for [[Keys in the ODB /Logger/History subtree#/Logger/History/0/Type|"MIDAS" type]] history, and is not used by the  ODBC or SQLITE history.
+
This key is only used for [[Keys in the ODB /Logger/History subtree#/Logger/History/0/Type|MIDAS-history]], and is not used by the  ODBC or SQLITE history.
  
 
Set this key in the [[#top|/History ODB tree]] to "y" if reading the history tags directly from the history files. Set to "n" to read the history tags from the ODB.  
 
Set this key in the [[#top|/History ODB tree]] to "y" if reading the history tags directly from the history files. Set to "n" to read the history tags from the ODB.  
Line 201: Line 203:
 
</div>  
 
</div>  
  
This subtree in the  [[#top|/History ODB tree]] is created by [[mlogger]]. If an equipment named "Trigger" is present, mlogger creates
+
This subtree in the  [[#top|/History ODB tree]] is created by [[mlogger]]. It is used for [[History System#Types of History Events|Virtual History Events]].
  
  
Line 253: Line 255:
 
</div>  
 
</div>  
  
This subtree in the  [[#top|/History ODB tree]] is used for private data storage for the [[Keys in the ODB /Logger/History subtree#/Logger/History/0/Type|"MIDAS" type]] history, and is not used by the  ODBC or SQLITE history.
+
This subtree in the  [[#top|/History ODB tree]] is used by the system for private data storage for the [[Keys in the ODB /Logger/History subtree#/Logger/History/0/Type|MIDAS-history]] with new-style tags, and is not used for ODBC-history or SQLITE-history (see [[History System#History drivers|history drivers). This subtree will be deleted for MIDAS-history with old-style tags.
 +
 
  
If MIDAS history is enabled, and the Equipment key [[/Equipment ODB tree#Log history]] is set for one or more Equipments, this subtree is created by [[mlogger]].
+
If MIDAS-history is enabled, and the Equipment key [[/Equipment ODB tree#Log history]] is set for one or more Equipments, this subtree is created by [[mlogger]].
 
It contains history tags created by [[mlogger]] for each equipment set to [[/Equipment ODB tree#Log history]]. If the global
 
It contains history tags created by [[mlogger]] for each equipment set to [[/Equipment ODB tree#Log history]]. If the global
 
[[Keys in the ODB /Logger/History subtree#/Logger/History/0/PerVariableHistory|PerVariableHistory]] key is set or the   
 
[[Keys in the ODB /Logger/History subtree#/Logger/History/0/PerVariableHistory|PerVariableHistory]] key is set or the   
Line 264: Line 267:
 
<br>
 
<br>
  
The contents of the event will then be completely copied into the history files, using the definition of the event as tag names for every element of the event.
+
The contents of the event will then be completely copied into the MIDAS-history files, using the definition of the event as tag names for every element of the event.
  
  
Line 274: Line 277:
 
</div>  
 
</div>  
  
This subtree in the  [[#top|/History ODB tree]] contains parameters used to control the History panels display. It contains a subtree for each defined [[History panel]].  
+
This subtree in the  [[#top|/History ODB tree]] is created by the Midas web server [[mhttpd]] when the History button on the main status page is pressed.
 +
It contains parameters used to control the History panels display on the [[mhttpd]] history page. It contains a subtree for each defined [[History panel]].  
  
  
Line 310: Line 314:
 
== <span style="color:purple; font-style:italic">Events</span> subtree ==
 
== <span style="color:purple; font-style:italic">Events</span> subtree ==
 
This subtree in the  [[#top|/History tree]]
 
This subtree in the  [[#top|/History tree]]
contains private data storage for the [[Keys in the ODB /Logger/History subtree#/Logger/History/0/Type|"MIDAS" type]] history, and is not used by the  ODBC or SQLITE history.
+
contains private data storage for the [[Keys in the ODB /Logger/History subtree#/Logger/History/0/Type|MIDAS-history]], and is not used by the  ODBC-history or SQLITE-history (see [[History System#History drivers|history drivers).
  
 
<br>
 
<br>

Revision as of 15:58, 18 June 2014

Links

Purpose

The ODB /History tree contains information related to the History System.

Creating the /History tree

The /History ODB tree is created by mlogger.



Example of /History tree

The system created the following /History tree using the /Equipment/INFO tree. The history tags are derived from the variable "Names" (if present) in the Settings subtree. MIDAS-history is selected.

[local:pol:S]/History>ls -lr
Key name                        Type    #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
History                         DIR
   LoggerHistoryChannel        STRING  1     32    24h  0   RWD
   DisableTags                 BOOL    1     4     1h   0   RWD  n
   Display                     DIR
       Default                 DIR
           Trigger rate        DIR
               Variables       STRING  2     64    1h   0   RWD
                                       [0]             System:Trigger per sec.
                                       [1]             System:Trigger kB per sec.
               Time Scale      STRING  1     32    1h   0   RWD  1h
               Factor          FLOAT   2     4     1h   0   RWD
                                       [0]             1
                                       [1]             1
               Offset          FLOAT   2     4     1h   0   RWD
                                       [0]             0
                                       [1]             0
               Timescale       STRING  1     32    1h   0   RWD  1h
               Zero ylow       BOOL    1     4     1h   0   RWD  y
               Show run markersBOOL    1     4     1h   0   RWD  y
               Log axis        BOOL    1     4     24h  0   RWD  n
               Show values     BOOL    1     4     24h  0   RWD  n
               Sort vars       BOOL    1     4     24h  0   RWD  n
               Show old vars   BOOL    1     4     24h  0   RWD  n
               Minimum         FLOAT   1     4     24h  0   RWD  -inf
               Maximum         FLOAT   1     4     24h  0   RWD  inf
   Links                       DIR
       System                  DIR
           Trigger per sec. -> /Equipment/Trigger/Statistics/Events per sec.
                               DOUBLE  1     8     16h  1   RWD  0
           Trigger kB per sec. -> /Equipment/Trigger/Statistics/kBytes per sec.
                               DOUBLE  1     8     16h  1   RWD  0
   Events                      DIR
       101                     STRING  1     7     1h   0   RWD  System
       0                       STRING  1     16    24h  0   RWD  Run transitions
       3                       STRING  1     5     24h  0   RWD  INFO
   Tags                        DIR
       101                     STRING  3     96    1h   0   RWD
                                       [0]             System
                                       [1]             10[1] Trigger per sec.
                                       [2]             10[1] Trigger kB per sec.
       0                       STRING  3     96    1h   0   RWD
                                       [0]             Run transitions
                                       [1]             6[1] State
                                       [2]             6[1] Run number
       3                       STRING  25    96    24h  0   RWD
                                       [0]             INFO
                                       [1]             9[1] Data still buffered
                                       [2]             9[1] Num SIS LNE events
                                       [3]             9[1] LNE count from SIS
                                       [4]             9[1] LNE preset value
                                       [5]             9[1] number of bins
                                       [6]             9[1] data bytes code
                                       [7]             9[1] num enabled channels
                                       [8]             9[1] discard first bin
                                       [9]             9[1] discard first cycle
                                       [10]            9[1] not used
                                       [11]            9[1] Scan type code
                                       [12]            9[1] Number good cycles
                                       [13]            9[1] Number supercycles
                                       [14]            9[1] Cycle num within supercycle
                                       [15]            9[1] Sweep number
                                       [16]            9[1] Num cycles skipped
                                       [17]            9[1] Num cycles histogrammed
                                       [18]            9[1] DAC Increment number
                                       [19]            9[1] DAC Set Value (volts)
                                       [20]            9[1] DAC Readback (volts)
                                       [21]            10[1] SC Sum ch17
                                       [22]            10[1] SC Sum ch18
                                       [23]            10[1] SC Sum ch19
                                       [24]            10[1] SC Sum ch20
   Display Settings            DIR
       Width Gropup            STRING  1     256   24h  0   RWD  Small



Keys in the /History ODB tree

LoggerHistoryChannel

  • Type: STRING
  • Default: "0"

This key in the /History ODB tree selects the channel ( or <history-logging-channel> ) in the /Logger/History subtree to be used for saving the History data. This <history-logging-channel> determines the history driver to be used for saving the history data, selected by the contents of the Type key in the /Logger/History/<history-channel>/ subtree.

If LoggerHistoryChannel is blank, the first active channel will be used.


DisableTags

  • Type: BOOL
  • Default: "n"

This key is only used for MIDAS-history, and is not used by the ODBC or SQLITE history.

Set this key in the /History ODB tree to "y" if reading the history tags directly from the history files. Set to "n" to read the history tags from the ODB. If this key is set to "y" the /History/Tags subdirectory (if present) will be deleted.

See Note1






CreateOldTags

  • Type: BOOL
  • Default: "n"


If this key in the /History ODB tree and set to "y", it will force creation of /History/Tags subtree(s) using the old format. See [[#Note1].

This key is optional and may not be present in recent versions.






MaxDisplayEvents

  • Type: INT
  • Default: 20

This key in the /History ODB tree is used by mhttpd to set the maximum number of events displayed in the history page maybe??






MaxDisplayTags

  • Type: INT
  • Default: 20

This key in the /History ODB tree is used by mhttpd to set the maximum number of tags ??






PerVariableHistory (obsolete)

  • Type: INT
  • Default: "n"

This key in the /History ODB tree is OBSOLETE and should be deleted from the ODB if using a recent version of MIDAS. A message will be printed to this effect.

It has been replaced by PerVariableHistory.





Links subtree

  • Type: DIR

This subtree in the /History ODB tree is created by mlogger. It is used for Virtual History Events.





System subtree

  • Type: DIR

This subtree in the Links subtree is created by mlogger if an equipment named "Trigger" is present.






Trigger per sec.

  • Type: DIR

This link in the System subtree is created by mlogger if an equipment named "Trigger" is present. Trigger per sec. is linked to the key /Equipment/Trigger/Statistics/Events per sec..




Trigger kB per sec.

  • Type: DIR

This link in the System subtree is created by mlogger if an equipment named "Trigger" is present. Trigger kB per sec. is linked to the key /Equipment/Trigger/Statistics/kBytes per sec..






Tags subtree

  • Type: DIR

This subtree in the /History ODB tree is used by the system for private data storage for the MIDAS-history with new-style tags, and is not used for ODBC-history or SQLITE-history (see [[History System#History drivers|history drivers). This subtree will be deleted for MIDAS-history with old-style tags.


If MIDAS-history is enabled, and the Equipment key /Equipment ODB tree#Log history is set for one or more Equipments, this subtree is created by mlogger. It contains history tags created by mlogger for each equipment set to /Equipment ODB tree#Log history. If the global PerVariableHistory key is set or the PerVariableHistory key in the /Equipment/Settings subtree of that equipment, then tags for that Equipment will be created automatically by mlogger. The names of the tags will be taken from /Equipment/Settings/Names if present, otherwise default tag names will be created.



The contents of the event will then be completely copied into the MIDAS-history files, using the definition of the event as tag names for every element of the event.



Display subtree

  • Type: DIR

This subtree in the /History ODB tree is created by the Midas web server mhttpd when the History button on the main status page is pressed. It contains parameters used to control the History panels display on the mhttpd history page. It contains a subtree for each defined History panel.






<panel-name> subtree

  • Type: DIR

This subtree in the Display subtree is named for the panel on the mhttpd History page, and contains information to define the contents of this panel. In the example, only one panel is defined, named Default. The Default panel is created when If there is more than one panel defined, there will be other panel subtrees present with different panel names.






Trigger rate subtree

  • Type: DIR






Events subtree

This subtree in the /History tree contains private data storage for the MIDAS-history, and is not used by the ODBC-history or SQLITE-history (see [[History System#History drivers|history drivers).