The Open Source LogbookThe Open Source Logbook

Gary HemmingGary HemmingEuropean Gravitational ObservatoryEuropean Gravitational Observatory

(gary.hemming@ego-gw.it) (gary.hemming@ego-gw.it)

KAGRA F2F, 31/07/14KAGRA F2F, 31/07/14

This presentationThis presentation

This presentation looks at the following areas:This presentation looks at the following areas:

• History of the application.History of the application.

• Open Source Logbook (OSL) functionality.Open Source Logbook (OSL) functionality.

• Technical requirements.Technical requirements.

• Open-source libraries.Open-source libraries.

• Future developments.Future developments.

22/04/23 2

About the applicationAbout the application

• 2005 – Virgo Logbook migration from Perl-based to 2005 – Virgo Logbook migration from Perl-based to PHP-based web application.PHP-based web application.

• 2008 – Following requests for usage from outside 2008 – Following requests for usage from outside organisations, application developed into easily-organisations, application developed into easily-installable open-source package. The Open Source installable open-source package. The Open Source Logbook (OSL) is born.Logbook (OSL) is born.

• OSL, is made available under the General Purpose OSL, is made available under the General Purpose Licence (GPL) open source licence. OSL is used in Licence (GPL) open source licence. OSL is used in Virgo, LIGO, EGO, LAL, LAPP, LMA, Aston University Virgo, LIGO, EGO, LAL, LAPP, LMA, Aston University and Glasgow University among others, both within and and Glasgow University among others, both within and without the Collaboration.without the Collaboration.

• Several updates have followed (current stable: v2r6).Several updates have followed (current stable: v2r6).

• Updated version (v3r0) currently under development. Updated version (v3r0) currently under development. Release foreseen ~end of September 2014.Release foreseen ~end of September 2014.

22/04/23 3

OSL functionality – 1. ReportsOSL functionality – 1. Reports

• OSL allows Reports to be entered and associated to OSL allows Reports to be entered and associated to specific Sections and Tasks, making it possible to track specific Sections and Tasks, making it possible to track the evolution of a project.the evolution of a project.

22/04/23 4

OSL functionality – 2. SearchOSL functionality – 2. Search

• Users can search on a range of fields, filtering search Users can search on a range of fields, filtering search results as required.results as required.

22/04/23 5

OSL functionality - 3. Adding ReportsOSL functionality - 3. Adding Reports

• Reports can be added using either a plain text editor…Reports can be added using either a plain text editor…

22/04/23 6

OSL functionality – 4. HTML editorOSL functionality – 4. HTML editor

• ……or an HTML editor (CKEditor)or an HTML editor (CKEditor)

22/04/23 7

OSL functionality – 5. File uploadOSL functionality – 5. File upload

• Multiple files can be uploaded and associated to a Multiple files can be uploaded and associated to a Report.Report.

• On image file upload, thumbnail images are created, in On image file upload, thumbnail images are created, in order to ensure large files do not slow the interface when order to ensure large files do not slow the interface when viewing multiple reports with many associated images.viewing multiple reports with many associated images.

22/04/23 8

OSL functionality – 6. PreviewOSL functionality – 6. Preview

• Reports can be Saved and Previewed at any time during Reports can be Saved and Previewed at any time during their creation.their creation.

• Preview shows what the Report would look like if posted Preview shows what the Report would look like if posted to the Logbook in that moment.to the Logbook in that moment.

22/04/23 9

OSL functionality – 7. DraftsOSL functionality – 7. Drafts

• Reports can be Saved to Draft and then returned to at a Reports can be Saved to Draft and then returned to at a later date; retrieving them from the Drafts section.later date; retrieving them from the Drafts section.

• Old, unwanted Drafts can also be deleted by a user from Old, unwanted Drafts can also be deleted by a user from this section.this section.

22/04/23 10

OSL functionality – 8. L-MailOSL functionality – 8. L-Mail

• The L-Mail functionality enables a user to request e-mail The L-Mail functionality enables a user to request e-mail notification whenever a Report is entered under a notification whenever a Report is entered under a specific Section-Task.specific Section-Task.

22/04/23 11

OSL functionality – 9. AdministrationOSL functionality – 9. Administration

• The Admin section enables authorised users to The Admin section enables authorised users to customise and configure their OSL instance.customise and configure their OSL instance.

22/04/23 12

OSL functionality – 10. Section/Task editingOSL functionality – 10. Section/Task editing

• Sections and Tasks can also be added and amended as Sections and Tasks can also be added and amended as required in the Admin section.required in the Admin section.

• The ‘Jump To on Task select’ option also makes it The ‘Jump To on Task select’ option also makes it possible to re-direct users to other areas or websites possible to re-direct users to other areas or websites when a specific Task is selected.when a specific Task is selected.

22/04/23 13

OSL functionality – 11. User group managementOSL functionality – 11. User group management

• Users can be associated to Standard User or Users can be associated to Standard User or Administrator access levels.Administrator access levels.

22/04/23 14

OSL functionality – 12. CustomisationOSL functionality – 12. Customisation

• Customised sections can be added in the Extra section Customised sections can be added in the Extra section of the interface.of the interface.

22/04/23 15

OSL functionality – 13. HelpOSL functionality – 13. Help

• Detailed Help section also available.Detailed Help section also available.

22/04/23 16

OSL functionality – 14. Authentication checkOSL functionality – 14. Authentication check

• In the event of a user being logged-out for any reason, In the event of a user being logged-out for any reason, the interface handles re-authentication, in order to avoid the interface handles re-authentication, in order to avoid entered information being lost.entered information being lost.

22/04/23 17

Technical requirementsTechnical requirements

• Standard web server (Apache, IIS, etc.)Standard web server (Apache, IIS, etc.)

• PHP 5.1+ (inc. GD library for thumbnail image creation)*PHP 5.1+ (inc. GD library for thumbnail image creation)*

• MySQL 5.0+ **MySQL 5.0+ **

• JavaScript-supporting (i.e. all modern) browserJavaScript-supporting (i.e. all modern) browser

* * 5.0+ would actually suffice, but up-coming version will use PHP Data 5.0+ would actually suffice, but up-coming version will use PHP Data Objects (PDO) for database communication and prepared statement Objects (PDO) for database communication and prepared statement execution, and is only available from PHP 5.1 onwards.execution, and is only available from PHP 5.1 onwards.

** A MySQL management application, such as phpMyAdmin ** A MySQL management application, such as phpMyAdmin (www.phpmyadmin.net), is recommended for easy management of (www.phpmyadmin.net), is recommended for easy management of the database itself.the database itself.

22/04/23 18

Open-source librariesOpen-source libraries

Open-source libraries used in application and already Open-source libraries used in application and already included in software package:included in software package:

• CKEditor (ckeditor.com) – used as HTML editor in Report CKEditor (ckeditor.com) – used as HTML editor in Report creation. Available under GPL, LPGL & MPL licences.creation. Available under GPL, LPGL & MPL licences.

• jQuery (jquery.com) - the widely-used jQuery JavaScript jQuery (jquery.com) - the widely-used jQuery JavaScript AJAX integration library (v1.4.4+). jQuery is made available AJAX integration library (v1.4.4+). jQuery is made available to applications under the MIT and GPL v2 licences.to applications under the MIT and GPL v2 licences.

• Tigra (www.softcomplex.com/products/tigra_calendar/) - Tigra (www.softcomplex.com/products/tigra_calendar/) - The JavaScript Tigra Calendar v4.0, available under the The JavaScript Tigra Calendar v4.0, available under the Tigra Calendar v4.0 licence is used in assisting user-filled Tigra Calendar v4.0 licence is used in assisting user-filled data HTML input fields.data HTML input fields.

• Simple AJAX Code-Kit (SACK) Simple AJAX Code-Kit (SACK) (www.twilightuniverse.com), available under a modified (www.twilightuniverse.com), available under a modified X11 licence.X11 licence.

22/04/23 19

Future developments – 1. GeneralFuture developments – 1. General

• Allow Administrator to set length of time up to which a Allow Administrator to set length of time up to which a User can edit a posted Report. (v3r0)User can edit a posted Report. (v3r0)

• Use prepared statements in the Data Access Object Use prepared statements in the Data Access Object code file. (v3r0)code file. (v3r0)

• Enable the positioning of uploaded images within Report Enable the positioning of uploaded images within Report text, rather than attached below. (v3r1)text, rather than attached below. (v3r1)

• Link with Hardware Inventory Database and Document Link with Hardware Inventory Database and Document Codifier applications; making one, single application. Codifier applications; making one, single application. (v3r?)(v3r?)

• Provide dedicated mobile interface. (v3r?)Provide dedicated mobile interface. (v3r?)

• Provide dedicated source-file download website.Provide dedicated source-file download website.

22/04/23 20

Future developments – 2. Links with other appsFuture developments – 2. Links with other apps

• e.g. Hardware Inventory Database (HWDB) (see image e.g. Hardware Inventory Database (HWDB) (see image below) and Document Codifier.below) and Document Codifier.

• Enabling creation of automatic linkages between content Enabling creation of automatic linkages between content entered in different applications.entered in different applications.

22/04/23 21