Elog: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
(Created page with "{{Pagelinks}} = Links = <div style="column-count:3;-moz-column-count:3;-webkit-column-count:3"> * /Elog ODB tree * Elog Page * Electronic Logbook (ELOG) </div> =...")
 
(The midas documentation has moved to https://midas.triumf.ca/docs/)
Tag: Replaced
 
Line 1: Line 1:
{{Pagelinks}}
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/features/monitoring_and_control/elog/#elog-for-external elog (for external)] on the Logbook (elog) page for the new documentation about the elog utility.
 
= Links =
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* [[/Elog ODB tree]]
* [[Elog Page]]
* [[Electronic Logbook (ELOG)]]
</div>
 
== elog utility ==
This utility is for an '''External''' [[Electronic Logbook (ELOG)]] and therefore is included in the
[https://midas.psi.ch/elog/ '''Elog''' ] package rather than the MIDAS package. Therefore it is not actually a MIDAS utility, but is documented here for completeness.
 
;Note
:To send an entry to a '''Built-in''' [[Electronic Logbook (ELOG)]], use the MIDAS [[melog]] utility instead.
 
== Purpose ==
The purpose of the <span style="color:darkcyan;">''elog''</span> utility is to submit an entry to an '''External''' [[Electronic Logbook (ELOG)]].  <span style="color:darkcyan;">''elog''</span> is used to submit the full Elog entry to the specified Elog port.
 
== Arguments ==
 
    -h hostname              Name of host where elogd is running
    -p port                  Port where [[Electronic Logbook (ELOG)#Installation considerations|elogd]] is running
    [-d subdir]              Subdirectory if different from default
    -l logbook/experiment    Name of logbook or experiment
    -s                      Use SSL for communication
    [-v]                    For verbose output
    [-u username password]  Username and password to access elog
    [-f <attachment>]        (up to 50 attachments)
    -a <attribute>=<value>  (up to 50 attributes)
    [-r <id>]                Reply to existing message
    [-q]                     Quote original text on reply
    [-e <id>]                Edit existing message
    [-x]                    Suppress email notification
    [-n 0|1|2]              Encoding: 0:ELcode,1:plain,2:HTML
    -m <textfile>] | <text>
 
Arguments with blanks must be enclosed in quotes
The elog message can either be submitted on the command line, piped in like
"cat text | elog -h ... -l ... -a ..." or in a file with the -m flag.
Multiple attributes and attachments can be supplied
     
== Usage ==
 
elog -h <hostname> -p <port> -l <myexpt>  -u "<username> <pwd>" -a author=myname "my message"
 
Note:
;  the <span style="color:darkcyan;">''elog''</span> utility is part of the ELOG distribution and resides in the same directory as the elogd daemon.
 
 
By default the attributes are "Author", "Type", "System" and "Subject". The "Author" attribute has to be present in the elog command in order to successfully submit the message. If multiple attributes are required append before "text" field the full specification of the attribute. In case of multiple attachments, only one "-f" is required followed by up to 10 file names.
 
== Examples ==
    >elog -h myhost -p 8082 -l myexpt -a author=pierre "Just a elog message"
    >elog -h myhost -p 8082 -l myexpt -a author=pierre -f file2attach.txt \
                    "Just this message with an attachment"
    >elog -h myhost -p 8082 -l myexpt -a author=pierre -m file_containing_the_message.txt
    >elog -h myhost -p 8082 -l myexpt -a Author=pierre -a Type=routine -a system=general \
                    -a Subject="my test" "A full Elog message"
 
[[Category:Utilities]] [[Category:ELOG]]

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See elog (for external) on the Logbook (elog) page for the new documentation about the elog utility.

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