Fermilab Logo
-----
Computing Division at Fermilab
Computing Division - Fermilab-Search the Computing Web-CD Departments-Index-Help Desk-What's New
System Status-Projects in the Computing Division-Security-Fermilab Policy on Computing-CD Organization-Fermilab at Work
CRL DOC Home Page | CRL PRODUCT Home Page | Computing Division | Fermilab at Work | Fermilab Home

Control Room Logbook (CRL)


Quick Reference Card (Generic)


Getting Started with CRL
Get started with the CRL application interface.
Contact your CRL administrator to obtain a CRL account.
Change your CRL password when you use CRL the first time. See Change Password under The CRL Toolbar, below.
Log in to CRL at start of shift, and log out at end. See Log In/Log Out under The CRL Toolbar, below.

The CRL Toolbar
The column of buttons on left side of CRL window.
Log In/Log Out
Log in (CRL username and password required), and log out self or other user(s).
For "password and PIN" login method, also enter a PIN of at least 4 characters. You may enter a different one each time you log in.
Entry Signers
Add/remove logged in users to/from list of logbook entry signers (used with "username and password" login method).
Administrator
Add/activate/delete users (admin password required).
Change Password
Change your CRL password (4-8 characters).
Search
Query database of archived logbook entries.
Thread Explorer
Bring up the Thread Explorer window to access entry threads.
Scheduler
Bring up the Scheduler window to change or terminate autoscheduled entry jobs.
Current Situation
Enter "current situation" global message.
Preferences
Select entry header lines to display/hide in container windows.
Checkpoint Recovery
If you suspect loss of unarchived entries, recover them here.
About LogBook
View information about the CRL application.
Exit LogBook
Exit the CRL application.

Create Logbook Entries in CRL
Select an appropriate category and topic to open the corresponding input container window. Create entry. Entry header appears in RED.
1. Select a desktop page from the page tabs at top of CRL window.
2. Open an input container:
· If one or more are open by default, click on one to select it.
· Otherwise, select container category and topic from drop-down menus.
3. Select entry type and create entry in one of three ways:
· Select target container then double-click button on Logbook Entry Toolbar (at right-hand side of desktop). See Logbook Entry Toolbars.
· Drag Logbook Entry toolbutton into target container.
· Double-click inside target container (if configured).
4. Add information to entry.
5. Archive entry when complete.
Note: Any logbook entry that remains unarchived longer than 2 hrs will generate a prompt to archive or delete. Prompt repeats every 25 min. These intervals are set by default; your CRL admin may change them.

Logbook Entry Toolbars
Logbook entry toolbars run down right-hand side of desktop pages. The toolbutton names vary by experiment; those shown here are examples. See "Create Logbook Entries in CRL" for instructions on creating an entry using toolbar buttons.
· Text
Type in text at cursor and/or insert date&time, image, or text from file.
· ROOT Data
In dialog box, enter name of ROOT output file, or browse for it. File is dropped into container.
· Attach File
In dialog box, enter name of an application output file of any type, or browse for it. File is dropped into container.
· Execute
In dialog box, enter an OS command. Command output is dropped into the container.
· Ipen
In dialog box, enter the COM Port, open it, and draw your picture on the tablet. Save, and drawing is dropped into the container.
· Form
Fill out the form.

Create Image File from Screenprint
Capture image of window for subsequent inclusion into CRL entry. Save image file as gif or jpg. (UNIX prompt shown below as %)
Setup the UPS product imagemagick: % setup imagemagick [version]
To capture a window on CRL "home" machine:
% cd /path/to/CRLfiles
% import -delay <n> <filename>.<ext>
Within <n> seconds, click twice on desired window. Image file is saved in directory from which "import" command is issued.
Log into remote machine using ssh:
(If no ssh, run "xhost <CRL home machine>" on remote host.)
(on CRL home machine) % cd /path/to/CRLfiles
(on CRL home machine) % import -display <remoteHost>:0.0 <file>.<ext>
(on remote machine) Click twice on desired window.
Image file saved in directory from which "import" command is issued.
To view image: % xv [&]
To view image: % xv [&]


Select Logbook Entry(ies) in Container Window
You can select one or more entries in a container. Selected entry header background turns gray.
select an entry
Click
Click once in the entry's header.
deselect single entry (only one entry selected)
Click
Click once in the entry's header.
deselect single entry (only one entry selected) and select different entry simultaneously
Click once in the header of the new entry.
select multiple entries
<Ctrl>-click
Select the first entry as described above, then press the <Ctrl> key and click once in the header of another entry. Continue for additional entries
deselect one of multiple selected entries
<Ctrl>-click
Press the <Ctrl> key and click once in the header of entry to deselect.
select all entries in container

Entries menu > Select ALL Entries
This selects non-archived and archived entries.
deselect all selected entries

Entries menu > Un-select ALL Entries
Or 2 single clicks in selected header.

Edit and Archive Logbook Entries from CRL
LOG ON BEFORE YOU ARCHIVE ANY ENTRIES!!
Entry header appears in BLACK after entry is archived.
Unarchived entries: Edit, Delete, Archive
Archived entries: Thread, Annotate
Any logbook entry that remains unarchived longer than 2 hrs will generate a prompt to archive or delete. Prompt repeats every 25 min.
select text/image in an entry

Position cursor and drag over text.
select all text/images in an entry
Ctrl-a
Position cursor in body of desired entry. Select all manually, or click
Edit menu > select-all
cut text/image
Ctrl-x
Select item,click Edit menu > cut-to-clipboard
copy text/image
Ctrl-c
Select item, click Edit menu > copy-to-clipboard
paste text/image
Ctrl-v
Position cursor, click Edit menu > paste-from-clipboard
change font family
Font menu > Family
change font style
Ctrl-i italic
Ctrl-b bold
Ctrl-u underline
Font menu > Style (Click the style again to toggle back to normal font.)
change font size

Font menu > Size
change font color
Font menu > Color
insert image from file
F9
Place cursor in entry.
Insert menu > Image > From a file
insert image from URL
F8
Place cursor in entry.
Insert menu > Image > From a URL. Type full URL.
insert text from file
Ctrl-o
Place cursor in entry.
Insert menu > Text > From a File.
insert text from program
Ctrl-e
Place cursor in entry.
Insert menu > Text > From a Program.
replace text with program output
Ctrl+Alt-A
Place cursor in entry.
Insert menu > Text > Replace ALL TEXT with Output from a Program.
undo previous operation
Ctrl-z
Edit menu > Undo <operation>
Repeat n times to undo last n operations in stack.
redo "undone" operation
Ctrl-y
Edit menu > Redo <operation>
Repeat n times to redo last n "undo" operations in stack.
add keyword(s) to entry

Click on . Select from the left-hand list of attachable keywords and click Add=>. You can add multiple keywords at a time.
add global keyword(s) to entry

Click on ; click Global Keywords. Select from the left-hand list of keywords and click Add=>. You can add multiple keywords at a time.
remove keyword(s) from entry

Click on ; select from the right-hand list of attached keywords and click <=Remove. You can remove multiple keywords at a time.
archive selected entry(ies)

Entries menu > Archive Selected Entries
archive all entries
in container
Ctrl-s
Entries menu > Archive All non-archived Entries in this Topic
remove selected entry(ies)

Entries menu > Remove Selected Entries
(Archived entries are removed only from view, they remain in the database. Non-archived entries are deleted.)
remove all entries from container

Entries menu > Remove All Entries in this Topic
(See note above.)
send selected entries
F8
Entries menu > Send Selected Entries to Mail Recipient
send all entries
Ctrl+Shift-s
Entries menu > Send ALL Entries to Mail Recipient
view container category

Check Category

Attach Same Message to All Upcoming Entries
The Current Situation button is used to turn a global message on and off. Once set, the message is included with all future entries of all types in local CRL installation.
To set a message

Click Current Situation button. Type in message, then click OK.
To change the message

Click Current Situation button and edit the message. Click OK.
To turn off the message

Click Current Situation button. Choose Terminate Current Situation.

Thread Entries
Logbook entries pertaining to a particular issue can be linked via a "thread". Manipulate threads in THREAD CONTAINERS and INPUT CONTAINERS, as noted below.
create new thread
Thread Explorer > New Thread (or from input or thread container: Add Selected Entries to a Thread)
view a thread
Thread Explorer: select thread and drag it to thread container
sort entry(ies) in a thread
thread container: Sort menu
add entry(ies) to a thread
input or thread container: Entries menu > Add Selected Entries to a Thread
select entry(ies) in a thread
thread container: Ctrl-click individual entries, or Entries menu > Select ALL Entries
send entries in a thread
thread container: Entries menu > Send ... Entries to Mail Recipient
delete existing thread
Thread Explorer: select thread and click Delete Thread

Recover Checkpointed Entries
Logbook entries are periodically checkpointed to protect against data loss. Once CRL is back up after a disruptive event, you can recover the lost entries.
Click the Search button (on the CRL toolbar) to bring up Checkpoint window.
Open a checkpoint container or input container for which category/topic matches that for entry(ies).
On Checkpoint window, select desired entry(ies) and drag them to target container. Then edit and archive as desired.

Autoscheduled Logbook Entries
Use SCHEDULE CONTAINERS to schedule and automate Logbook entries from a periodically updated file.
Drag-and-drop a logbook entry toolbar button into schedule container. Use only data types that require no operator input.
A Schedule window pops up in which to set up the job parameters. Fill in values and click OK.

Search, View, Annotate Entries from CRL
Query database to retrieve archived entries. Use a REPORT CONTAINER to view and annotate them (if INPUT CONTAINER used, it filters on its category/topic).
Note: Printing is not enabled in CRL; print entries from Web interface.
Search and view archived entries:
Click the Search button (on the CRL toolbar at left). This brings up a window with two tabs:
· Inquiries
Set one or more filters for searching the database. You can configure your inquiry, execute it, save results, save the inquiry for future use, restore and edit inquiry. To view results, drag the Found <n> button to a report container.
· LogEntry Explorer
Search the database by year, month, day, or hour and by category/topic. Within the selected time window, optionally confine the search to a particular data input category and/or topic. Drag entry(ies) to a report container to view them.
Annotate an entry
Add a note to an archived entry. Scroll to entry and click Annotate button on entry.
Enter text, and click Commit Annotation.
View annotation
Click Refresh button on entry (all annotations made on entry appear).

Dec. 3, 2002
CRL v1_7_4
http://www.fnal.gov/docs/products/crl
--------
Security, Privacy, LegalFermi National Accelerator Laboratory