Demo Discussion
Forum Config Examples Contributions Vulnerabilities
  Configuration examples for ELOG, Page 2 of 2  Not logged in ELOG logo
ID Date Author Author Emailup Category Configuration Name Last Revision
  4   Wed Feb 26 09:45:23 2003 Stefan Rittstefan.ritt@psi.chPublic LogbookForumWed Jul 14 21:49:36 2004 by Stefan Ritt
This is the configuration of the discussion forum on this server. Special 
things are:

- a guest menu so people without an account can read it
- an entry can only be edited by the original author ('restrict edit = 1')
- the author and email attributes are taken from the password file and
  cannot be changed by the author, thus to make sure who wrote a specific
  entry
- the email notification is sent to all people who registered for it, but
  their email address is not contained in the "To:" field 
  (Omit Email to = 1) so that they don't see each other's email address
  (for security reasons). For the 'from' field in the email, my address
  is used to that people can hit 'reply' on automatic notifications and
  they will reach me.
- The option "Format <attribute>" is used for a compact page display
Attachment 1: elogd.txt
[Forum]

; general options
Password file = forum.pwd
CSS = forum.css
Login expiration = 1000
Allow delete = stefan
Self register = 2
Comment = Discussion forum about ELOG
Display mode = threaded
Guest menu commands = Back, Find, Login, Help
Guest find menu commands = Find, Login, Help
Number Attachments = 1
Message comment = <img src=icons/icon6.gif> Please enter only serious messages here, for testing use the <b>Linux</b> Logbook:
Filtered browsing = 0
Entries per page = 8
Reverse sort = 1
Restrict edit = 1

; Attributes
Attributes = Icon, Author, Author Email, Category, OS, ELOG Version, Subject
Options Category = Info, Bug report, Bug fix, Question, Request, Comment, Other
IOptions Icon = icon1.gif, icon2.gif, icon3.gif, icon4.gif, icon5.gif, icon6.gif, icon7.gif, icon8.gif, icon12.gif, icon13.gif, icon14.gif
MOptions OS = Linux, Windows, Mac OSX, All, Other
Icon comment icon1.gif = Entry
Icon comment icon2.gif = Reply
Icon comment icon3.gif = Idea
Icon comment icon4.gif = Warning
Icon comment icon5.gif = Question
Icon comment icon6.gif = Cool
Icon comment icon7.gif = Smile
Icon comment icon8.gif = Angy
Icon comment icon12.gif = Blink
Icon comment icon13.gif = Disagree
Icon comment icon14.gif = Agree
Required Attributes = Author, Author Email, Subject, Icon
Subst on reply subject = Re: $subject
Thread display = $subject, posted by $author on $Entry time
Thread icon = Icon
Remove on reply = Author, Author Email
Date format = %B %d, %Y
Preset Author = $long_name
Preset Author Email = $user_email
Locked Attributes = Author
Quick filter = Date, Category

; Combine attributes into singles lines
Format Author = 1
Format Author email = 1
Format Category = 1
Format OS = 1
Format ELOG Version = 1
Format Subject = 0, subjname, subjvalue

; Email notification
Email message body = 1
Display Email recipients = 0
Omit Email to = 1
Use Email from = stefan.ritt@psi.ch
Use Email subject = ELOG Forum: "$Subject" posted by $Author
  5   Wed Feb 26 10:09:54 2003 Stefan Rittstefan.ritt@psi.chDatabase likeDemo DatabaseMon Mar 22 15:22:05 2004 by Stefan Ritt
This is the configuration of the demo database on this server. It is also 
very basic, with a few exceptions:

- no message text is used (show text = 0)
- no attachments are used (enable attachments = 0)
- in the message listing page, only certain attributes are displayed 
  (display search = ...)

This database like implementations work a bit like an Excel worksheet. 
Attributes are displayed in grid table, and one can click on the column 
titles to sort that column.
Attachment 1: elogd.txt
[Database]
Comment = Demo of database-like elog
CSS = compact.css

Attributes = Type, Operating system, Location, Status, Comment
Required Attributes = Type, Operating system, Location, Status
Options Type = PC, Router, Bridge
Options Operating system = Linux, Windows NT, Windows 2000, Windows XP, Windows ME, Embedded
Options Location = Building1, Building2, Building3
Options Status = working, defect, in repair
Quick Filter = Type, Location, Status
Display search = #, Type, Location, Status

Show text = 0
Summary lines = 0
Enable Attachments = 0
Suppress default = 2
Entries per page = 10
  6   Sat May 3 15:10:25 2003 Stefan Rittstefan.ritt@psi.chCSS FileUpdated default CSS fileMon Mar 22 15:22:21 2004 by Stefan Ritt
I made a new CSS file, which simulated 3D cells using different border 
colors for the four sides of each cell. I plan to put this as the new 
default into the distribution. There is also a new ELOG icon. If anyone 
has a better one, please post it here!

The attached test.html (elog:/3) show the different classes in the CSS 
file, thanks to Etienne Van Caille <etienne.vancaillie@mba.be>.
Attachment 1: elog.gif
elog.gif
Attachment 2: default.css
/* default formatting */
body {
  margin:3px;
  color:black;
  background-color:white;
  font-family:sans-serif;
  /* background-image:url(elog.gif); */
}

/* standard link colors and decorations */
a:link { color:#0000FF; text-decoration:none }
a:visited { color:#800080; text-decoration:none }
a:hover { color:#0000FF; text-decoration:underline }
a:active { color:#0000FF; text-decoration:underline }
a:focus { color:#0000FF; text-decoration:underline }

td {
  color:black;
  font-family:sans-serif; 
}

/* frame table */
.frame {
  width:100%;
}

/* standard formatting for logbook tabs */
.tabs {
  font-family:sans-serif;
  font-size:10pt;
  background-color:white;
}

/* unselected and selected group tabs */

.gtab a {
  background-color:#B0E0B0;
  padding-left:5px;
  padding-right:5px;
}

.gtab {
  background-color:#B0E0B0;
  border-right:1px solid #409040;
}

.sgtab a {
  color:white;
  padding-left:5px;
  padding-right:5px;
}

.sgtab {
  background-color:#486090;
  color:white;
  border-right:1px solid #084070;
}

.sgtab a:visited { color:white; } /* buf for IE */

/* unselected and selected logbook tabs */

.ltab a {
  background-color:#E0E0E0;
  padding-left:5px;
  padding-right:5px;
}

.ltab {
  background-color:#E0E0E0;
  border-right:1px solid gray;
}

.sltab a {
  background-color:#486090;
  color:white;
  padding-left:5px;
  padding-right:5px;
}

.sltab {
  background-color:#486090;
  color:white;
  border-right:1px solid #084070;
}

.sltab a:visited { color:white; } /* bug for IE */

/* logbook title, left, middle and right cell */

.title1 {
  background-color:#486090;
  border-bottom:1px solid black;
  border-top:1px solid #E0E0E0;
  border-left:1px solid #E0E0E0;
  color:white;
  font-size:medium;
  font-family:sans-serif;
  text-align:left;
}

.title2 {
  background-color:#486090;
  border-bottom:1px solid black;
  border-top:1px solid #E0E0E0;
  color:white;
  font-size:medium;
  font-family:sans-serif;
  text-align:center;
}

.title3 {
  border-bottom:1px solid black;
  border-top:1px solid #E0E0E0;
  border-right:1px solid black;
  background-color:#486090;
  text-align:right;
}

/* main menu row */

.menuframe {
  border:1px solid #486090;
  border-top:1px solid white;
  border-left:1px solid white;
  padding:3px;
  background-color:#E0E0E0;
}

.menu1 {
  text-align:left;
  font-size:10pt;
}

.menu2a {
  text-align:left;
  font-size:10pt;
}

.menu2b {
  text-align:right;
  font-size:10pt;
}

.menu3 {
  text-align:left;
  font-size:8pt;
  font-weight:bold;
}

.menu4 {
  text-align:right;
  font-size:10pt;
  vertical-align:middle;
}

/* frame table in listings */
.listframe {
  border:1px solid #0000FF;
  border-top:1px solid white;
  border-left:1pc solid white;
  background-color:#486090;
  border:0px;
}

/* title row in listing */
.listtitle {
  border:1px solid #0000FF;
  border-top:1px solid white;
  border-left:1px solid white;
  background-color:#CCCCFF;
  text-align:center;
}

/* odd and even lines in message listing */

.list1 {
  border:1px solid #308000;
  border-top:1px solid white;
  border-left:1px solid white;
  background-color:#DDEEBB;
  text-align:center;
}

.list2 {
  border:1px solid #808040;
  border-top:1px solid white;
  border-left:1px solid white;
  background-color:#FFFFB0;
  text-align:center;
}

/* attachment line */

.attachment {
  border:1px solid #808040;
  border-top:1px solid white;
  border-left:1px solid white;
  background-color:#FFFFB0;
  text-align:left;
}

/* threaded listing */
.thread {
  border:1px solid #308000;
  border-top:1px solid white;
  border-left:1px solid white;
  background-color:#DDEEBB;
  text-align:left;
}

.threadreply {
  border:1px solid #808040;
  border-top:1px solid white;
  border-left:1px solid white;
  background-color:#FFFFB0;
  text-align:left;
}

/* attribute names and values on single message page */
.attribname {
  background-color:#CCCCFF;
  border:1px solid #0000FF;
  border-top:1px solid white;
  border-left:1px solid white;
  padding:3px;
}

.attribvalue {
  border:1px solid #308000;
  border-top:1px solid white;
  border-left:1px solid white;
  background-color:#DDEEBB;
  padding:3px;
}

.attribvalue2 {
  border:1px solid #808040;
  border-top:1px solid white;
  border-left:1px solid white;
  background-color:#FFFFB0;
  padding:3px;
}

/* message cell in listing */
.messagelist {
  background-color:white;
  border-right:1px solid gray;
  border-left:1px solid gray;
  border-bottom:1px solid gray;
  font-family:'lucida console',courier,monospace;
  font-size:10pt;
  padding:5px;
}

/* message display in single message page */
.messageframe {
  background-color:white;
  border:1px solid #486090;
  border-top:0px;
  padding:3px;
}

.messagepre {
  font-family:'lucida console',courier,monospace;
  font-size:10pt;
}

/* attachment size */
.bytes {
  font-family:'lucida console',courier,monospace;
  font-size:10pt;
}

/* summary display (threaded mode expand) */
.summary {
  border:1px solid black;
  border-top:1px solid white;
  border-left:1px solid white;
  background-color:white;
  font-family:'lucida console',courier,monospace;
  font-size:8pt;
}

/* input forms */
.form1 {
  border:1px solid #308000;
  border-top:1px solid white;
  border-left:1px solid white;
  background-color:#DDEEBB;
  padding:3px;
}

.form2 {
  border:1px solid #308000;
  border-top:1px solid white;
  border-left:1px solid white;
  background-color:#DDEEBB;
  padding:3px;
}
... 61 more lines ...
Attachment 3: test.html
  10   Mon Mar 22 15:27:07 2004 Stefan Rittstefan.ritt@psi.chDatabase likePersonal Address Book 
The attached simple elogd.cfg implements a personal address book. Since 
version 2.5.2, data can be incorporated into ELOG via the CSV format. This 
way I moved my address data from MS Outlook to ELOG.

The address book is sorted according to the attribute "LastName", and the 
EmailAddress field is converted into a "" link which can be clicked 
to start your email frontend directly. Using the CSV or XML export 
functionality, the address book contents can easily be exported to other 
programs through the "find" page.
Attachment 1: elogd.cfg
Comment = Personal Address Book
Attributes = FirstName, LastName, Company, BusinessStreet, BusinessCity, BusinessState, BusinessPostalCode, BusinessCountry, HomeStreet, HomeCity, HomeState, HomePostalCode, HomeCountry, BusinessFax, BusinessPhone, BusinessPhone2, HomePhone, HomePhone2, MobilePhone, OtherPhone, Birthday, EmailAddress, Email2Address, Notes
Find menu commands = New, Find, Select, Config, Logout, CSV Import, Help
List display = LastName, FirstName, Company, BusinessPhone, HomePhone, MobilePhone, EmailAddress
Summary lines = 0
Start page = ?sort=LastName
Display EmailAddress = <a href="$EmailAddress">$EmailAddress</a>
  1   Wed Feb 26 09:07:44 2003 Stefan Rittstefan.ritt@psi.chOtherWelcomeMon Apr 18 22:43:47 2005 by Stefan Ritt
Welcome to the "Config Examples" logbook. This database contains elogd.cfg 
examples from various users, showing how ELOG can be configured for various 
purposes. Feel free to use these configuration files as a starting point 
for your own logbook.

To enter a new configuration example, you have to register an account on 
the "Forum" logbook, then you can log in with the same username and 
password to this database.

Then you are supposed to upload your "elogd.cfg", but I suggest to first 
rename it locally to "elogd.txt" and then upload it. This way it gets 
automatically displayed below the message body, so people can see the 
message body and the contents of the configuration file at the same time.

If you want to revise your entry at a later time, hit 'edit', delete your 
old attachment, and submit your new 'elogd.txt' file.
  9   Mon Feb 16 21:10:18 2004 Stefan Rittstefan.ritt@psi.chDatabase likeVisitor registrationTue Feb 17 09:41:07 2004 by Stefan Ritt
This configuration example shows a few of the newly developed advanced 
options. We use it at our institute as a visitor registration database. 
Before someone from our collaboration visits the institute, she/he has to 
register on this public logbook.

Following advanced functionality is used:

- The arrival and departure dates are attributes of type "date". This way 
a visitor can select the date from the date picker. In addition, the 
entries can be sorted according to the arrival date. Using a quick filter 
on arrival date, one can show the new arrivals for the next week, next 
month and so on. By adding a bookmark to the browser in the form

http://server.domain/Visitor%20Registration/?Arrival+date=7

one can click on that bookmark to see who will come in the upcoming week. 
Using the find page, one can query the database for arbitrary arrival and 
departure dates, like "who was here last year between May and July?".

- The "visitor" and "email" attributes are preset with the name and email 
of the current user. Of course every user has to register on that logbook 
(enabled with "self register = 2")

- The attribute "Home Institute" can be chosen from a list of preset 
institutes. Using the home institute as a conditional attribute, the elogd 
server fills in automatically the fax number of the institute (see the 
list {1},{2}, ...) after it has been selected.

- Email notifications are set up such that on each new registration, an 
email is sent to stefan.ritt@psi.ch, and an email is sent to 
radiation@psi.ch if the check box "Radiation badge" is checked. Please 
change the smtp server host name to make email notifications work.

elog:/1 shows an example entry screen.
Attachment 1: visit.gif
visit.gif
Attachment 2: elogd.cfg
[global]
logbook tabs = 0
port = 80
smtp host = <your.smtp.host>

[Visitor Registration]
Comment = Please register here if you want to visit PSI

; Access control
Password file = passwd
Self register = 2
Admin user = stefan

; Attributes
Attributes = Visitor, Email, Home Institute, Arrival date, Departure date, Home Address, FAX number
Preset Visitor = $long_name
Preset Email = $user_email
Preset Radiation badge = 0
Options Home Institute = INFN Pisa{1}, INFN Genova{2}, INFN Pavia{3}, INFN Lecce{4}, Univ. of Tokyo{5}, KEK{6}, Osaka Univ.{7}, Waseda Univ.{8}, Budker Institute{9}, Other{10}
Options Radiation badge = boolean
Required Attributes = Home Institute, Arrival date, Departure date
Type Arrival date = date
Type Departure date = date

Comment Radiation badge = Check if you need a temporary radiation badge (visit the experimental hall)
Comment Home Address = Enter home institute address only if this is your first visit to PSI
Comment FAX number = Please supply always your institute's fax number

Quick filter = Home Institute, Arrival date, Departure date

; institue faxes
{1} Preset Fax number = +39 050 2214 317
{2} Preset Fax number = +39 010 3133 58
{3} Preset Fax number = +39 0382 423241 
{4} Preset Fax number = +39 0832 325128
{5} Preset Fax number = +81 3 3814 8806 
{6} Preset Fax number = +81 298 64 2580 
{7} Preset Fax number = +81 ...
{8} Preset Fax number = +81 3 3203 4379
{9} Preset Fax number = +7 383 2 342 163
{10} Preset Fax number = +xx xxx xxxx xxx

; flags
Message comment = <i>Optional comment:</i>
List display = Visitor, Home Institute, Arrival date, Departure date, Radiation badge
Summary lines = 0
Message Height = 10
Message Width = 50
Enable Attachments = 0
HTML default = 2
Suppress default = 2
Resubmit default = 2
Last Submission = $date by $Visitor
Date format = %a, %d %b %Y

; email
Use Email subject = Visit of $Visitor from $Home Institute on $Arrival date
Use Email heading = A new visitor will arrive at PSI for the MEG experiment:
Use Email heading edit = An old visitor registration has been updated:
Suppress email to users = 1
Email all = stefan.ritt@psi.ch
Email "Radiation badge" 1 = radiation@psi.ch
Email format = 11
  11   Wed May 19 00:03:48 2004 Stefan Rittstefan.ritt@psi.chPublic LogbookExample for accelerator logbook 
This is a typical shift logbook, in this case for an accelerator. It
contains following features:

- public read access
- write access only for registered users
- typical attributes for shift logbook
- author and author email get automatically filled in
- no email notification
Attachment 1: elogd.cfg
[global]

; port under which server is listening
Port = 8080


[Accelerator]
Comment = Accelerator Logbook

; use user level password access
Password file = passwd
Login expiration = 1000
Admin user = ritt
Self register = 1

; look and feel
Guest menu commands = Back, Find, Login, Help
Guest find menu commands = Find, Login, Help
Date format = %B %d, %Y

; attributes
Attributes = Author, Author Email, Category, Subject
Options Category = Routine entry, Shift summary, Problem, Fix, Question, Info, Other
Extendable attributes = Category
Required Attributes = Category, Subject
Thread display = $Subject, entered by $author on $Entry date
Quick filter = Date, Category

; title as shown in the browser
Page Title = Accelerator Logbook - $subject

; preset author and email
Preset Author = $long_name
Preset Author Email = $user_email

; these attributes cannot be changed
Locked Attributes = Author, Author Email

; only author can change its own entry
Restrict edit = 1

; options for reply
Subst on reply subject = Re: $Configuration Name
Remove on reply = Author, Author Email

; No Email notification
Suppress Email to users = 1
  14   Tue Jul 11 09:10:44 2006 Stefan Rittstefan.ritt@psi.chPersonal Logbookwebmouse 

Arno Teunisse wrote:
There is only one disadvantage: it's very slow in stating up. Has this to do with the large listings I've included into the configutation file , or is there something wrong in my config file.?


This has to do with the extensive use of conditional attributes. It has been reported by someone else recently and there is a fix: Just upgrade to Version 2.6.1-7 (SVN revision 1696). Also read the note about List conditions in the documentation.
  16   Tue Jul 11 10:38:44 2006 Stefan Rittstefan.ritt@psi.chPersonal Logbookwebmouse 

Arno Teunisse wrote:
I'm running version SVN 1695 ( which is the latest ) on windows. SVN 1696 is not available for this Operating System.


It is. Just use Version 2.6.2 which I released just now.
  18   Thu Jul 13 15:13:04 2006 Stefan Rittstefan.ritt@psi.chPersonal Logbookwebmouse 

Arno Teunisse wrote:
Have some problem with elog. But using verion 2.6.2 revision 1699 , No matter the option : List conditions = 1
The Floor options will not be displayed.


This does not have anything to do with List conditions but with a bug I introduced in 1696. I fixed it now in 1702. I will soon make a 2.6.2-2 containing that fix.
ELOG V3.1.5-fe60aaf