US Army Corps 

of Engineers

Construction Engineering

Research Laboratories

Technical Report REMR-OM-20

July 1998

REMR Management SystemsC

BREAKWATER Computer Program

User Manual (Version 1.0)

by Ricardo Aguirre

U.S. Army Construction Engineering

Research Laboratories

Don Plotkin

U.S. Army Construction Engineering

Research Laboratories

Approved For Public Release; Distribution Is Unlimited.
Repair, Evaluation, Maintenance, and Technical Report REMR-OM-20

Rehabilitation Research Program July 1998

REMR Management SystemsC

BREAKWATER Computer Program

User Manual (Version 1.0)

by Ricardo Aguirre

Research Assistant 

U.S. Army Construction Engineering

 Research Laboratories

PO Box 9005

Champaign, Illinois 61826-9005

Don Plotkin

Civil Engineer 

U.S. Army Construction Engineering

 Research Laboratories

PO Box 9005

Champaign, Illinois 61826-9005

Approved for public release; distribution is unlimited.

Prepared for U.S. Army Corps of Engineers

Washington, DC 20314-1000

Under Civil Works Research Work Unit 32673

Monitored by Maintenance Management and Preservation Division

U.S. Army Construction Engineering Research Laboratories

PO Box 9005, Champaign, IL 61826-9005
ii

Contents

Contents ............................................ ii

Preface ............................................ iv

1 Introduction ....................................... 1

Background ...................................... 1

Objectives ....................................... 1

Scope .......................................... 2

Approach ........................................ 2

Mode of Technology Transfer ........................ 2

2 Overview ......................................... 3

Program Description ............................... 3

Breakwater’s Major Components ..................... 3

General Program Operation and Arrangement ........... 5

Manual and Program Conventions .................... 7

Program Operation Keys: Functions and Conventions ..... 8

Program Help: The F1 Key ......................... 9

Using a Mouse ................................... 9

Multiple Program Operation ........................ 10

3 Program Installation and Setup ....................... 11

Introduction ..................................... 11

Hardware Requirements ........................... 11

.............................................. 11

Computer Configuration ........................... 12

Installing BREAKWATER .......................... 12

Starting BREAKWATER ........................... 13

BREAKWATER Setup Options ...................... 13

.............................................. 13

Program Configuration ............................ 14

4 Inventory ........................................ 17

Introduction ..................................... 17

Defining a Project ................................ 17

Editing/Deleting a Project .......................... 19

Defining a Structure .............................. 21

Editing and Deleting a Structure ..................... 23

Defining a Reach ................................. 24

Editing/Deleting a Reach ........................... 26
iii

5 Inspection ........................................ 28

Adding Inspection Data ............................ 28

Modifying Inspection Data .......................... 32

Modes ......................................... 32

Change Modes ................................... 33

Comments ...................................... 33

Structural Data ................................... 34

Reach Stations, Suggested Actions, Comments ......... 36

Additional Data ................................... 37

Functional Data .................................. 37

Other Functions .................................. 38

6 Reports and Forms ................................. 40

General Organization and Operation .................. 40

District Inventory Summary ......................... 41

Condition Index Calc: Reach ....................... 41

Historical Rating Summary ......................... 42

Comment Report: Reach .......................... 43

Missing Information Report ......................... 44

Print Inspection Forms ............................. 44

7 Database Administration ............................ 46

Introduction ..................................... 46

Selecting a Database .............................. 46

Copying a Database .............................. 46

Deleting a Database .............................. 48

Merging Two Databases ........................... 48

Reorganizing a Database .......................... 49

Creating a Database .............................. 50

Appendix A: Reports .................................. 51

Appendix B: Forms ................................... 97
iv

Preface

The computer program described herein was authorized by Headquarters, US Army Corps of

Engineers (HQUSACE), as part of the Operations Management problem area of the Repair,

Evaluation, Maintenance, and Rehabilitation (REMR) Research Program. This work was

performed as part of Civil Works Research Work Unit 32673 “Development of M&R Guidelines

and Management Systems for Civil Work Structures” Mr. Don Plotkin is the Principal Investigator and Mr. Harold Tohlen (CECW-O) is the REMR technical monitor for this work.

Mr. David B. Mathis (CERD-C) is the REMR Coordinator at the Directorate of Research and

Development, HQUSACE; Mr. Tohlen and Dr. Tony C. Liu (CECW-EG) serve as the REMR

Overview Committee; Mr. William McCleese (CEWES-SC-A), US Army Engineer Waterways

Experiment Station (WES), is the REMR Program Manager; Dr. Paul Howdyshell is the Problem

Area Leader for the Operations Management problem area.

This work was conducted by the US Army Construction Engineering Research Laboratories,

Facilities Technology Laboratory, Maintenance Management and Preservation Division (FL-P). 

Dr. Simon Kim is FL-P Division Chief.

The authors gratefully acknowledge the assistance of the Coastal Structure Advisory Group and

many others throughout the Corps’ coastal community whose excellent ideas helped guide this

work.

COL James A. Walter is Commander of USACERL, and Dr. Michael J. O’Connor is Director.
v
Chapter 1: Introduction 1

1 Introduction

Background

In an effort to improve maintenance techniques and practices for inland waterway and coastal

structures, the U.S. Army Corps of Engineers (USACE) established the Repair, Evaluation,

Maintenance, and Rehabilitation Research (REMR) program. Within the REMR program is a

group of projects dedicated to the development of computerized maintenance management

systems for coastal and inland waterway navigational structures. The general intent of these

REMR Management Systems is to provide maintenance managers at all levels with tools to

promote easier and more effective maintenance and budget planning. Additional objectives are

to create uniform procedures for assessing the condition of structures and to create assessment

methods that will allow the condition of structures, and their parts, to be expressed numerically

to take best advantage of the benefits available from the use of microcomputers in maintenance

management.

The computer program described here is the initial version of the computer program for

maintenance management of coastal structures. This version is a companion program for the

Condition and Performance Rating Procedures for Rubble Breakwaters and Jetties, developed as

part of REMR Work Unit 32672. 

Objectives

The objectives of this phase of the project were to produce a computer program which would:

1. Allow the establishment of a database of rubble breakwaters and jetties.

2. Allow the collection of structure inspection and rating information, as required by the

condition and performance rating procedures for rubble breakwaters and jetties

developed under REMR Work Unit 32672.

3. Calculate Structural Index (SI), Functiponal Index (FI), and Condition Index (CI)

values. 

4. Produce a selection of reports showing inventory, inspection, and index data. 

This manual describes the operation of the BREAKWATER program, version 1.0, which

contains the basic features described in items (a) through (d) above.
2 Chapter 1: Introduction

Scope

The computer program described here represents the first stage in developing a maintenance

management system for coastal navigation and protection structures. The computer software

(currently called BREAKWATER) is a DOS-based program intended to handle the most basic

maintenance management functions and calculate the required index values. 

This initial program concentrates on breakwaters and jetties of rubble construction with either

rock or concrete armor units. Future efforts will include system features for breakwaters and

jetties of nonrubble construction and also seawalls, bulkheads, and revetments, as well as other

desired management functions. Future versions of the program will be Windows-based and

otherwise consistent with the most current operating and network systems in use at that time.

Approach

As a companion program to the condition and performance rating procedures for rubble

breakwaters and jetties (developed under REMR Work Unit 32672), the program screens were

made to closely match the inspection and rating forms developed for the field and office ratings

and analysis. The method for calculating the index values is as described in the manual on

“Condition and Performance Rating Procedures for Rubble Breakwaters and Jetties.”

Mode of Technology Transfer

This manual is the primary means of technology transfer. As time and funding permit, program

demonstrations and short classes will occasionally be conducted.
Chapter 2: Overview 3

2 Overview

Program Description

This is the initial version of BREAKWATER—the REMR management system computer

program for coastal structures. It was developed as part of the REMR (Repair, Evaluation,

Maintenance, and Rehabilitation) research program (Work Unit 32673) sponsored and guided by

the U.S. Army Corps of Engineers Directorate of Civil Works – Operations and Readiness

Division. 

This initial DOS-based version handles basic structural and functional information, reporting,

and Condition Index (CI) calculations for rubble (or primarily rubble) breakwaters and jetties,

with either rock or concrete armor units. It is a companion program for the manual on Condition

and Performance Rating Procedures for Rubble Breakwaters and Jetties, also produced under

the REMR program.

It is intended that future versions of BREAKWATER will be expanded to cover other types of

coastal structures and to incorporate other modules and features needed to assist with maintenance management of these structures. Future versions will also include updated software.

Breakwater’s Major Components

There are four components to the BREAKWATER Program.

Inventory

Inventory is the set of data that describes the location, dimensions, and general construction 

characteristics of each structure. It also indicates the division of the structures into reaches, the

functions each structure (or reach) is intended to perform, and which Corps project the structure

is part of. For each structure, a completed inventory data set defines that structure within the

program so that all subsequent inspection and condition information can be properly associated

with it. Details are in Chapter 3.

Inspection

Inspection is data that describes the physical condition and functional performance of a structure. 

Most inspection entires are either structural and functional numerical ratings (from which the
4 Chapter 2: Overview

program calculates Condition Indexes) or comments that explain the rating choices and

document other observations about the structure. Screens in the Inspection component follow the

same format as the structural and functional rating forms used by inspectors and engineers. 

Details are in Chapter 4.

Reports and Forms

The reports and forms component offers the user a series of reports summarizing or detailing past

inspections and pre-headed blank structural and functional rating forms for the next inspection

and rating for a reach or structure. The Reports option contains the following five choices: 

1. District Inventory Summary

2. Condition Index Calculation for Reaches

3. Historical Rating Summary

4. Comment Report for Reaches

5. Missing Information Report. 

The Forms option contains the following five choices:

1. Blank Inspection Form

2. Date Selected Inspection Form

3. Project Selected Inspection Form

4. Structure Selected Inspection Form

5. Reach Selected Inspection Form 

The forms are the same as those shown in the rating procedures manual. Details are in Chapter

5.

Database Administration

A database is a set of data for a group of coastal projects and thus typically contains data on

many structures. In practice, it is expected that each Corps District will maintain one database

for its structures, although smaller databases (as for Area Offices) are also possible. 

The Database Administration component allows the user to perform these operations with

databases:

1. Create databases (essentially giving them a name that defines them in the computer).

2. Select a database to work with.

3. Copy databases.

4. Merge databases (creates a Division database from two or more District databases).
Chapter 2: Overview 5

5. Reorganize databases (restores them in the computer to occupy disk space most

efficiently).

6. Delete databases.

All of these options can be performed on databases that are on a floppy disk, a hard drive, or a

network drive. Details are in Chapter 6.

General Program Operation and Arrangement

Working with Data

Before any data can be entered, viewed, or edited, a database must be chosen or created. Do this

by choosing (5) Database Administration from the main menu and then choose either (1) Select a

Database or (6) Create a Database from the Database Administration menu.

The Two Menu Types

BREAKWATER is menu driven; that is, most operations are initiated by choosing a selection

from a menu (or list) of options. There are two types of menus in the program. They appear in

the following general formats:

1 2

[A] Option 1 Main Menu

[B] Option 2 Submenu

[C] Option 3 Submenu 2

In either type an option may be selected by:

1. Using the arrow keys to highlight the desired option and pressing the key labeled

[ENTER], or

2. Pressing the key designated as the trigger.

In column 1, the triggers are A, B, and C. In column 2 the triggers are M, S, and 2.

Entering Data

Data entry is handled in two ways:

1. A Pop-up Menu system, where the appropriate data may be selected by the two

methods described above.
6 Chapter 2: Overview

2. Typing in the information, where the size of the box indicates the amount of data that

can be entered (the maximum number of characters).

The Main Menu

The program begins with the Main Menu, which provides the following options:

• Add/Edit Project & Structure Inventory

• Modify/View/Delete Inspection Data

• Add Inspection Data

• Reports and Forms

• Database Administration

• Machine Configuration.

Add/Edit Project & Structure Inventory

This option is used for defining structure inventory. It allows the user to describe the location,

dimensions, and general construction characteristics of the projects, the structures, and the

reaches. This option also allows the user to edit already defined projects, structures, and reaches. 

Modify/View/Delete Inspection Data

This option (to modify, view, or delete inspection data) is a supplement to Add Inspection Data

and can only be used after inspection data has been entered. This option is also useful for

quickly viewing calculated Condition Index values for individual reaches and their respective

structures. The user should be careful, however, when choosing Delete as there is no retrieving

feature to recover data after it is deleted.

Add Inspection Data

This option is used for entering inspection data. It can only be used after the project and

structure inventory have been completely defined. 

Reports and Forms

This option is used for obtaining reports and forms. Reports provides organized formats for

viewing or printing inventory or inspection data, comments, missing information, structural and

functional ratings, and the related calculated Condition Index values. Forms provides field

inspection sheets that can have blank headings or be pre-labeled with the project, structure, reach,

and inspection date headings.
Chapter 2: Overview 7

Database Administration

This option is used for managing the program’s databases. As with Modify/View/Delete

Inspection Data, the user should be careful when using the delete mechanism in this option;

once deleted, a database cannot be recovered. 

Machine Configuration

This option is used for adjusting screen colors, printer options, and program sounds. It allows

the user to create a comfortable setting for working with this program and provides printing

options for various printers.

Manual and Program Conventions

Manual Convention

Throughout the manual it is assumed that most entries are actuated by pressing the ENTER key. 

Therefore, this step will not be shown in the manual. Any exceptions will be noted.

Program Conventions

The following conventions are used with BREAKWATER:

1. The box at the bottom of the screen is the key information box. Available keys and

their functions are noted in that box.

2. Most data fields must be completed to allow the program to calculate condition

indexes; optional data fields are usually apparent. 

3. Incomplete data sets may be saved. 

4. The F10 (Done) key:

• May be used at any time during the operation of the program.

• During data entry and modification the F10 key will prompt the user to

Save the data and return, Abort the data and return, or Continue

editing the current data set. Upon completion of the Save or Abort,

the system returns the user to the previous screen.

• At non-data entry and modification screens, the F10 key simply returns

the user to the previous screen.
8 Chapter 2: Overview

Program Operation Keys: Functions and Conventions

The Three Operation Key Types

There are three types of keys available for use throughout BREAKWATER:

1. Data Entry Keys

2. Editing Keys

3. Specialty Keys

The functions of each type are discussed below:

Data Entry Keys

The data entry sections of BREAKWATER use a number of keys for cursor movement, data

selection, and special functions. The system employs two different methods for data entry. The

first involves selection of data from a pop-up menu (Type 1). The second requires the user to

key in the data (Type 2). Key availability and function is displayed in a box at the bottom of the

screen.

Key Name Symbol Function

Enter Key [ENTER] Accepts the data and moves cursor to the next data field.

Home Key Home Places cursor on the first data entry field.

End Key End Places cursor on the last data entry field.

Up Arrow Key ↑ Type 1: Moves the highlight bar up one menu option.

Type 2: Places the cursor on the data entry field above the current field.

Down Arrow Key ↓ Type 1: Moves the highlight bar down one menu option.

Type 2: Places the cursor on the data entry field below the current field.

Right Arrow Key → Type 1: Moves the highlight bar down or to the right one menu option.

Type 2: Places the cursor on the next data entry field.

Left Arrow Key ← Type 1: Moves the highlight bar up or to the left one menu option.

Type 2: Places the cursor on the previous data entry field.

F1 Key F1 Displays help screen.

F2 Key F2 Functions as a Type 2 up arrow key, and a Type 1 and Type 2 entry only on those

screens that apply.

F3 Key F3 Functions as a Type 2 down arrow key, and a Type 1 and Type 2 entry only on those

screens that apply.

F10 Key F10 F10 always exits the current process and returns the user to the previous one.
Chapter 2: Overview 9

Editing Keys

The following editing keys are used mainly when making changes to the data already entered

into the program:

Key Name Symbol Function

Backspace Key ← Backward one space (erases characters as it moves)

Delete Key DEL Deletes the character at the cursor position

Insert Key INS Toggles the Insert Mode on / off

Left Arrow Key ← Backward one space (moves without erasing characters)

Right Arrow Key → Forward one space (moves without erasing characters)

Specialty Keys

Function Keys F2, F3 and F4 perform different actions at different locations in the system. 

During the editing process they function as described above. At other times the actions are listed

at the bottom of the screen in the key box.

Program Help: The F1 Key

Program Help was created for user convenience, and supports most screens in the BREAKWATER program. When activated, the F1 Key provides the user with a description of the highlighted option displayed on the current screen. If F1 Help is activated on a menu screen, such as

the main menu of the program, it will remain on until an option is chosen. This allows the user

to scroll down the menu to see a description of each option.

If a screen is not supported by F1 help, then pressing the F1 key defaults to the system help box. 

The system help box gives a listing of the Breakwater and computer program definitions. In

addition to the definitions, the system help provides tutorials on the major procedures for

inventory and inspection. The user may want to skim the system help box and review the

provided tutorials for brief step by step procedures on how to input data into this system.

Using a Mouse

The mouse acts as a supplement to the keyboard, and can be used in almost all of the screens. 

The mouse has the same point and click features in this program as all other Windows type

programs. However, the cursor for the mouse will not be an arrow like most windows programs,

but rather a block that takes up the space of one character. Like other Windows-type programs,
10 Chapter 2: Overview

you are able to point anywhere in a screen and click to insert your entry or select a menu option. 

In some screens, however, the mouse is not activated.

Multiple Program Operation

Due to the origination and development as a DOS based program, Breakwater is best run with

few or no resident programs open. Lack of memory might cause the BREAKWATER program

to produce a fatal error if too many other computer programs are being run at the same time.
Chapter 3: Program Installation and Setup 11

3 Program Installation and Setup

Introduction

This chapter will explain the steps required prior to entering data into BREAKWATER. The

following topics will be covered:

• Hardware Requirements

• Computer Configuration

• Installing BREAKWATER

• Starting BREAKWATER

• BREAKWATER Setup Options.

Hardware Requirements

BREAKWATER was developed for operation on an IBM (TMInternational Business Machines

Corp.) compatible personal computer that runs at least MS-DOS 3.3 (TMMicrosoft Corp.). A hard

disk drive is required with a recommended 20 megabytes or higher free storage capacity. 4

megabytes of Extended Memory is required to run this version of the program. 640K RAM

memory is also required. 

If the computer has memory resident utilities such as Sidekick or PC Tools loaded into memory,

they may need to be unloaded before BREAKWATER can be run.

If BREAKWATER is to be run on an older (slower) PC, a system for disk caching is highly

recommended. There are many utilities, shareware and otherwise, available which can improve

disk performance substantially. We warrant no caching system to perform with this program

other than SMARTDRIVE.
12 Chapter 3: Program Installation and Setup

Computer Configuration

A file called CONFIG.SYS must be present in the root directory of the PC with the following

commands for this program to run properly.

BUFFERS =25

FILES = 25

The CONFIG.SYS file can be detected by typing DIR CONFIG.SYS in the root directory. If

the file exists, the PC will list the file name, size and date created. If you do not have a

CONFIG. SYS file, use a text editor (not a word processor unless the information can be saved in

text format) to create one with the above commands. Place the file in the root directory of the

PC. After creating a new CONFIG.SYS, restart the PC (CTRL-ALT-DEL). To ensure that the

PC has at least 640K of available RAM memory, type the command CHKDSK at the C:\>

prompt to receive a disk and memory status report. The last two lines displayed on the screen

should read:

# BYTES TOTAL MEMORY

# BYTES FREE

The number of bytes total memory should be at or near 640K. The number of bytes free should

be near 511K or greater. If it is not, check for the presence of a memory resident utility. For

further explanation concerning CONFIG.SYS, BUFFERS, and FILES commands, consult a DOS

manual.

Installing BREAKWATER

BREAKWATER will be supplied on floppy disk. All the files will be copied onto the local hard

drive when the program is installed. A summary of the install procedure follows (while in DOS):

1. Insert the floppy disk labeled Disk #1 into the PC's A: drive.

2. Type A:install at the C:\>prompt.

3. Follow the instructions displayed on the screen. Choose BRKWATR as your

subdirectory.

When the install process is complete BREAKWATER is on your local hard drive in a directory

called BRKWATR, as you have chosen.
Chapter 3: Program Installation and Setup 13

Starting BREAKWATER

When you are ready to access BREAKWATER, you must be in the BRKWATR directory.

1. Access the BREAKWATER directory. At the system prompt type:

C:\>CD BRKWATR

2. Type the command BWMAIN after the system prompt.

C:\BRKWATR>

The first BREAKWATER screen will now appear.

BREAKWATER Setup Options

After BREAKWATER is invoked with the command C:\BRKWATR> BWMAIN, and a

password is given, the main menu is displayed. All options begin at this menu.
14 Chapter 3: Program Installation and Setup

Program Configuration

When using BREAKWATER on a color monitor, the ability to specify foreground and

background colors, as well as printer types has been provided in the Machine Configuration,

option 6, from the main menu. The machine configuration option provides a menu driven

method for the user to modify the default settings for a number of different display

characteristics. When the Machine Configuration Menu of each new selection is displayed, the

current setting is shown as the default.

•Breakwater PC Configuration Menu
Chapter 3: Program Installation and Setup 15

•Printer Configuration Menu

The system must be configured for the proper printer to print the reports and forms.

BREAKWATER provides the parameters for six predefined printers. These are: HP LaserJet,

Epson, Null, AP4000, Okidata, and an IBM printer. If the appropriate printer is not available in

the above listing, a fifth option, CUSTOM is provided. When selecting CUSTOM the user

must supply the system with two pieces of information about the printer. First, a user defined

printer name is necessary for reference by the program (i.e., 'IBM PROPRINTER'). Second, you

must enter the printer codes manually. See your Printer Operating Manual for instructions on

how to do this.

C Screen Configuration

The system has the ability to work with color or monochrome screens. These can be selected via

the screen configuration menu.

C Screen Colors

The foreground and background colors may be specified for the following displays: titles, boxes,

text, highlighted text, error messages, pop-up boxes, triggers, data, highlight (menu) bars, and

fields. The possible color choices are selected from a menu. They are: Blue/Gold, Blue/Green,

Blueline, Gas Plasma, Green/Gray, LCD Laptop, Monochrome, and Rainbow. The user should

try out each color scheme to see which one is the most preferable.

The arrow keys are used to maneuver the menu bar over the desired color scheme, and the

carriage return is used to select it. Also, the user is able to select any color scheme by clicking

on it with the left mouse button. As the colors are changed the main selection menu acts as a
16 Chapter 3: Program Installation and Setup

sample box, and reflects the user’s new choices. Upon completion, the new colors may be

stored by pressing the F10 key and answering Y to the store changes prompt. From this point

forward the Coastal Structure Module will reflect the new colors chosen by the user.
Chapter 4: Inventory 17

4 Inventory

Introduction

Inventory information defines the projects and structures within the program database. This

information must be entered before any inspection data can accepted by the program. Inventory

is divided into these three types of data:

C Project Data

C Structure Data

C Reach Data

Defining a Project

To add (define) a project:

C Select Add/Edit Project & Structure Inventory, option 1, from the Main Menu.

The following screen will appear—the Project/Structure/Reach Menu.

C Select Add Project Information, Option 1.
18 Chapter 4: Inventory

The Add Project screen will appear.

The following data should be entered for each project:

Project Name: Name of project. It is the name under which the structures are listed.

Project Number: The number that corresponds to the project and distinguishes it from other

projects.

District: The USACE district where the project is located.

Division: A three-letter abbreviation of the division where the project is located. (i.e.

SPD - South Pacific Division).

City: The city where the structure is located.

State: The state where the structure is located.

Protected Waters: The body of water that the structure is protecting: harbor, channel, etc. 

Authority: The legislative authority that led to the construction and maintenance of the

project.

Owner: The owner of the project may be a public or government agency.

Office File: The number that corresponds to an office file of the project.
Chapter 4: Inventory 19

Congress: The congressional district where the project is located. This field has two

parts. The first part is automatically entered by BREAKWATER and is the

two-letter state abbreviation supplied in the State field. The second part is a

three digit number. This number is user-supplied.

The following keys can be used to move the cursor on the screen:

Arrow Keys Move the cursor from field to field around the screen.

Home/End Moves the cursor to the first / last field on the screen.

F2 Acts the same as the up arrow key.

F3 Acts the same as the down arrow key.

After entering the Congressional District Number, BREAKWATER will automatically save the

record if all the information was entered correctly. If data is missing in the Project Name field

or the Project Number field or both, a warning box pops up and the user is allowed to go back

and enter the missing information.

If F10 is pressed before the Congressional District Number is entered, a box pops up and asks

whether to (A)ccept, (M)odify or (E)xit. Exit will stop and not save the current data. Modify

will allow editing of the current data, and/or additional data to be entered. Accept will record the

current entry and return to the previous menu.

Editing/Deleting a Project

To Edit a Project

C Select Add/Edit Project & Structure Inventory, option 1, from the Main Menu.

C Select Edit/Delete Project Information, option 2, from the Project/Structure/Reach Menu.
20 Chapter 4: Inventory

The Select a Project to Edit screen will appear.

After a short pause, a large bounce-bar menu appears within a box labeled Select a Project. 

Inside the box is the list of projects that have been defined. The project in the top row is

highlighted. The arrow keys will move the highlight bar up or down as desired.

The list can be longer than that shown on the screen. The page down (PGDN) and page up

(PGUP) keys may be used to flip to the next (or previous) screen.

Press [ENTER] to select the highlighted record for editing. At this point the user is ready to edit

a previously defined project. The data entry screen will appear with the previously entered data

next to the field names. The user may now step through each field in the same manner as when

originally entered.

One exception is at the last field, Congress. The [ENTER] key will complete this entry and

prompt the user with a small box to Save Record (Y/N)? After answering appropriately, the

screen stays in the edit mode. F10 can also be used to indicate that the user is done editing the

screen. When F10 is pressed the user will get an Accept, Modify, or Exit pop-up box. If no

changes were made to the project record, the user will be returned to the previous menu after

hitting F10.
Chapter 4: Inventory 21

To Delete a Project

From the Select a Project to Edit box, pressing F2 for a highlighted project will mark that

project for deletion. After pressing F2, the user is asked to confirm the deletion, by answering

the prompt:

<<No>> <Yes>

By pressing Y the user confirms the removal of the project data. The N key will abort the

command and not delete the data. The user will be returned to the Select a Project box and can

proceed to mark other records for deletion.

The user should note that records marked for deletion are denoted with a "D" to the left of the

Project Name. Pressing F3 while the highlight bar is on a marked record will restore the record

from deletion. The user is asked to confirm the restore with a <<No>> <Yes> prompt. Records

can be marked and unmarked for deletion as often as desired before the F10 key is pressed.

The F10 key is used to signal that the user is done and the message “packing ....” appears briefly

on the screen. The program returns to the previous menu.

NOTE: When records are marked for deletion, if the user attempts to edit a record

by pressing the [ENTER] key the records will be permanently deleted, just

as though F10 had been pressed.

Defining a Structure

To add (define) a structure

C Select Add/Edit Project & Structure Inventory, option 1, from the Main Menu.

The screen that appears is the Project/Structure/Reach Menu, shown under the Defining a

Project section earlier in this chapter.

C Select Add Structure Information, option 3, from the Project/Structure/Reach Menu.

The Select a Project screen will appear enabling the user to select a project under which to add a

structure.
22 Chapter 4: Inventory

Use the arrow keys to highlight a Coastal Project.

C Press [ENTER] to select a project.

(Note: If the user decides not to add a project at this time, pressing F4 will return to the previous

menu).

The Add Structure data entry screen will then appear. The following data should be entered for

each structure:

Structure Name: The name corresponding to the structure.

Total Length: The total length of the structure to the nearest foot.

Structure Intent: The purpose of the structure.

Year Completed: The year that the structure was completed and fully operational.

Structure Type: Pick one: Breakwater or Jetty.

Connection Type: Pick one: Shore-connected or Offshore.

Structural Elevs.: Pick one: Overtopping or Nonovertopping.

Armor - Crest: The type of material of which the crest / cap is composed.

Armor - Sea Side: The type of material of which the seaside slope of the structure is

composed.

Armor - Channel/

Harbor Side: The type of material of which the channel/harbor side slope of the structure

is composed.

Foundation: The type of material of which the foundation of the structure is composed.

Crest Width: The total width of the crest to the nearest foot.

Auxiliary: The auxiliary structures that exist on the structure. (i.e. navigation lights,

hand railing, etc.)
Chapter 4: Inventory 23

Head Reach: The designation or label to indicate which reach is a structure head. (an

offshore breakwater typically will have two head reaches)

The structure type fields are each filled in with a pop-up menu that appears with the appropriate

options available. To select, use the arrow keys to highlight the proper choice and press

[ENTER]. For the index calculations to be done properly, the system requires the following

fields be filled in: Structure Name, Breakwater/Jetty, and Total Length.

NOTE: The Structure Name field must be completed. If left blank, a pop-up box

will give a warning message, and the user is then returned to editing that

structure.

C Press F10 when done entering structures. A pop-up box will then appear with the choices

[A]ccept, [M]odify, or [E]xit. Choose Accept, or hit return on the last data field and all of

your input will automatically be retained.

Editing and Deleting a Structure

To Edit a Structure

C Select Add/Edit Project & Structure Inventory, option 1, from the Main Menu.

C Select Edit / Delete Structure Information, option 4, from the Project/Structure/Reach

Menu.

C Select a project, same as when Adding a Structure.

A box will appear that lists the structures under the selected project. Use the arrow keys to

highlight a structure and press [ENTER].
24 Chapter 4: Inventory

C The system will then display the current data for editing.

C If F10 is pressed when the cursor is at any field on the screen after entering data, the user

will be prompted to [A]ccept, [M]odify or [E]xit the record. Choose Accept. Entering data

consists of pressing the [ENTER] key when completing a data field.

To Delete a Structure

Follow the same procedures as for editing a structure. At the Select a Structure box, use the F2

key to mark that structure for deletion. The deletion procedure works the same as when deleting

a project. See the Deleting a Project section earlier in this chapter for more details.

Defining a Reach

To Add a Reach

C Select Add/Edit Project & Structure Inventory, option 1, from the Main Menu.

C Select Add Reach, option 5, from the Project/Structure/Reach Menu.

As for adding a structure, the user must first select a project in which to add a reach. Use the

arrow keys to highlight the project and press [ENTER] to select. After selecting a project, the

user must select a structure under which to define a reach. The Select a Structure screen is very

similar to the Select a Project screen. Use the arrow keys to highlight the desired structure and
Chapter 4: Inventory 25

press [ENTER] to select. After selecting a structure the Add Reach screen is available for data

entry.

The following data should be entered for each reach:

Reach: The reach designation (reach number).

Length: The length of the reach in feet.

Beginning Station: The surveyor’s station number at the start of the reach. (i.e. 25+04

represents 2504 ft. - from the beginning of the structure).

Ending Station: The surveyor’s station number at the end of the reach.

Head Reach?(Y/N): If the reach is a head reach, answer [Y] for yes, otherwise, [N] 

After data entry for the reach is complete, the user is able to continue adding reaches under the

selected project and structure.

C Press F10 when finished adding reaches. The program then returns to the Select a

Structure screen which must be selected to add more reaches under a different structure. 

Press F10 to return to Selecting a Project. Press F10 one more time to return to the

Project/Structure/Reach Menu.
26 Chapter 4: Inventory

Editing/Deleting a Reach

To Edit a Reach

C Select Add/Edit Project & Structure Inventory, option 1, from the Main Menu.

C Select Edit/Delete Reach, option 6, from the Project/Structure/Reach Menu.

As for adding a reach, the user must select a project and a structure. If no reaches have been

defined for the selected project and structure, a pop-up box will appear and the user will be able

to select another structure. A similar pop-up box will appear if no structures have been defined

under the selected project. The user may then select another project.

After a project and a structure have been selected, the Select a Reach box will pop up, as shown

in the sample screen below.

Use the UP arrow and DOWN arrow to highlight the desired reach, then press [ENTER] to

select. Reaches are listed by their name,and beginning and ending stations.

After selecting a reach, the user can edit the data that defines the reach by using the arrow keys

and the F2 and F3 keys to navigate the screen. Pressing the UP arrow when on the first field will

scroll to the previous reach, which can then be edited. Pressing the DOWN arrow when on the

last field will scroll to the following reach, which can then be edited.
Chapter 4: Inventory 27

If F10 is pressed when the cursor is at any field on the screen after entering data, the user will be

prompted to [A]ccept, [M]odify or [E]xit the record. Choose Accept to save the edited data. 

Entering data into the program occurs when the [ENTER] key is pressed after completing a data

field. After saving the changes, the program returns the user to Project/Structure/Reach Menu.

To Delete a Reach

Follow the same path as for editing a reach, up to the Select a Reach box. At this point, the F2

key can be used to toggle to the choice for deleting a reach. For more details, see the Deleting a

Project section in this chapter.
28 Chapter 5: Inspection

5 Inspection

Adding Inspection Data

The process of adding Inspection Data begins at the Main Menu. Select option 3, Add

Inspection Data, and a list of coastal projects is presented:

Using the arrow keys, highlight the project to be selected and press [ENTER]. The user will

then be presented with the structures associated with that project:
Chapter 5: Inspection 29

The list may be longer than what is shown on the screen. The page down (PGDN) and page up

(PGUP) keys may be used to see the next (or previous) screen. Highlight the desired structure

and press [ENTER]. The screen will then show dates for inspections that have been recorded for

that structure:

With the arrow keys, the user may select one of the dates shown or enter a new inspection date

by selecting New Inspection Date.

NOTE: It is important for the user to enter the Inspection Start Date by structure and not by

each individual reach. Use the date that the first reach was inspected as the date for inspection of

all reaches within the structure, even if inspection of some reaches was not actually completed

(or started) that day. Inspection data for the reaches will not be associated with a complete

inspection of the structure if different dates are entered for each reach.

After the date is entered, a pop-up screen (as on the next page) gives the user the list of reaches

within that structure. The user may scroll with the scroll keys to select a reach. The reaches

were defined in option 1 (Add/Edit Project & Structure Inventory) in the Main Menu. Note: 

Reaches must be defined before any inspection data for them can be entered.
30 Chapter 5: Inspection

Inspection Date- Current and Inspection Time are entered next. This is the date and time that

the selected reach is inspected. If data already exists for this date and structure, a message is

displayed, offering the user an opportunity to modify the existing data:
Chapter 5: Inspection 31

When the Date and Time are completed, the Inspection Team Data pop-up box is displayed. 

The team is a listing of the Inspectors, Addresses, and Office Symbols:

The menu at the bottom of the screen provides the capability to see additional Team Data that

may exist for the structure. Highlight the NEXT, PREVIOUS, FIRST and LAST options to

view the various records. To EDIT, APPEND and DELETE data, highlight the appropriate

option and press [ENTER].

After the Inspection Team Data is completed, choose Q for Quit. The next screen allows you

to input the Sea and Weather Conditions on the day of the Inspection for the selected reach. 

Highlight the appropriate condition and press [ENTER], or input the appropriate values using

the keyboard:
32 Chapter 5: Inspection

The Inspection Type field must be typed in by the user. These inspection types may include,

but are not limited to, walking and boating.

Modifying Inspection Data

To begin the process of modifying inspection data, select Modify/View/Delete Inspection Data

option 2, from the Main Menu. The following are selected from scrolling menus in this order:

• Project

• Structure

• Inspection Date

• Reach

After entering this data, the Select Data to Enter menu is presented. This will be discussed in

the MODES Section.

Modes

Upon completion of adding or modifying inspection data, the Select Data to Enter menu is

displayed:
Chapter 5: Inspection 33

Change Modes

The manner in which the data is acted upon is executed through the Change Modes command. 

To activate this command, highlight Change Mode or press the trigger "M". Control is passed

to the horizontal menu at the bottom of the screen. Add Data, Edit Data, Delete Data, and

View Data are the selections. These choices have the following functions:

1. Add Data The information the user enters is added to the database.

2. Edit Data The information is retrieved from the database for the user to modify.

3. Delete Data All the information is erased from the database.

4. View Data The information is retrieved from the database for the user to view (but

not change).

Comments

The feature, Comments, which is found in the Select Data to Enter menu, allows the user to

make general comments about a reach. A document of overall comments for a specific reach can

be created and edited. After selecting Comments from the Select Data to Enter menu, a box

will appear titled COMMENTS. The user must press F8 to close the comment box. The

comment box is displayed below.
34 Chapter 5: Inspection

Structural Data

Crest/Cap, Seaside (or Head) and Channel/Harborside Selections

Each section, Crest/Cap, Seaside and Channel/Harborside, potentially can display the

following types of distress:

Breach (for Crest/Cap only)

Core (or Underlayer) Exposure or Loss

Armor Loss

Loss of Armor Contact or Interlock

Armor Quality Defects

Slope Defects (Not Used for Crest/Cap)

Each distress type (rating category) is further defined by:

Recommended Action

Defect Type (for 4 of the 6 categories)

Reach Stations

CI Rating

The first entry is the rating (range: 0-100) for each structural rating category. Since breach only

applies to the Crest/Cap area of the reach, it is dimmed (not available for data entry) in the

Seaside and Channel/Harborside screens. Likewise, a slope defect applies only to the Seaside

and Channel/Harborside slopes of the reach, therefore, it is dimmed (and not available for data

entry) in the Crest/Cap screen.

Upon entering the Defect type field a pop-up menu appears with the available choices for 4 of

the 6 rating categories. These four menus are described below. 

Breach: The defect type pop-up menu for the breach is titled Breach Damage, and has four

choices: a blank, None, Displaced, and Settling. (See example on next page).

Armor Loss: The defect type pop-up menu for armor loss is titled Armor Loss, and has 5

choices: a blank, None, Displaced, Settling, and Bridging. (See example on next page). 
Chapter 5: Inspection 35

Armor Quality: The defect type pop-up menu for armor quality is titled Armor Quality, and

has six choices: a blank, None, Rounding, Cracking, Spalling, and Fracturing:
36 Chapter 5: Inspection

Slope Defects: The defect type pop-up menu for slope defects is titled Slope Defects, and has 4

choices: a blank, None, Steepening, and Sliding:

Reach Stations, Suggested Actions, Comments

After completing the defect ratings, the (surveyor’s) stationing representing the beginning

(Station Start) and ending points (Station End) of the observed defects are filled in. Next, are

the Suggested Actions, as explained in the Procedures Manual, and in the right column, a place

to mark that a comment is associated with the defect rating. A separate box is then made

available in which to write the comments.
Chapter 5: Inspection 37

Additional Data

Selecting Additional Data from the Select Data to Enter menu leads to another data entry

screen (shown below). There are four comment categories on this screen: Warning Signs/

Gates, Auxilary Structures, Amount of Debris in Armor, and Below Water Indications. 

These are explained in the Procedures Manual. The last field, Below Water Indications, has a

pop-up menu with the following 5 choices: a blank, Armor Dispacement, Slope Steepening,

Slope Sliding, and None Visible.

Functional Data

There are three screens for entering Functional Data: Harbor Area, Channel/Sediment/

Protection, and Other Functions. These match the general format found on the rating form, but

are divided due to limited space available on a single screen. 

For each category which applies to the reach being rated, enter the desired 0 -100 rating. If a

rating category does not apply to that reach, (i.e. Ebb Shoal) then that category must be left

blank. DO NOT USE ZERO. (Entering zero instead of leaving a category blank will result in

incorrect index calculations). 

The Recommended Action pop-up menu contains six choices: a blank, Immediate, Act Soon,

Watch, Defer, and Investigate Further. These choices are explained in the Procedures Manual. 

Here is the Harbor Area screen:
38 Chapter 5: Inspection

The Navigation Channel/Sediment/Protection screen contains three main functional areas, as

shown in this example screen:

Other Functions

As described in the Procedures Manual, the four Other Functions do not take a rating, but rather

a Suggested Action and Comment. Below Other Functions are the two questions which

appear at the bottom of the rating form:
Chapter 5: Inspection 39
40 Chapter 6: Reports and Forms

6 Reports and Forms

General Organization and Operation

Selecting Reports and Forms from the Main Menu will advance the user to another menu that

contains a selection of reports. The items on this menu include:

[1] District Inventory Summary

[2] Condition Index Calc: Reach

[3] Historical Index Rating Summary

[4] Comment Report: Reach

[5] Missing Information Report

[6] Print Inspection Forms

[E] Exit - Return to Main Menu

After selecting a report type (from options 1-6 of the Main Menu), the user is given a series of

pop-up menus that lead through the hierarchy of the choices. For example, for Condition Index

Calc: Reach, a menu listing the projects appears first, then one listing the related structures. 

Once a structure is chosen, a menu appears with inspection start-dates related to that structure. 

Finally, the fourth menu shows all the reaches related to that structure. Not all options react in

this manner; however, this is the general format:

See Appendix A for examples of reports printed with different options.
Chapter 6: Reports and Forms 41

Two function keys are available on this screen: F1 for Help, and F10 for Done. Otherwise,

follow directions on the screen for choosing the desired options. 

For all report types, after Accepting the desired options for a report, hitting F10 will tell the

program to prepare the report. The program will display the Output Options screen that

provides the following choices: [T] Terminal, [P] Printer, [F] File, or [E] Exit.

C The Terminal option will display the report on the screen.

C The Printer option will send the report to a printer.

C The File option will prompt the user for a file name and will save the report on disk with

the specified file name.

C Exit will bring back the main Report Menu screen.

District Inventory Summary

The District Inventory Summary screen (top of next page) gives the user a menu containing a

selection of sort options for the reports. The sort options available include:

1. Project: Alpha Order (ASC)

2. Structural Index: (ASC)

3. Structural Index: (DESC)

4. Functional Index(CI): (ASC)

5. Functional Index (CI): (DESC)

6. Last Inspection Date: (ASC)

7. Last Inspection Data: (DESC)

Condition Index Calc: Reach

There are four menus involved in producing the Condition Index Calculation: Reach report,

which appear in this order: Project Menu, Structure Menu, Inspection Start-Date Menu, and

Reach Menu. (See next page for example screen).

The user may select one inspection start-date for a particular structure and obtain all of the

inspection information for all of the reaches for that Inspection start-date. Otherwise, the user

may pick one or more reaches for that structure for that particular inspection. In any case the

report will include a summary of the structure’s overall Structural Index, and Functional Index.
42 Chapter 6: Reports and Forms

Historical Rating Summary

The Historical Index Rating Summary is a report based on a structure’s inspection start-dates,

structural index, and functional index. This report displays one project at a time. The user will

see all of the structures within one project along with the structure’s inspection start-dates, 

structural indexes, and functional indexes. There are two menus to obtain this report. They are

Project Menu, and Structure Menu, as shown on the example screen below:
Chapter 6: Reports and Forms 43

Comment Report: Reach

Obtaining a Comment Report: Reach is exactly like obtaining the Condition Index Calc:

Reach Report. The same four menus are presented: Project Menu, Structure Menu, Inspection

Start-Date Menu, and Reach Menu.

The user can choose to define the report with the same detail as in the Condition Index Calc:

Reach. The format is also similar to a field sheet; however, only the comments are listed in this

report. An example screen is shown at the top of the next page. 
44 Chapter 6: Reports and Forms

Missing Information Report

The Missing Information Report has the same menu format as the previously-described reports. 

This report will give the user a list of items that have not been completed yet. For example, if

the user is missing an item in the structural rating categories, this report will show the item that

is missing. An example screen is shown at the top of the next page. 

Print Inspection Forms

Selecting the Print Inspection Forms option will give the user a menu listing the types of

inspection forms available. The options available include:

1. B)lank Inspection Forms

2. D)ate selected Inspection Forms

3. P)roject selected Inspection Forms

4. S)tructure selected Inspection Forms

5. R)each selected Inspection Forms

See Appendix B for an example of a blank inspection form, and a reach-selected inspection form

from the Print Inspection Form options. The other three options operate the same as the Reach

option, however, those options will print out all of the reaches within that project, structure, and

date. (See example screen on the next page).
Chapter 6: Reports and Forms 45
46 Chapter 7: Database Administration

7 Database Administration

Introduction

Selecting Database Administration, option 5 on the Main Menu, will bring you to the Database

Administration Menu shown below. To select an option, highlight the desired option and press

[ENTER].

Selecting a Database

A database must be selected to add, edit or view any data. To select a database, place the

highlight bar over Select a Database or press the Number 1. A pop-up screen will then appear

that contains a list of current databases. Place the highlight bar over the desired database and

press [ENTER] or press the appropriate letter. (See example screen on next page). 

Copying a Database

Copying a database enables the transfer of a BREAKWATER database from one workstation to

another and allows making a back-up or modifying a copy on the same drive. To make a copy

of a database, highlight Copy a Database and press [ENTER] or press the number 2. (See
Chapter 7: Database Administration 47

example screen at bottom of page). The Select a Database pop-up screen will appear. 

Highlight the desired database and press [ENTER] or press the appropriate letter. 
48 Chapter 7: Database Administration

Pressing F5 will allow the user to select a different disk drive; another pop-up screen (as shown

below) will appear:

The cursor will be waiting for the user to enter appropriate information and the letter of the disk

drive where the copied database is to be written.

Deleting a Database

When a database is no longer useful and the user wishes to delete it from the disk drive, simply

highlight Delete a Database and press [ENTER] or press the Number 3. The Select a

Database window will appear and the user will select the database. The Delete a Database

pop-up window will appear for the user to verify that the desired database has been correctly

selected. If so, press Y for Yes. (See example screen at top of next page). 

Merging Two Databases

By selecting Merge Two Databases, option 4 on the Database Administration Menu, the user

will be able to select two databases to be merged. The user must provide the new database

symbol, database title, and disk drive. One database will then be created.

Note that the first database chosen will default as the new database symbol. (See example screen

on next page).
Chapter 7: Database Administration 49

Reorganizing a Database

By selecting Reorganize a Database, the user is able to recover disk space from deleted entries. 

No change in the remaining information is made. See example screen on the next page:
50 Chapter 7: Database Administration

Creating a Database

The user can create a new database by selecting Create a Database from the Database

Administration menu. The user must then provide a database symbol and database title.

An example screen is shown below:
Appendix A: Reports 51

Appendix A: Reports

District Inventory Summary

Project: Alpha Order (ASCENDING)

Structural Index: (ASCENDING)

Structural Index: (DESCENDING)

Functional Index (CI): (ASCENDING)

Functional Index (CI): (DESCENDING)

Last Inspection Date: (ASCENDING)

Last Inspection Date: (DESCENDING)

Condition Index Calc: Reach

Historical Index Rating Summary

Comment Report: Reach

Missing Information Report