Progress Fathom Replication
Installation Guide

> ## Preface

> This Preface contains the following sections:

> - Purpose

> - Audience

> - Organization

> - Typographical conventions

> - Examples of syntax descriptions

> - Progress messages

> - Progress documentation

> ### Purpose

> This book provides documentation for Database Administrators (DBAs) who plan to install Progress® Fathom™ Replication.

> ### Audience

> This book is intended for those who are familiar with Progress database administration, and who plan to install Fathom Replication on their system.

> ### Organization

> Chapter 1 "Welcome to Progress Fathom Replication"

> Provides an overview of the Progress® Fathom™ Replication product, new features, and information about product support.

> Chapter 2 "Before You Install Fathom Replication"

> Documents the pre-installation tasks for Fathom Replication.

> Chapter 3 "Windows Installation"

> Documents how to install Fathom Replication on Windows. It provides information on setup prior to installation and gives step-by-step instructions to follow during the installation.

> Chapter 4 "UNIX Installation"

> Documents how to install Fathom Replication on UNIX. It provides information on setup prior to installation and gives step-by-step instructions to follow during the installation.

> ### Typographical conventions

> This manual uses the following typographical conventions:

> Convention | Description
> --- | ---
> Bold | Bold typeface indicates commands or characters the user types, or the names of user interface elements.
> Italic | Italic typeface indicates the title of a document, provides emphasis, or signifies new terms.
> SMALL, BOLD CAPITAL LETTERS | Small, bold capital letters indicate Progress® key functions and generic keyboard keys; for example, GET and CTRL.
> KEY1-KEY2 | A hyphen between key names indicates a simultaneous key sequence: you press and hold down the first key while pressing the second key. For example, CTRL-X.
> KEY1 KEY2 | A space between key names indicates a sequential key sequence: you press and release the first key, then press another key. For example, ESCAPE H.
> Syntax:
>     Fixed width
> | A fixed-width font is used in syntax statements. code examples, and for system output and filenames.
> `Fixed-width italics` | Fixed-width italics indicate variables in syntax statements.
> `Fixed-width bold` | Fixed-width bold indicates variables with special emphasis.
>     UPPERCASE
>     fixed width
> | Uppercase words are Progress® 4GL language keywords. Although these always are shown in uppercase, you can type them in either uppercase or lowercase in a procedure.
> | This icon (three arrows) introduces a multi-step procedure.
> | This icon (one arrow) introduces a single-step procedure.
> Period (.) or colon (:) | All statements except `DO`, `FOR`, `FUNCTION`, `PROCEDURE`, and `REPEAT` end with a period. `DO`, `FOR`, `FUNCTION`, `PROCEDURE`, and `REPEAT` statements can end with either a period or a colon.
> [ ] | Large brackets indicate the items within them are optional.
> [ ] | Small brackets are part of the Progress 4GL language.
> { } | Large braces indicate the items within them are required. They are used to simplify complex syntax diagrams.
> { } | Small braces are part of the Progress 4GL language. For example, a called external procedure must use braces when referencing arguments passed by a calling procedure.
> | | A vertical bar indicates a choice.
> ... | Ellipses indicate repetition: you can choose one or more of the preceding items.

> ### Examples of syntax descriptions

> In this example, `ACCUM` is a keyword, and `aggregate` and `expression` are variables:

>     ACCUM aggregate expression

> `FOR` is one of the statements that can end with either a period or a colon, as in this example:

>     FOR EACH Customer:
>       DISPLAY Name.
>     END.

> In this example, `STREAM` `stream`, `UNLESS-HIDDEN`, and `NO-ERROR` are optional:

>     DISPLAY [ STREAM stream ] [ UNLESS-HIDDEN ] [ NO-ERROR ]

> In this example, the outer (small) brackets are part of the language, and the inner (large) brackets denote an optional item:

>     INITIAL [ constant [ , constant ] ]

> A called external procedure must use braces when referencing compile-time arguments passed by a calling procedure, as shown in this example:

>     { &argument-name }

> In this example, `EACH`, `FIRST`, and `LAST` are optional, but you can choose only one of them:

>     PRESELECT [ EACH | FIRST | LAST ] record-phrase

> In this example, you must include two expressions, and optionally you can include more. Multiple expressions are separated by commas:

>     MAXIMUM ( expression , expression [ , expression ] ... )

> In this example, you must specify `MESSAGE` and at least one `expression` or `SKIP` [ (`n`) ], and any number of additional `expression` or `SKIP` [ ( `n` ) ] is allowed:

>     MESSAGE { expression | SKIP [ ( n ) ] } ...

> In this example, you must specify {`include-file`, then optionally any number of `argument` or `&argument-name = "argument-value"`, and then terminate with }:

>     { include-file
>         [ argument | &argument-name = "argument-value" ] ... }

> #### Long syntax descriptions split across lines

> Some syntax descriptions are too long to fit on one line. When syntax descriptions are split across multiple lines, groups of optional and groups of required items are kept together in the required order.

> In this example, `WITH` is followed by six optional items:

> Syntax
>     WITH [ ACCUM max-length ] [ expression DOWN ]
>       [ CENTERED ] [ n COLUMNS ] [ SIDE-LABELS ]
>       [ STREAM-IO ]

> ### Progress messages

> Progress displays several types of messages to inform you of routine and unusual occurrences:

> - Execution messages inform you of errors encountered while Progress is running a procedure; for example, if Progress cannot find a record with a specified index field value.

> - Compile messages inform you of errors found while Progress is reading and analyzing a procedure before running it; for example, if a procedure references a table name that is not defined in the database.

> - Startup messages inform you of unusual conditions detected while Progress is getting ready to execute; for example, if you entered an invalid startup parameter.

> After displaying a message, Progress proceeds in one of several ways:

> - Continues execution, subject to the error-processing actions that you specify or that are assumed as part of the procedure. This is the most common action taken after execution messages.

> - Returns to the Progress Procedure Editor, so you can correct an error in a procedure. This is the usual action taken after compiler messages.

> - Halts processing of a procedure and returns immediately to the Procedure Editor. This does not happen often.

> - Terminates the current session.

> Progress messages end with a message number in parentheses. In this example, the message number is `200`:

>     ** Unknown table name table. (200)

> If you encounter an error that terminates Progress, note the message number before restarting.

> #### Obtaining more information about Progress messages

> On Windows platforms, use Progress online help to obtain more information about Progress messages. Many Progress tools include the following Help menu options to provide information about messages:

> - Choose Help Recent Messages to display detailed descriptions of the most recent Progress message and all other messages returned in the current session.

> - Choose Help Messages and then enter the message number to display a description of a specific Progress message.

> - In the Procedure Editor, press the help key (F2 or CTRL-W).

> On UNIX platforms, use the Progress `PRO` command to start a single-user mode character Progress client session and view a brief description of a message by providing its number.

> To use the `PRO` command to obtain a message description by message number:

> 1. Start the Progress Procedure Editor:

>     install-dir/dlc/bin/pro

> 2. Press F3 to access the menu bar, then choose Help Messages.

> 3. Type the message number and press ENTER. Details about that message number appear.

> 4. Press F4 to close the message, press F3 to access the Procedure Editor menu, and choose File Exit.

> ### Progress documentation

> This section lists some of the Progress Software Corporation documentation that you might find useful.

> #### Progress Fathom Replication

> Progress Fathom Replication User’s Guide

> A guide that provides users with concepts and architecture for running Fathom Replication, followed by administration steps, reference information, and quick commands. This guide provides all the information necessary to setup and use Fathom Replication.

> #### Database

> Progress Database Design Guide

> A guide that uses a sample database and the Progress Data Dictionary to illustrate the fundamental principles of relational database design. Topics include relationships, normalization, indexing, and database triggers.

> Progress Database Administration Guide and Reference

> This guide describes Progress database administration concepts and procedures. The procedures allow you to create and maintain your Progress databases and manage their performance.

> #### Reference

> Pocket Progress and WebSpeed (Hard copy only)

> A reference that lets you quickly look up information about the Progress and SpeedScript languages and about the Progress and WebSpeed programming environments.

Copyright © 2004 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095