<title> An XML based web service for an electronic logbook </title> <author>raimund Kammering</author> <institute>desy MVP</institute> <date>2002-10-16</date> <conference>pcapac 2002 Frascati</conference>
Overview Motivation Requirements The basic technology Internal data handling Software components The TTF e-logbooke Conclusions <author value= Raimund Kammering /><institute value= DESY MVP /> 2
Motivation Most of us know the good old paper logbook with all its pros and cons!? <author value= Raimund Kammering /><institute value= DESY MVP /> 3
The old paper logbook + Intuitive read/write access + Freedom in creation of entries + No access problems (only one version) - Preparation can be very time consuming - No standard layout for entries - Only one version exists - No systematic search possible <author value= Raimund Kammering /><institute value= DESY MVP /> 4
The electronic logbook An e-logbook can: make editing easier and faster offer helpful search functionality be the common place for measurement results can be made accessible for everyone make remote shift possible E-logbook is a must for a GAN ( Talk of K. Rehlich) <author value= Raimund Kammering /><institute value= DESY MVP /> 5
Requirements Simplicity: Input must be self describing and easy Availability: Must run on nearly every computer system Stability: Running 24 hours 7 days the week <author value= Raimund Kammering /><institute value= DESY MVP /> 6
Meeting the requirements 1 Simplicity: A standard web browser as front end can serve our purpose & today nearly everybody is familiar with it! <author value= Raimund Kammering /><institute value= DESY MVP /> 7
Meeting the requirements2 Availability: the standard web browser runs on every computer system & mostly no additional installation is required! <author value= Raimund Kammering /><institute value= DESY MVP /> 8
Meeting the requirements 3 Stability: Concerns only side holding and serving the data (server). A standard web server can do this job! Many existing web servers are available. Years of experience with these server exists. <author value= Raimund Kammering /><institute value= DESY MVP /> 9
The basic technology Classic client server architecture: User program client Web browser client Print Graphic PS Text ASCII HTML + JPEG or PDF Combined content E-logbook Web server <author value= Raimund Kammering /><institute value= DESY MVP /> 10
The I/O concept Three distinct communication channels: Two input channels: 1. Graphics via printing to PS printer 2. ASCII textual data via web interface One output channel: Standard HTTP communication (LAN, Internet etc.) <author value= Raimund Kammering /><institute value= DESY MVP /> 11
Internal data handling User program Web browser 1. Print 1. Request 5. Response PS HTML PDF UNIX pipe - script XSLT / XSL FO 2. Store convert create JAVA servlets PS JPEG logbook folder XML 2. Read 3. Create Apache / Jakarta Framework 4. Combine content layout XML XSL <author value= Raimund Kammering /><institute value= DESY MVP /> 12
Data input Graphics are stored as PS and converted to JPEG for display in web browsers. XML files hold the connection between these files and metadata like date, author, etc. All files are stored in a pool reflecting the local requirements (e.g. 3 shifts per day, weekly or monthly etc.). <author value= Raimund Kammering /><institute value= DESY MVP /> 13
Data output JAVA Servlet collects requested data out of pool (named logbook folder ). This data is redirected to an XML parser. The parser passes the parsed data to an XSL transforming processor for final generation of either HTML or PDF output. <author value= Raimund Kammering /><institute value= DESY MVP /> 14
Software components 1 On the client side we need: Standard JAVA capable web browser (e.g. Netscape 6 or Internet Explorer 5) Every program that can print to a standard PS printer (e.g. MATLAB, ROOT etc.) <author value= Raimund Kammering /><institute value= DESY MVP /> 15
Software components 2 On the server side we need: A standard web server with a servlet engine (e.g. Apache web server with Tomcat servlet engine) An XML parser and an XSLT processor (e.g. Xerces and Xalan from the Apache software foundation) <author value= Raimund Kammering /><institute value= DESY MVP /> 16
The TTF e-logbook So let s have a look at the e-logbook s e GUI. <author value= Raimund Kammering /><institute value= DESY MVP /> 17
The TTF e-logbook (cont.) Create new entry Generate PDF Status info. Change entry Navigation <author value= Raimund Kammering /><institute value= DESY MVP /> 18
The e-logbook search Free text search string Direct link to entry Search certain XML tags Limit search range <author value= Raimund Kammering /><institute value= DESY MVP /> 19
Conclusions 1 Now one year of experience with an e-logbook e at the TESLA Test Facility (TTF). Good or even very good resonance from the operators. E-logbook has grown up to be an integral part of the machine operation. More people are involved in the machine operation. <author value= Raimund Kammering /><institute value= DESY MVP /> 20
Conclusions 2 The e-logbook e is a promising trial to work with this modern web technologies. Interfacing with other web services (see poster of O. Hensler) possible. Many ideas and suggestions are appearing since its introduction. <author value= Raimund Kammering /><institute value= DESY MVP /> 21
The end Thanks for your attention! <author value= Raimund Kammering /><institute value= DESY MVP /> 22