Project

General

Profile

elogsum.txt

Margherita Vittone Wiersma, 09/20/2010 11:52 AM

 
1
				M.Vittone  July 2010
2
				
3
	 Electronics logbooks "around the scientific world"..
4
	 
5
This is a summary of a web-based search on existing electronic logbooks.
6
The purpose of this investigation was to see how existing elogs
7
are deployed, which language, packages they are based on and what features they offer.
8
Many articles were read and even evaluation through some online demo was done.
9
Evaluations was done based of information retrieved from web articles and real
10
sources  mainly to see what the big experiments are currently using and compare with
11
our current CRL.
12

    
13
Common comments in articles written by elog designers and/or investigators are that 
14
many people started writing their one to fulfill needs for the experiments.
15
However, as a results of my search , main characteristic is that logbook entries
16
are stored as flat files. Only two use Oracle to store information:
17
Jlab uses Oracle to store text and pointers to attachments.
18
SNS at ORNL uses Oracle to store all the entries.
19

    
20
The electronic logbook mostly investigated are free software.
21
I also researched some commercially available. Please see at the end of the 
22
document.
23

    
24
Two main electronic logbooks are mostly used :
25

    
26
--------------------------------------------------------------------------------------------
27
1) e-logbook developed by the DOOCS team at DESY
28
   http://tesla.desy.de/doocs/elogbook/elogbook.html 
29
   
30
   It is an xml based web service for an electronic logbook
31
   Standard Apache server, JAVA servlet technology in Tomcat environment.
32
   Data is organized in a flat files.
33
   As they summarized for both serevr and cleint:
34
      
35
   Some explanations of the technology used for the logbook: 
36
   The user programs:
37

    
38
    * any program that allows to print PostScript as the source for the logbook entries 
39
    * a standard browser (e.g.Netscape) to display the logbook 
40
    * an applet for the dynamic tree view of the shifts 
41
    * an applet to do the spell checking 
42

    
43
    The server: 
44
    * a daemon (shell script) that listens to the print queues 
45
    * the UNIX file system to store the entries (one file per entry) 
46
    * Apache web server with XALAN and XERCES runnning in a tomcat engine 
47
    * JAVA servlets to create the dynamic HTML pages 
48
    * XML files to store the meta information 
49
    * XSL files to define the translation of the dynamic content into the HTML pages 
50
    * JAVA server pages are used as a further step to display dynamic content in HTML pages 
51
    * JAVA taglibs are used to take the parameters from configuration files 
52

    
53
   
54
   Demo was used.  (http://gan.desy.de/guestelog/show.jsp)
55

    
56
   Few Comments after using the demo:
57
       a) when opening the logbook, need to click on an folder to view entries.
58
       b) Not obvious how to make "new entry" from the main page.
59
          No preview before saving new entry
60
	  A new entry allows to add: text (basic), an image, send email.
61
	  At lwast from the demo it does not appear to allow attachments.
62
       c) Search is very basic, author, dates, words.
63
       d) It seems you can't add comments to an entry.
64
       e) it does have a Help guide.
65

    
66
--------------------------------------------------------------------------------------------
67

    
68
2) ELOG developed by Stefan Ritt at the Paul Scherrer Institute in Switzerland.
69
   https://midas.psi.ch/elog/
70

    
71
   A CERN, it  is used by:  CMS, LHCb
72
   ATLAS also uses with some modification, and it is called ATLOG.
73

    
74
   In England is used by Alice (not to be confised with ALICE at CERN>>)
75
   http://alice.stfc.ac.uk/elog/alicelog/
76
   ALICE (Accelerators and Lasers In Combined Experiments) is a prototype accelerator which 
77
   has been designed and built at Daresbury Laboratory. 
78
   ---
79
   ELOG is a Web application written by Stefan Ritt in C which can be used to create 
80
   personal and common logbooks. 
81
   It has been developed at the Paul Scherrer Institute originally for shift logbooks 
82
   in particle physics experiments, but is now widely used in other fields. 
83
   Besides the CERN experiments LHCb and CMS is it used on the US coastguard icebreaker 
84
   USCGC Healy and part of the Debian distribution.
85

    
86
   ELOG is licensed under the GNU General Public License as free software. 
87
   It is currently available in 13 languages.
88
   ---
89

    
90
   I looked at the source code for the server , and it is in C.
91
   All the displayed pages are html / css / javascript
92
   Logbook entries are stored as ASCII files and formatted into HTML  for display 
93
   Only forms and tables are used, no Java or Javascript is used.
94
   
95
   Demo was used.  https://midas.psi.ch/elog/Linux+Demo
96

    
97
   Few Comments after using the demo:
98

    
99
     a) Display: entries are all organized in a table. (no special graphic)
100
        Clicking on an entry it shows a detailed description.
101
	You can actually change an existing entry! which seems a little dangerous..
102
     b) New entry: text editor with HTML encoding. You can upload files.
103
	There is preview before storing the entry.
104
     c) Search: typical by author, dates, subject,text
105
     
106
     
107
=========================================================================================
108
Details now follow and also a list of other elogs which are more ad hoc for the 
109
requesting experiment and/or project.
110

    
111
=========================================================================================
112

    
113
1) e-logbook  DOOCS team at DESY  (http://tesla.desy.de/doocs/elogbook/elogbook.html)
114
       "Home of the electronic logbook (e-logbook) developed by the DOOCS team"
115
  
116
   It is an xml based web service for an electronic logbook
117
   A standard Apache server is generating dynamic content by use
118
   of JAVA servlet technology in Tomcat environment.
119
   Data is organized in a flat files hierarchical directory tree based on date ordering.
120
   Demo was used.
121
   It requires very little specific software, just Java+Apache+Tomcat combo, which is readily
122
   available in most Linux distributions. 
123

    
124
    Extract from the authors article available at:
125
    http://tesla.desy.de/doocs/papers/PCaPAC2002/PCaPAC2002-E-logbook.pdf    
126

    
127
    http://www.lnf.infn.it/conference/pcapac2002/TALK/WE-02/WE-02.pdf
128

    
129
    From the abstract:
130
    
131
    The data is stored in the today widely used XML format
132
    to allow high performance searches and also to allow interfacing
133
    with other web based services. A standard web
134
    server like Apache is generating dynamic content by use
135
    of JAVA servlet technology.
136
    
137
    From the article:
138

    
139
    REQUIREMENTS To be a good substitute for the old paper logbook version the e-LogBook 
140
      has to fulfil a number of requirements. 
141
 
142
     2.1 Simplicity First of all one must accommodate the needs of the operators .
143
         since they will be the ones who are heavily making use of the logbook. 
144
	 Since the input to this e-LogBook should be at least equally or even easier than 
145
	 it has been in the paper version, an easy to use front end  is a must. 
146
     2.2 Availability Due to the requirement for the use outside the hosting institute, the
147
        electronic version of the logbook must be available at a usual Windows, Linux, Solaris, 
148
	etc. system. There should not be any need for special "set-up" and "installation" 
149
	procedures at the guest institutes to implement the front end. 
150
     2.3 Stability Because most of the bigger accelerator facilities are running
151
         around the clock 24 hours 7 days the week such a electronic logbook has to be always available.
152
	 This gives  the e-LogBook a status of a high availability software product with all 
153
	 the know requirements. .... The core functionality provided by the e-LogBook is based 
154
	 on the internal data handling and storing by using the extensible mark-up language (XML). 
155
    
156
     6 SOFTWARE COMPONENTS 
157
       The overall structure of the e-LogBook can be divided into the classic 
158
       client- server architecture (see figure 2) and we will discuss the used
159
       software components corresponding to this classification. ...
160
       We are currently running a Apache web server[2] in combination with the 
161
       JAVA servlet engine from the Apache Jakarta project (alias "Tomcat" see [2]
162
       for details). The XML parser "Xerces" and the stylesheet processor "Xalan" are also 
163
       part of the Apache XML framework. The already mentioned pipe mechanism for the graphic 
164
       input can easily be installed on any UNIX system without additional software components. 
165
       The remaining component is the storage pool (named "Logbook folder" in figure 3). 
166
       We are currently working with a plain directory structure mapping the underlying
167
       hierarchical date ordering that is determined by the machine/ shift cycle.
168

    
169
   1.1  This is another article that refers to e-logbook taken from:
170
   
171
   http://accelconf.web.cern.ch/accelconf/ica07/PAPERS/RPPB10.PDF
172

    
173
   Proceedings of ICALEPCS07, Knoxville, Tennessee, USA
174
   USE OF E-LOGBOOK IN VEPP-5 CONTROL SYSTEM
175

    
176
   D.Yu.Bolkhovityanov.., R.E.Kuskov
177
   The Budker Institute of Nuclear Physics, Novosibirsk, Russia
178

    
179
   Abstract
180
   An electronic logbook (e-logbook) becomes a must for
181
   large experimental facilities not only during operation, but
182
   also at building and commissionning stages (where VEPP-
183
   5 is now).
184
   [G I. Budker Institute of Nuclear Physics, 
185
   Siberian Branch of Russian Academy of Sciences, Novosibirsk, Russia ]
186

    
187
    Unfortunately, the "market" of such products
188
   is almost nonexistent. So, the choice is narrow: either use
189
   some other lab.s software (adapting it for local needs) or
190
   create your own one from scratch. We have chosen the former
191
   way and picked DOOCS e-logbook from DESY. 
192
   ...
193
   .. A similar requirement had risen in other high-energy
194
   physics centers some years ago, and it got an answer -
195
   E-Logbook[2, 3], and even more advanced uses of this technology
196
   were invented[4].
197
   Since e-logbooks for control systems have narrow use,
198
   there.s no "market" of such software. While many labs
199
   create their own e-logbook software, BINP in general and
200
   VEPP-5 in particular don.t have enough manpower for this.
201
   So, we chose to adapt some other lab.s e-logbook software
202
   for our needs.
203
   We have made a brief analysis of available e-logbooks,
204
   where comparison table [5] was extremely useful (while it
205
   is dated, no newer analogues exist). Finaly, we have chosen
206
   DOOCS E-Logbook[2], due to following reasons:
207

    
208
   * It is a complete product.
209
   * It is easily available, and has a web-site where one can
210
     test it interactively.
211
   * It requires very little specific software, just
212
     Java+Apache+Tomcat combo, which is readily
213
     available in most Linux distros. And all these are free
214
     software (as opposed to e.g. JLab's E-Log, which
215
     requires Oracle).
216
   * It's code has moderate size, which allows to grok it
217
     and to tailor to our needs.
218
   * It is still maintained by original author.
219

    
220
   ...
221

    
222
   DOOCS E-Logbook is browsed via web-interface, with
223
   Java-applet used for vivid time overview. For logging, ELogbook
224
   provides 2 ways:
225
   1. Via web-form.used for manual input; this allows to
226
   input textual data with optional binary attachments.
227
   2. Via so-called "virtual printer" . this way is used by
228
   applications, which just print graphics to PostScript
229
   printer, redirected to E-Logbook.
230

    
231

    
232

    
233
   [2] "An XML based web service for an electronic logbook"
234
       www.lnf.infn.it/conference/pcapac2002/TALK/WE-02/WE-02_talk.pdf
235

    
236
   [3] "The Electronic Logbook @ the TTF VUV-FEL - Making the necxt step.
237

    
238
   [4] "Beyond an Electronic LOgbook" 
239
       http://conference.kek.jp/pcapac2005/paper/TUB4.pdf
240
   [5] Comparison of several E-logbooks
241
       http://docdb.fnal.gov/ILC/DocDB/0002/000292/005/Elogs.pdf
242
   
243

    
244

    
245
==========================================================================================
246

    
247
2)  ELOG Electronic Web Logbook  https://midas.psi.ch/elog/
248

    
249
   The ELOG server is a small stand-alone C program, which runs 
250
   under Linux and Windows. No other packages are required. 
251
   The logbooks are saved in plain ASCII files for easy and fast access.
252
   Since the ELOG daemon contains its own http server, no additional server like Apache is required. 
253
   Logbook entries are read from teh ASCII files and formatted into HTML. 
254
   Only forms and tables are used, no Java or Javascript is used.
255

    
256
   ELOG was originally developed as a shift logbook for the 
257
   PiBeta and Muegamma particle experiments at PSI.
258
   Demo was used.
259
   
260

    
261

    
262
    ELOG was originally developed as a shift logbook for the 
263
    PiBeta and Muegamma particle experiments at PSI  http://www.psi.ch/
264
    The Paul Scherrer Institute, PSI, is the largest research centre for 
265
    natural and engineering sciences within Switzerland.
266

    
267
   This from their website:
268
   {
269
   How It All Works       
270

    
271
   For the technically curious : 
272

    
273
   The concept of ELOG is very simple. The logbook functionality is implemented by a single 
274
   daemon program, elogd, which is written in C. It contains an integrated Web server, 
275
   which does not serve files like standard Web servers, but reads logbook entries from 
276
   its "database" and formats them into HTML. Since only forms and tables are used, 
277
   no Java or Javascript is necessary, which makes the logbook display very fast. 
278
   The system does not use any images on purpose to reduce the amount of data to be transferred. 
279
   Since the ELOG daemon contains its own http server, no additional server like Apache is required. 
280

    
281
   The "database" in which ELOG saves its entries is in plain ASCII format. 
282
   One file is created for each day in the form YYMMDDa.log (where YY is the year, MM the month 
283
   and DD the day). For ELOG versions 1.x.x, the format was YYMMDD.log. 
284
   ...
285
   If attachments are submitted, they are saved as separate files named YYMMDD_HHMMSS_name 
286
   - where in addition to the date the time is specified and name is the original file name 
287
   of the attachment.
288
   }
289
   -------------------------------------------------------------------------------------
290

    
291

    
292
   2.1 THis is from an article  about LHCb:
293
   
294
       The LHCb Electronic Logbook   http://lhcb-online.web.cern.ch/lhcb-online/elog/
295

    
296
    An extract from another presentation:
297
    http://lhcb-online.web.cern.ch/lhcb-online/elog/LHCbLogbook.pdf
298
    
299
    From the above paper:
300
    The LHCb Electronic Logbook
301
     Tobias Lohe
302
    University of Muenster, Germany LHCb Computing Group, CERN LHCb Team Meeting (01-Sep-2005)
303
    
304
    ....
305
    Elog in a Nutshell
306
    * Developed at Paul Scherrer Institut (PSI) by Stefan Ritt (since 2001).
307
    * Released as Open Source program under the GNU General Public License (GPL).
308
    * Single daemon program written in C, available for Linux and Windows.
309
    * It contains an integrated Web server.
310
    * The "database" consists of plain ASCII files.
311
    * Very versatile, can be adapted using the configuration file.
312
    * A command line client to submit entries is also provided.
313
    * Homepage: http://midas.psi.ch/elog
314
 
315
    Some Problems:
316
    * Elog could not be integrated with the central Web servers.
317
      I actually spent one week developing an own, alternative
318
      program (using ASP, PerlScript and the Oracle database)
319
      until the decision for Elog was made
320

    
321
    * The scalability was tested and the program did not respond
322
      sany more after it was filled with 100 000 entries.
323

    
324
    They still decided to use it and some changes were made.
325
   
326
========================================================================================
327

    
328
3)  The ALICE Electronic Logbook: A Large Ion Collider Experiment at CERN
329
    
330
    This is standalone package, couldn't look at directly because is protected.
331
    It is  web-based GUI (https://cern.ch/alice-logbook) was developed using modern web
332
    technologies, including PHP5, Javascript and Cascading Style Sheets (CSS). 
333
    It is hosted on an Apache web server.
334

    
335

    
336
    The ALICE Electronic Logbook  http://cdsweb.cern.ch/record/1269927?ln=ru
337
    From 17th International Conference on Computing in High Energy and Nuclear Physics, 
338
    Prague, Czech Republic, 21 - 27 Mar 2009, pp.022027
339
    
340
    http://iopscience.iop.org/1742-6596/219/2/022027/pdf/1742-6596_219_2_022027.pdf
341
    
342
      Abstract:
343
      
344
      All major experiments need tools that provide a way to keep a record of the events 
345
      and activities, both during commissioning and operations. 
346
      In ALICE (A Large Ion Collider Experiment) at CERN, this task is performed by the 
347
      Alice Electronic Logbook (eLogbook), a custom-made application developed and maintained 
348
      by the Data-Acquisition group (DAQ). 
349
      Started as a statistics repository, the eLogbook has evolved to become not only 
350
      a fully functional electronic logbook, but also a massive information repository 
351
      used to store the conditions and statistics of the several online systems. 
352
      It's currently used by more than 600 users in 30 different countries and it plays 
353
      an important role in the daily ALICE collaboration activities. 
354
      This paper will describe the LAMP (Linux, Apache, MySQL and PHP) based architecture 
355
      of the eLogbook, the database schema and the relevance of the information stored in 
356
      the eLogbook to the different ALICE actors, not only for near real time procedures 
357
      but also for long term data-mining and analysis. 
358
      It will also present the web interface, including the different used technologies, 
359
      the implemented security measures and the current main features. 
360
      Finally it will present the roadmap for the future, including a migration to 
361
      the web 2.0 paradigm, the handling of the database ever-increasing data volume 
362
      and the deployment of data-mining tools. 
363

    
364
      ...http://iopscience.iop.org/1742-6596/219/2/022027/pdf/1742-6596_219_2_022027.pdf
365
      
366
      2. Architecture and components
367
      The eLogbook architecture is based on LAMP (Linux, Apache, MySQL and PHP) software stack,
368
      with the relational database (DB) serving as a data repository and the web-based Graphical User
369
      Interface (GUI) providing interactive access to members of the ALICE collaboration. A C Application
370
      Programming Interfaces (API) and a Command-line Interface (CLI) grant the different automatic
371
      actors read/write access to the DB.
372
      
373
      2.1. Database   :The DB, running on a MySQL 5.1 Community Server..
374
      ... the tables that compose this DB can be grouped into 3 different categories:
375
          * RUN CENTERED: related to a specific run (data-taking period identified by an unique ID
376
            called .Run Number.)
377
	  * LOG ENTRY CENTERED: related to a specific human or automatic text report with optional
378
            file attachment
379
	  * USER CENTERED: related to the GUI users
380
	 
381
      2.2. Graphical User Interface
382
         The eLogbook web-based GUI (https://cern.ch/alice-logbook) was developed using modern web
383
         technologies, including PHP5, Javascript and Cascading Style Sheets (CSS). 
384
	 It is hosted on an Apache web server  ...
385
    
386
    
387
========================================================================================
388

    
389
4) SNS LOGBOOK  Spallation Neutron Source (SNS) at Oak Ridge National Lab.
390

    
391
   It is deployed as a standard Java Enterprise Edition (J2EE) servlet.
392
   The logbook was developed on a Macintosh? using  Apple WebObjects? 5.3.3 
393
   Server side is in Java; clients use JavaScript
394
   The application generates standards based output conforming to HTML,CSS and
395
   Document Object Model level II (DOM-2).
396
   Important aspect is that all data is store in Oracle.
397

    
398
   Very useful info comes from the initial requirements:
399
        http://www.aps.anl.gov/epics/meetings/2002-11/talks/pelaia.pdf
400
   and from 
401
        http://www.aps.anl.gov/epics/meetings/2006-06/EPICS_Tools/SNS_Logbook.pdf
402

    
403
   Layout:  Familiar three pane navigation
404
            User can sort by columns (date, author or priority)
405
   Navigation:
406
            Navigate forward and back by specified step
407
            Navigate directly to a specific day
408
            View all entries for a day or each entry individually
409

    
410
   New Entries: 
411
            Authors enter the title and text content
412
            One or more category may be selected
413
            The entry type may indicate Maintenance, Repair, etc.
414
            Priority may be used to indicate urgency
415
            Users may specify email notification
416
            Event time may be specified
417
    
418
            User can add images, attachments
419
	    
420
	    Preview entry is available.
421

    
422
   Notification via email
423
   
424
   Navigation via threads
425
   
426
   Search: Users can search by
427
   - Date range
428
   - Author
429
   - Title
430
   - Content
431
   - Entry Type
432
   - Logbook
433
   - Group
434
   - Required Reading Status
435

    
436
   The following information is taken from an article from:
437
   
438
   http://accelconf.web.cern.ch/accelconf/ica07/PAPERS/RPPB04.PDF
439
                    Proceedings of ICALEPCS07, Knoxville, Tennessee, USA
440
		    
441
   Abstract:
442
   An electronic logbook has been developed for the
443
   Spallation Neutron Source (SNS) [1] at Oak Ridge
444
   National Lab. This logbook serves as a means of
445
   chronologically recording daily operations activities and
446
   experiences and communicating them to appropriate
447
   groups. The logbook is database driven and integrates into
448
   our existing database schema. The interface to the
449
   logbook is web based and works with most modern web
450
   browsers on the major platforms. Additionally, a Java
451
   package provides a simple mechanism to post entries.
452

    
453

    
454
   The SNS Logbook is the official electronic logbook for
455
   the Spallation Neutron Source. It has a web interface
456
   compatible with modern web browsers and is backed by a
457
   database. While the SNS Logbook has been presented at
458
   other meetings [3, 4], there have not been any papers
459
   describing it.
460
   In spring 2002, before the start of commissioning the
461
   linear accelerator, the operations group realized the need
462
   for maintaining an electronic log of operations activities.
463
   We performed a search for electronic logbooks at use at
464
   other laboratories to determine whether we could use an
465
   existing one. Then, we could not find any logbooks that
466
   were backed by a database for all of their data. Some
467
   were either entirely file driven while others were a hybrid
468
   of file and database backing. We found it desirable not
469
   only to have a logbook that was completely database
470
   backed, but to have one that was integrated into our
471
   existing database schema. Other common problems with
472
   existing logbooks were their complexity for both the end
473
   user and the administrator.
474
   ...
475
   Development Tools
476
   The logbook was developed on a Macintosh? using
477
   Apple WebObjects? 5.3.3 [5] due to its mature state,
478
   rapid development environment, powerful object oriented
479
   database abstraction and support for open standards. Java
480
   (version 1.5) is the language for the server side code.
481
   JavaScript (version 1.5) is used to handle client side
482
   scripting. The application generates standards based
483
   output conforming to Hypertext Markup Language
484
   (HTML) 4.0, Cascading Style Sheet (CSS) 2.0 and
485
   Document Object Model level II (DOM-2).
486
   Web browsers are the main clients for the logbook, but
487
   because the entries are recorded in a database, it is easy
488
   for other client applications to make and read logbook
489
   entries, too.
490

    
491
   Deployment
492
   We deploy the logbook as a standard Java Enterprise
493
   Edition (J2EE) servlet on a two node Sun Solaris? server
494
   with load balancing. Oracle 10g? is used for our database.
495
   ....
496
   An entry is the primary entity. An entry consists
497
   of a title, an author, a message, images (PNG, GIF,
498
   JPEG), attachments (PDF, HTML, XLS, ZIP), groups,
499
   entry type (e.g. problem report, repair, status, shift
500
   summary, daily order, required reading), an event time
501
   stamp, a publish time stamp and a priority.
502
  
503
  --------------------------------------------------------------------------
504
   More information coming from the Presentation
505
   http://www.aps.anl.gov/epics/meetings/2006-06/EPICS_Tools/SNS_Logbook.pdf
506
 
507
   Active Development Team: Mario Giannella (Specifications),Jeff Patton (Database),Tom Pelaia (Web interface)
508
   Electronic Logbook Evaluation Task Force 
509

    
510
   http://www.aps.anl.gov/epics/meetings/2002-11/talks/pelaia.pdf
511
		    
512
========================================================================================
513
5) I also found an article on FNAL site where an evaluation team was created
514
   to investigate elogs for ILC:
515
   
516
   http://cd-amr.fnal.gov/ilc/LogbookEvaluation/LogbookEvaluation.htm
517
   
518
    
519
   Charge/Mission:  
520

    
521
    Deliver a report to FNAL ILC management by July 1st, 2006 that contains a recommendation 
522
    and defense thereof for an electronic logbook to be used by ILC test areas at A0, Meson, 
523
    IB1, and New Muon. The committee is charged with choosing a single recommendation to meet 
524
    the needs of a control room logbook AND a single recommendation to meet the needs of an 
525
    electronic notebook. The committee is strongly urged to choose the recommendation(s) 
526
    from an existing implementation and highly encouraged to have the same recommendation 
527
    for both the control room logbook and the notebook.
528

    
529

    
530
   Logbook Candidates: 
531
     CRL 		  written by Computing Division and used by several experiments 
532
     FNAL-AD Elog  	  written by Accelerator Division and used at CDF and MCR 
533
     FNAL-TD WebLog 	  written by Technical Division and used at IB1 
534
     JLAB elog at SLAC 	  written at JLAB and used at SLAC main control 
535
     TTF-DESY E-logbook   written at DESY and used at TESLA Test Facility (TTF) and by the LHC 
536
                          accelerator for the hardware and beam commissioning 
537
     DESY IHEP elog 	  an evolution of the TTF elog, using a similar front end but 
538
                             a different back end. About 3 years experience but with fewer users. 
539
			    (Please contact Rob Kutschke for the URL and login credentials) 
540
     Knowledge Book 	   used as a notebook by CMS 
541
     PSI		   written at Paul Scherrer Institute and used by CMS (CMS ROC elog) 
542
     SNS logbook  	   list of requirements and features 
543

    
544
   
545
========================================================================================
546
6) http://www.jlab.org/~adaq/halog/html/logdir.html
547
   Jefferson Lab HALL A Logbook 
548
   
549
   User interfaces use PHP with HTML & JavaScript
550
   PERL for xml file processing/creation & getting form info into the db
551
   tkl used for one interface (view and entry )
552
   Use of database , Oracle to store:  
553
       The pieces of text data from the web form or xml file and pointers to the graphics
554
       attachments.
555
   
556
========================================================================================
557

    
558
7) CDF Elog (courtesy of Federica Moscato)
559

    
560
The  CDF e-log is written in perl, and javascript and cookies are 
561
mandatories for the right operations.
562
The author is Vidal (rvidal@fnal.gov).
563

    
564
Main Page: http://www-cdfonline.fnal.gov/elog/
565

    
566
I did look at the CAF e-log: 
567
http://www-cdfonline.fnal.gov/cgi/elog/det-system-elog.pl?nb=caf&action=view&page=2&scroll=true
568

    
569
CRL functionality that  CDF e-log doesn't have:
570

    
571
-no topics
572
-no index
573
-no authorization is enforced : apache  authorization is used  (down 
574
 side : once  you are logged  in the  system you can  create an entry 
575
with any name)
576
-no subscription ( a different way to send e-mail is enforced)
577
-no custom form
578
-no administration (since there is not any user control)
579
-no saved search
580

    
581

    
582
The CDF-elog has two configuration: system and detector e-log.
583

    
584
Actions available for the detector e-log:
585

    
586
* Start shift: Presents the user with a form to start the current shift. 
587
  The application is aware of the time of day and the operations schedule. 
588
  This button is dimmed until the current shift expires. Shift    
589
  personnel's names are required.
590

    
591
* End shift: Allows final notes for the shift to be entered and presents 
592
  a form for some relevant shift information to be entered.
593

    
594
* Navigate: navigate between the shift with the buttons Prev,Next,Current
595

    
596
* Make  entry: Allows the user to add an entry into the log. Text and 
597
  the author's name are required. Both txt and html is supported.
598
                         An email can be send with the entry. There is 
599
   the ability to specify the subject and destination  in this case.
600
                       
601
*Add a comment: Click on the little green ball at the front of the 
602
  desired entry.  Both txt and html supported
603

    
604
*Search:  Presents the user with a form to allow searches for text 
605
  strings in the log.  The search is done by string and time range.
606
  Result of the search are displayed by
607
               -entry
608
               -notebook page  (to see in the entire page with the 
609
  string searched  underlined)
610

    
611
*Add Graph: Presents the user with a form for adding graphics files FROM 
612
 the local machine (the user computer executing the browser) to be 
613
 entered into the log.
614
 The images supported are: gif, jpg, or ps format.  
615
 The user can add single images with a comment, multiple images  without 
616
 comments.
617
 Gave the option to list all the image stored in 
618
 the logs. From the resulting list of images, there is the option to 
619
 directly past the images in the e-log.
620
                    
621

    
622

    
623
Features summary:
624

    
625
1) e-logbook developed by the DOOCS team at DESY.
626

    
627
   Apache, Java, Tomcat
628
   Entries stored in flat files
629
   Demo available:
630
       a) when opening the logbook, need to click on an folder to view entries.
631
       b) Not obvious how to make "new entry" from the main page.
632
          No preview before saving new entry
633
	  A new entry allows to add: text (basic), an image, send email.
634
	  At last from the demo it does not appear to allow attachments.
635
       c) typical by author, dates, words.
636
       d) It seems you can't add comments to an entry.
637
       e) it does have a Help guide.
638
   
639

    
640
2) ELOG https://midas.psi.ch/elog/
641

    
642
   C (server) , Integrated Web server to read ASCII and present results in html.
643
   Entries stored in flat files
644
   Demo available:
645
     a) Display: entries are all organized in a table. (no special graphic)
646
        Clicking on an entry it shows a detailed description.
647
	You can actually change an existing entry! which seems a little dangerous..
648
     b) New entry: text editor with HTML encoding. You can upload files.
649
	There is preview before storing the entry.
650
     c) Search: typical by author, dates, subject,text
651

    
652
3) ALICE (CERN)  
653

    
654
   web-based GUI, PHP5, Javascript and CSS
655
   Can't access site due to CERN protections
656

    
657
4) SNS LOGBOOK  Spallation Neutron Source (SNS) at Oak Ridge National Lab.
658
   No demo found, Can't access site due to protections
659
   
660
   The following info is from 
661
       http://www.aps.anl.gov/epics/meetings/2006-06/EPICS_Tools/SNS_Logbook.pdf
662

    
663
   Layout:  Familiar three pane navigation
664
            User can sort by columns (date, author or priority)
665
   Navigation:
666
            Navigate forward and back by specified step
667
            Navigate directly to a specific day
668
            View all entries for a day or each entry individually
669

    
670
   New Entries: 
671
            Authors enter the title and text content
672
            One or more category may be selected
673
            The entry type may indicate Maintenance, Repair, etc.
674
            Priority may be used to indicate urgency
675
            Users may specify email notification
676
            Event time may be specified
677
    
678
            User can add images, attachments
679
	    
680
	    Preview entry is available.
681

    
682
   Notification via email
683
   
684
   Navigation via threads
685
   
686
   Search: Users can search by
687
   - Date range
688
   - Author
689
   - Title
690
   - Content
691
   - Entry Type
692
   - Logbook
693
   - Group
694
   - Required Reading Status
695

    
696
=====================================================================================
697

    
698
These are some comments about investigation on commercial electronic logbooks.
699

    
700
JLogBook
701
--------
702
JLogBook developed by the St James Software company based in South Africa 
703
http://www.sjsoft.com
704

    
705
JLogbook uses a standard database (Access, MySQL, SQLServer, PostGreSQL or Oracle) 
706
which can be accessed from anywhere within the Company.
707
The only scientific use found was at ESRF Grenoble, for which they still needed to add 
708
some customization to fulfill their requirements.
709
see http://www.sjsoft.com/J5-in-the-Particle-Accelerator-Industry.html
710

    
711
As a general overview, it seems to have a very rigid output format: for each "category"
712
the layout has to be preconfigured by admin : the configuration information 
713
involves the setting up of the different fields (such as the log date and time, areas, users etc.)
714
The configuration information is stored in a standard database . 
715
It uses apache or its own web server and Interent Explorer or Netscape for browsers.
716
nest releases allow to use Firefox.
717
It is a window based application.
718
Attachments are available as links.
719

    
720
This product seems to be too restrictive to suit our use compared to others which are 
721
available as free software.
722

    
723
This is in brief how it works (extract from their documentation):
724
Whenever a user clicks on a link in the Browser on his or her screen, 
725
* A request is sent to the main server asking for the relevant information for that user. 
726

    
727
* The web server (Apache or j5Server) then transfers the request to the j5 Application. 
728
  j5 then first reads the configuration tables, which define the layout of the form to 
729
  be presented to the user. (For example, the order in which the logs are presented to 
730
  the user is a parameter specified in the configuration tables.) 
731
  It then creates the j5 html information according to the format defined in the configuration tables. 
732

    
733
* The j5 application then sends the information via the Web Server back to the user's browser. 
734
  In the browser, the information is translated and displayed in the relevant form and grid.
735

    
736
Whenever a user adds a new log, the information is stored, together with the categories 
737
associated with that log entry in the data tables. 
738
Additional system categories such as the console name, shift number, Date, Time, etc. are also
739
stored with the log information.
740

    
741
=====================================================================================
742

    
743
Doing more search on commercial companies which provide electronic lookbooks 
744
it appears  that their main purpose is to provide software for aviation pilots or shiplogs.
745
To acquire information and or try a demo you have to register.
746
Example of links:
747

    
748
http://www.arinc.com/products/data_applications/elas_webasa.html
749
https://www.aircraftlogs.com/ACL/Static/TripSheetFeatures.aspx
750
http://www.safelogweb.com/
751

    
752

    
753