CRLW Release Notes

v1_11 April 8, 2008

- New Index page with collapsable topics
- Ability to add and close studies (i.e. new topics)
- Fixed the time zone bug
- New entry page with improved UI

v1_9_1 November 26, 2007

- Fixed spelling mistakes
- Fixed direct access to SingleEntry.jsp

v1_9 September 25, 2007

- Added the ability to attach a script to a form
- Show the annotations when one clicks on the single entry link.
- Fixed the two column sorting on the index page if there are more than 8 categories.
- Added the Memo Pad feature
- Removed the yucky buttons and replaced them with links
- Fixed the paging for a relative date serach (for example paging back for Last-24 hour search is fixed)

v1_8_28 September 6, 2006

- Changed the default view of entries when entering from the Index:
When one clicked on a category on the Index.jsp page, he saw the current shift's entries. If there were no entries for that shift the resulting page was blank. With this change you will see the last 15 entries in that category, no matter when they were entered. If you
click on All Categories, you will get the last 15 entries in the logbook. This is much better if the logbook has not been used for a while, for example during a shutdown, or if it is used to query/store archived entries.
NOTE: the previously saved searches of "Last N Entries' will no longer work, please regenerate these.

- Added an option to set the default view to last 15 entries or current shift.

- Clarified the search title and made the font larger

- Fix Bug: when choosing the last n entries for category c, returns now the last n entries in category c, rather than the entries in category c in the last n entries.

v1_8_27 July 18, 2006

Bug Fixes:
- Fix search for the last 'N' Entries and paging foreward and backward

v1_8_26 July 18, 2006

New Features:
- Added conditional refresh. Now only the searches below are automatic refreshed:

search for the last n-hours/days/entry numbers
current shift.

- Allow image names with "." in name other than the "." before the extension
- Added the page background color option
- Added text background color option

Bug Fixes:
- Bug fix in Menu.java for iteration over submenus.
- Catch session timeout when logging in and out.
- Catch session expiration in Annotation.jsp
- Added error message for entry note saved
- Added check for missing @ sign in email when editing or adding users

v1_8_23 April 11, 2005

New Features:

Speed improvement: each entry is written to the html text as it is retrieved. This allows the user to start reading entries while others are retrieved.

v1_8_22 March 17, 2005

New Features:

The login name is now displayed on the Admin page user list.

Bug Fixes:

The text fields on the Search.jsp page have been made longer (256 char) to accomodate comining categories with long names.

v1_8_20 February 9, 2005

Bug Fixes:

Changed Preview.jsp so that it getEntryText matches the paramter list. This error was introduced when I added the Move Entry feature in the last release.

Increased buffer size in getFormText to 50,000, was 20,000 and too short. This allows for longer forms.

Allowed for relative sequence number saved search. When one saves a sequence number search, for instance "the last 20 entires" it is now relative, so that when new entries are added, it will retrieve the last 20 entries.

v1_8_18 January 12, 2005

New Features:

Moving Entries From One Category/Topic To Another

It is now possible for a user with admin privileges to move entries from one topic to another. To do so, log in and if you have admin privileges an Admin button will be visible on the Index page. Press the Admin button and on the next page press the Move Entries button. On the resulting page (the MoveEntries page) there are two tables. On the left, there is a list of the current entries, on the right a list of available topics. Select the entries to be moved, the topic to move them to, and click on Move Entries. Once the entry is moved it will automatically refresh and print a status statement. The entry is annotated with a time stamp and stating that it has been moved from A to B by you.

Check boxes for keywords

Instead of listing the keywords in a pull down menu, I have changed the layout to list each keyword with a check box. This way the keywords are all visible at once.

Bug Fixes

The session variable holding the form name was lost when the user hit the back button to return to a form entry. This is now fixed.

Fix to current shift search. The 'current' parameter in the winq file was overwritten with the actual shift before the custom search was saved.

Show the navigation bar on the button based on the length of the log in bytes rather than the number of entries.

* note: v1_8_17 was not released to the FNAL users.

v1_8_16 November 16, 2004

New Features:

Automatic Refresh for the Log page

The Log.jsp page is now automatically refreshed every 15 minutes. When the seach was for a particular shift, the shift is not changed, so if the shift has ended, you must manually step forward to get the next shift. If the search was on a relative time, for example every 24 hours, the window shifts to the most current 24 hours. The New Entry page which also shows the log, is not refreshed. If it were refreshed automatically, it would whipe out any entry text in progress.

Session Timeout Recovery

The session has a life time of 3 hours, this is so that the server does not get overloaded with abandoned sessions. In the past when a user made an entry, but did not save it and the session timed out, the entry was lost. I added a recovery page that prints the text. You can copy this text, log back on, and paste it into a new entry.

Bug Fixes
When a user entered the log page directly with the syntax Log?inquiry=my_search.winq he was redirected to the Index page. This is now fixed, and one can use this URL to access the log.

The Admin page was not protected with the uname and pw when accessed directly. This is now fixed.

Added error handling for the case when the CRLW is unable to read the winq files in the CRLWindex.

v1_8_15 September 1, 2004

New Features:

Change Password:
You can now change your CRL password on-line:

If you are not logged in, login by pressing on the green circle in top tool bar.
Go to the Index page
Press 'Change Password'
Enter the new password and the confirmation password. The password has to be between 4 and 8 characters long.
Press 'Done'

User Administration

The CRLW Administrator can now add new user and change user information on-line. Log in (admin priviledges are required) and go to the Index page. Press the Admin button. To edit a user's profile, select the user from the drop down lise and click OK. Edit the fields and click Save. To add a new user, click "New User" and fill in the fields, then click Save.

The user's login name is the email address up to the @ sign. For example my email is spanacek@fnal.gov, my user name is spanacek.

Users can not be deleted from the list, they can only be deactivated. The "Active User" check box at the left bottom is checked by default. To deactivate a user, un-check this box.
You can check the Admin Priviledges box to give the user the ability to change the CRLW configuration, modify subscriptions, and add/change users.

The console CRL application separates "remote" priviledge from simple "operator" priviledge, where "remote" priviledges enables one to make entries on-line. I have grouped these together in the CRLW, so that every active user is an operator with remote priviledges.

Bug Fixes
When saving a custom search, the URL shown in the browser no longer showed the custom search file in the query string. This has been fixed in this release.

v1_8_14 August 17, 2004

New Features:

Subscriptions are now available for any topic and any HTML form. When you are subscribed to a topic or form, you receive the entry/form via email when it is submitted.

To see the current subscriptions click on the Subscriptions button. This brings up the page below. Then type an email address and click on "Show Subscription". On the left is the list of active topics for this log book, the ones with the green dot are being subscribed to by the email above. On the right is the list of forms.

If you do not have administrator privileges you can only view subscriptions and not change them. To subscribe or unsubscribe contact you CRLW administrator.

If you have administrator privileges, you can log in and modify the subscriptions from the subscription. You may add subscriptions for any email address, meaning the email does not have to be on the CRL user list.

The subscriptions are managed with mailing lists which are kept in a directory specified by the Log Book_admin/LogbookConfigParms.properties file. The parameter is: Logbook.file_location.mail_list_directory. It is conventionally set to:

Logbook.file_location.mail_list_directory C:/crl_apps/crl_admin/CRLmaillists

Where C:/crl_apps/crl_admin is the directory that also contains Log Book_admin.

The mailing list directory contains an XML file for each topic and html form if there is at least one subscriber. Below is an example. You may edit the XML file directly rather than using the web interface.

<?xml version="1.0" encoding="UTF-8" ?>
<MAILLIST>
<TO>spanacek@fnal.gov</TO>
<FROM>Suzanne_s_Logbook@fnal.gov</FROM>
<SUBJECT>Developement/Subscriptions-Subscriptions $D $T</SUBJECT>
</MAILLIST>

Note that, XML forms, used by the Control Room Logbook Application can not be subscribed to by the CRLW.

v1_8_13 July 28, 2004

New Features:

Show who is logged in all the time (requested by MIPP)
Index and new Entry button on Annotation page (requested by CMS)
Added the "closed" option for a topic:
You can close a topic to new entries by modifying the LogBook_admin/LogBookConfig.xml file. The <Topic> XML tag has an attribute called parm1, set this attribute to "closed". The CRLW will not allow any new entries to a topic with the parm1="closed", the topic will not be visible on the Index, but it will be available on the pick list of the search page. Also note that the CRL application is unaware of this flag and will allow new entries on that topic, it is only closed to the CRLW.

Here is an example of a closed topic tag:
```
   <Topic
   class="logbook.MyInternalTopicFrame"
   name="General"
   size="80%,80%" offset="5%,5%"
   command="add_to_Menu_Page"
   double-click="logbook.logentry.LogEntryText"
   parm1="closed">
   </Topic>
```
By default all topics are open, to open a closed topic just remove the line parm1="closed".
Added navigation bar to bottom of pages with entries (Log and Entry page)

Fixes:

Fixed the link to the entry on the preview page.
Fix to word search. It now searches the HTML entries and no longer the XML entries. This way the image data is not searched.

v1_8_12 July 6, 2004

New Features:

Preview: I have added a button on the New Entry page that lets you preview the entry before saving it. This is very helpful for previewing forms and tables. You can save the entry directly from the Preview page or return without saving the entry.
The CRLW now 'remembers' the selected optional keywords from one entry to the next. You can deselect an optional keyword CTRL-Click.
The sequence number is now displayed in the entry header.

Fixes:

When hitting Quick Search in the Search page, the browser showed the source code. This is now fixed.
More explicit error checking on plain text & attached images, and plain text & attached file. (i.e. check when attempting to preview
or save)
Removed the temporary image files when pressing Clear in the New Entry page.

v1_8_11 June 21, 2004

New Features:

Added a link to the release notes on the version number
Added the Category to the header
Explicit default of form search list to 4

Fixes:

Fix to annotation text, the DONE button no longer saves empty annotations.
Changed the algorithm for form/word search. Now it covers xml and html forms, it OR's the forms, and 'AND's' the result with the word search filter. XML forms and HTML forms are now following a different algorithm for searching.
Set return URL in search default to Log.jsp
Eliminated duplicates in the optional keyword list

v1_8_10 June 14, 2004

New Features:

Added a plain text entry option. This is very useful when adding tables or to preserve white space in general. Here is the same entry without and with plain text:

You can now search multiple forms and words independently of each other. For example, you can find 'Crate 6' in all VB-Change forms and End of Shift forms. The multiple form search, searches for any of the forms listed, in other words a logical OR is uses. This result is then combined with a logical AND with the word filter (or any other selected filer). When a form is selected, it is moved to the top of this list the next time the Search page is opened, so that you can clearly see which ones are selected.
Added a quick search drop down list. On the log and new entry page, there is now a drop down list of the index searches.
Optional keywords are now sorted, automatic keywords are delimited with a comma in an attempt to ease the reading.
Made all navigation buttons images so that one can open it in a new window with a right click.
Added Refresh button
Made the login/logout button click able to login and logout (was previously a separate button).
Removed configure link on Log page
Enlarged annotation entry text area to match the size of new entry text area

Fixes:

Fixed a bug introduced in the last release. When one changes the topic, the search criteria did not change. Now when changing a topic, the search criteria is changed to the new topic, the other filters are preserved.
Fix for a Cancel on login
Clear the word search string when searching for forms, and remember the forms that were searched for and select them upon new entry

v1_8_09 May 20, 2004

New Features:

Allowed selecting multiple keywords on Entry page.
Sorted the forms in alphabetical order and only accept .htm and .html files (sugestion by MIPP)
Changed form list to be a pull down rather than fixed size (suggestion by MIPP)
Added the name of the logbook to the Error page (lets me know who is sending me the error report).
Fixed the clean up of the temp tables for the data base. Check your database for TMPxxx tables. These can be deleted.
Preserve the filter parameters when it is called with a winq. This is especially handy for searching of old categories.
Changed the name of the properties file to be derived from the URI rather than the path name. This way, we can use a common path using symbolic links, and have unique property files. This will allow us to run multiple CRLW's using the same source code with unique property files (crlweb)

Fixes:

Fixed bug with categories and blank spaces. It could not match the category name, and hence asked the user to pick a topic again. This will solve the problem for Global Monitoring at D0

v1_8_08 April 29, 2004

There are three changes in this release that need retrofit work.

1) Move the HTML forms

I moved the HTML forms so that CRLW directory contains no data, but only executables. This means that you have to move the html form:

Locate the Logbook.properties file in the LogbookAdmin directory
In the Logbook.properties file look the value of Logbook.file_location.www_directory
Go to the Logbook.file_location.www_directory and create a new directory called crlwforms
Move the existing HTML forms from /webapps/your_webapp/forms to Logbook.file_location.www_directory/crlwforms.

2) Change the name of the CRLwebapp.properties file

I did this so we can have one installation of CRLW and have several webapps link to it with symbolic links. This way every webapp can have its own property file in the same directory. If you don't rename the properties file, you will be prompted to enter the properties again.

Note the name of the webapp directory, for example ..tomcat/webapps/your-webapp/ .
Find the properties file .../my-web-app/WEB-INF/CRLWebapp.properties
Rename it to .../my-web-app/WEB-INF/my-web-app.properties

3) Remove the Help directory

The Help file now resides on the CRL web site at: http://www-cpd.fnal.gov/CRL/crlwhelp/CRLW.htm. You can remove the directory: /webapps/your_webapp/Help and its subdirectories. Of course this is not mandatory, it's just good practice.

New Features:

The Entry page now has all the functionality of the Log page. You can change the sort order of he entries, page forwards and backwards, refresh, show the latest entries (see below) and go to the Search, Index, and Log.
The "Change Topic" procedure is now streamlined, the current search is preserved, only the topic to associate the new entry has changed.
The page forward button is now disabled if this puts you into the future.
Added a 'Latest' button to the log and entry page. The lets you view to the latest entries in the context of your search. For example the latest 8 hours, or the latest shift. The tool tip of the Latest button is context sensitive. The filters are preserved.
Refined the 'Refresh' feature for shift searches. It only refreshes the current shift.

Fixes:

Added code so that the search and annotation pages know what page to return to (i.e. Log or New Entry)
Fixed the Cancel option in the PickTopic page.
Added error handling when no topic is picked.
Took out the Help button on the FormMaker, it does not work to go there an back with the include
On the Entry page, check for missing application object, and return to the Index page if it happens. Currently it crashes with an exception.
Refined the entry text getting
Changed the FormMaker.jsp to read the html form and write it out rather than using the jsp include directive

v1_8_07 April 7, 2004

The Search page now has a pick list for searching for a particular form. Xml and html forms are included. The xml forms have a prefix of 'XML Forms' and are at the end of the picklist.

Added a 'New Entry' button to Index page, you can now go to the Entry page without having to go to the log first.

Fixed the Refresh functionality on the Entry and Log pages.

Updated the where clause printing on a refresh.

Added the word search parameter to the printed where clause.

Display the where clause on the Entry page.

Added a check for no toolbars in the config file.

Added a specific exception for an invalid config file.

v1_8_06 March 25, 2004

Set the session time out to -1 (infinite) for the FormMaker.jsp, and reset it to 3 hours when returning to Entry.jsp. This should allow for infinite time to fill out forms.

v1_8_05 March 2, 2004

Made Submit on users forms case insensitive
Preserved the order of form elements in the user forms.
Fixed the category names in the pick topic list.