Revised 3/29/2018

Getting Started with OFFPIPE 3

Installing OFFPIPE 3

OFFPIPE 3 is a new, Microsoft Windows®1 compatible program that replaces OFFPIPE 2.07xx
and other previous versions of OFFPIPE. OFFPIPE 3 is compatible with Windows XP, Vista
and both 32-bit and 64-bit versions of MS Windows 7, 8 and 10.

To install OFFPIPE 3 on your computer’s hard disk, please do the following:

1) Load the OFFPIPE 3 installation CD into the CD or DVD drive on your computer.

Note: If OFFPIPE 3 was downloaded or supplied in another form, it can be installed by

copying the setup file (below) onto your hard drive or a USB storage device. Only the
setup file and key driver software are required to install OFFPIPEE 3 on your computer.

2) Open Windows Explorer to display the contents of the CD and double click on the setup
file: “setup_OFFPIPE_3xxxxx.exe” to run the installation program. Windows may ask au-
tomatically if you want to display the contents of the installation CD in an open window. If
it does, answer “yes”.

Note: On your CD, the characters “xxxxx” above will be replaced by a version number
and two letter release code that are used to identify each copy of OFFPIPE 3; for exam-
ple: “OFFPIPE 302XY”.

3) Follow the instructions given on screen during the installation process.

4) If the latest drivers for the copy protection key have not previously been installed on your
computer, you should install them now by double clicking on the file: “HASPUserSe-
tup.exe”. This file is included in the directory “Sentinel_LDK_Run-time_setup\...” on
the installation CD.

Note: On computers running Windows 10, OFFPIPE 3 may not be able to detect the
USB key using older key drivers distributed with previous versions of OFFPIPE and
OFFPIPE 3.

A copy protection key or USB “dongle” must be installed on your computer for OFFPIPE 3 to
run. Depending upon when you acquired OFFPIPE 3 and the terms of your OFFPIPE license
agreement, your copy of OFFPIPE 3 may be compatible with older USB and/or parallel port
keys that were provided with OFFPIPE V2.07 and earlier versions of OFFPIPE.

Uninstalling OFFPIPE 3

OFFPIPE 3 can be uninstalled from your computer like any other Windows application by se-
lecting the “Uninstall Program” option on the Windows “Control Panel” screen. When OFFPIPE
3 is uninstalled, the program’s files, screen icon and directory entries will be removed from your

1
Windows XP, Vista, 7, 8 and 10 are registered trademarks of Microsoft Corporation. Microsoft’s Win-
dows operating systems are referred herein as simply as “Windows”, it being understood that this term
refers to the Windows operating systems that are the trademarked property of Microsoft Corporation.
 Revised 3/29/2018

computer. However, any input data and output files stored in your personal “Documents\ OFF-
PIPE 3\...” or “My Documents\OFFPIPE 3\...” directory should not be affected.

Nevertheless, it is recommended that any important OFFPIPE 3 related input data and output
files be backed up before OFFPIPE 3 is installed or uninstalled on your computer.

When OFFPIPE 3 is updated with a new version, it is recommended that you uninstall any pre-
vious version of OFFPIPE 3 on your computer before the new version is installed, to ensure that
there are no incompatible program or reference files remaining on your computer.

It is not necessary to remove OFFPIPE V2.07 or older versions of OFFPIPE from your computer
before installing OFFPIPE 3. There are no potential conflicts with older versions of OFFPIPE,
because none of the files or directories used by OFFPIPE 3 are shared by Version 2.xx.

Installation Directories

When OFFPIPE 3 is installed on a computer running the 64-bit version of Windows 7, 8 or 10,
the program executables are installed in the directory:

“C:\Program Files (x86)\OFFPIPE 3\...”

The directory “C:\Program Files (x86)” is used by recent versions of Windows for 32 bit applica-
tions. The present release of OFFPIPE 3 is compiled as a 32-bit application to maintain com-
patibility with older hardware. However, future releases of OFFPIPE 3 will require a 64-bit op-
erating system. On computers running Windows XP, the installation directory is:

“C:\Program Files\OFFPIPE 3\...”.

After OFFPIPE 3 is installed, this directory will contain the OFFPIPE 3 program executables:
“OFFPIPE_3.EXE”, “OFFPIPE_3.DLL”, “OFFPIPE_BATCH.EXE”, etc. and two sub-directories. The
sub-directory “..\OFFPIPE 3\HELP SCREENS\...” contains the help screens for OFFPIPE 3’s
Windows based user interface.

The sub-directory “..\OFFPIPE 3\PROGRAM FILES\...” contains several reference files that are
required to run OFFPIPE 3. These reference files include the OFFPIPE 3 configuration file, er-
ror and warning messages, and the default values of factors and parameters used by OFF-
PIPE 3 to prepare API and DNV code compliance reports.

Note: In Windows 7, 8 and 10, write access (and sometimes read access) to the program direc-
tories and sub-directories is restricted to user’s with “Administrator” access privileges.

OFFPIPE 3’s input data files and output files are placed in two sub-directories that are con-
tained in your personal “Documents” (or “My Documents”) directory. These sub-directories
are created when OFFPIPE 3 is first installed on your computer. By default, these sub-
directories are named “Documents\OFFPIPE 3\Data\...” and “Documents\OFFPIPE 3\Out-
put\...”.

If necessary, the default directories can be changed by editing the OFFPIPE 3 configuration file
“CONFIG.V30” which is installed in the directory “..\OFFPIPE 3\PROGRAM FILES\...”, or by ref-
erencing other directory paths for the input and output files when OFFPIPE 3 is executed.

Note: It is recommended that OFFPIPE 3’s input and output files be kept in sub-directories of
the default directories created when OFFPIPE 3 is installed, for example: “Documents\-
OFFPIPE 3\Data\My Project\...” and “Documents\OFFPIPE 3\Output\ My Project\...”.
 Revised 3/29/2018

Compatibility with OFFPIPE V2.07

OFFPIPE 3 is compatible with input data files created using OFFPIPE 2.0x, but files created
with OFFPIPE 3 can generally not be used by previous versions of OFFPIPE. This reverse in-
compatibility is due to the new features provided by OFFPIPE 3, and to changes in some of the
keywords used in the input data by OFFPIPE 3. Some keywords have been changed to make
their usage more consistent across all of the different input data screens/records used by OFF-
PIPE 3. However, the older versions of these keywords are still recognized by OFFPIPE 3.

Help Files

OFFPIPE 3’s help screens provide comprehensive information about the data specified on each
screen and in each data entry field used by OFFPIPE 3’s user interface. The help screens are
provided in the directory “..\Program Files (x86)\OFFPIPE 3\Help Screens\..” and recorded in
the Rich Text File (“*.RTF”) format. The help files can be edited using MS Word® and, when
desired, can be rewritten to include additional information not provided in the original files. You
can even add images and illustrations to the help screens.

The formatting of the help files has been intentionally kept as simple as possible and should be
self-explanatory. A unique help file is provided for each data entry screen and sub-screen used
by OFFPIPE 3. The name of each help file is based on the name of the matching screen.

For example: “PipeSpanScreen1.rtf” is the name of the help file for the first (primary) data en-
try screen used to define the *SPAN record in pipe span analyses. A total of five (5) screens,
one (1) primary screen and four (4) secondary sub-screens are used to define the *SPAN rec-
ord in OFFPIPE 3’s input data file. The help files “PipeSpanScreen2.rtf” through “PipeSpan-
Screen5.rtf” provide help information for the four (4) secondary screens.

General help information for each data entry screen is placed at the beginning (in the first
“page”) of the help file for each screen. The help information for each individual data entry field
on the screen is then given in a series of help screens or “pages” that follow. The help screens
for the fields are entered in the help file in the order in which the fields appear on the data entry
screen. Each individual help screen (page) is terminated (separated from the following screen)
in the help file by a blank line and “#” character.

Note: If you decide to edit the help screens, note that the help screens are selected by OFF-
PIPE 3 by indexing (counting) the pages in the help file and matching each page to the index of
a field on the data entry screen. The titles used in the help screens are for reference only and
are not used by OFFPIPE 3 to identify or select individual help screens.

Program Files

The files provided in the directory “..\Program Files (x86)\OFFPIPE 3\PROGRAM FILES\...” in-
clude: the error and warning messages printed by OFFPIPE 3 during execution, the OFFPIPE 3
configuration file “CONFIG.V30”, a file “CODE_DEFAULTS.DAT” containing data used to prepare
code compliance reports, and an image file “OFFPIPE_3_Logo.emf” that is displayed when
OFFPIPE 3 begins execution.

The configuration file “CONFIG.V30” lists the directory paths, and in many cases the file names,
for the input, output and temporary disk files used by OFFPIPE 3. The code defaults file
“CODE_DEFAULTS.DAT” contains the default values for factors and parameters required to pre-
pare DNV OS-F101 and API RP-1111 code compliance reports. Both of these files are simple,
self-documenting ASCII text files that can be edited by the user when necessary. However, in
almost all cases these files should be left alone in their original, as-supplied condition.

3
 Revised 3/29/2018

The file “OFFPIPE_3_Logo.emf” provides the background image (blue waves) for the logo
screen that is displayed when OFFPIPE 3 begins execution. This background image can be re-
placed with one that has special meaning for you, for example with a company logo or a picture
of a pipelay vessel. However, it should be noted that this image will become distorted if you
change the aspect ratio of OFFPIPE 3’s “Input Data File Editor” screen. The default screen
image (waves) was chosen, in part, because it looks more or less the same when its aspect ra-
tio changes.

The error and warning message files “ERRORS.V30” and “WARNINGS.V30” are binary (not text)
files. OFFPIPE3’s error and warning messages cannot be edited by the user.

Running OFFPIPE 3 in Windows - Overview

When OFFPIPE 3 is installed, an icon is added to your computer’s “desktop”. To load and run
OFFPIPE 3 you simply double click on this icon.

When OFFPIPE 3 begins execution, it displays the “Input Data File Editor” screen which is the
centerpiece or “hub” of OFFPIPE’s Windows based user interface. This screen includes a verti-
cal menu on its left hand side that allows you to: create a new input data file, edit an existing file,
edit a copy of an existing file, run OFFPIPE 3, or examine the output for the previous run.

When the “Input Data File Editor” screen is first loaded, the review/editing window (below) is
occupied by a simple logo screen. This screen identifies the version of OFFPIPE 3 being used,
displays a copyright notice, and provides the name of the company licensed to use OFFPIPE 3.

When you select an existing input data file or elect to create a new file, the contents of the file
are displayed in the review/editing window on the “Input Data File Editor” screen. A blank
screen is displayed when a new file is being created.

OFFPIPE 3’s input data file is a simple ASCII text file that contains all of the input data required
by OFFPIPE 3 to perform a pipelay, davit lift or pipe span analysis. The input data file is orga-
nized as a series of “records”. Each record consists of the data associated with some aspect of
 Revised 3/29/2018

the analysis being performed, such as the properties of the pipeline or the pipelay vessel con-
figuration. Each input record includes one or more “data entry fields” that are used to identify
the data values entered on the record.

Each input record and each data entry field is identified by a 3 or 4-character keyword. Be-
cause of these keywords, you can easily read and, with practice, understand the input data for
an analysis without having to rely on OFFPIPE 3’s Windows based user interface. By seeing
the input data file as a whole, you can get an overview of the analysis being performed that is
difficult to achieve by only looking at individual data entry screens.

The large window on the “Input Data File Editor” screen is a text editor that allows you to both
review and edit the input data file on screen while running OFFPIPE 3. The input data file can
be modified by typing directly on the screen, or by deleting, copying, or cutting and pasting data
to or from the screen. Text can also be copied from another data file or text file and inserted
directly into the input data file with the editing screen.

When entering new data or creating a new input data file, you can load data entry screens that
help you specify the input data for each record using the vertical menu on the left hand side of
the editing window. In the example below, the user has clicked on the “Pipe/Cable” button to
load a drop down menu for records associated with the pipe and cable properties.
 Revised 3/29/2018

If the input data file already exists, you can select a record for editing by double clicking on the
desired record in the review/editing window. When the data entry screen is loaded, the data
contained in the record is displayed in a series of data entry fields on the screen. You can use
these data entry fields to enter, delete and/or modify each value on the chosen record.

The data entry screens include a brief description on the screen for each data entry field. Help
screens provide additional information regarding the data entered on each screen and in each
field. Three (3) buttons at the top of each data entry screen let you display the help screens.

To load one of the help screens, you simply select the desired data entry field and use your
mouse to click on the above “screen help” or “field help” button at the top of the screen.
 Revised 3/29/2018

To run OFFPIPE 3’s solution module after an input data file has been created or reviewed and
edited, you simply click on the “running man” button at the top of the “Input Data File Editor”
screen.

When OFFPIPE 3’s solution module finishes execution, OFFPIPE 3’s printed output is displayed
automatically in a separate “View Printed Output” screen. The “View Printed Output” screen
(below) allows the user to view, page through, and save or print OFFPIPE 3’s printed output.

Output parameters that have been requested on a *PROF (profile) or *HIST (time history) rec-
ord in the input data file can be viewed graphically and saved or plotted using OFFPIPE 3’s
“View Graphic Output” screen. You can load the “View Graphic Output” screen by clicking
on a button at the top of the “Input Data File Editor” or “View Printed Output” screen.
 Revised 3/29/2018

A separate “Select Plot Table Entry” screen can be used to select individual plots for viewing,
and to select or de-select individual plots and the output parameters displayed on each plot.

Note that although OFFPIPE 3 is a completely new program, its input data file and output are
similar to the input and output from OFFPIPE V2.07 and previous versions of OFFPIPE. This
similarity is intentional and has been maintained to ensure that users familiar with OFFPIPE can
begin using OFFPIPE 3 immediately and take advantage of its improved efficiency and ease of
use with little or no “learning curve”.

You will find a much more detailed and comprehensive explanation OFFPIPE 3’s Windows
based user interface, and how the program is used to perform pipelay, davit lift and pipe span
analyses in the OFFPIPE 3 User’s Guide.

Screen Size and Placement

The initial positions and dimensions of OFFPIPE 3’s screens are determined by data contained
in the status file “STATUS.TXT” which is maintained in your applications data directory. The
initial positions and dimensions for OFFPIPE 3’s screens are assigned during installation such
that at least a portion of each screen should be visible on even the smallest laptop screens.

The screen positions and dimensions are updated and saved for future use by OFFPIPE 3 each
time they are changed by the user. This allows you to optimize the screen size and placement
for your personal working environment and return to this configuration each time OFFPIPE 3 is
used.

Note: If the size of the display screen changes between executions of OFFPIPE 3, for example
if you connect a larger display to your laptop when you are in the office but use only your laptop
at home, some of the windows displayed by OFFPIPE 3 could be invisible (displayed on a part
of the screen that cannot be seen on your laptop) when OFFPIPE 3 is run without the larger
display. If this is the case, you should remember to move all of OFFPIPE 3’s screens to an area
that is visible on your laptop before exiting OFFPIPE 3.

Running OFFPIPE 3 In Batch Mode

When OFFPIPE 3 is installed, a program called “OFFPIPE_BATCH.EXE” and an example batch

file “RUN_BATCH.BAT” are loaded into the OFFPIPE 3 program directory: “C:\Program Files
(x86)\OFFPIPE 3\...”.
 Revised 3/29/2018

The program “OFFPIPE_BATCH.EXE” is a DOS shell program that takes the place of OFF-
PIPE 3’s Windows based user interface “OFFPIPE_3.EXE” and allows the OFFPIPE 3 solution
module “OFFPIPE_3.DLL” to be run in a “Command Prompt” window (Windows 7 – 10) or “Win-
dows Power Shell” window (Windows 10) without loading the screen-based user interface.

The primary reason for running OFFPIPE 3 in batch mode is to perform large numbers of highly
repetitive analyses, in which only one variable or a few related variables are varied, in a single
execution of OFFPIPE 3. For example, OFFPIPE 3’s batch mode might be used to perform a
series of analyses in which the sea state and vessel heading are varied to determine the most
severe conditions in which pipelay operations can be performed.

The file “RUN_BATCH.BAT” is a simple batch file that can be used to execute “OFFPIPE_-
BATCH.EXE” and run OFFPIPE 3 in batch mode. The steps required to run the batch file are:

1) Manually open a Command Prompt or Windows PowerShell (32 bit) window.

2) Make the OFFPIPE 3 program directory the current directory by entering the following
command in the “Command Prompt” or “Windows PowerShell” window:

CD “C:\Program Files (x86)\OFFPIPE 3”

Note: This command can also be the first line in the batch file “RUN_BATCH.BAT”.

3) Enter the command “RUN_BATCH” in the “Command Prompt” window or the command
“.\RUN_BATCH” in the “Windows PowerShell” window to execute the batch file.

Note: If the current directory is not the OFFPIPE 3 directory (because you included step
2 above in the batch file), this command must be preceded by the correct path specifica-
tion for the batch file. In Windows 7/8/10 the correct path and command are given by:

“C:\Program Files (x86)\OFFPIPE 3\RUN_BATCH”

The primary reason for using a batch file to run the shell program “OFFPIPE_BATCH.EXE” is that
the batch file allows you to easily specify the command line arguments for the shell program.
The simple, example batch file included in the programs directory when OFFPIPE 3 is installed
consists of the following two lines:

CD C:\Program Files (x86)\OFFPIPE 3

OFFPIPE_BATCH C:\Users\Public\OFFPIPE 3\Program Files\Examples\ListFile

You can add other commands to this batch file to copy, delete and/or rename the files used as
input data or produced as output by OFFPIPE 3.

Command Line Arguments

The shell program “OFFPIPE_BATCH.EXE” can have up to two (2) optional command line argu-
ments. When both arguments are present, the two (2) command line arguments must be sepa-
rated by a comma (“,”). When only the first argument is given, a comma can be used to mark
the end of the first argument, but its use is not required.

When only the second argument is given, it must be preceded by a comma to terminate the first
field and “tell” the shell program “OFFPIPE_BATCH.EXE” that the value given is the second ar-
 Revised 3/29/2018

gument. If no command line arguments are needed, a comma is not required, and the com-
mand line can be left blank.

The first command line argument is the complete file path (excluding the file name) for the file
“PATHFILE.V30”. The file “PATHFILE.V30” communicates the file paths for the following three
(3) Windows’ system directories to the shell program “OFFPIPE_BATCH.EXE”:

1) (PROG PATH) The programs directory where OFFPIPE 3’s executables, reference files,
error message files and help files are stored.
2) (USER PATH) The personal “Documents” or “My Documents” directory where OFF-
PIPE 3’s input data and output files are stored.
3) (TEMP PATH) The applications data directory where OFFPIPE 3 stores the temporary
scratch files that are required to run OFFPIPE 3.

These three (3) system directories are assigned by Windows when OFFPIPE 3 is first installed
on your computer. They are required for OFFPIPE 3 (and most other Windows applications) to
run in the Windows environment.

Note: The terms in parenthesis above are the placeholders used for these directories in the
OFFPIPE 3 configuration file “CONFIG.V30”. When OFFPIPE 3 reads the configuration file, it
automatically substitutes the correct system directory path for each of these placeholders.

The default file path for the file “PATHFILE.V30” in Windows 7, 8 and 10 is given by:

C:\Users\Public\OFFPIPE 3\Program Files\

Note that the last backslash character “\” is included in the path name, but the name of the path-
file is omitted. OFFPIPE 3 always assumes that the name of the path-file is “PATHFILE.V30”.

As an example, the contents of the file “PATHFILE.V30” on the author’s personal computer are
given by:

C:\Program Files (x86)\OFFPIPE 3\

C:\Users\RMalahy\Documents\OFFPIPE 3\
C:\Users\RMalahy\AppData\Roaming\OFFPIPE 3\

The three (3) directory paths in the above example were assigned when OFFPIPE 3 was in-
stalled on the author’s computer. These directory paths must be communicated to the shell
program via the file “PATHFILE.V30”, because “OFFPIPE_BATCH.EXE” is a DOS application that
does not communicate directly with the Windows operating system.

Note that two (2) of the system file paths in the above example include the author’s Windows’
user id “RMalahy”. On your computer, the user id “RMalahy” above must be replaced by your
own Windows’ user id. Your Windows’ user id was chosen by you or specified for you by your
IT Administrator when Windows was installed on your computer. Your personal user id is nor-
mally displayed at the center of your computer’s screen whenever your computer is powered up
or rebooted.

The second optional argument on the command line is the file name for the user’s input data
list-file. This list-file contains a list of sub-directory names and file names for the input data files
that will be “run” by OFFPIPE 3 in batch mode. A example showing the contents of a typical list-
file is given by the following:
 Revised 3/29/2018

Examples\Example 1.dat
Examples\Example 2.dat
Examples\Example 3.dat
:
:
:

Where the path name “Examples\” is the sub-directory of OFFPIPE 3’s default input data direc-
tory in which the input data files are stored. In most cases, the sub-directory and input data file
names in your list-file(s) will reference the project name and/or installation conditions for which
the batch mode analyses are being performed.

When a list-file is used to run multiple input data files in batch mode, the sub-directory and file
name for the list-file (similar to the above example) must be included as the second command
line argument for the shell program “OFFPIPE_BATCH.EXE”.

This list-file must always be placed in OFFPIPE 3’s default input data directory or a sub-
directory of the default input data directory. In the above example, the input data files are stored
in the subdirectory “Examples\”. The complete file path and file name for the above list-file on
the author’s computer is given by:

C:\Users\RMalahy\Documents\OFFPIPE 3\Data\Examples\ListFile.lst

The part of the complete file path that is underlined above is the file and sub-directory name
chosen by the author for this example list-file. This underlined part is the sub-directory path and
file name that must be entered as the second command line argument for “OFFPIPE_-
BATCH.EXE”.

The part of the complete file path that is not underlined is the default input data directory path on
the author’s computer. On your computer, the name “RMalahy” above will be replaced by your
Windows’ user id. OFFPIPE 3 automatically adds this input data directory path (with your user
id) to the list-file name that you provide on the command line for “OFFPIPE_BATCH.EXE”..

Note: The list-file can use any desired file name and any extension (or no extension at all). The
extension “.lst” used in the above example helps to identify the file type, but it is not required.

More Information About Command Line Arguments

If the first command line argument for the shell program “OFFPIPE_BATCH.EXE” is specified,
OFFPIPE 3 will search the given directory for the file “PATHFILE.V30”. If the path-file is found,
OFFPIPE 3 will use the contents of the path-file to “complete” the file paths and file names con-
tained in the configuration file “CONFIG.V30”.

If the first command line argument is not given or the path-file is not found, OFFPIPE 3 will
search for the path-file in the default path-file directory:

C:\Users\Public\OFFPIPE 3\Program Files\

Note: This directory path does not exist in Windows XP and earlier versions of MS Windows.

When you run the Windows based user interface for OFFPIPE 3, it communicates with the Win-
dows operating system to determine the three (3) Windows system file paths for your computer.
If you are using Windows 7, 8 or 10, it then writes a copy of the file “PATHFILE.V30” to the
 Revised 3/29/2018

above default directory for use by “OFFPIPE_BATCH.EXE”. If this path-file is created successful-
ly, you do not have to specify the file path for “PATHFILE.V30” in the command line; you can
simply leave the first command line argument blank.

Note: By default, the above directory “C:\Users\Public\...” should be accessible by all comput-
er users under Windows 7, 8 and 10, even those without special access privileges. However,
your IT Administrator can restrict access to this directory. If you are not able to access this di-
rectory on your computer, you will have to contact your IT Administrator to obtain the necessary
permissions if you want to run OFFPIPE 3 in batch mode using the above default file path.

OFFPIPE 3’s user interface cannot create the file “PATHFILE.V30” in the default path-file direc-
tory unless you have “write” access to this directory. However, when you run OFFPIPE 3’s
Windows based user interface, it also creates a copy of “PATHFILE.V30” in your personal input
data and output directory in the following location:

C:\Users\<your user id>\Documents\OFFPIPE 3\Program Files\

If you cannot access the path-file in its default directory, you can still run OFFPIPE 3 in batch
mode by using the above directory path (with your correct user id inserted in the location shown)
as the first command line argument for “OFFPIPE_BATCH.EXE”.

If the second command line argument is specified, OFFPIPE 3 will run OFFPIPE 3 in batch
mode using the input data files given in the list-file. The files will be used in the order in which
they are entered. If any of the input data files listed in the list-file are not found or cannot be
read, the batch mode shell program will display an error message in the Command Prompt/-
PowerShell window, and then attempt to continue running using any remaining input data files.

Batch Mode Output

When OFFPIPE 3 is run in batch mode using a list-file, “OFFPIPE_BATCH.EXE” creates new
sub-directories in OFFPIPE 3’s default output directory to receive the output files produced by
each execution of OFFPIPE 3 in batch mode. The names of these output sub-directories are
chosen based on the names of the sub-directories and input data files used to generate the out-
put. These new sub-directories created by OFFPIPE 3 identify and organize the output files and
ensure that the files for one run won’t be overwritten by the output for the next input data file.

The output files produced by “OFFPIPE_BATCH.EXE” for the first input data file specified in the
preceding example list-file will be given by:

C:\Users\ … \OFFPIPE 3\OUTPUT\Examples\Example 1\OFFPIPE.OUT

C:\Users\ … \OFFPIPE 3\OUTPUT\Examples\Example 1\PROFILE.PLT
C:\Users\ ... \OFFPIPE 3\OUTPUT\Examples\Example 1\PROF_TBL.PLT
C:\Users\ … \OFFPIPE 3\OUTPUT\Examples\Example 1\PROF_EXL.CSV

And so forth for the remaining input data files and output files. Note that the characters “…”
above are a placeholder for the file path “<your user id>\Documents” which is too long to fit in
the above example.

Note also that the file names of the above output files are the same as the (default) names of
the files produced when OFFPIPE 3 is run interactively using its Windows’ based user interface.
When OFFPIPE 3 is run in batch mode, the output files are made unique and protected against
being overwritten by storing the output for each run in a subdirectory which has the same name
as the input data file for that run. Thus, the output created by OFFPIPE 3 for the input data file:
 Revised 3/29/2018

“...\OFFPIPE 3\Data\Examples\Example 1.dat”

is stored in a sub-directory of OFFPIPE 3’s default output directory which has the name:

“...\OFFPIPE 3\Output\Examples\Example 1\”.

Note: The file extensions of input data files are ignored when sub-directory names are created
for the output files. Thus, the file extensions should not be used to convey information about the
project, equipment, operating conditions, or other data related to individual batch mode anal-
yses, because any such information conveyed by the file extensions will be lost in the output.

Running in Batch Mode Without a List File

If a list-file is not specified, OFFPIPE 3 will run in batch mode using the present contents of the
input data file “OFFPIPE.DAT” which is stored in your default input data directory. The name
and directory path for this file are given by:

C:\Users\<your user id>\Documents\OFFPIPE 3\DATA\OFFPIPE.DAT

Note that this is the same intermediate input data file that is produced by OFFPIPE 3’s Windows
based user interface when the solution module “OFFPIPE_3.DLL” is run interactively with the
Windows based user interface. When you click on the “run” button on the Windows’ based user
interface, OFFPIPE 3 copies the current active input data file to the intermediate file “OFF-
PIPE.DAT” and then calls (loads and executes) the solution module.

When OFFPIPE 3 is run in batch mode without a list-file, you must first copy your desired input
data file to OFFPIPE 3’s default input data file before running “OFFPIPE_BATCH.EXE”. If you
want to run OFFPIPE 3 in batch mode using multiple input data files, without using a list-file,
then your batch file (or the external program that calls “OFFPIPE_BATCH.EXE”) must copy each
input data file to the above default input data file each time “OFFPIPE_BATCH.EXE” is executed.

Note: MS Windows’ batch (DOS) commands actually constitute a programming language that
can be used to copy, delete and rename files, call other batch programs, and create loops and
implement conditional logic. These commands can be used to construct batch programs to ma-
nipulate the input data and output files in ways that are much more complex than the functionali-
ty provided by the list-file. OFFPIPE 3’s batch mode shell program “OFFPIPE_BATCH.EXE” can
also be executed using programs created with MS Excel and other programming languages.
Any computer program or language that can execute a batch command can potentially be used
to run OFFPIPE 3 in batch mode and manipulate its input data and output files.

When OFFPIPE 3 is run in batch mode without a list-file, its printed output is written to the in-
termediate output files “OFFPIPE.OUT”, “PROF_EXL.CSV”, “HIST_EXL.CSV”, etc. in your personal
output directory:

C:\Users\<your user id>\Documents\OFFPIPE 3\OUTPUT\

This is also the same output directory that is used by OFFPIPE 3’s Windows’ based user inter-
face. If OFFPIPE 3 is run in batch mode without a list-file, you must copy OFFPIPE 3’s tempo-
rary output file “OFFPIPE.OUT” and other output files to a different output file and/or path name
after each run. Otherwise, the output files will be overwritten the next time OFFPIPE 3 is exe-
cuted.