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 Product Home Page | CRL Manual Home Page
TOC PREV NEXT INDEX
View/print PDF file
Fermilab CD logo Control Room Logbook User's and Administrator's Guide

Table of Contents


About this Manual

Purpose and Intended Audiences

Availability

Notational Conventions

Your Comments are Welcome!

Overview and User's Guide

Chapter 1: Overview

1.1 About Control Room Logbook (CRL)

1.2 The CRL Application Window

1.2.1 The Look and Feel

1.2.2 The CRL Toolbar

1.2.3 The CRL Desktop

1.3 Logbook Entries

1.3.1 Entry Format

1.3.2 Entry Features

Chapter 2: Invoking and Logging Into CRL

2.1 Invoking the CRL Application

2.1.1 Windows

2.1.2 Linux

2.2 About Logging In

2.3 Username and Password Configuration

2.3.1 About the Entry Signers Feature

2.3.2 Logging In

2.3.3 Logging Out

2.4 Password and PIN Configuration

2.4.1 About PINs

2.4.2 Logging In

2.4.3 Logging Out

2.5 Changing your Password

Chapter 3: Making Entries in the Logbook

3.1 Selecting Category/Topic and Opening a Container

3.2 Selecting Entry Type and Creating Entry

3.3 Logbook Data Entry by Type

3.3.1 Text

3.3.2 Forms

3.3.3 Online Images

3.3.4 Output Files from External Applications

3.3.5 Freehand Equations, Drawings and Notes

3.3.6 Output from a Program or Command

3.4 Including Current Date and Time in Entry

3.5 Attaching Global Message to All Entries

3.5.1 Turn On a Message

3.5.2 Change or Turn Off a Message

Chapter 4: Editing Logbook Entries

4.1 Input Container Menu Options

4.2 Selecting Logbook Data

4.2.1 Select/Deselect Single or Multiple Entries

4.2.2 Select Text within an Entry

4.3 Modifying Non-archived Logbook Entries

4.3.1 Add to or Change Text in an Entry

4.3.2 Cut, Copy and Paste Text

4.3.3 Undo and Redo Operations

4.3.4 Change Text Font

4.3.5 Delete Entries

4.4 Attaching Keywords to a Logbook Entry

4.4.1 Keywords Tailored to Entry's Topic and Data Type

4.4.2 Global Keywords

4.5 Recovering or Deleting Checkpointed Entries

4.6 Printing Entries

4.7 Sending Entries via Email

Chapter 5: Archiving Logbook Entries to the CRL Database

5.1 About Archiving Logbook Entries

5.1.1 General Information for All Entry Types

5.2 Archiving Entries

5.3 Removing Archived Logbook Entries from View

5.4 Entries Left Unarchived

Chapter 6: Automated Logbook Entry and Archiving

6.1 Overview of the Autoschedule Feature

6.2 Setting up an Autoscheduled Job

6.2.1 Open a Container and Select Entry Source

6.2.2 Provide Autoscheduling Parameters

6.2.3 Change Scheduling Parameters or Stop Job

Chapter 7: Threading Logbook Entries

7.1 About Threads

7.1.1 The Thread Explorer

7.1.2 Thread Containers

7.2 Creating a Thread

7.2.1 From the Thread Explorer

7.2.2 From an Entry Input Container

7.2.3 From a Thread Container

7.3 Adding Entries to a Thread

7.3.1 From an Entry Input Container

7.3.2 From a Thread Container

7.4 Viewing and Manipulating a Thread

7.4.1 View and Sort Entries in a Thread

7.4.2 Print Entries in a Thread

7.4.3 Send Entries to an Email Recipient

7.4.4 Add Entries from One Thread to Another

7.4.5 Delete Entries from a Thread

7.5 Deleting a Thread

Chapter 8: Working with Archived Entries

8.1 Accessing Archived Entries from within CRL

8.2 Inquiries

8.2.1 Create an Inquiry

8.2.2 Execute an Inquiry and View Results

8.2.3 Halt Execution of an Inquiry

8.2.4 Save an Inquiry

8.2.5 Restore an Inquiry

8.3 LogEntry Explorer

8.4 Accessing Archived Entries on the Web

8.4.1 Define your own Search Criteria

8.4.2 Run a One-Click Search

8.5 Annotating Archived Entries

8.5.1 Annotate Within CRL Application

8.5.2 Annotate from the Web Interface

8.6 Downloading/Viewing Attached Files

8.7 Creating, Editing and Printing Reports in CRL

8.7.1 Pull Up a Report Container

8.7.2 Report Container Menu Options

8.7.3 Insert Entries into Report Container

8.7.4 Export Binary Files from Report Container

8.7.5 Select Report Entries in Container

8.7.6 Remove Entries from Report Container

8.7.7 Send Entries to an Email Recipient

8.7.8 Print Report

8.7.9 Add Entries to a Thread

Chapter 9: Programmer's Guide to the Process Logger

9.1 Introduction

9.2 Guidelines for Programmers

9.2.1 Entry Message Format

9.2.2 Return Messages from Plog

9.2.3 Sample Java Program Excerpt

CRL Administrator's Guide

Chapter 10: CRL Installation

10.1 Requirements

10.2 Software Requirements

10.2.1 Requirements for Installing CRL

10.2.2 Requirements for Running CRL

10.3 Installing CRL on Windows

10.4 Installing CRL on Linux

10.4.1 Install from tar File

10.4.2 Install using UPD

10.5 Upgrade Instructions

10.6 Preparing to Use CRL in Fermilab's AFS Products Area

10.6.1 Instructions

10.6.2 Note for Linux

10.6.3 Notes for Windows

10.6.4 Linux and Windows Combined Setup

10.7 Uninstalling CRL

10.7.1 Uninstall on Windows

10.7.2 Uninstall on Linux

Chapter 11: Configuring and Launching CRL

11.1 Editing the Properties File

11.1.1 The Bare Minimum

11.1.2 Further Edits

11.2 Launching the CRL Application

11.2.1 Once you're ready for launch...

11.2.2 Windows (Local and AFS Installations)

11.2.3 Linux (Local UPD Installation)

11.2.4 Linux (Local Tar File Installation)

11.2.5 Linux (AFS Installation)

11.3 Configuring Your Desktop

11.3.1 Define Keywords

11.3.2 Define a new Desktop Page (Data Entry or Report)

11.3.3 Define a Menu and/or Submenu on a Desktop Page

11.3.4 Define a ToolBar with ToolButtons for Data Entry Types

11.4 Creating Configuration Files for Forms

11.4.1 Create/Modify the XML Form Definition Files

11.4.2 Enable Automatic Electronic Mailing of Form Entries

11.4.3 Include Tables in a Form

11.4.4 Create Forms with Selected Reloadable Fields

11.5 Enabling Document View plus Thumbnail for PS and PDF File Entries

11.6 Editing the Inquiries Configuration File

11.7 Configuring Print Queues

11.8 Starting the Process Logger Daemon

Chapter 12: Managing User Information

12.1 The Administrator Button

12.2 Adding Users

12.3 Activating/Deactivating Users

12.4 Editing Information on Active Users

12.5 Exiting the Administrative Area

Chapter 13: Configuring Web Access to Logged CRL Entries

13.1 Editing the Properties File

13.2 Installing and Configuring Additional Software

13.3 Obtaining and Editing the JavaServer Page

13.3.1 Configure Keywords Table

13.3.2 Finding Information on JSP

13.4 Configure "One-Click" Searches

CRL Administrator's Reference Manual

Chapter 14: CRL's Java Properties

Chapter 15: Introduction to XML and DTD Files

15.1 XML Compared to HTML

15.2 Let's Get a Feel For It...

15.3 Element Types and Attributes in the DTD

15.3.1 Element Type Declarations

15.3.2 Attributes and Attribute Lists

15.3.3 Example of Element Type Declaration plus Attribute List

Chapter 16: The CRL Desktop Configuration File

16.1 CRL Configuration DTD Listing

16.2 Element Type and Attribute Listing

16.2.1 XML Declaration

16.2.2 LogBookConfig

16.2.3 Keyword

16.2.4 InitialTabs

16.2.5 Page

16.2.6 EntryInputPage

16.2.7 Menu and SubMenu

16.2.8 Topic

16.2.9 ToolBar and ToolButton

16.3 The CRL Java Class Libraries

16.3.1 Container (Topic) Classes

16.3.2 Entry type Classes

16.3.3 Desktop Page Classes

Chapter 17: Form and Inquiry Configuration Files

17.1 Form Definition Files

17.1.1 XML Elements Allowed in Forms

17.1.2 Sample "Start of Shift" Form

17.1.3 Sample "End of Shift" Form

17.1.4 Sample Form using a Variety of Form Elements

17.1.5 Sample Table Element in a Form

17.1.6 Sample Line for Running a Script or Command

17.1.7 Sample Lines with Field Placement Grouping

17.1.8 Sample Form with Embedded Forms

17.2 The Logbook Inquiry Configuration File

17.2.1 DTD Listing for Inquiries

17.2.2 Default XML File Listing for Inquiries

Index


TOC PREV NEXT INDEX
This page generated on: 05/14/03 14:43:20
--------
Security, Privacy, LegalFermi National Accelerator Laboratory