Work Journal Manual

Thornton Rose (thornton_rose@yahoo.com)

Copyright © 2001, Thornton Rose

Contents:

• Description
• Installation
• Running Work Journal
• Work Journal Window
• Journal Entry Window
• Journal Report
• Time Report
• Files
• Database

Description

Work Journal is a small application that is used to keep a journal of work activity -- date, start time, end time, notes, etc. It is written in Java and has a Swing GUI.

Installation

1. If you are installing over a previous version of Work Journal, make a backup of the db directory.

2. Make a directory somewhere for the application (herein referred to as WORK_JOURNAL_HOME).

3. Unzip the Work Journal distribution file (WorkJournal-<version>.zip) into WORK_JOURNAL_HOME. You can use a GUI tool like WinZip, or you can use the jar utility that comes with the JDK. Here's an example of the latter:

   cd WORK_JOURNAL_HOME
   jar xvf /WorkJournal1.2.jar

4. If you made a backup of the db directory, copy its contents into the db directory in WORK_JOURNAL_HOME.

5. On Unix/Linux:

   1. Make WORK_JOURNAL_HOME/WorkJournal executable.
   2. If you are using a desktop such as KDE, create a shortcut and point it at WORK_JOURNAL_HOME/WorkJournal.

6. On Windows, copy the WorkJournal shortcut (WORK_JOURNAL_HOME/WorkJournal.lnk) to your start menu.

Running Work Journal

If you have created an icon/shortcut for Work Journal, just double-click it. Otherwise, to run Work Journal from the command-line:

cd WORK_JOURNAL_HOME
WorkJournal

If you want to run Work Journal directly:

(Unix/Linux)
java -jar WORK_JOURNAL_HOME/lib/WorkJournal.jar

(Windows)
java -jar WORK_JOURNAL_HOME\lib\WorkJournal.jar
-or-
javaw -jar WORK_JOURNAL_HOME\lib\WorkJournal.jar

Work Journal Window

The Work Journal Window is the main window the Work Journal application.

Menu:

• File:
  • New Entry -- Create a new journal entry.
  • Edit Entry --Edit the selected journal entry.
  • Delete Entry -- Delete the selected journal entry.
  • Exit -- Exit the application.
• Reports:
  • Time Report -- Run the Time Report.
  • Journal Report -- Run the Journal Report.
• Help:
  • About -- View application identification.

Toolbar:

• New Entry
• Edit Entry
• Delete Entry
• Journal Report
• Time Report
• About

Journal Entry Window

The Journal Entry window is used to add and edit journal entries

Fields:

• Work Date - The date on which you worked. The format is MM/DD/YYYY.
• Start Time - The time at which you started work. The format is HH:mm a.
• End Time - The time at which you ended work. The format is HH:mm a.
• Meal Time - The time you spent on meals, in hours and minutes. The format is HH:mm.
• Notes - Notes about the work.

Buttons:

• Save - Save the journal entry and close the window.
• Cancel - Close the window without saving the journal entry.

Defaults:

Defaults for the fields on the Journal Entry Window can be specified in the WorkJournal.properties file. Here is an example:

   entry.startTime=7:00 AM
   entry.endTime=4:00 PM
   entry.mealTime=1:00

Journal Report

The Journal Report shows journal entries for a given date range.

Fields:

• Start - The start date for the report. The format is MM/DD/YYYY.
• End - The end date for the report. The format is MM/DD/YYYY.

Buttons:

• Run - Run the report.

Time Report

The Time Report shows work time for a given date range, with totals for meals and hours.

Fields:

• Start - The start date for the report. The format is MM/DD/YYYY.
• End - The end date for the report. The format is MM/DD/YYYY.

Buttons:

• Run - Run the report.

Files

   build.xml              -- Build file (used with Ant).
   window.properties      -- Window properties
   WorkJournal            -- Shell script to start app. (uses java.exe)
   WorkJournal.bat        -- Batch file to start app.
   WorkJournal.jpr        -- JBuilder project file
   WorkJournal.jpr.local  -- JBuilder project file
   WorkJournal.lnk        -- Windows shortcut to app. (uses javaw.exe)
   WorkJournal.properties -- App. properties
   db/                    -- Database files
   db/wjdb.backup         -- Database backup file
   db/wjdb.data           -- Database data file
   db/wjdb.properties     -- Database properties file
   db/wjdb.script         -- Database statement log
   docs/                  -- Documentation
   docs/api/              -- Javadocs
   docs/history.txt       -- Version history
   docs/manual.txt        -- Manual
   docs/readme.txt        -- Distribution information
   lib/                   -- Library files
   lib/hsqldb.jar         -- HSQLDB database library
   lib/javacogs.jar       -- JavaCogs library
   lib/workjournal.jar    -- Work Journal library
   src/                   -- Source code

Database

The Work Journal database is an HSQLDB database. It contains the following tables.

• journal -- Journal Entries:
  
  

  Column	Datatype
  ID	bigint
  workdate	date
  starttime	varchar
  endtime	varchar
  mealtime	varchar
  notes	varchar

• journal_seq -- Journal Sequence Number:
  
  

  Column	Datatype
  seq	long