Introduction

Welcome to the SNS Logbook. The SNS Logbook is the official log of SNS operations activity. You must have a valid UCAMS user id and password to use the logbook. You may browse entries as well as compose and commit new entries from modern web browsers. Please see the release notes for more information about the requirements and version history.

General Tips
Getting Started

Log into the logbook using your valid UCAMS user ID and password. Please log out once you have finished to free resources on the server and to maintain the security of your account. Each session will be logged out after 30 minutes of inactivity.

The layout of the main window consists of the main toolbar fixed to the top of the page with the content below. For most pages (Browse, Bookmarks, Recent and Notifications), this content is typically a list of entries appropriate to the page. Initially, the entries are displayed in a collapsed summary list. When expanded, an entry is displayed fully formatted and with an entry toolbar in its header.

Browsing entries:
To browse (including search) the logbook, press the Browse link in the main toolbar. This will open an entry browser in which you can browse, filter and search entries.
Composing entries:
To compose and publish a new entry, press the Compose link in the main toolbar. A form for composing an entry will appear.
Bookmarks:
The bookmarks feature allows you to create and view entry bookmarks within a logbook. Every entry has a button that allows the user to bookmark the entry. Bookmarks are organized by logbook and are displayed for the currently selected logbook. To view your bookmarks for the currently selected logbook, press the Bookmarks link in the main toolbar.
Message Board:
To post or edit a message in the message board, press the Message Board link in the main toolbar. A form for Posting/Editing a message will appear.
Work Orders:
To view or associate work orders with an entry, press the Work Order link in the entry's toolbar. A Work Order window will pop up and display the list of associated work orders and a form for attaching a work order. You must attach work orders one at a time. Close the Work Order window when you are done with it.
Personnel on Duty:
To view personnel currently on duty, press the Personnel link in the main toolbar. To view the the personnel on duty at the incident time of an entry, press the Personnel link in the entry's toolbar.
Extend Timeout:
Users accessing the logbook from select terminals within the Controls network will see a checkbox labeled Extend Timeout sandwiched between their name and the logout link. Selecting this checkbox will extend your session for 12 hours from the moment you logged into the logbook. After that time has expired, the normal 30 minute timeout logic applies. If you are using a HTML 5 compliant browser, your selection will be saved for your account within your browser's local storage.
Help:
To view help, please press the Help link in the main toolbar. A new window (or tab depending your browser configuration) will open. In this way you can view the help content as you work with the logbook.
Browsing

To browse entries within the currently selected logbook, press the Browse link in the main toolbar. A browsing bar will be displayed and below that a list of entries for the current day. Each such entry is composed of a header (time stamp, title, author and several other entry attributes) followed by a summary (first few lines of unformatted text). From within this view, you can display the full entry (including full formatted text, images and attachments), display entries for different time ranges, filter the currently displayed entries, search the logbook for entries matching your specified criteria and sort the entries by the selected property.

By default, entries are sorted chronologically by the time stamp of the posting.

Logbook Selection:
When you login, by default your logbook selection will be your primary logbook if you have specified one, otherwise it will be your custom view. Use the Logbook menu to select from one of the Quick Picks: My Custom View, My Call List Membership, My Primary, My Favorite Logbooks, All Logbooks or any one of your favorite logbooks as the source for browsing entries. To edit your list of favorite logbooks and your default logbook, select the "Edit Favorite Logbooks" item at the bottom of the logbook menu.
Logbook Selection Quick Picks
Logbook Selection Matches Entries for Which
My Custom View Any of the following are true:
  • You are a member of the call list (non-null categories) for which the corresponding logbook and category are both assigned to the entry.
  • You have a subscription (either logbook or logbook and category) for which the corresponding (logbook or logbook and category) is/are assigned to the entry.
  • You have a logbook favorite for which the corresponding logbook is assigned to the entry.
  • You are the author of the entry.
My Call List Membership You are a member of the call list (non-null categories) for which the corresponding logbook and category are both assigned to the entry.
My Primary One of the entry's logbooks matches your Primary logbook which you selected in the Favorite Logbooks Editor.
My Favorite Logbooks One of the entry's logbooks matches any one of your favorite logbooks which you selected in the Favorite Logbooks Editor.
All Logbooks Matches any entry.
View an entry:
To view an entry, click the mouse on the entry's summary text. The entry will expand inline within the list of entries. You may also click on the entry's title and the entry will be displayed within its own window. An entry view displays the entry header followed by the entry toolbar followed by the full formatted text of the entry, attachments, images and threaded replies.
Bookmark an entry:
To bookmark an entry select the Bookmark link in the entry's toolbar. To delete a bookmark for an entry, press the Unbookmark link in the entry's toolbar. The entry will be added to your bookmarks and organized by its associated logbook(s). You can view all of your bookmarks by selecting the Bookmarks link in the main toolbar.
Reply to an entry:
To reply to an entry press the Reply link in the entry's toolbar. Then compose your entry as usual. The new entry will be added to a threaded discussion which includes the current entry as the parent.
View an entry's thread:
If an entry is part of a threaded discussion, the entry's parent and its immediate children will be visible. To view an entry's entire discussion thread press the Thread link in the entry's toolbar and a window will display the earliest ancestor of the current entry.
Navigating by date:
In the browsing bar, select the reference date role (Start or End date), edit the reference date, select the maximum time range and the logbook(s) to search. You may optionally select the sort ordering from the popup menu. Press the "Fetch" button to submit the request.
Filtering entries:
Type text in the filter field located in the browsing bar to immediately filter entries currently displayed on the page. An entry is matched if every word in the filter field appears somewhere in the entry. You can quote several consecutive words to require that those words appear in the specified order. An asterisk "*" is a wildcard which will match any string of characters. To filter entries by specific fields, you can prepend a word (or quoted words) with an entry field key and a colon. For example, group:physics will match entries where the group contains the word "physics". As a quick reference to determine the key for a particular entry field, simply place your mouse over a field in an entry and the tooltip will indicate the name of the field. Below is a table of field keys. Note that matching is case insensitive.
Field Description
alert Either "obsolete" or "active" indication for standing orders, daily orders or required readings.
author first, middle or last name of the entry's author
body Main text of the entry
group Logbook group
impact Impact area
logbook Logbook name
priority Either "urgent", "high" or "normal" indication of entry priority.
title title of the entry
type Entry type such as "Problem Report"

Examples:

To filter for entries matching every word in thomas pelaia ring loss against any field, enter:
thomas pelaia ring loss
To filter for entries matching every word in ring loss against any field and author, pelaia, enter:
author:pelaia ring loss
To filter for entries matching the expression, ring loss against any field and entry type, Problem Report and group, Physics, enter:
"ring loss" type:"Problem Report" group:physics
To filter for entries whose title includes the words, ring loss with Urgent priority, enter:
title:ring title:loss priority:urgent
To filter for entries whose title includes the word, ring followed by arbitrary text and then the word, loss, enter:
title:ring*loss

Searching:
Searching entries combines the features of date navigation and filtering. You select the reference date role (Start or End date), edit the reference date, select the maximum time range and logbook(s) just as discussed above when navigating by date. Next, enter the search criteria in the filter field just as described for filtering entries. Press the "Fetch" button to submit the search request.
Notifications

To display notifications, press the Notifications link in the main toolbar. Notifications display pending daily orders (operators only), required reading and email notifications. Daily orders and required readings require the user to acknowledge that they have read the entry. If an entry's title is striked through then this entry has been marked obsolete by operation management. These obsolete entries will remain in the list until the user has logged into the logbook system a few times so that they will be aware of the status change.

Batch delete notifications:
To delete a batch of your notifications, select the checkbox for each notification you wish to delete. Then press the button to delete the selected notifications.
Call List

The Call List displays your current group membership and allows you to view the members who belong to a specific category. To view your Call List membership as well as the Call List membership of others, press the Membership link in the main toolbar.

From this page you can also manage subscriptions to logbooks and categories to which you are not a member by pressing the Edit Subscriptions link at the bottom of the page.

Impacted Area

The Impacted Area Matrix page displays a matrix of impacted areas versus roles and the associated assignments in the cells. To view the impact areas, press the Impact Areas link in the main toolbar.

Bookmarks

Bookmarks provide a convenient way to maintain a list of entries of particular interest in a logbook. Personal bookmarks are maintained in the database for each user. Bookmarked entries are displayed chronologically just as when browsing entries.

Display your bookmarked entries:
To display your bookmarks for the current logbook selection, press the Bookmarks link in the main toolbar.
Bookmark an entry:
To bookmark an entry, select the Bookmark link in the entry's toolbar.
Delete a bookmark:
To delete a bookmark for an entry, press the Unbookmark link in the entry's toolbar.
Batch delete bookmarks:
To delete a batch of bookmarks, select the checkbox for each bookmark you wish to delete. Then press the button to delete the selected bookmarks.
Recently Viewed Entries

Whenever you view an entry, that entry is cached and you can see a list of the fifteen entries you most recently viewed. To list recently viewed entries, press the Recent link in the main toolbar.

Composing a New Entry

You may compose and publish an entry by pressing the Compose link in the main toolbar. If you have any saved drafts waiting to be published, you will see a list and have an opportunity to continue editing them or create a new entry. If you have no saved drafts you will immediately be directed to the edit page (or the favorite logbooks editor if you have not specified any favorite logbooks). A tab panel will be displayed allowing you to compose, preview and publish your new entry (or draft if you selected one).

Edit Tab:
The "Edit" tab allows you to select one or more logbooks and zero or more equipment categories and impacted areas. Enter a title and enter the plain text content. There is a 4000 character limit to the text, and a counter just below the content box keeps track of the length of your text. If you need to enter more text, you should add a text attachment as will be described later. Please note that the session timeout timer starts counting from the last action sent to the server. Editing text is only on the client side so does not count as server activity. If you are editing a long entry, either cut and paste from another editor or periodically press the preview tab to reset the timeout timer. If the session timeout occurs while you are editing text, there is no feedback until you attempt to commit your entry, select a link or perform some other session activity. If the session timeout occurs before you commit your entry you will lose your entry. Note that the title and content fields are required.
Image Tab:
The image tab allows you to add images. Select the image tab and then press the "browse" button (the button name is browser dependent but is the button associated with file upload) to select the images to upload. You may optionally edit the image titles and provide a description for your images. You may add as many images as you like. To remove an image simply press the button at the upper left corner of the image entry you wish to delete. To reorder an image entry, simply select the desired image order from the popup menu to the upper left corner of the image entry you wish to reorder.
Attachment Tab:
The attachment tab allows you to add attachments. Select the attachment tab, press the file upload button and select the files you wish to add. You can optionally provide alternative labels. To remove an attachment simply press the button at the upper left corner of the attachment entry you wish to delete. To reorder an attachment entry, simply select the desired attachment order from the popup menu to the upper left corner of the attachment entry you wish to reorder.
Preview Tab:
The preview tab allows you to preview your entry. Your published entry will appear as in the preview tab.
Saving, Publishing and Deleting:
Press the "Save Draft" button to save your entry to the logbook without making it visible to others. Your saved draft will be preserved even after you logout. You can resume editing your saved draft at a later time. It is recommended that you save your work frequently to avoid loss of your entry should your session expire.
Press the "Publish" button to save and publish your entry for others to read. Published entries cannot be edited. If you wish to clarify or correct an existing entry, it is recommended that you reply to it with a new entry.
Press the button to delete the entry including any saved drafts. Caution: You will not be able to recover an entry should you delete it.
Message Board

The message board allows operators to post and edit messages that get displayed on SNS web channels. Only operators have privilege to edit such messages. Some channels allow the operator to add and delete messages and to edit both the message title and the message body. For other channels, operators may only be able to edit the message body, but not the title and they won't be able to add or delete messages. The logbook will automatically display the controls and fields as appropriate to the user's privileges for the specific channels.

Adding a new message:
  1. Click the message board Message Board link in the main toolbar.
  2. Select a channel by clicking on its name.
  3. Click the Add link at the bottom of the list of messages.
  4. Edit the title and message body and press the "Save" button.
Deleting a message:
  1. Click the message board Message Board link in the main toolbar.
  2. Select a channel by clicking on its name.
  3. Click the delete button to the left of the message you wish to delete in the table of messages.
Editing a message:
  1. Click the message board Message Board link in the main toolbar.
  2. Select a channel by clicking on its name.
  3. Select the Edit link.
  4. Edit the title or message body as you wish.
  5. Press the "Save" button to commit the changes.