ELisA Logbook User Documentation

Quick overview

ELisA is a tool to be developed by the ATLAS TDAQ community as the daily electronic logbook facility. ELisA should be used as a replacement for the ATLOG.

The last 500 entries or the last 6 months' entries are retrieved from the database and displayed by default. These numbers can be changed via the logbook configuration, get in contact with your logbook administrator. By clicking anywhere on a row entry, the row is expanded and its complete content is displayed. One can Reply to that entry or you can Edit the entry. You can also click on the Date&Time link to display the entry in a separate browser tab in a more detailed way. Hovering the mouse over the row columns one can see the full text displayed as a tooltip.

One can select the number of entries per page to be shown. You can navigate through the pages with the arrow buttons on the table top toolbar.

Show/Hide columns button lets you customize the table view ie you can choose the columns you want to see. This information is stored for the next usage. The Reload data table button will update the information displayed on your table gathering the latest changes from the logbook database.

You can do a quick search across columns on the entries already available in the table using "Search all cols" field. You can also do on-the-fly filtering on a specific column. If you need to select another set of entries you should use the Advanced search tab or The Advanced search plugin at the bottom of the main page.

To create a new logbook entry you should use the New entry tab.

Reply: you can use your preferred mail client to reply to ELisA entries, without the need to use the web interface. Get in contact with your logbook administrator. Nevertheless this is meant for text-only replies. If you want to include an attachment in your reply, please use ELisA web interface.

You can check the email notification configuration for a given message type, one or more systems affected, one or more message type options. A list of egroups is displayed for a given combination of options. The user can subscribe/unsubscribe to these egroups directly from the web interface or using the CERN IT web page https://e-groups.cern.ch/

Flat View

The flat table view displays the entries chronologically. There is no visible connection between entries belonging to the same thread.

1. User information

The user currently logged in is displayed and the user can logout from ELisA web page.

2. Multiple logbooks

If in the configuration there are defined multiple logbooks, the user can select a logbook name to visualize the messages.

3. Customize table view

By clicking on the "Show/Hide columns" button you can customize your table view ie you can choose which columns you want to display and which ones to hide.

4. Expand and Collapse entries on a page

The user can expand or collapse all the entries displayed on a page. Depending on the number of rows shown in the table, this operation can have a slight delay.

5. Reload table

The user can reload the table, ie the default view of 500 entries or entries from the last 6 months.

6. SearchBuilder

The user can search for entries using a combination of AND/OR criteria. If no Date_time filter is selected, the consequent search is performed on the entries already displayed in the table. Therefore select first a Date_Time interval for your search to get a different set of entries from the server.

7. Fetch entries

Users can retrieve entries from the database in a very convenient way choosing from a list of well-defined time intervals ie entries from the last day, last week, etc. Default means last 500 entries.

8. Fast filtering

Users can do a quick search on the entries already loaded in the table. The filter 'Search all cols' is applied across all columns in the table, while the filters under each column header are applied to the specific column only. The filters' values (individual columns and global) are saved, applied, and displayed next time the webpage is accessed. Regex expressions are allowed as well.

9. Displaying options

If there is a filter applied to the table data, the number of selected entries will be shown also. The number of displayed entries per page can be changed using the select box Show, page navigation is available as well.

10. Inspect the entry row

Hovering an entry row with the mouse will show the full information in a tooltip, for example, a large message text or a long list of systems affected. If you want a better visualization of the message and of the attachments click anywhere on the entry row (but not on the Date_Time link). This expanded form gives faster access to the Reply and Edit functionalities and to the full information on the message options (click on the Info button to see the options).

11. Reply and Edit

When expanding an entry row the user can have the possibility to Reply or Edit that entry.

12. Display entry

To display any entry in a separate browser tab click on the Date_Time link. This view will show the full message thread if there are any linked messages.

13. Submit feedback using JIRA

If you want to submit a bug, or you have questions, use this link to submit an issue to the JIRA project dedicated to ELisA. Please submit your name in the submitter form. NB: access to JIRA is not available from inside P1 network.

14. Release log

User can access the twiki page containing the application release log.

Threaded View

The threaded table view groups and displays the entries in threads of messages as a mailer client. Only the last message in every thread is visible in the table. The table header is almost the same as the Flat View table. The user settings (for example the number of entries per page, filters, table customisation) are saved correspondingly per table view.

1. Thread indicator

This triangle means that the current entry has one or more replies.

2. Replies counter

In square brackets, you can see the number of replies in a thread.

3. DisplayThread tab

To display the current thread just click anywhere on the entry row (but not on the date) and the full thread will be displayed in the DisplayThread tab.

4. Display on a new page

Click on the entry Date_Time link will display the full thread on a separate browser tab.

New Entry

This form is used to create a new logbook message (entry).

1. Message type and attributes

First, you need to choose a message type. Every message type can have additional attributes (optional). The System Affected field will be pre-filled depending on the message type and the attributes specified. You can modify this predefined value.

2. Author

The predefined value is the full name of the user currently logged into ELisA application. You can modify this predefined value.

3. Status

Check one of the two choices, the status is 'open' by default.

4. Subject of the message

Depending on the message type and attributes, some subject values are predefined. Predefined values can be changed.

5. Message text formatting

The text to submit is limited to 50kB. The editor has several formatting capabilities. One can: preview the text before submitting it, add links or tables, use lists, quotes, etc. You can insert the current time at the location of the cursor when the top left icon on the toolbar is clicked. Drafts are saved as well and can be used by clicking "Restore last draft" icon.

6. Attachments

To add one or more attachments to your message you can use the area under the message text. Drag and drop a file or click and choose a file from the browser window. Any type of file is accepted. Depending on the file type, a preview is available when the entry is displayed. Maximum upload size is 5MB.

7. Insert

If all the parameters are provided correctly your new entry will be submitted to the logbook database. Else an error message is shown.

Advanced Search

This form provides the query parameters for searching the logbook entries.

You can search on a number of parameters like system affected, message type, optional attributes, author, status, subject, etc. A free text search on the message text field is also possible. You can do a match case search as well (4). You can select a time interval specified with the help of a popup calendar or as a predefined time interval (ie one, three, six, or twelve months).

The query parameters are saved.

1. Do search

Clicking on this button starts the database query process and when the search is finished, the user is redirected to the Flat view tab displaying the entries that match your search criteria. Important! Depending on your search time interval, the response time can be long. If no time interval is selected, the search button is disabled.

2. Reset filters

This button cleans all search fields.

3. Search by entry ID

Use this field if you wish to query for a specific entry ID. Press Display will show the entry on a different browser tab.

Notification Configuration

User can check the email notification configuration for a given message type and/or systems-affected combination. Click 'Check' button will display a list of egroups used for the email notification. The logged-in user subscription is checked for each egroup in that list and a corresponding button is displayed giving the possibility to the user to subscribe or unsubscribe to one or more egroups. If this action fails because of the permissions, please use the CERN IT web page https://e-groups.cern.ch/

Using text templates

This is a feature that creates a text template to be automatically loaded in the message text editor when the user selects a certain message type with given options. Any message type can have a template defined for it.

Create new template

1. The templates are maintained by the logbook/system responsible and the location is their choice, but the template location has to be accessible from the server where the logbook application is running. For ELisA ATLAS Operations logbook, the templates location has to be in P1 (for example under /det/ area).

2. Create a .txt file HTML formatted that contains the text to be displayed in the message editor.

Use <br> at the end of every line and &nbsp; for spaces/tabs.

Here is an example of one of the LAr templates:

    [DETAILS OF UPDATE]<br>
    <br>
    The following files have been modified:<br>
    &nbsp;&nbsp;- /det/lar/project/oks/tdaq-09-04-00/lar/[.../FILE 1]<br>
    &nbsp;&nbsp;- /det/lar/project/oks/tdaq-09-04-00/lar/[.../FILE 2]<br>
    <br>
    Please commit and reload at the next available opportunity.<br>

3. Add this template to a README file (an example: /det/calo/ELisA_templates/LAr/README) that should contain the template and the following configuration information:

• Required configuration information: Option name for which you want the template to be used (in the screenshot above: LAr_EntryType=Development/Maintenance) Path to .txt file
• Optional configuration information: Name of option that you want to be preselected with a given template if any (in the screenshot above: LAr_System=Software) System Affected (list of preselected systems affected to be used with a given template if any) Subject (in the screenshot above: OKS Update:[SUMMARY of UPDATE])

4. Contact your logbook administrator and inform them about a new message template, and either specify the path to your README file or provide the information directly.

Modify an existing template

To modify the message template text, simply modify the appropriate txt file in the location you've chosen.

To modify anything else in the ELisA configuration, Contact the logbook developer and/or your logbook administrator.