Vous êtes sur la page 1sur 137

Advanced Data Transfer

Software Installation and


Administration

2008 Landmark Graphics Corporation

Advanced Data Transfer Software Version 5000.0.0 August 2008


2008 Landmark Graphics Corporation
All Rights Reserved Worldwide

This publication has been provided pursuant to an agreement containing restrictions on its use. The publication is also protected by
Federal copyright law. No part of this publication may be copied or distributed, transmitted, transcribed, stored in a retrieval system,
or translated into any human or computer language, in any form or by any means, electronic, magnetic, manual, or otherwise, or
disclosed to third parties without the express written permission of:

Landmark Graphics Corporation


2107 CityWest Blvd, Building 2, Houston, Texas 77042-3051, USA
P.O. Box 42806, Houston, Texas 77242, USA
Phone: 713-839-2000
Fax: 713-839-2015
Internet: www.halliburton.com/landmark

Trademarks
3D Drill View, 3D Drill View KM, 3DFS, 3D Surveillance, 3DView, Active Field Surveillance, Active Reservoir Surveillance, ADC, Advanced
Data Transfer, ARIES, ARIES DecisionSuite, AssetConnect, Asset Decision Solutions, Asset Development Center, AssetDirector, Asset Journal,
AssetLink, AssetLink Advisor, AssetLink Director, AssetLink Observer, AssetObserver, AssetObserver Advisor, Asset Performance, AssetPlanner,
AssetSolver, AssetSolver Online, AssetView, BLITZPAK, CasingLife, CasingSeat, COMPASS, Corporate Data Archiver, Corporate Data Store,
Data Analyzer, DataManager, DataStar, DBPlot, Decision Management System, DecisionSpace, DecisionsSpace 3D Drill View KM, DecisionSpace
AssetLink, DecisionSpace AssetPlanner, DecisionSpace AssetSolver, DecisionSpace AssetView 2D, DecisionSpace AssetView 3D, DecisionSpace
Atomic Meshing, DecisionSpace Decision Management Systems(DMS), DecisionSpace for Production, DecisionSpace Infrastructure,
DecisionSpace Nexus, DecisionSpace PowerModel, DecisionSpace PrecisionTarget, DecisionSpace Reservoir, DecisionSpace TracPlanner,
DecisionSpace Well Seismic Fusion, DecisionSpace WellSolver, DecisionSuite, DepthTeam, Depth Team, DepthTeam Explorer, Depth Team
Explorer, DepthTeam Express, Depth Team Express, DepthTeam Extreme, Depth Team Extreme, DepthTeam Interpreter, Depth Team Interpreter,
Desktop Navigator, DESKTOP-PVT, DESKTOP-VIP, DEX, DIMS, Discovery, Discovery Asset, Discovery FrameBuilder, DMS, Drillability Suite,
Drilling Desktop, DrillModel, Drill-to-the-Earth Model, Drillworks, Drillworks ConnectML, DSS, Dynamic Reservoir Management, Dynamic
Surveillance System, EarthCube, EDM, EDT, eLandmark, Engineers Data Model, Engineer's Desktop, Engineers Link, ESP, Event Similarity
Prediction, ezFault, ezModel, ezSurface, ezTracker, FastTrack, FG+, FieldPlan, Field Scenario Planner, FZAP!, GeoAtlas, GeoDataLoad,
GeoGraphix, GeoGraphix Exploration System, GeoLink, GeoProbe GF DataServer, GES, GES97, GESXplorer, GMAplus, GMI Imager,
GRIDGENR, Handheld Field Operator, HHFO, I2 Enterprise, iDIMS, IsoMap, iWellFile, i Wellfile, KnowledgeSource, Landmark, Landmark
Decision Center, Landmark & Design, Landmark Logo and Design, Landscape, Lattix, LeaseMap, LMK Resources, LogEdit, LogM, LogPrep,
Make Great Decisions, MathPack, MIMIC, MIMIC+, Model Builder, MyLandmark, Nexus, Object MP, OpenBooks, OpenJournal, OpenSGM,
OpenVision, OpenWells, OpenWire, OpenWorks, OpenWorks Development Kit, OpenWorks Well File, OpenWorks Production, PAL, Parallel-VIP,
PetroBank, PetroBank Explorer, PetroBank Master Data Store, PetroWorks, PetroWorks Asset, PetroWorks Pro, PetroWorks ULTRA, PlotView,
Point Gridding Plus, Pointing Dispatcher, PostStack, PostStack ESP, PostStack Family, PowerCalculator, PowerExplorer, PowerExplorer Connect,
PowerGrid, PowerHub, Power Interpretation, PowerJournal, PowerModel, PowerView, PrecisionTarget, Presgraf, Pressworks, PRIZM, Production
Asset Manager, Production, PROFILE, Project Administrator, ProMAGIC, ProMAGIC Connect, ProMAGIC Server, ProMAX, ProMAX 2D,
ProMAX 3D, ProMAX 3DPSDM, ProMAX 4D, ProMAX Family, ProMAX MVA, ProMAX VSP, pSTAx, Query Builder, Quick, Quick+,
QUICKDIF, QuickWell, QuickWell+, QUIKRAY, QUIKSHOT, QUIKVSP, RAVE, RAYMAP, RAYMAP+, Real Freedom, Real Time Asset
Management Center, Real Time Decision Center, Real Time Operations Center, Real Time Production Surveillance, Real Time Surveillance, Real-
Time View, Reference Data Manager, Reservoir Framework Builder, RESev, ResMap, RightTime, RTOC, SCAN, SeisCube, SeisMap, SeisModel,
SeisSpace, SeisVision, SeisWell, SeisWorks, SeisWorks 2D, SeisWorks 3D, SeisWorks PowerCalculator, SeisWorks PowerJournal, SeisWorks
PowerSection, SeisWorks PowerView, SeisXchange, Semblance Computation and Analysis, Sierra Family, SigmaView, SimConnect, SimConvert,
SimDataStudio, SimResults, SimResults+, SimResults+3D, SIVA+, SLAM, smartSECTION, Spatializer, SpecDecomp, StrataAmp, StrataMap,
StrataModel, StrataSim, StrataWorks, StratWorks, StratWorks 3D, StreamCalc, StressCheck, STRUCT, Structure Cube, Surf & Connect, SynTool,
SystemStart, SystemStart for Clients, SystemStart for Servers, System Start for Servers, SystemStart for Storage, Tanks & Tubes, TDQ, Team
Workspace, TERAS, The Engineers Desktop, Total Drilling Performance, TOW/cs, TOW/cs Revenue Interface, TracPlanner, TracPlanner Xpress,
Trend Form Gridding, Turbo Synthetics, VESPA, VESPA+, VIP, VIP-COMP, VIP-CORE, VIPDataStudio, VIP-DUAL, VIP-ENCORE, VIP-
EXECUTIVE, VIP-Local Grid Refinement, VIP-THERM, WavX, Web Editor, Wellbase, Wellbore Planner, Wellbore Planner Connect, WELLCAT,
Well Cost, WELLPLAN, Well Seismic Fusion, WellSolver, WellXchange, WOW, Xsection, You're in Control. Experience the difference, ZAP!, and
Z-MAP Plus are trademarks, registered trademarks or service marks of Landmark Graphics Corporation.

All other trademarks are the property of their respective owners.

Note
The information contained in this document is subject to change without notice and should not be construed as a commitment by
Landmark Graphics Corporation. Landmark Graphics Corporation assumes no responsibility for any error that may appear in this
manual. Some states or jurisdictions do not allow disclaimer of expressed or implied warranties in certain transactions; therefore,
this statement may not apply to you.
Landmark acknowledges that certain third party code has been bundled with, or embedded in, Landmarks software.
The licensors of this third party code, and the terms and conditions of their respective licenses, may be found at the
following location:

<ADT_Install_Path>/docs/Third_Party.pdf Linux
<ADT_Install_Path>\docs\Third_Party.pdf Windows
Landmark Advanced Data Transfer Installation and Administration Guide

Contents

Introduction

Welcome to Advanced Data Transfer Software . . . . . . . . . . . . . . . . . . . . . . . . . 1


Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3


OWHOME Variable Must Be Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Third-Party Connection Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Generic Synchronization Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Installation Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installing Over an Existing Version of the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Installation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Pre-installation Steps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Install Only Advanced Data Transfer

Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Install All Options

Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Install Advanced Data Transfer And Third-Party Connection Wizard

Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Install Third-Party Connection Wizard Only

Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

5000.0.0 Contents iv
Landmark Advanced Data Transfer Installation and Administration Guide

Install Third-Party Connection Wizard and Generic Synchronization

Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Post-Installation Steps

All Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Verify That All Configured Data Models Are Online . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Check Your Authorization to Write to Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Set Login Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Other Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Shared Message Server on a Different Machine?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Configure Datamodels for Third-Party Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Configure Generic Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Accessing Servers

Using Long (Fully-Qualified) and Short Server Names. . . . . . . . . . . . . . . . . . . . 94


Corporate Data Store Monikers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
OpenWorks Monikers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
PowerHub Monikers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Coporate Data Store Software Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95


About Coporate Data Store Database Monikers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Adding Corporate Data Store Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Changing the Default Corporate Data Store Database . . . . . . . . . . . . . . . . . . . . . . . . . 97
Presetting Corporate Data Store Software Login Credentials . . . . . . . . . . . . . . . . . . . 98
Same User Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Different User Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

OpenWorks Software Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99


About OpenWorks Database Monikers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Changing the Default OpenWorks Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Presetting OpenWorks Login Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

PowerHub Software Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

5000.0.0 Contents v
Landmark Advanced Data Transfer Installation and Administration Guide

Environment and Setting Defaults

ADTUser.properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Setting the OpenWorks Software Measurement System . . . . . . . . . . . . . . . . . . . . . . . 105
ADTLastSession.job.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Memory Usage Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

All Arguments and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107


Command Line Arguments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Message Server Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Data Model-specific Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Configuration Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118


Objects Contained in the Configuration Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Defining Active Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Launching the Advanced Data Transfer Software

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Command Line Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Launching in User Interface Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123


Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Launching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Launching in Standalone Batch Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124


Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Launching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Appendix

Uninstalling the Advanced Data Transfer Software . . . . . . . . . . . . . . . . . . . 125

Java Runtime Environment (JRE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

5000.0.0 Contents vi
Landmark Advanced Data Transfer Installation and Administration Guide

Is JRE Installed? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126


Install JRE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Set Mozilla Preferences for Online Help and Documentation . . . . . . . . . . . . . . . . . . . . 127
Diagnostic ZIP File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

5000.0.0 Contents vii


Landmark Advanced Data Transfer Software Installation and Administration Guide

Introduction

Welcome to Advanced Data Transfer Software

This document describes how to install and configure Advanced Data


Transfer software to run in standalone and batch modes.

Installation

Before you begin the installation process, take a few moments to read
through this chapter in its entirety to familiarize yourself with the
installation process.

Before You Begin on page 3

Installation Checklist on page 5

Pre-installation Steps on page 6

There are several options for installing the software:

Install Only Advanced Data Transfer on page 8

Install All Options on page 19

Install Advanced Data Transfer And Third-


Party Connection Wizard on page 44

Install Third-Party Connection Wizard Only on page 63

Install Third-Party Connection Wizard and Generic


Synchronization on page 74

After installation, perform the appropriate steps in Post-


Installation Steps on page 91.

If you are installing Advanced Data Transfer for use with the
PowerExplorer software Transfer Wizard, you will find notes
throughout the installation procedures specifying which option to
choose.

5000.0.0 Welcome to Advanced Data Transfer Software 1


Landmark Advanced Data Transfer Software Installation and Administration Guide

Administration

Use the information in the Administration chapters to use and maintain


the installation.

Accessing Servers on page 94

Environment and Setting Defaults on page 103

Launching the Advanced Data Transfer Software on


page 121

Appendix on page 125

5000.0.0 Welcome to Advanced Data Transfer Software 2


Landmark Advanced Data Transfer Software Installation and Administration Guide

Before You Begin

OWHOME Variable Must Be Set

You must have the OWHOME variable set and must have write access
to the OWHOME/bin directory.

If the OWHOME variable is not set, the installer informs you. Exit
the installer, set this variable, and restart the installer.

If you do not have write access to the OWHOME/bin directory, the


installer informs you. You can restart the installer after obtaining
write permission to OWHOME/bin or you can continue with the
install. If you continue with the install without write permission to
the OWHOME/bin directory, the installer cannot create symbolic
links from the <ADT_Install_Path>/bin to OWHOME/bin. You
must either create the link manually after the install or run the
Advanced Data Transfer software from
<ADT_Install_Path>/bin.

To ensure that the Advanced Data Transfer software installs


properly, Landmark strongly recommends installing the
OpenWorks software and ensuring that you have permission to
write to OWHOME/bin before starting the Advanced Data
Transfer installer.

Third-Party Connection Wizard

The Advanced Data Transfer installer includes a Third-Party


Connection Wizard to perform the configuration file manipulations
required to configure a basic third-party database connection.

The wizard handles setup of the datamodel folder, basic property,


pipeline and link files, and a stub datatree file. After running the
Connection Wizard, you can run the first script to create the full
datamodel DSOS xml and html files. See
<ADT_Install_Path>/doc/ThirdParty/readme.txt.

Generic Synchronization Framework

The Advanced Data Transfer installer also includes the Generic


Synchronization Framework for automated synchronization of well
data to Corporate Data Store software. Generic Synchronization uses
Advanced Data Transfer in batch mode for inserts and updates to
OpenWorks and the PowerHub software API for accessing data

5000.0.0 Before You Begin 3


Landmark Advanced Data Transfer Software Installation and Administration Guide

from the target database. See the


<ADT_Install_Path>/sync/doc/Generic Synchronization Framework
User Reference Guide.

Installation Options

There are two kinds of Advanced Data Transfer installations:

Standalone mode allows you to run transfer jobs using the


Advanced Data Transfer softwares graphical user interface and
in standalone batch mode.

Joint mode allows you to run the Advanced Data Transfer


transfer jobs using the PowerExplorer/Advanced Data
Transfer software Transfer Wizard and in special batch mode.

The major differences between the two kinds of installations include,


but are not limited to:

OpenWorks software user authentication method [i.e., External


(connects automatically using your operating system login) versus
Internal (username and password must be specified, either
manually or via a file)]
Message server process and port settings
OpenWorks measurement system must be pre-set
OpenWorks user login credentials must be pre-set

Changing the configuration from standalone to joint mode is beyond


the scope of this document.

Installing Over an Existing Version of the Software

If Advanced Data Transfer has already been installed in the location


you choose, you are prompted to select a different install location. The
installer no longer allows you to overlay or replace an existing
installation.

5000.0.0 Before You Begin 4


Landmark Advanced Data Transfer Software Installation and Administration Guide

Installation Checklist

1. Verify that the following programs have been installed on the


machine where the Advanced Data Transfer software will be
installed, or, if the programs are installed on another machine,
verify that you can access them.

Oracle 10g Enterprise Edition (i.e., Oracle 10.2.0.1 and the


Oracle 10.2.0.3 patch)

OpenWorks software version 5000.0.0.2 (or later)

LAM 5000.0.0

Java 1.6 (or later)

Browser: Internet Explorer 6.0 or later (Windows); Mozilla 1.7


or later (Linux)

PDF Reader: Adobe Reader 7.x (all platforms)

2. PowerHub sofware server information:

PowerHub server host name = ___________


Dictionary name = _____________________ case-sensitive
Server name = ________________________ case-sensitive

3. Corporate Data Store software database name =


_________________ case-sensitive

4. OpenWorks district and project (5000.0.0.2 or later) information:

OpenWorks district name = ___________ case-sensitive


OpenWorks project name = ___________ uppercase

5. Path where Advanced Data Transfer will be installed:

<ADT_Install_Path> = _________________________

6. Optional. Uninstall previous version of Advanced Data


Transfer.

7. Install Advanced Data Transfer.

5000.0.0 Installation Checklist 5


Landmark Advanced Data Transfer Software Installation and Administration Guide

Pre-installation Steps

Throughout the installation, replace

<ADT_Install_Path>

with the location noted in the Installation Checklist on page 5.

1. Log on to the system as a user who can fulfill the installation


requirements listed in OWHOME Variable Must Be Set on
page 3.

If a previous version of the Advanced Data Transfer software has


been installed, perform the next two steps, otherwise go to Step 4.

2. Kill the current message server

cd $ADTHOME/bin
./StopMessageServer.sh

3. Optional. If desired, you can keep your older version of Advanced


Data Transfer or uninstall it altogether.

To keep your older version of the software, copy the old


directory. For example:

cd ..
cp -rp ADT ADT_keep

To uninstall your older version of the software, see


Uninstalling the Advanced Data Transfer Software on
page 125.

4. Linux only: If necessary, install Mozilla from the following URL:

http://www.mozilla.org

5. Linux only: If you are installing remotely, set the display.

C shell (.csh): setenv DISPLAY mycomputer:0.0


Korn shell (.ksh): export DISPLAY=mycomputer:0.0

6. Set the OWHOME environment variable.

5000.0.0 Pre-installation Steps 6


Landmark Advanced Data Transfer Software Installation and Administration Guide

7. Download or mount the Advanced Data Transfer install image


and change to the install image directory.

8. Begin the installation:

Linux: In a terminal window, go to the directory (for the


appropriate OS) where the CDROM is mounted. For example:

Linux: cd /mnt/cdrom/ADTvol13/Linux

In the same terminal window, launch the installer:

sh ./setup.bin

Windows: Double-click setup.exe

Note: Machine, database, project, and other names shown in


the examples are for illustrative purposes only.

With the exception of hsqldb-related examples, the machine, database,


project, and other names shown in the examples are for illustrative
purposes only.

5000.0.0 Pre-installation Steps 7


Landmark Advanced Data Transfer Software Installation and Administration Guide

Install Only Advanced Data Transfer

Use the steps in this section to install the Advanced Data Transfer
software only.

Installation Steps

1. When the Choose Features to Install screen opens, choose the


Advanced Data Transfer installation option, then click Next.

5000.0.0 Install Advanced Data Transfer Only 8


Landmark Advanced Data Transfer Software Installation and Administration Guide

2. When the Introduction screen opens, click Next. ADT

3. When the Choose ADT Install Directory screen opens, accept the
default or click Choose to navigate to the desired installation
directory, then click Next. ADT

If the software has already been installed in the location you


choose, you are prompted to choose a different location than the
existing installation.

5000.0.0 Install Advanced Data Transfer Only 9


Landmark Advanced Data Transfer Software Installation and Administration Guide

4. When the Optional Datamodels screen opens, select the


datamodels to include in this installation, then click Next. ADT

The OpenWorks datamodel is installed by default.

The Corporate Data Store and LAS datamodels are also


installed by default.

The Corporate Data Store datamodel must be installed for a


joint Advanced Data Transfer/PowerExplorer software
installation.

5000.0.0 Install Advanced Data Transfer Only 10


Landmark Advanced Data Transfer Software Installation and Administration Guide

5. If you checked the CDS box in the previous screen, the CDS
PowerHub Server Connection screen opens you that you can enter
the connection settings for the server where the Corporate Data
Store software datamodel will be installed. Type the appropriate
information in the following text boxes, then click Next. ADT

PowerHub Server hostname: The machine name of your


PowerHub server. This can be the short name or the long
(fully-qualified) name.

Dictionary name: case sensitive. For example, pe_dic.

PowerHub Server name: case sensitive. For example, server.

CDS Database name: case sensitive and must match your


Corporate Data Store software installation. For example,
prod.

Note: The installer prepends cds_ to the Corporate Data Store


software database name.

See About Coporate Data Store Database Monikers on page 95 for a


detailed explanation of Corporate Data Store software database names.

5000.0.0 Install Advanced Data Transfer Only 11


Landmark Advanced Data Transfer Software Installation and Administration Guide

6. When the OpenWorks Preferences screen opens, enter the


following information, then click Next. ADT

OpenWorks District: case-sensitive. This can be the short


name or the long (fully-qualified) name.

Note: The case used here must match the case of the district.
You can use the OpenWorks Project Status Tool to check the
case of the district name.

OpenWorks Project: uppercase only.


Note: The project must be version 5000.0.0.2 or later.

5000.0.0 Install Advanced Data Transfer Only 12


Landmark Advanced Data Transfer Software Installation and Administration Guide

7. When the Default OpenWorks Authentication Mode screen opens,


choose one of the authentication options, then click Next. ADT

External connects to OpenWorks software using your


operating system user id. Choose this option to run the
Advanced Data Transfer software in standalone mode
without PowerExplorer software.

Internal connects to OpenWorks software after prompting


you for a username and password. This option is required for a
joint Advanced Data Transfer /PowerExplorer software
installation.

5000.0.0 Install Advanced Data Transfer Only 13


Landmark Advanced Data Transfer Software Installation and Administration Guide

8. When the Message Server Configuration screen opens, choose one


of the configuration options, then click Next. ADT

Local (private) runs one message server for each Advanced


Data Transfer software job. Choose this option to run in
standalone mode. This is the default.

Shared runs one message server for multiple jobs. This option
is required for a joint Advanced Data
Transfer/PowerExplorer software installation.

5000.0.0 Install Advanced Data Transfer Only 14


Landmark Advanced Data Transfer Software Installation and Administration Guide

9. If you chose Shared in the previous screen, the Shared Message


Server Configuration screen opens so that you can enter the host
name and port number of the message server. ADT

This screen does not appear if you chose Local in the previous
Message Server Configuration screen.

Shared Message Server on a Different Machine?

If the machine hosting the shared message server is a different machine than
the machine where the Advanced Data Transfer software is installed the
machine hosting the shared message server must be running when the
Advanced Data Transfer software is launched.

10. Linux only. In the Which Browser? screen, locate the browser on
your computer, then click Next.

11. Linux only. In the Which XTerm? screen, locate the xterm on your
computer, then click Next.

12. Linux only. In the Which Editor? screen, locate the text editor on
your computer, then click Next.

5000.0.0 Install Advanced Data Transfer Only 15


Landmark Advanced Data Transfer Software Installation and Administration Guide

13. When the User Specific Customization File screen opens, set your
preference for the location of the ADTUser.properties file, then
click Next. ADT

Note: The installer does not overwrite an existing


ADTUser.properties file. A backup copy is created.

The default is checked. The installer copies


ADTUser.properties to your home directory.

This option is required for a joint Advanced Data


Transfer/PowerExplorer software installation.

If you do not want to copy ADTUser.properties to your home


directory, uncheck the box.

Note: Many individual user preferences can be set in ADTUser.properties.

Using a custom ADTUser.properties file allows you to run the software with your
preferences without affecting other Advanced Data Transfer software users. See
ADTUser.properties on page 103.

5000.0.0 Install Advanced Data Transfer Only 16


Landmark Advanced Data Transfer Software Installation and Administration Guide

14. Windows only: When the Choose Shortcut Folder screen opens,
choose the appropriate option, then click Next. ADT

5000.0.0 Install Advanced Data Transfer Only 17


Landmark Advanced Data Transfer Software Installation and Administration Guide

15. Review the information in the Pre-Installation Summary screen.


Make any necessary changes by clicking Previous to go to the
screen where changes should be made. When you are satisfied
with the installation parameters, click Install.

A status bar shows the progress of the installation.

16. When the Install Complete screen opens, click Done.

The installer windows close.

17. Perform post-installation steps. See Post-Installation Steps on


page 91.

5000.0.0 Install Advanced Data Transfer Only 18


Landmark Advanced Data Transfer Software Installation and Administration Guide

Install All Options

Use the steps in this section to install the Advanced Data Transfer
software, the Third Party Connection Wizard, and Generic
Synchronization at the same time.

Installation Steps

1. When the Choose Features to Install screen opens, choose all of


the installation options, then click Next.

5000.0.0 Install All Options 19


Landmark Advanced Data Transfer Software Installation and Administration Guide

2. When the Introduction screen opens, click Next. ADT

3. When the Choose ADT Install Directory screen opens, accept the
default or click Choose to navigate to the desired installation
directory, then click Next. ADT

If the software has already been installed in the location you


choose, you are prompted to choose a different location than the
existing installation.

5000.0.0 Install All Options 20


Landmark Advanced Data Transfer Software Installation and Administration Guide

4. When the Optional Datamodels screen opens, select the


datamodels to include in this installation, then click Next. ADT

The OpenWorks software datamodel is installed by default.

The Corporate Data Store software and LAS datamodels are


also installed by default.

The Corporate Data Store software datamodel must be


installed for a joint Advanced Data Transfer
/PowerExplorer software installation.

5000.0.0 Install All Options 21


Landmark Advanced Data Transfer Software Installation and Administration Guide

5. If you checked the CDS box in the previous screen, the CDS
PowerHub Server Connection screen opens you that you can enter
the connection settings for the server where the Corporate Data
Store software datamodel will be installed. Type the appropriate
information in the text boxes, then click Next. ADT

PowerHub Server hostname: The machine name of your


PowerHub software server. This can be the short name or the
long (fully-qualified) name.

Dictionary name: case sensitive. For example, pe_dic.

PowerHub Server name: case sensitive. For example, server.

CDS Database name: lowercase only. Must match your


Corporate Data Store software installation. For example,
prod.

Note: The installer prepends cds_ to the Corporate Data Store


software database name.

See About Coporate Data Store Database Monikers on page 95 for a


detailed explanation of Corporate Data Store software database names.

5000.0.0 Install All Options 22


Landmark Advanced Data Transfer Software Installation and Administration Guide

6. When the OpenWorks Preferences screen opens, enter the


following information, then click Next. ADT

OpenWorks District: case-sensitive. This can be the short


name or the long (fully-qualified) name.

Note: The case used here must match the case of the district.
You can use the OpenWorks Project Status Tool to check the
case of the district name.

OpenWorks Project: uppercase only.


Note: The project must be version 5000.0.0.2 or later.

5000.0.0 Install All Options 23


Landmark Advanced Data Transfer Software Installation and Administration Guide

7. When the Default OpenWorks Authentication Mode screen opens,


choose one of the authentication options, then click Next. ADT

External connects to OpenWorks software using your


operating system user id. Choose this option to run the
Advanced Data Transfer software in standalone mode
without PowerExplorer software.

Internal connects to OpenWorks software after prompting


you for a username and password. This option is required for a
joint Advanced Data Transfer /PowerExplorer software
installation.

5000.0.0 Install All Options 24


Landmark Advanced Data Transfer Software Installation and Administration Guide

8. When the Message Server Configuration screen opens, choose one


of the configuration options, then click Next. ADT

Local (private) runs one message server for each Advanced


Data Transfer software job. Choose this option to run in
standalone mode. This is the default.

Shared runs one message server for multiple jobs. This option
is required for a joint Advanced Data
Transfer/PowerExplorer software installation.

5000.0.0 Install All Options 25


Landmark Advanced Data Transfer Software Installation and Administration Guide

9. If you chose Shared in the previous Message Server


Configuration screen, the Shared Message Server Configuration
screen opens so that you can enter the host name and port number
of the message server, then click Next. ADT

This screen does not appear if you chose Local in the previous
Message Server Configuration screen.

Shared Message Server on a Different Machine?

If the machine hosting the shared message server is a different machine than
the machine where the Advanced Data Transfer software is installed the
machine hosting the shared message server must be running when the
Advanced Data Transfer software is launched.

10. Linux only. In the Which Browser? screen, locate the browser on
your computer, then click Next.

11. Linux only. In the Which XTerm? screen, locate the xterm on your
computer, then click Next.

12. Linux only. In the Which Editor? screen, locate the text editor on
your computer, then click Next.

5000.0.0 Install All Options 26


Landmark Advanced Data Transfer Software Installation and Administration Guide

13. When the User Specific Customization File screen opens, set your
preference for the location of the ADTUser.properties file, then
click Next. ADT

Note: The installer does not overwrite an existing


ADTUser.properties file. A backup copy is created.

The default is checked. The installer copies


ADTUser.properties to your home directory.

This option is required for a joint Advanced Data


Transfer/PowerExplorer software installation.

If you do not want to copy ADTUser.properties to your home


directory, uncheck the box.

Note: Many individual user preferences can be set in ADTUser.properties.

Using a custom ADTUser.properties file allows you to run the Advanced Data
Transfer software with your preferences without affecting other Advanced Data
Transfer software users. See ADTUser.properties on page 103.

5000.0.0 Install All Options 27


Landmark Advanced Data Transfer Software Installation and Administration Guide

14. Windows only: When the Choose Shortcut Folder screen opens,
choose the appropriate option, then click Next. ADT

5000.0.0 Install All Options 28


Landmark Advanced Data Transfer Software Installation and Administration Guide

15. When the PowerHub Server Connection Settings screen opens,


enter the information necessary to connect to the PowerHub
software server, then click Next. TPCW

PowerHub Server hostname: The machine name of your


PowerHub server. This can be the short name or the long
(fully-qualified) name.

PowerHub Dictionary name: Default is 'pe_dic'

PowerHub Server name: Default is 'server'

Note: This is not usually the machine name unless your


administrator chose to make it so during the PowerHub server
installation.

PowerHub Data Model Name: The datamodel/datastore name


you configured on the PowerHub server.

Database Name: The database/data source name you created


on the PowerHub server.

Primary top level table name: Default is well_t. This should


be the primary topic you created on the PowerHub server. It
is the only topic that the installer pre-configures. Other topics
must be manually defined later. See Configure Datamodels for
Third-Party Connections on page 92 for more information.

5000.0.0 Install All Options 29


Landmark Advanced Data Transfer Software Installation and Administration Guide

16. When the PowerExplorer Username and Password screen opens,


enter the PowerExplorer software login credentials for the target,
then click Next. TPCW

PowerExplorer Server username and password

Database username and password

After installation, there are scripts that must be run to complete the
synchronization configuration. Successful execution of these
scripts requires pre-configured PowerExplorer login credentials.

These credentials may be removed later if it is undesirable to


persist them permanently. (The file holding the persisted
credentials is defined in the next step.)

5000.0.0 Install All Options 30


Landmark Advanced Data Transfer Software Installation and Administration Guide

17. When the Credentials Storage screen opens, specify whether the
PowerExplorer software username and password should be
shared or if they are for your use only, then click Next. TPCW

Specify whether the username and password should be shared


or if they are for your use only.

If you do not want the credentials you provide to be used by all


users, accept the default ADTUser.properties (only for you).
Other users must then persist their own credentials in their own
$HOME/ADTUser.properties files, or enter them on the
command line when launching the Advanced Data Transfer
software.

5000.0.0 Install All Options 31


Landmark Advanced Data Transfer Software Installation and Administration Guide

18. Optional. When the Global Database Attribute Names screen


opens, enter date attributes for the database, then click Next.

Entering date attributes is optional during the install, but date


attributes may be important depending on how you want to use the
data in this database. TPCW

The Advanced Data Transfer software supports date-based


read filtering and date-based update rules. For these features to
function, the software must know the date attribute names.

For improved performance, Advanced Data Transfer


supports skipping updates to data that is nearly equivalent to
existing data. Defining names of any attributes holding create
and update users allows the software to ignore those values so a
source record that differs only by who created or last updated it
won't result in an update to the target record. If your datamodel
supports it, defining a data source attribute name allows
Advanced Data Transfer to skip an update when the only
difference in the source and target records is the value of that
attribute.

5000.0.0 Install All Options 32


Landmark Advanced Data Transfer Software Installation and Administration Guide

19. When the Target Server Connection Settings screen opens, enter
the information necessary to connect to the target PowerHub
software server, then click Next. GS

Target PowerHub Server hostname: The machine name of


the target PowerHub server. This can be the short name or the
long (fully-qualified) name.

PowerHub Dictionary name: Default is 'pe_dic'

PowerHub server name: Default is 'server'

Note: This is not usually the machine name unless your


administrator chose to make it so during the PowerHub
server installation.

PowerHub Data Model Name: The datamodel/datastore name


you configured on the PowerHub server.

Database Name: The database/data source name you created


on the PowerHub server. If the database is OpenWorks, use
the format DISTRICT.PROJECT. Case sensitive if not OW?

Primary top level table name: Default is WellEntire. This


should be the primary topic you created on the target server. It
is the only topic that the installer pre-configures. Other topics
must be manually defined later. See Configure Generic
Synchronization on page 92 for more information.

5000.0.0 Install All Options 33


Landmark Advanced Data Transfer Software Installation and Administration Guide

20. When the Target PowerExplorer Username and Password screen


opens, enter the PowerExplorer software login credentials for the
target, then click Next. GS

After installation, there are scripts that must be run to complete the
synchronization configuration. Successful execution of these
scripts require pre-configured PowerExplorer login credentials.

These credentials may be removed later if it is undesirable to


persist them permanently. (The location of the local.props file
that holds the persisted credentials is determined in the next two
steps.)

5000.0.0 Install All Options 34


Landmark Advanced Data Transfer Software Installation and Administration Guide

21. When the Synchronization Framework Installation screen opens,


choose a folder for the synchronization files, then click Next. GS

The default location is under the folder you choose at the


beginning of this installation.

5000.0.0 Install All Options 35


Landmark Advanced Data Transfer Software Installation and Administration Guide

22. When the Name This Implementation screen opens, enter a name
for this synchronization implementation, then click Next. GS

The name should be valid for use as a folder name on the


operating system of this installation.

Do not use any special characters other than underscore, dash,


and period.

5000.0.0 Install All Options 36


Landmark Advanced Data Transfer Software Installation and Administration Guide

23. When the hsqldb-ow Specific Measurement System screen opens,


select a default measurement system, then click Next. GS

The path and measurement systems listed are dynamic based on


your choices in the Name This Implementation screen in the
previous step.

For example, if you named the synchronization frameword Red


the title would be Red-Specific Measurement System instead of
hsqldb-ow Specific Measurement System.

5000.0.0 Install All Options 37


Landmark Advanced Data Transfer Software Installation and Administration Guide

24. When the Oracle Home screen opens, identify the folder where
Oracle 10g is installed, then click Next. GS

. Does ADT care about this?

5000.0.0 Install All Options 38


Landmark Advanced Data Transfer Software Installation and Administration Guide

25. When the Default OpenWorks District screen opens, type the
district name that will be used with this generic synchronization
implementation in the District field, then click Next. GS

Districts are case-sensitive.

After installation, you can change the district in the file

<ADT_Install_Path>/sync/hsqldb-ow/adt_files/ADTUser.properties

5000.0.0 Install All Options 39


Landmark Advanced Data Transfer Software Installation and Administration Guide

26. If known, when the Email Configuration screen opens, enter the
SMTP server and email address for this synchronization
implementation, then click Next. GS

After installation, you can add or change the SMTP server and
From email address in the file

<ADT_Install_Path>\<sync_dir>\<implementation_name>\conf\local.props

5000.0.0 Install All Options 40


Landmark Advanced Data Transfer Software Installation and Administration Guide

27. When the Logs Folder URL screen opens, type the URL of the
web server where the logs folder resides, then click Next. GS

After installation, you can add or change the URL setting


(sync.adtlog.url) of the web server in the file

<ADT_Install_Path>\<sync_dir>\<implementation_name>\conf\local.props

See the Generic Synchronization User Reference Manual


(<ADT_Install_Path>/doc/Generic_Sync_Reference_Manual.pdf)
for information about viewing log files.

5000.0.0 Install All Options 41


Landmark Advanced Data Transfer Software Installation and Administration Guide

28. Review the information in the Pre-Installation Summary screen.


Make any necessary changes by clicking Previous to go to the
screen where changes should be made. When you are satisfied
with the installation parameters, click Install.

A status bar shows the progress of the installation.

5000.0.0 Install All Options 42


Landmark Advanced Data Transfer Software Installation and Administration Guide

29. The Tasks Remaining: Datamodel Configuration screen opens,


listing the tasks you must perform to create DSOS files and
Schema files for your data store and finalize the Third Party
Connection datamodel configuration. Click Next.

30. The Tasks Remaining: Synchronization Configuration screen


opens, listing the tasks you must perform to finalize the Generic
Sychronization configuration. Click Next.

31. When Install Complete screen opens, click Done.

The installer windows close.

32. Perform post-installation steps. See Post-Installation Steps on


page 91.

5000.0.0 Install All Options 43


Landmark Advanced Data Transfer Software Installation and Administration Guide

Install Advanced Data Transfer


And Third-Party Connection Wizard

Use the steps in this section to install the Advanced Data Transfer
software and the Third-Party Connection Wizard.

Installation Steps

1. When the Choose Features to Install screen opens, choose the


Advanced Data Transfer and Third-party Connection Wizard
installation options, then click Next.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 44


Landmark Advanced Data Transfer Software Installation and Administration Guide

2. When the Introduction screen opens, click Next. ADT

3. When the Choose ADT Install Directory screen opens, accept the
default or click Choose to navigate to the desired installation
directory, then click Next. ADT

If the software has already been installed in the location you


choose, you are prompted to choose a different location than the
existing installation.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 45


Landmark Advanced Data Transfer Software Installation and Administration Guide

4. When the Optional Datamodels screen opens, select the


datamodels to include in this installation, then click Next. ADT

The OpenWorks software datamodel is installed by default.

The Corporate Data Store software and LAS datamodels are


also installed by default.

The Corporate Data Store datamodel must be installed for a


joint Advanced Data Transfer /PowerExplorer software
installation.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 46


Landmark Advanced Data Transfer Software Installation and Administration Guide

5. If you checked the CDS box in the previous screen, the CDS
PowerHub Server Connection screen opens you that you can enter
the connection settings for the server where the Corporate Data
Store software datamodel will be installed. Type the appropriate
information in the text boxes, then click Next. ADT

PowerHub Server hostname. The machine name of your


PowerHub software server. This can be the short name or the
long (fully-qualified) name.

Dictionary name: case sensitive. For example, pe_dic.

PowerHub Server name: case sensitive. For example, server.

CDS Database name: case sensitive and must match your


Corporate Data Store installation. For example, prod.

Note: The installer prepends cds_ to the Corporate Data Store


software database name.

See About Coporate Data Store Database Monikers on page 95 for a


detailed explanation of Corporate Data Store database names.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 47


Landmark Advanced Data Transfer Software Installation and Administration Guide

6. When the OpenWorks Preferences screen opens, enter the


following information, then click Next. ADT

OpenWorks District: case-sensitive. This can be the short


name or the long (fully-qualified) name.

Note: The case used here must match the case of the district.
You can use the OpenWorks Project Status Tool to check the
case of the district name.

OpenWorks Project: uppercase only.


Note: The project must be version 5000.0.0.2 or later.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 48


Landmark Advanced Data Transfer Software Installation and Administration Guide

7. When the Default OpenWorks Authentication Mode screen opens,


choose one of the authentication options, then click Next. ADT

External connects to OpenWorks software using your


operating system user id. Choose this option to run the
Advanced Data Transfer software in standalone mode
without PowerExplorer software.

Internal connects to OpenWorks software after prompting


you for a username and password. This option is required for a
joint Advanced Data Transfer /PowerExplorer software
installation.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 49


Landmark Advanced Data Transfer Software Installation and Administration Guide

8. When the Message Server Configuration screen opens, choose one


of the configuration options, then click Next. ADT

Local (private) runs one message server for each Advanced


Data Transfer job. Choose this option to run in standalone
mode. This is the default.

Shared runs one message server for multiple jobs. This option
is required for a joint Advanced Data
Transfer/PowerExplorer software installation.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 50


Landmark Advanced Data Transfer Software Installation and Administration Guide

9. If you chose Shared in the previous Message Server


Configuration screen, the Shared Message Server Configuration
screen opens so that you can enter the host name and port number
of the message server, then click Next. ADT

This screen does not appear if you chose Local in the previous
Message Server Configuration screen.

Shared Message Server on a Different Machine?

If the machine hosting the shared message server is a different machine than
the machine where the Advanced Data Transfer software is installed the
machine hosting the shared message server must be running when the
Advanced Data Transfer software is launched.

10. Linux only. In the Which Browser? screen, locate the browser on
your computer, then click Next.

11. Linux only. In the Which XTerm? screen, locate the xterm on your
computer, then click Next.

12. Linux only. In the Which Editor? screen, locate the text editor on
your computer, then click Next.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 51


Landmark Advanced Data Transfer Software Installation and Administration Guide

13. When the User Specific Customization File screen opens, set your
preference for the location of the ADTUser.properties file, then
click Next. ADT

Note: The installer does not overwrite an existing file. A backup


copy is created.

The default is checked. The installer copies


ADTUser.properties to your home directory.

This option is required for a joint Advanced Data


Transfer/PowerExplorer software installation.

If you do not want to copy ADTUser.properties to your home


directory, uncheck the box.

Note: Many individual user preferences can be set in ADTUser.properties.

Using a custom ADTUser.properties file allows you to run the Advanced Data
Transfer software with your preferences without affecting other Advanced Data
Transfer software users. See ADTUser.properties on page 103.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 52


Landmark Advanced Data Transfer Software Installation and Administration Guide

14. Windows only: When the Choose Shortcut Folder screen opens,
choose the appropriate option, then click Next. ADT

5000.0.0 Install Advanced Data Transfer and Connection Wizard 53


Landmark Advanced Data Transfer Software Installation and Administration Guide

15. When the PowerHub Server Connection Settings screen opens,


enter the information necessary to connect to the PowerHub
software server, then click Next. CW

PowerHub Server hostname: The machine name of your


PowerHub server. This can be the short name or the long
(fully-qualified) name.

PowerHub Dictionary name: Default is 'pe_dic'

PowerHub Server name: Default is 'server'

Note: This is not usually the machine name unless your


administrator chose to make it so during the PowerHub
software server installation.

PowerHub Data Model Name: The datamodel/datastore name


you configured on the PowerHub server.

Database Name: The database/data source name you created


on the PowerHub server.

Primary top level table name: Default is well_t. This should


be the primary topic you created on the PowerHub server. It
is the only topic that the installer pre-configures. Other topics
must be manually defined later. See Configure Datamodels for
Third-Party Connections on page 92 for more information.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 54


Landmark Advanced Data Transfer Software Installation and Administration Guide

16. When the Default Connection Availability screen opens, choose


whether the PowerHub software connection should be available
to all users or just you, then click Next. CW

Select Global if you want the connection to be available for all


users by default.

Select User Specific to configure the connection for the current


user, but disable it for all other users.

If the current user does not have an $HOME/ADTUser.properties


file, the file in $ADTHOME is copied to the user's $HOME.

The current user's $HOME/ADTUser.properties file is modifed to


enable the database connection by adding a line formatted as
follows

dm_<<datamodelname>>_DMActive=true

This line can be added to any user's ADTUser.properties file to


enable / disable the connection.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 55


Landmark Advanced Data Transfer Software Installation and Administration Guide

17. When the Default Moniker/URL Configurability screen opens,


specify whether the URL of the default moniker should be shared
or if it is for your use only, then click Next. ADT and CW

The Advanced Data Transfer software reads datamodel


metadata from a database instance.

Typically, there will not be multiple instances of the database


you are configuring a third-party connection to, so you may
ignore this dialog.

However, if you do have multiple instances of the same


datamodel on different servers, and want to support individual
user definition of which instance should be their default, check
the box Enable User Override Support.

When enabled, all users will have the same default instance
until they modify their $HOME/ADTUser.properties file to
change their default instance.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 56


Landmark Advanced Data Transfer Software Installation and Administration Guide

18. When the PowerExplorer Username and Password screen opens,


enter the PowerExplorer software login credentials for the target,
then click Next. CW

PowerExplorer Server username and password

Database username and password

After completion of the wizard, there are scripts that must be run
to complete the configuration. Successful execution of these
scripts requires pre-configured PowerExplorer login credentials.

These credentials may be removed later if it is undesirable to


persist them permanently. (The file holding the persisted
credentials is defined in the next step.)

5000.0.0 Install Advanced Data Transfer and Connection Wizard 57


Landmark Advanced Data Transfer Software Installation and Administration Guide

19. Whe the Credentials Storage Support screen opens, decide


whether the PowerExplorer software login credentials should be
stored in individual ADTUser.properties files, then click Next. CW

The Advanced Data Transfer software supports persistence of


user-specific PowerExplorer login credentials in
$HOME/ADTUser.properties files.

If you enable support allowing users to specify their


PowerExplorer login credentials in their
$HOME/ADTUser.properties file, this dialog will be followed
by one asking if any PowerExplorer login credentials you
provided earlier should be private or shared globally for all
users.

If you do not enable this support, the PowerExplorer login


credentials you provided in the previous step are added to the
datamodel properties file and are globally shared by anyone
using the connection.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 58


Landmark Advanced Data Transfer Software Installation and Administration Guide

20. The Credentials Storage screen opens if you checked Enable


User Defined Credentials Support in the previous Credentials
Storage Support screen. CW

Specify whether the PowerExplorer software username and


password you provided in the PowerExplorer Username and
Password screen should be shared or if they are for your use
only.

If you do not want the credentials you provided to be used by all


users, accept the default ADTUser.properties (only for you).
Other users must persist their own credentials in their own
$HOME/ADTUser.properties files, or enter them on the
command line when launching the Advanced Data Transfer
software.

Click Next.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 59


Landmark Advanced Data Transfer Software Installation and Administration Guide

21. Optional. When the Global Database Attribute Names screen


opens, enter date attributes for the database, then click Next. CW

Entering date attributes is optional during the install, but date


attributes may be important depending on how you want to use the
data in this database.

The Advanced Data Transfer software supports date-based


read filtering and date-based update rules. For these features to
function, Advanced Data Transfer must know the date
attribute names.

For improved performance, Advanced Data Transfer


supports skipping updates to data that is nearly equivalent to
existing data. Defining names of any attributes holding create
and update users allows Advanced Data Transfer to ignore
those values so a source record that differs only by who created
or last updated it won't result in an update to the target record.
If your datamodel supports it, defining a data source attribute
name allows Advanced Data Transfer to skip an update when
the only difference in the source and target records is the value
of that attribute.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 60


Landmark Advanced Data Transfer Software Installation and Administration Guide

22. Review the information in the Pre-Installation Summary screen.


Make any necessary changes by clicking Previous to go to the
screen where changes should be made. When you are satisfied
with the installation parameters, click Install.

A status bar shows the progress of the installation.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 61


Landmark Advanced Data Transfer Software Installation and Administration Guide

23. The Tasks Remaining: Datamodel Configuration screen lists the


tasks you need to perform to create DSOS files and Schema files
for your data store and finalize the Third Party Connection
datamodel configuration. Click Next. CW

24. When the Install Complete screen opens, click Done.

The installer windows close.

25. Perform post-installation steps. See Post-Installation Steps on


page 91.

5000.0.0 Install Advanced Data Transfer and Connection Wizard 62


Landmark Advanced Data Transfer Software Installation and Administration Guide

Install Third-Party Connection Wizard


Only

Use the steps in this section to set up a new third-party connection after
the Advanced Data Transfer software has been installed. The
example data store DM_HSQLDB installed by the wizard is used in the
illustrations. How many third-party connections can exist at once?

Installation Steps

1. When the Choose Features to Install screen opens, select the


Third-Party Connection Wizard from the Install Set list, then click
Next.

5000.0.0 Install Connection Wizard After Advanced Data Transfer 63


Landmark Advanced Data Transfer Software Installation and Administration Guide

2. When the Introduction screen opens, click Next. ADT

3. When the Identify ADT Installation screen opens, select the


location where the software is already installed, then click Next.

5000.0.0 Install Connection Wizard After Advanced Data Transfer 64


Landmark Advanced Data Transfer Software Installation and Administration Guide

4. When the PowerHub Server Connection Settings screen opens,


enter the information necessary to connect to the PowerHub
software server, then click Next. CW

PowerHub Server hostname: The machine name of your


PowerHub server. This can be the the short name or the long
(fully-qualified) name.

PowerHub Dictionary name: Default is 'pe_dic'

PowerHub Server name: Default is 'server'

Note: This is not usually the machine name unless your


administrator chose to make it so during the PowerHub server
installation.

PowerHub Data Model Name: The datamodel/datastore name


you configured on the PowerHub server.

Database Name: The database/data source name you created


on the PowerHub server.

Primary top level table name: Default is well_t. This should


be the primary topic you created on the PowerHub server. It
is the only topic that the installer pre-configures. Other topics
must be manually defined later. See Configure Datamodels for
Third-Party Connections on page 92.

5000.0.0 Install Connection Wizard After Advanced Data Transfer 65


Landmark Advanced Data Transfer Software Installation and Administration Guide

5. When the Default Connection Availability screen opens, choose


whether the PowerHub connection should be available to all users
or just you, then click Next. CW only after ADT

Select Global if you want the connection to be available for all


users by default. This is the default.

Select User Specific to configure the connection for the current


user, but disable it for all other users.

If the current user does not have an $HOME/ADTUser.properties


file, the file in $ADTHOME is copied to the user's $HOME.

The current user's $HOME/ADTUser.properties file is modifed to


enable the database connection by adding a line formatted as
follows

dm_<<datamodelname>>_DMActive=true

This line can be added to any user's ADTUser.properties file to


enable/disable the connection.

5000.0.0 Install Connection Wizard After Advanced Data Transfer 66


Landmark Advanced Data Transfer Software Installation and Administration Guide

6. When the Default Moniker/URL Configurability screen opens,


specify whether the URL of the default moniker should be shared
or if it is for your use only, then click Next. CW

The Advanced Data Transfer software reads datamodel


metadata from a database instance.

Typically, there will not be multiple instances of the database


you are configuring a third-party connection to, so you may
ignore this dialog.

However, if you do have multiple instances of the same


datamodel on different servers, and want to support individual
user definition of which instance should be their default, check
the box Enable User Override Support.

When enabled, all users will have the same default instance
until they modify their $HOME/ADTUser.properties file to
change their default instance.

5000.0.0 Install Connection Wizard After Advanced Data Transfer 67


Landmark Advanced Data Transfer Software Installation and Administration Guide

7. When the PowerExplorer Username and Password screen opens,


enter the PowerExplorer software login credentials for the target,
then click Next. CW

PowerExplorer Server username and password

Database username and password

After completion of the wizard, there are scripts that must be run
to complete the configuration. Successful execution of these
scripts requires pre-configured PowerExplorer login credentials.

These credentials may be removed later if it is undesirable to


persist them permanently. (The file holding the persisted
credentials is defined in the next step.)

5000.0.0 Install Connection Wizard After Advanced Data Transfer 68


Landmark Advanced Data Transfer Software Installation and Administration Guide

8. Whe the Credentials Storage Support screen opens, decide


whether the PowerExplorer software login credentials should be
stored in individual ADTUser.properties files, then click Next. CW

The Advanced Data Transfer software supports persistence of


user-specific PowerExplorer login credentials in
$HOME/ADTUser.properties files.

If you enable support allowing users to specify their


PowerExplorer login credentials in their
$HOME/ADTUser.properties file, this dialog will be followed
by one asking if any PowerExplorer login credentials you
provided earlier should be private or shared globally for all
users.

If you do not enable this support, the PowerExplorer login


credentials you provided in the previous step are added to the
datamodel properties file and are globally shared by anyone
using the connection.

5000.0.0 Install Connection Wizard After Advanced Data Transfer 69


Landmark Advanced Data Transfer Software Installation and Administration Guide

9. The Credentials Storage screen opens if you selected Enable User


Defined credentials support in the Credentials Storage Support
screen. CW

Specify whether the PowerExplorer software username and


password should be shared or if they are for your use only.

If you do not want the credentials you provided to be used by all


users, accept the default ADTUser.properties (only for you).
Other users must persist their own credentials in their own
$HOME/ADTUser.properties files, or enter them on the
command line when launching the Advanced Data Transfer
software.

Click Next.

5000.0.0 Install Connection Wizard After Advanced Data Transfer 70


Landmark Advanced Data Transfer Software Installation and Administration Guide

10. Optional. When the Global Database Attribute Names screen


opens, enter date attributes for the database, then click Next. CW

Entering date attributes is optional during the install, but date


attributes may be important depending on how you want to use the
data in this database.

The Advanced Data Transfer software supports date-based


read filtering and date-based update rules. For these features to
function, the Advanced Data Transfer software must know
the date attribute names.

For improved performance, the Advanced Data Transfer


software supports skipping updates to data that is nearly
equivalent to existing data. Defining names of any attributes
holding create and update users allows Advanced Data
Transfer to ignore those values so a source record that differs
only by who created or last updated it won't result in an update
to the target record. If your datamodel supports it, defining a
data source attribute name allows Advanced Data Transfer to
skip an update when the only difference in the source and target
records is the value of that attribute.

5000.0.0 Install Connection Wizard After Advanced Data Transfer 71


Landmark Advanced Data Transfer Software Installation and Administration Guide

11. Review the information in the Pre-Installation Summary screen.


Make any necessary changes by clicking Previous to go to the
screen where changes should be made. When you are satisfied
with the installation parameters, click Install.

A status bar shows the progress of the installation.

5000.0.0 Install Connection Wizard After Advanced Data Transfer 72


Landmark Advanced Data Transfer Software Installation and Administration Guide

12. The Tasks Remaining: Datamodel Configuration screen lists the


tasks you must perform to create DSOS files and Schema files for
your data store and finalize the Third Party Connection datamodel
configuration. Click Next. CW

13. When the Install Complete screen opens, click Done.

The installer windows close.

14. Perform post-installation steps. See Post-Installation Steps on


page 91.

5000.0.0 Install Connection Wizard After Advanced Data Transfer 73


Landmark Advanced Data Transfer Software Installation and Administration Guide

Install Third-Party Connection Wizard


and Generic Synchronization

Use the steps in this section to set up a new third-party connection and
generic synchronization after the Advanced Data Transfer software
has been installed. The example data store DM_HSQLDB installed by
the wizard is used in the illustrations. How many third-party
connections can exist at once?

Installation Steps

1. When the Choose Features to Install screen opens, click the


Third-Party Connection Wizard and Generic Synchronization
Framework boxes so that check marks appear in them, then click
Next.

5000.0.0 Install Connection Wizard and Generic Synchronization 74


Landmark Advanced Data Transfer Software Installation and Administration Guide

2. When the Introduction screen opens, click Next. ADT

3. When the Identify ADT Installation screen opens, select the


location where the Advanced Data Transfer software is already
installed, then click Next.

5000.0.0 Install Connection Wizard and Generic Synchronization 75


Landmark Advanced Data Transfer Software Installation and Administration Guide

4. When the PowerHub Server Connection Settings screen opens,


enter the information necessary to connect to the PowerHub
software server, then click Next. CW

PowerHub Server hostname: The machine name of your


PowerHub server. This can be the the short name or the long
(fully-qualified) name.

PowerHub Dictionary name: Default is 'pe_dic'

PowerHub Server name: Default is 'server'

Note: This is not usually the machine name unless your


administrator chose to make it so during the PowerHub server
installation.

PowerHub Data Model Name: The datamodel/datastore name


you configured on the PowerHub server.

Database Name: The database/data source name you created


on the PowerHub server.

Primary top level table name: Default is well_t. This should


be the primary topic you created on the PowerHub server. It
is the only topic that the installer pre-configures. Other topics
must be manually defined later. See Configure Datamodels for
Third-Party Connections on page 92 for more information.

5000.0.0 Install Connection Wizard and Generic Synchronization 76


Landmark Advanced Data Transfer Software Installation and Administration Guide

5. When the PowerExplorer Username and Password screen opens,


enter the PowerExplorer software login credentials for the target,
then click Next. CW

PowerExplorer Server username and password

Database username and password

After completion of the wizard, there are scripts that must be run
to complete the configuration. Successful execution of these
scripts requires pre-configured PowerExplorer login credentials.

These credentials may be removed later if it is undesirable to


persist them permanently. (The file holding the persisted
credentials is defined in the next step.)

5000.0.0 Install Connection Wizard and Generic Synchronization 77


Landmark Advanced Data Transfer Software Installation and Administration Guide

6. When the Credentials Storage screen opens, specify whether the


PowerExplorer software username and password should be
shared or if they are for your use only, then click Next. CW

Specify whether the PowerExplorer username and password


should be shared or if they are for your use only.

If you do not want the credentials you provided to be used by all


users, accept the default ADTUser.properties (only for you).
Other users must persist their own credentials in their own
$HOME/ADTUser.properties files, or enter them on the
command line when launching the Advanced Data Transfer
software.

5000.0.0 Install Connection Wizard and Generic Synchronization 78


Landmark Advanced Data Transfer Software Installation and Administration Guide

7. Optional. When the Global Database Attribute Names screen


opens, enter date attributes for the database, then click Next. CW

Entering date attributes is optional during the install, but date


attributes may be important depending on how you want to use the
data in this database.

The Advanced Data Transfer software supports date-based


read filtering and date-based update rules. For these features to
function, the Advanced Data Transfer software must know
the date attribute names.

For improved performance, Advanced Data Transfer


supports skipping updates to data that is nearly equivalent to
existing data. Defining names of any attributes holding create
and update users allows Advanced Data Transfer to ignore
those values so a source record that differs only by who created
or last updated it won't result in an update to the target record.
If your datamodel supports it, defining a data source attribute
name allows Advanced Data Transfer to skip an update when
the only difference in the source and target records is the value
of that attribute.

5000.0.0 Install Connection Wizard and Generic Synchronization 79


Landmark Advanced Data Transfer Software Installation and Administration Guide

8. When the Target Server Connection Settings screen opens, enter


the information necessary to connect to the target PowerHub
software server, then click Next. GS

Target PowerHub Server hostname: The machine name of


the target PowerHub server. This can be the the short name or
the long (fully-qualified) name.

PowerHub Dictionary name: Default is 'pe_dic'

PowerHub server name: Default is 'server'

Note: This is not usually the machine name unless your


administrator chose to make it so during the PowerHub
server installation.

PowerHub Data Model Name: The datamodel/datastore name


you configured on the PowerHub server.

Database Name: The database/data source name you created


on the PowerHub server. If the database is OpenWorks, use
the format DISTRICT.PROJECT. Case sensitive if not OW?

Primary top level table name: Default is WellEntire. This


should be the primary topic you created on the target server. It
is the only topic that the installer pre-configures. Other topics
must be manually defined later. See Configure Generic
Synchronization on page 92 for more information for more
information.

5000.0.0 Install Connection Wizard and Generic Synchronization 80


Landmark Advanced Data Transfer Software Installation and Administration Guide

9. When the Target PowerExplorer Username and Password screen


opens, enter the PowerExplorer software login credentials for the
target, then click Next. GS

After installation, there are scripts that must be run to complete the
synchronization configuration. Successful execution of these
scripts require pre-configured PowerExplorer login credentials.

These credentials may be removed later if it is undesirable to


persist them permanently. (The location of the local.props file
that holds the persisted credentials is determined in the next two
steps.)

5000.0.0 Install Connection Wizard and Generic Synchronization 81


Landmark Advanced Data Transfer Software Installation and Administration Guide

10. When the Synchronization Framework Installation screen opens,


choose a folder for the synchronization files, then click Next. GS

The default location is under the folder you choose at the


beginning of this installation.

5000.0.0 Install Connection Wizard and Generic Synchronization 82


Landmark Advanced Data Transfer Software Installation and Administration Guide

11. When the Name This Implementation screen opens, enter a name
for this synchronization implementation, then click Next. GS

The name should be valid for use as a folder name on the


operating system of this installation.

Do not use any special characters other than underscore, dash,


and period.

5000.0.0 Install Connection Wizard and Generic Synchronization 83


Landmark Advanced Data Transfer Software Installation and Administration Guide

12. When the hsqldb-ow Specific Measurement System screen opens,


select a default measurement system, then click Next. GS

The path and measurement systems listed are dynamic based on


your choices in the Name This Implementation screen in the
previous step.

For example, if you named the synchronization frameword Red


the title would be Red-Specific Measurement System instead of
hsqldb-ow Specific Measurement System.

5000.0.0 Install Connection Wizard and Generic Synchronization 84


Landmark Advanced Data Transfer Software Installation and Administration Guide

13. When the Oracle Home screen opens, identify the folder where
Oracle 10g is installed, then click Next. GS

5000.0.0 Install Connection Wizard and Generic Synchronization 85


Landmark Advanced Data Transfer Software Installation and Administration Guide

14. When the Default OpenWorks District screen opens, type the
district name that will be used with this generic synchronization
implementation in the District field, then click Next. GS

After installation, you can change the district in the file

<ADT_Install_Path>/sync/hsqldb-ow/adt_files/ADTUser.properties

5000.0.0 Install Connection Wizard and Generic Synchronization 86


Landmark Advanced Data Transfer Software Installation and Administration Guide

15. If known, when the Email Configuration screen opens, enter the
SMTP server and email address for this synchronization
implementation, then click Next. GS

After installation you can add or change the SMTP server and
From email address in the file

<ADT_Install_Path>\<sync_dir>\<implementation_name>\conf\local.props

5000.0.0 Install Connection Wizard and Generic Synchronization 87


Landmark Advanced Data Transfer Software Installation and Administration Guide

16. When the Logs Folder URL screen opens, type the URL of the
web server where the logs folder resides, then click Next. GS

After installation you can add or change the URL setting


(sync.adtlog.url) of the web server in the file

<ADT_Install_Path>\<sync_dir>\<implementation_name>\conf\local.props

See the Generic Synchronization User Reference Manual


(<ADT_Install_Path>/doc/Generic_Sync_Reference_Manual.pdf)
for information about viewing log files.

5000.0.0 Install Connection Wizard and Generic Synchronization 88


Landmark Advanced Data Transfer Software Installation and Administration Guide

17. Review the information in the Pre-Installation Summary screen.


Make any necessary changes by clicking Previous to go to the
screen where changes should be made. When you are satisfied
with the installation parameters, click Install.

A status bar shows the progress of the installation.

5000.0.0 Install Connection Wizard and Generic Synchronization 89


Landmark Advanced Data Transfer Software Installation and Administration Guide

18. The Tasks Remaining: Datamodel Configuration screen opens,


listing the tasks you must perform to to create DSOS files and
Schema files for your data store and finalize the Third Party
Connection datamodel configuration. Click Next.

19. The Tasks Remaining: Synchronization Configuration screen


opens, listing the tasks you must perform to finalize the Generic
Sychronization configuration. Click Next.

20. When the Install Complete screen opens, click Done.

The installer windows close.

21. Perform post-installation steps. See Post-Installation Steps on


page 91.

5000.0.0 Install Connection Wizard and Generic Synchronization 90


Landmark Advanced Data Transfer Software Installation and Administration Guide

Post-Installation Steps

All Configurations

Verify That All Configured Data Models Are Online

Before launching the Advanced Data Transfer software, verify that


the default configured datamodels, i.e., OpenWorks, Corporate Data
Store (if selected during installation), and LAS (if selected during
installation), are online. Advanced Data Transfer must initialize each
defined data model and thus must connect to one object connect for
each datamodel to read metadata.

You can disable datamodels either via the command line or in your
ADTUser.properties file. If, for example, a third-party database will be
offline for maintenance for a week, simply add a line to your properties
file to disable the offline database.

Check Your Authorization to Write to Targets

Choosing a target in Advanced Data Transfer implies that you intend


to write data to that target.

If the target is an Object Server, you must have authorization to write


data to that target.

If the target is a custom database configured via PowerHub software,


that configuration must support create and update capabilities in
addition to adequate credentials.

A custom database exposed via PowerHub and configured with only


read capabilities is read-only cannot be written to no matter what
credentials a user provides.

Set Login Credentials

Set up logins to automatically access databases. See Presetting


Corporate Data Store Software Login Credentials on page 98 and
Presetting OpenWorks Login Credentials on page 101.

5000.0.0 Post-Installation Steps 91


Landmark Advanced Data Transfer Software Installation and Administration Guide

Other Configurations

Shared Message Server on a Different Machine?

If the machine hosting the shared message server is a different machine


than the machine where the Advanced Data Transfer software is
installed verify that the machine hosting the shared message server is
running before launching Advanced Data Transfer.

Configure Datamodels for Third-Party Connections

See the Set Up the Third-Party Data Model Directory document


(<ADT_Install_Path>/doc/ThirdParty/SetupADTDataModelDir.pdf).

Following is an outline of the steps to perform after installing the


Third-Party Connection Wizard.

1. Run the datamodel DSOS scripts xml scripts in


<ADT_INSTALL_PATH>/conf/datamodels/dm_hsqldb:

ADT_DSOS_DataModel
ADT_DSOS_XML2HTML

2. Create and populate partitions in the DM_HSQLDBDataTree.xml


file.

3. Run the partition DSOS script: ADT_DSOS_Partition.

4. Run the partition schema creation script:


ADT_Schema_Partition.

5. For each partition you defined, iteratively run the script:


ADT_DSOS_XML2HTML.

Configure Generic Synchronization

See the Generic Synchronization User Reference Manual


(<ADT_Install_Path>/doc/Generic_Sync_Reference_Manual.pdf) for
detailed information about configuring generic synchronization.

Following is an outline of the steps to perform after installing generic


synchronization:

5000.0.0 Post-Installation Steps 92


Landmark Advanced Data Transfer Software Installation and Administration Guide

1. Perform XSL translation tasks.

2. Create job and selection templates.

3. Run sanity checking scripts.

After running the Third Party Connection Wizard and installing the
Generic Synchronization Framework, the sanity test scripts in the
<ADT_Install_Path>/sync/test folder will run successfully.

5000.0.0 Post-Installation Steps 93


Landmark Advanced Data Transfer Software Installation and Administration Guide

Accessing Servers

Using Long (Fully-Qualified) and Short Server Names

The Advanced Data Transfer software now allows you to use long
(fully-qualified) or short names when defining Corporate Data Store,
OpenWorks, and PowerHub software monikers.

Corporate Data Store Monikers

To use long names when defining Corporate Data Store monikers,


enclose the long name with ' (one single quote) at the beginning of the
name and ' (one single quote) at the end of the name. For example,

'MACHINE.DOMAIN.COM'

dm_cds_defaultmoniker='pe_dic-server@dayden.lgc.com'.CDS5000.cds_prod

You must enclose long names with single quotes in the CDS.properties
and ADTUser.properties files. However, it is not necessary to enclose
long names for Corporate Data Store monikers in single quotes in the
PHServer.properties file.

OpenWorks Monikers

To use long names when defining OpenWorks monikers, enclose the


long name with \\' (two backslashes and one single quote) at the
beginning of the name and ' (one single quote) at the end of the name.
For example,

\\'DISTRICT.DOMAIN.COM'.PROJECT.ALL_DATA

dm_ow_defaultmoniker=OpenWorks/\\'OWWARM.LGC.COM'.ADT_5000.ALL_DATA

PowerHub Monikers

It is not necessary to enclose long names for PowerHub monikers in


quotes.

5000.0.0 Using Long (Fully-Qualified) and Short Server Names 94


Landmark Advanced Data Transfer Software Installation and Administration Guide

Coporate Data Store Software Servers

About Coporate Data Store Database Monikers

Important: Corporate Data Store server names must be lowercase!

The Advanced Data Transfer software connects to Corporate Data


Store servers using the following syntax:

<dictionary_name>-<server_name>@app_server_host.CDS5000.cds_name

where

<dictionary_name>-<server_name> is constructed from the dictionary name, such as


pe_dic, and the PowerHub software server (or RMI
server) name, such as server, separated by a hyphen.
For example: pe_dic-server.

app_server_host is as listed in the Oracle table slg_datastore in the


PowerExplorer software dictionary table. For
example: dayden.lgc.com.

CDS5000 is the Corporate Data Store data model type. Always


CDS5000.

cds_name is the name of the Corporate Data Store database.


Must be lower case, for example, prod.
Note: The Advanced Data Transfer installer prepends
the cds_ prefix.

Example: A properly defined Corporate Data Store moniker in


<ADT_Install_Path>/ADTUser.properties:

dm_cds_defaultmoniker='pe_dic-server@dayden.lgc.com'.CDS5000.cds_prod

Example: A properly defined Corporate Data Store moniker in


<ADT_Install_Path>/conf/datamodels/cds/CDS.properties:

ADTGLOBAL_dm_cds_defaultmoniker='pe_dic-
server@dayden.lgc.com'.CDS5000.cds_prod

5000.0.0 Coporate Data Store Software Servers 95


Landmark Advanced Data Transfer Software Installation and Administration Guide

Adding Corporate Data Store Servers

The PHServer.properties file contains the names of all of the Corporate


Data Store servers to which you can connect.

It is not necessary to enclose long names for Corporate Data Store


monikers in single quotes in the PHServer.properties file.

To add additional Corporate Data Store servers, use the following


steps:

1. Edit <ADT_Install_Path>/resources/PHServer.properties.

The file looks similar to this:

Short name example

com.pgs.dm.slegge.dsos.SCWAppServers=pe_dic-server@dayden;

Long name example

com.pgs.dm.slegge.dsos.SCWAppServers=pe_dic-server@dayden.lgc.com;

2. Add the second server to the end of the line using this syntax:

<dictionary_name>-<server_name>@app_server_host>;

so that the line appears similar to the following example

com.pgs.dm.slegge.dsos.SCWAppServers=pe_dic-
server@dayden.lgc.com;pe_dic-server@trojan.lgc.com;

Do not remove the semi-colon at the end of the string.

3. Save and close PHServer.properties.

5000.0.0 Coporate Data Store Software Servers 96


Landmark Advanced Data Transfer Software Installation and Administration Guide

Changing the Default Corporate Data Store Database

To change the default Corporate Data Store database set during


installation:

1. Edit <ADT_Install_Path>/conf/datamodels/cds/CDS.properties.

2. For example, change the database in the following line

Short name example from

ADTGLOBAL_dm_cds_defaultmoniker=pe_dic-server@dayden.CDS5000.cds_prod

to

ADTGLOBAL_dm_cds_defaultmoniker=pe_dic-server@dayden.CDS5000.cds_dev

Long name example from

ADTGLOBAL_dm_cds_defaultmoniker=
'pe_dic-server@dayden.gc.com'.CDS5000.cds_prod

to

ADTGLOBAL_dm_cds_defaultmoniker=
'pe_dic-server@dayden.lgc.com'.CDS5000.cds_dev

5000.0.0 Coporate Data Store Software Servers 97


Landmark Advanced Data Transfer Software Installation and Administration Guide

Presetting Corporate Data Store Software Login Credentials

To preset user login credentials for a Corporate Data Store database,


do as follows:

1. Open $HOME/ADTUser.properties.

2. Remove the leading # to uncomment the line dm_cds_login=.

Same User Names

The format to use the same PowerExplorer and Corporate


Data Store software user name:

<moniker1>|<username1>|<password1>;<moniker2>|<username2>|<password2>

Short name example:

pe_dic-server@dayden.CDS5000.cds_prod|username|password

Long name example:

'pe_dic-server@dayden.lgc.com'.CDS5000.cds_prod|username|password

Different User Names

The format to use different PowerExplorer and Corporate


Data Store software user names:

<moniker1>|<peusername1>|<pepassword1>|<cdsuser>|<cdspasswd>

Short name example:

pe_dic-server@dayden.CDS5000.cds_prod|peusername|pepassword|cdsuser|cdspassword

Long name example:

'pe_dic-
server@dayden.lgc.com'.CDS5000.cds_prod|peusername|pepassword|cdsuser|
cdspassword

Joint Advanced Data Transfer/PowerExplorer software users: See


the PowerExplorer System Administration manual.

5000.0.0 Coporate Data Store Software Servers 98


Landmark Advanced Data Transfer Software Installation and Administration Guide

OpenWorks Software Servers

About OpenWorks Database Monikers

Important: OpenWorks district and project names must be uppercase!

The OpenWorks monikers are constructed using the following


syntax:

dm_ow_defaultmoniker=OpenWorks/<DISTRICT>.<PROJECT>.ALL_DATA

where

DISTRICT is the OpenWorks district. For example:


OWWARM

PROJECT is the name of the OpenWorks project. For


example: ADT_5000

A properly defined entry in ADTUser.properties has an appearance


similar to the following:

Short DISTRICT name

dm_ow_defaultmoniker=OpenWorks/DISTRICT.PROJECT.ALL_DATA

dm_ow_defaultmoniker=OpenWorks/OWWARM.ADT_5000.ALL_DATA

Long DISTRICT name

dm_ow_defaultmoniker=OpenWorks/\\'DISTRICT.DOMAIN.COM'.PROJECT.ALL_DATA

dm_ow_defaultmoniker=OpenWorks/\\'OWWARM.LGC.COM'.ADT_5000.ALL_DATA

5000.0.0 OpenWorks Software Servers 99


Landmark Advanced Data Transfer Software Installation and Administration Guide

Changing the Default OpenWorks Database

To change the default OpenWorks database set during installation:

1. Edit <ADT_Install_Path>/conf/datamodels/ow/OW.properties

2. Change the moniker in the following line

Short name example from

ADTGLOBAL_dm_ow_defaultmoniker=OpenWorks/OWWARM.ADT_5000.ALL_DATA

to

ADTGLOBAL_dm_ow_defaultmoniker=OpenWorks/OWCOLD.ADT_5000.ALL_DATA

Long name example from

ADTGLOBAL_dm_ow_defaultmoniker=OpenWorks/\\'OWWARM.LGC.COM'.ADT_5000.ALL_DATA

to

ADTGLOBAL_dm_ow_defaultmoniker=OpenWorks/\\'OWCOLD.LGC.COM'.ADT_5000.ALL_DATA

5000.0.0 OpenWorks Software Servers 100


Landmark Advanced Data Transfer Software Installation and Administration Guide

Presetting OpenWorks Login Credentials

To preset user login credentials for an OpenWorks database, do as


follows:

1. Open $HOME/ADTUser.properties.

2. Remove the leading # to uncomment the line dm_ow_login=.

3. Type the OpenWorks login in the following format:

Short DISTRICT format

DISTRICT.PROJECT|username|password;<repeat>

Long DISTRICT format

\\'DISTRICT.WORLD'.PROJECT|username|password;<repeat>

Short DISTRICT format example

OWWARM.ADT_AUTO_READONLY|AC|ac

Long DISTRICT format example

\\'OWWARM.LGC.COM'.ADT_AUTO_READONLY|AC|ac

4. To add user login credentials for an additional OpenWorks


database, edit the dm_ow_login= line as follows:

\\'OWWARM.LGC.COM'.ADT_5000|AC|ac;\\'OWCOLD.LGC.COM'.ADT_5000|AC|ac

5000.0.0 OpenWorks Software Servers 101


Landmark Advanced Data Transfer Software Installation and Administration Guide

PowerHub Software Servers

To change the default PowerHub server set during installation,


change the hostname following pe_dic-server in the following
files:

1. <ADT_Install_Path>/resources/PHServer.properties

com.pgs.dm.slegge.dsos.SCWAppServers=pe_dic-server@dayden.lgc.com;

2. <ADT_Install_Path>/conf/datamodels/cds/CDS.properties

ADTGLOBAL_dm_cds_defaultmoniker=
'pe_dic-server@dayden.lgc.com'.CDS5000.cds_prod

3. $HOME/ADTUser.properties

dm_cds_defaultmoniker=
'pe_dic-server@dayden.lgc.com'.CDS5000.cds_prod

Note: As of Release 5000.0.0, you can use fully-qualified or short


names to identify PowerHub servers.

5000.0.0 PowerHub Software Servers 102


Landmark Advanced Data Transfer Software Installation and Administration Guide

Environment and Setting Defaults

ADTUser.properties

Each user should have a copy of the ADTUser.properties file in their


operating system home directory. Then they can customize their
Advanced Data Transfer software settings as needed without
affecting other users running the software.

The Advanced Data Transfer software can be launched using an


ADTUser.properties file in a location other than the users home
directory.

If the software is launched with -userdir set in the command


line, the software looks for an ADTUser.properties file in the
specificed directory.

If a valid ADTUser.properties file is found in userdir, the


software reads it and launches with the parameters set in it.

If no ADTUser.properties file is found in userdir, the software


launches using $HOME/ADTUser.properties.

The following defaults are set or can be set in the ADTUser.properties


file:

General defaults including job name and log file type

Default session name: AdtLastSession.job.xml.


Link files (see Configuration Files on page 118 for more
information).
user.name refers to user's operating system login or the
location of -userdir.
Input and output directories; defaults to user's operating system
home directory or -userdir.
Selection directory and file name; defaults to user's operating
system home directory; can be any directory to which the user
can write.

5000.0.0 ADTUser.properties 103


Landmark Advanced Data Transfer Software Installation and Administration Guide

Database connections used for project selection and for data model
metadata. These are data model-specific and specify default
moniker and login.

Location and names of file viewers and editors.

Error level: verbose, summary, error, or off.

Log content volume setting that controls the amount of


information that is sent to the User Interface and the log file. Valid
values are summary, which gives a brief report of Advanced
Data Transfer software events, verbose, which give a detailed
report, and default, which currently is the same as summary.

Log type: ASCII or XML.

Other defaults that may be set in ADTUser.properties are:

OpenWorks software measurement system.

OpenWorks authentication mode. The installation default is


External, which connects to OpenWorks using your
operating system user id.

Message server configuration. The installation default is


false, which runs one message server for each Advanced Data
Transfer software job.

Note: Windows only: Use \\ instead of \ for property file paths

On Windows only, in any of the Advanced Data Transfer software's properties files,
directory separators must be escaped with a "\" character. In other words, use \\ instead of \
for the file separator or the Advanced Data Transfer software will not be able to locate
the specified path. For example, C:\ADT\CONF will appear to ADT as C:ADTCONF, but
C:\\ADT\\CONF works.

Some additional properties are defined when Advanced Data


Transfer is installed via questions to the install program. These
properties are stored in the resources/ADT.properties file. You can
override the properties defined in ADT.properties by defining them in
$HOME/ADTUser.properties.

Command line arguments provided when you invoke Advanced Data


Transfer start script will override properties defined in
ADTUser.properties and ADT.properties.

5000.0.0 ADTUser.properties 104


Landmark Advanced Data Transfer Software Installation and Administration Guide

Setting the OpenWorks Software Measurement System

The default OpenWorks measurement system can be pre-set in the


ADTUser.properties file. During a transfer, the measurement system
setting controls the units of data being read from an OpenWorks
project independent of the projects original units.

To run in User Interface mode, if the value is not set, you will be
prompted to select a measurement system.

To run in standalone or special batch mode, the value must be set.

1. In the file $HOME/ADTUser.properties, set

dm_ow_meassys=US Oil Field

or choose another default measurement system. A measurement


system is required, but it doesnt matter which one, as long as it
is valid.

The standard OpenWorks measurement systems are listed in


ADTUser.properties. There may be other, i.e., user-defined,
measurement systems on the default projects SID.

The value is not validated.

2. Save and close ADTUser.properties.

For more information about how the Advanced Data Transfer


software handles units of measure, see Units of Measure Treatments
in the Advanced Data Transfer online help.

ADTLastSession.job.xml

The Advanced Data Transfer software presets the source, target, and
selection file from the previous session using the contents of the
ADTLastSession.job.xml file. You will see a message stating
Initialization complete. Loaded session file from file
$HOME/ADTLastSession.job.xml.

5000.0.0 ADTUser.properties 105


Landmark Advanced Data Transfer Software Installation and Administration Guide

Memory Usage Parameters

-Xmx 756 sets the maximum memory size for the Java Virtual
Machine to 756 megabytes. This value is adequate for most workflows
up to 40,000 wells. Some workflows (Well Logs) are limited to 1000 or
less wells at this maximum memory setting. Workflows beyond this
size are likely to require use of a higher maximum memory. See your
administrator for advice on how high a value is safe in your runtime
environment.

This value may be changed on a session by session basis. This allows


the default to remain low for small jobs, while providing the ability to
specify larger parameters as anticipated job requirements change. See
Command Line Arguments on page 122 for more information.

-Xms256m sets the minimum memory size for the Java Virtual Machine
to 256 megabytes. This parameter is optional, but improves
performance. Set it to between 50% and 75% of the value specified for
-Xmx.

Note that the format of the Xmx and Xms parameters changes
depending on whether they are used in a script or on the command line.
The format -Xmx756m is what is inside the script, and is not correct
syntax for use as a command line parameter. For example, using this
format on the command line

ADT -Xmx1024m

results in

-Xmx1024m: Error: This argument requires a setting

The correct syntax for use as a command line parameter is

ADT -Xmx 1024

5000.0.0 ADTUser.properties 106


Landmark Advanced Data Transfer Software Installation and Administration Guide

All Arguments and Parameters

Many of the arguments and parameters that can be set in


ADTUser.properties are discussed in several places throughout this
manual. They are presented here in their entirety for convenience.

The Advanced Data Transfer software has a three-level system of


user defaults. Each level may or may not contain a specific item. An
item may appear in a file, but if it is commented out it will be ignored
by the software.

The software first reads the properties found in the


resources/ADT.properties file.

The software then reads the ADTUser.properties file in the users


operating system home directory. Parameters set in the
$HOME/ADTUser.properties file override those set in the
ADT.properties file.

If the software is launched with the command line argument -userdir


<dir> the software uses the ADTUser.properties file in the directory
named. Parameters set in this ADTUser.properties file override those
set in the ADT.properties file.

The software processes the command line arguments last. Command


line arguments override any parameters set in the ADT.properties and
ADTUser.properties files.

Command Line Arguments on page 108

Message Server Settings on page 109

General Settings on page 110

Configuration Settings on page 117

Data Model-specific Settings on page 115

5000.0.0 All Arguments and Parameters 107


Landmark Advanced Data Transfer Software Installation and Administration Guide

Command Line Arguments

The following command line arguments are valid on the command line
only, and have no corresponding install or user level defaults.

Argument: -mode
Default: gui
Valid values: gui, batch

Controls whether the Advanced Data Transfer software runs in User


Interface or batch mode. If batch mode is specified, -session
<sessionfile> must also be specified.

Argument: -userdir
Default: The user's home directory according to the operating system
Valid values: A fully-qualified, valid directory

This directory is where the software looks for the user's


ADTUser.properties file, and also as the default directory for many
other items such as DefaultInputDir, DefaultOutputDir,
DefaultSelectionFileDir. If a default specifies user.home, this is the
directory that is used.

Argument: -h or -help
Default: none
Valid values: none
Set in: command line only

Display the known command line arguments. Because the Advanced


Data Transfer software is expandable, not all possible arguments are
known. For example, if another database is added, the software
processes the parameters and makes them available to the new database
code.

Argument: -printsettings
Default: none
Valid values: yes, no

Display the parameters as they are processed.

Argument: -xmx
Default: 756 megabytes
Valid values: any integer

The largest size the Java Virtual Machine is allowed to grow to. See
Memory Usage Parameters on page 106.

5000.0.0 All Arguments and Parameters 108


Landmark Advanced Data Transfer Software Installation and Administration Guide

Argument: -session
Default: none
Valid values: a valid session file
Set in: command line argument only

If used with gui mode, the session is loaded into the gui upon
initialization. If used with batch mode, the session file determines the
job that will be run.

Message Server Settings

Parameter: com.lgc.im.dataio.msgsvr.MessageFactory.useRMI
Default: true
Valid values: true, false
Set in: ADT.properties and launch script

If the value is set to true, the Advanced Data Transfer software


message server runs in a separate process and has the ability to connect
to more than one Advanced Data Transfer process. If set to true, the
properties com.lgc.im.datio.host and com.lgc.im.dataio.port determine
what machine and port the message server will connect to. If set to
false, com.lgc.im.dataio.host and com.lgc.im.dataio.port are ignored.

Parameter: com.lgc.im.dataio.port
Default: 44444
Valid values: any integer representing an unused port number
Set in: ADT.properties and in launch script if the Message Server
configuration is shared.

Determines the port number that the Advanced Data Transfer


software attempts to connect with the message server on.

Parameter: com.lgc.im.dataio.host
Default: localHost (commented out)
Valid values: any valid host name
Set in: ADT.properties and in launch script if the Message Server
configuration is shared.

Determines the host name that the Advanced Data Transfer software
attempts to connect with the message server on.

5000.0.0 All Arguments and Parameters 109


Landmark Advanced Data Transfer Software Installation and Administration Guide

General Settings

Parameter: AllInstanceWarningLevel
Default: 1000
Valid values: any integer; if invalid or -1, user is always warned
Set in: ADT.properties, ADTUser.properties

If the user attempts to transfer all instances in a data type, at what level
is the user warned?

Parameter: com.lgc.im.dataio.AvailableMemoryThreshold
Default: 10
Valid values: 0-100
Set in: by the software, ADT.properties

The level at which the software aborts a running job.

Parameter: com.lgc.im.dataio.MaxLicenseRetry
Default: 12
Valid values: any integer
Set in: by the software, ADT.properties

If the software fails to obtain a license, how many times does it retry
before exiting? The software only checks for a license at the start of a
job, so once a job has started, the license server can fail and the job still
finishes.

Parameter: com.lgc.im.dataio.MemoryMonitorWaitInSeconds
Default: 15
Valid values: any integer
Set in: by the software, ADT.properties

Determines how often the software monitors memory usage.

Parameter: com.lgc.im.dataio.ProgressPanelLinesMax
Default: 2001
Valid values: any integer
Set in: ADT.properties

The maximum number of lines to display in the progress panel.

Parameter:
com.lgc.im.dataio.infra.QueueManager.MaxQueueSize
Default: 600
Valid values: any integer between 200 and 1200
Set in: ADT.properties

5000.0.0 All Arguments and Parameters 110


Landmark Advanced Data Transfer Software Installation and Administration Guide

Determines the size of the invoker queues between the components in a


pipeline. It is a tuning value. Low memory environments should use a
lower value.

Parameter:
com.lgc.im.dataio.ui.LgcDataItemListWaitCursor.DATA_WARNI
NG_SIZE_PROPERTY
Default: 50,000
Valid values: any integer
Set in: ADT.properties

The maximum number of rows to return in the Top and child level
query sets. If no value is specified, the hard coded max is 10,000.
Values greater than 50,000 are not recommended.

Parameter: CreateDiagnosticFileInBatch
Default: false
Valid values: true, false
Set in: ADT.properties, ADTUser.properties

Determines whether the software creates a Dianostic Zip file for each
job in batch mode..

Parameter: DefaultInputDir
Default: The user's home directory
Valid values: any valid directory
Set in: ADT.properties, ADTUser.properties

The default directory where the software looks for import files.

Parameter: DefaultLogFileDir, -logdir


Default: the user's home directory
Valid values: any valid directory path
Set in: ADT.properties, ADTUser.properties, command line

The directory where job log files are written.

Parameter: DefaultOutputDir
Default: The user's home directory
Valid values: any valid directory
Set in: ADT.properties ADTUser.properties

The default directory where the software writes export files.

5000.0.0 All Arguments and Parameters 111


Landmark Advanced Data Transfer Software Installation and Administration Guide

Parameter: DefaultOutputFileName
Default: AdtExport.xml
Valid values: any valid file name
Set in: ADT.properties, ADTUser.properties

The default file name the software uses for export files.

Parameter: DefaultSelectionDir
Default: The user's home directory
Valid values: any valid directory
Set in: ADT.properties, ADTUser.properties

The default directory where the software writes and looks for selection
files.

Parameter: DefaultSelectionFileName
Default: AdtSelection.xml
Valid values: any valid file name
Set in: ADT.properties, ADTUser.properties

The default file name the software uses for selection files.

Parameter: DefaultSessionFileName
Default: AdtLastSession.job.xml
Valid values: any valid file name, must end in ".job.xml" for the file
selection filters to work
Set in: ADT.properties, ADTUser.properties

The default file name the software uses in the session file selection
boxes.

Parameter: DeleteErrFilesOlderThan
Default: none (files are not automatically deleted)
Valid values: any integer
Set in: ADTUser.properties

The software automatically deletes old error files older than the number
of days this is set to.

Parameter: DeleteLogFilesOlderThan
Default: none (files are not automatically deleted)
Valid values: any integer
Set in: ADTUser.properties

The software automatically deletes old log files older than the number
of days this is set to.

5000.0.0 All Arguments and Parameters 112


Landmark Advanced Data Transfer Software Installation and Administration Guide

Parameter: GuiLogLevel
Default: verbose
Valid values: verbose, summary, off
Set in: ADT.properties, ADTUser.properties

The level of messages sent to the progress window.

Parameter: JobName, -jobname


Default: the user's OS login name
Valid values: OS login name
Set in: ADTUser.properties, command line

The software uses the name plus a unique identifier to name the job.
Only available in batch mode.

Parameter: LogLogLevel
Default: verbose
Valid values: verbose, summary, off
Set in: ADT.properties, ADTUser.properties

Determines the level of messages sent to the log files.

Parameter: LogType
Default: ascii
Valid values: ascii, xml
Set in: ADT.properties, ADTUser.properties

Determines the format of the log file. If ascii, one line per message will
be written. If xml, the log file is written in xml and can be formatted
and filtered by the software's xml viewing tools.

Parameter: MSLogLevel
Default: verbose
Valid values: verbose, summary, off
Set in: ADT.properties, ADTUser.properties

Determines the level of messages sent to the message server. This


setting also limits what is sent to the log files and displayed on the
progress window, since messages that are not sent to the message
server will not reach the log file or progress window.

Parameter:
RELATIVE_ROOT_PLACEHOLDER.$MY_ADT_FILES$
Default: commented out
Valid values: see the ADTUser.properties file for usage
Set in: ADTUser.properties

5000.0.0 All Arguments and Parameters 113


Landmark Advanced Data Transfer Software Installation and Administration Guide

Provides portability of job and session files.

Parameter: UnixViewer
Default: /usr/openwin/bin/xterm -e //usr/bin/vi
Valid values: any valid unix or linux viewer
Set in: ADT.properties, ADTUser.properties

The program the software uses to view XML files on Linux machines.

Parameter: UnixEditor
Default: /usr/openwin/bin/xterm -e //usr/bin/vi
Valid values: any valid unix or linux editor
Set in: ADT.properties, ADTUser.properties

The program the software uses to view ASCII files on Linux machines.

Parameter: UnixBrowser
Default: /usr/bin/netscape file://
Valid values: any valid windows editor
Set in: ADT.properties, ADTUser.properties

The program the software uses to view html files on Windows


machines.

Parameter: ValidateInstances
Default: no
Valid values: yes, no
Set in: ADT.properties, ADTUser.properties

When loading a selection file or select list into the main window,
determines if the software should validate each instance in the list.
Since this can take a very long time for large lists, the user can also turn
this feature on and off on the main window.

Parameter: WindowsViewer
Default: C:\\Program Files\\Internet Explorer\\IEXPLORE.exe
Valid values: any valid windows browser
Set in: ADT.properties, ADTUser.properties

The program the software uses to view XML and html files on
Windows machines.

Parameter: WindowsEditor
Default: C:\\Program Files\\Windows
NT\\Accessories\\WORDPAD.EXE
Valid values: any valid windows editor

5000.0.0 All Arguments and Parameters 114


Landmark Advanced Data Transfer Software Installation and Administration Guide

Set in: ADT.properties, ADTUser.properties

The program the software uses to view ASCII files on Windows


machines.

Data Model-specific Settings

Parameter: com.lgc.ow.user
Default: External
Valid values: Internal, External
Set in: ADTUser.properties

Controls whether the user sees only those projects that she has external
permissions to see, or all projects under a SID so she can log into the
project internally.

Parameter: dm_cds_defaultmoniker, -dm_cds_defaultmoniker


Default: determined on installation
Valid values: any valid cds moniker in the short or long name form:

pe_dic-server.CDS5000.cds_prod
'pe_dic-server@dayden.lgc.com'.CDS5000.cds_prod

Set in: ADTUser.properties, command line

The Corporate Data Store database the Advanced Data Transfer


software uses to retrieve data model information from, and the default
the main window uses when the user clicks Browse.

Parameter: dm_cds_login, -dm_cds_login


Default: none
Valid values: must be in the short or long name form:

pe_dic-server@dayden.CDS5000.cds_prod|username|password;<repeat>
'pe_dic-
server@dayden.lgc.com'.CDS5000.cds_prod|username|password;<repeat>

Set in: ADTUser.properties, command line

The login string for one or more Corporate Data Store databases. If
the user is running in batch mode, the login credentials must be
specified in the user's ADTUser.properties file. In User Interface mode,
the Advanced Data Transfer software prompts the user for
credentials.

5000.0.0 All Arguments and Parameters 115


Landmark Advanced Data Transfer Software Installation and Administration Guide

Parameter: dm_ow_defaultmoniker, -dm_ow_defaultmoniker


Default: determined on installation
Valid values: any ow moniker in the short or long name form:

OpenWorks/DISTRICT.PROJECT.ALL_DATA
OpenWorks/\\'DISTRICT.WORLD'.PROJECT.ALL_DATA

Set in: ADTUser.properties, command line.

The Corporate Data Store database the Advanced Data Transfer


software uses to retrieve data model information from, and the default
the main window uses when the user clicks Browse.

Parameter: dm_ow_login, -dm_ow_login


Default: none
Valid values: must be in the short or long name form:

DISTRICT.PROJECT|username|passWord;<repeat>
\\'DISTRICT.WORLD'.PROJECT|username|passWord;<repeat>

Set in: ADTUser.properties, command line

The login string for one or more OpenWorks databases. If the user is
running in batch mode, the login credentials must be specified in the
user's ADTUser.properties file. If the user is running in User Interface
mode, and the login credentials are not set, the user is prompted for
username and password.

Parameter: dm_ow_meassys, -dm_ow_meassys


Default: None
Valid values: Any valid measurement system in the default
OpenWorks database
Set in: ADTUser.properties, command line

The OpenWorks Measurement system the Advanced Data Transfer


software uses when reading OpenWorks data. WARNING: Once this
is set, it cannot be changed without exiting and restarting the Advanced
Data Transfer software.

5000.0.0 All Arguments and Parameters 116


Landmark Advanced Data Transfer Software Installation and Administration Guide

Configuration Settings

See Configuration Files on page 118 for more information on these


parameters.

Parameter: AdminConfigDirs
Default: not set
Valid values: folder containing custom pipelines and links files in
addition to those shipped with the software.
Set in: ADT.properties

Use to specify a global set of custom folders.

Parameter: LinkFileName
Default: Links.xml
Valid values: any valid links file. Must reside in conf directory
Set in: ADT.properties, ADTUser.properties

The links file determines what workflows are available to the user in
the software's main window.

Parameter: UserConfigDirs
Default: not set
Valid values: folder containing custom pipelines and links files in
addition to those shipped with the software.
Set in: ADTUser.properties

Allows users to specify their own set of custom folders independently


of whatever might be set globally.

5000.0.0 All Arguments and Parameters 117


Landmark Advanced Data Transfer Software Installation and Administration Guide

Configuration Files

The Advanced Data Transfer software has the capability to handle


multiple instances of some of its configuration files, and the location of
these files is not tied to Advanced Data Transfer installation
directory. This allows an administrator to maintain a set of installation-
independent files that do not have to be moved or changed each time
Advanced Data Transfer is installed.

Objects Contained in the Configuration Files

Component: Components are the basic units that Advanced Data


Transfer builds on. A reader is a component, and several
components are joined together to create a Pipeline.

Pipeline: A pipeline is everything but the reader. A translator is


joined to a string substitution that is joined to a cartographic
converter that is joined to a database writer. Together they are
known as a Pipeline. The same component can appear in many
pipelines.

Link: A link is a combination of a reader and a pipeline. Links


control what the user sees as choices of source and target types in
Advanced Data Transfer main window.

Configuration Files

ComponentRegistry.comp.xml

The component registry is the file that contains all possible


components such as a database reader, database writer, xml reader,
xml writer, mapping translator, cartographic converter, etc.

Links.lnk.xml

The links file(s) controls what the user sees in Advanced Data
Transfer User Interface as the source and target choices. The
user can only see those reader/pipeline combinations that have
been identified in the links file(s).

Pipelines.pln.xml

The pipelines file(s) contains the combinations of components that


make up the available pipelines. If a pipeline is in a links file, it

5000.0.0 Configuration Files 118


Landmark Advanced Data Transfer Software Installation and Administration Guide

must be identified in the pipelines file. In turn, all components in


the pipelines file must be contained in a component registry file.

Advanced Data Transfer installs a ComponentRegistry file in


<ADT_Install_Path>/conf/registry. Each datamodel has specific files in
<ADT_Install_Path>/conf/datamodels/<datamodel>/conf/registry.
Users can define an additional configuration file directory during an
installation or by editing the properties files after installation.

Defining Active Configuration Files

The Advanced Data Transfer software looks in global and datamodel


specific directories for files with an extension that matches the
respective registry file extensions.

Global directories for files are under:

<ADT_Install_Path>/conf/registry

Datamodel specific directories for files are under:

<ADT_Install_Path>/conf/datamodels/<datamodelname>/conf/registry

Files ending in .lnk.xml are treated as a Link file and files ending in
.pln.xml are treated as Pipelines files. The software only supports one
ComponentRegistry file ending in comp.xml. The ComponentRegistry
file must be in the global registry folder.

The workflows to display in Advanced Data Transfer is controlled


by the LinkFileName property, set globally in ADT.properties files and
individually in $HOME/ADTUser.properties files.

The LinkFileName property is a comma-delimited list of specific Link


files to load. Setting the LinkFileName property to null causes all
workflows from all Links files in all active datamodels to be visible in
the software.

Example LinkFileName property set to null:

LinkFileName =

The AdminConfigDirs property is used to globally specify additional


locations where the software should look for Links and Pipelines files.
This property is only supported globally in
<ADT_Install_Path>/resources/ADT.properties.

5000.0.0 Configuration Files 119


Landmark Advanced Data Transfer Software Installation and Administration Guide

Eample AdminConfigDirs property setting:

AdminConfigDirs=/d02/adt/production;/d02/adt/drilling

The UserConfigDirs property provides the same function as


AdminConfigDirs on a user by user basis. The UserConfigDirs
property is set in $HOME/ADTUser.properties files.

AdminConfigDirs and UserConfigDirs are used extensively in


creation of custom workflows. For more details, see the Advanced Data
Transfer Software Cookbook.

5000.0.0 Configuration Files 120


Landmark Advanced Data Transfer Software Installation and Administration Guide

Launching the Advanced Data


Transfer Software

Overview

Command Line Arguments

Launching in User Interface Mode

Launching in Standalone Batch Mode

5000.0.0 Launching the Advanced Data Transfer Software 121


Landmark Advanced Data Transfer Software Installation and Administration Guide

Command Line Arguments

The command line arguments for the Advanced Data Transfer


software are shown in the following table. Command line options
override those set in ADTUser.properties.

Full name Parameter Description/Syntax example

-userdir <directory> Read custom ADTUser.properties file in


the specified directory.

-logdir <log directory> Default log directory7

-mode <batch, gui> Run in User Interface or batch mode. User


Interface is the default. Required for batch
mode.

-session <session filename> Loads the named session file. Required


for batch mode.

-jobname <job name> Default job name.

-Xmx <max virtual machine size> Memory usage parameters. Must be an


integer. Defaults are 512 (Unix), 256
(Windows).

-logconfigfile <filename> fully-qualified file name.

-printsettings yes Print the arguments and parameters upon


initialization.

-help n/a Prints Usage (help)

Data Model specific options

-dm_ow_login <DISTRICT>.<PROJECT>|<userNa See Presetting OpenWorks Login


me>|<password> Credentials on page 101.

-dm_ow_defaultmoniker <default OpenWorks software See About OpenWorks Database


server> Monikers on page 99.
-dm_ow_meassys <OpenWorks software See Setting the OpenWorks Software
measurement system > Measurement System on page 105.

-dm_cds_login <moniker|user|password;repeat > See Presetting Corporate Data Store


Software Login Credentials on page 98.

-dm_cds_defaultmoniker <default Corporate Data Store See About Coporate Data Store
software server> Database Monikers on page 95.

Other unknown data model options: must always be in the form -dm_[dm name]_[dm option]

5000.0.0 Launching the Advanced Data Transfer Software 122


Landmark Advanced Data Transfer Software Installation and Administration Guide

Launching in User Interface Mode

This section describes launching standalone the Advanced Data


Transfer software in User Interface mode.

Prerequisites

User must be an External OpenWorks software user.

Launching

Advanced Data Transfer opens with the source, target and selection
file used in the previous session if the application quit normally with
valid selections and you launched Advanced Data Transfer with the -
session argument.

For example:

ADT -session <session file name>

If the session file was a job list, the list is loaded into the Job List
Manager which then opens.

If the OpenWorks measurement system is not set in


$HOME/ADTUser.properties, you are prompted for the
measurement system when the User Interface is initialized.

If the Corporate Data Store software login is not set in


$HOME/ADTUser.properties, you are prompted for the Corporate
Data Store login and password.

No environment variables are used on the command line (for example,


$HOME).

The session file has an absolute path reference to the corresponding


selection file. The session file could have been created in the User
Interface and saved or created by a joint Advanced Data
Transfer/PowerExplorer software Transfer Wizard job.

5000.0.0 Launching the Advanced Data Transfer Software 123


Landmark Advanced Data Transfer Software Installation and Administration Guide

Launching in Standalone Batch Mode

This section describes launching standalone the Advanced Data


Transfer software without the User Interface.

Prerequisites

The OpenWorks software measurement system must be pre-set in


$HOME/ADTUser.properties

Launching

ADT -mode batch -session <session file name>

For example:

ADT -mode batch -session /export/home/myuser/AdtLastSession.job.xml

No environment variables are used on the command line (for example,


$HOME).

The session file has an absolute path reference to the corresponding


selection file. The session file could have been created in the User
Interface and saved or created by a joint Advanced Data
Transfer/PowerExplorer software Transfer Wizard job.

5000.0.0 Launching the Advanced Data Transfer Software 124


Landmark Advanced Data Transfer Software Installation and Administration Guide

Appendix

Uninstalling the Advanced Data Transfer Software

1. Log on to the system as anyone who can write to the directory


where the Advanced Data Transfer software was installed.

2. Kill the current message server

cd <ADT_Install_Path>/bin
./StopMessageServer.sh

Windows:

Run the uninstaller in the UninstallerData directory

cd <ADT_Install_Path>\UninstallerData
.\Uninstall.ADT.Application.exe

When the Uninstall screen opens, click Uninstall.

The Uninstaller will not remove the HSQLDB files and folders
in the conf, examples, and resources folders in Advanced Data
Transfer installation directory. Remove these files and folders
manually.

Linux:

Delete the Advanced Data Transfer install folder. Do not use


Uninstall_ADT.Application.

Delete the link for launching Advanced Data Transfer. The


link is: $OWHOME/bin/ADT.

5000.0.0 Uninstalling the Advanced Data Transfer Software 125


Landmark Advanced Data Transfer Software Installation and Administration Guide

Java Runtime Environment (JRE)

Additional information about the Java Runtime Environment (JRE)


may be obtained from http://www.java.sun.com.

Is JRE Installed?

Use the following steps to determine whether the correct version of the
JRE has been installed:

In a terminal window, type the following:

which java

This step may take some time, depending on the configuration of the
machine (e.g., number of mounted file systems, user directories, etc.).
Note the JRE installation path here

<JRE_Install_Path> = _________________________

and in the space provided in the Installation Checklist on page 5.

Install JRE

Follow these steps to install the correct version of the JRE:

1. In a Web brownser, navigate to


http://java.sun.com/javase/downloads/index.jsp

2. Click the Downloads button in the most recent Java Runtime


Environment (JRE) 6 Update pane. At publication time, this was
Update 7.

3. Choose the platform and and language.

4. Accept the license agreement, then click Continue.

5. When the install wizard opens, accept the license agreement, then
click Next.

6. When prompted, click Finish in the install wizard.

7. Note the JRE installation path in the space provided above and in
the Installation Checklist on page 5.

5000.0.0 Java Runtime Environment (JRE) 126


Landmark Advanced Data Transfer Software Installation and Administration Guide

Troubleshooting

Set Mozilla Preferences for Online Help and Documentation

You may need to set your Mozilla preferences so that extra windows
close automatically.

1. In Mozilla, select Edit > Preferences.

2. When the Preferences dialog opens, expand the Navigator list.

3. Click on Helper Applications, then select application/pdf and click


the Edit button.

4. When the Edit Type dialog opens, select the "Open it with" radio
button, then click Choose, and navigate to and select Adobe
Reader.

5. Click OK to close the Edit Type dialog.

6. Click OK to close the Preferences dialog.

Diagnostic ZIP File

The Diagnostic ZIP File is a tool that encapsulates job session,


selection, log, and error files in a zip file for troubleshooting purposes.

In user interface mode, choose Tools > Create Diagnostic File.

In batch mode, set the following property in

ADT_Install_Path>/resources/ADT.properties:

CreateDiagnosticFileInBatch=true

or

in ADTUser.properties:

CreateDiagnosticFileInBatch=yes

The zip file is saved in the default log file directory (DefaultLogFileDir
in ADT.properties or ADTUser.properties).

5000.0.0 Troubleshooting 127


Landmark Advanced Data Transfer Software Installation and Administration Guide

A
Index
AdminConfigDirs 117, 119

ADT.properties 104, 107, 119 com.lgc.im.dataio.port 109

ADTGLOBAL_dm_cds_defaultmoniker 95, com.lgc.im.dataio.ProgressPanelLinesMa


97, 102 x 110

ADTLastSession.job.xml com.lgc.im.dataio.ui.LgcDataItemListWait
using settings from previous session Cursor.DATA_WARNING_SIZE_PR
105 OPERTY 111

ADTUser.properties 95, 98, 101, 102, 103, com.lgc.ow.user 115


105
default settings for launching ADT 103 com.pgs.dm.slegge.dsos.SCWAppServer
s 96, 102
setting OpenWorks measurement
system 105 command line arguments 91, 103, 104, 106,
using settings from previous session 107, 108-115, 122
105
Component 118
AllInstanceWarningLevel 110
ComponentRegistry.comp.xml 118

C Corporate Data Store


Login Credentials 98
CDS.properties 95, 97, 102
Monikers 94, 95
com.lgc.im.dataio.AvailableMemoryThres
hold 110 CreateDiagnosticFileInBatch 111

com.lgc.im.dataio.host 109
D
com.lgc.im.dataio.infra.QueueManager.M
DefaultInputDir 111
axQueueSize 110
DefaultLogFileDir 111
com.lgc.im.dataio.MaxLicenseRetry 110
DefaultOutputDir 111
com.lgc.im.dataio.MemoryMonitorWaitInS
econds 110
DefaultOutputFileName 112
com.lgc.im.dataio.msgsvr.MessageFactor
DefaultSelectionDir 112
y.useRMI 109

5000.0.0 Index 128


Landmark Advanced Data Transfer Software Installation and Administration Guide

DefaultSelectionFileName 112 J

DefaultSessionFileName 112 Java Virtual Machine 106, 108

DeleteErrFilesOlderThan 112 JobName 113

DeleteLogFilesOlderThan 112 Joint mode 4

dm_cds_defaultmoniker 94, 95, 102, 115


L
dm_cds_login 98, 115
Launching ADT 123, 124
dm_ow_defaultmoniker 94, 99, 116 command line arguments 122

dm_ow_login 101, 116 Link 118

dm_ow_meassys 105, 116 LinkFileName 117, 119

Links.lnk.xml 118
G
Login Credentials
Generic Synchronization Framework 3, 19,
Corporate Data Store 98
92
OpenWorks 101
GuiLogLevel 113
LogLogLevel 113

I LogType 113

install long (fully-qualified) name 11, 12, 22, 23, 29,


Advanced Data Transfer software 33, 47, 48, 54, 65, 76, 80, 94
and the Third-Party Connection
Wizard 44
M
Advanced Data Transfer software
only 8 measurement system 105, 123
Advanced Data Transfer software,
the Third Party Connection Wizard Memory usage parameters 106, 122
and Generic Synchronization at the minimum memory size 106
same time 19
new third-party connection 63 Message Server 92
new third-party connection and generic
synchronization 74 Monikers
Coporate Data Store 94, 95
OpenWorks 94, 99

5000.0.0 Index 129


Landmark Advanced Data Transfer Software Installation and Administration Guide

PowerHub 94 short name 11, 12, 22, 23, 29, 33, 47, 48, 54,
65, 76, 80, 94
MSLogLevel 113
Standalone mode 4
O
T
OpenWorks
Changing the Default Database 100 Third-Party Connection Wizard 3, 92
Database Monikers 99
Login Credentials 101 U
Monikers 94
UnixBrowser 114
setting measurement system 105
UnixEditor 114
OW.properties 100
UnixViewer 114
OWHOME variable 3, 6
UserConfigDirs 117, 120
P
V
PHServer.properties 96, 102
ValidateInstances 114
Pipeline 118
VM size 122
Pipelines.pln.xml 118

PowerHub W
Changing the default server 102
WindowsEditor 114
Monikers 94
WindowsViewer 114
preset user login credentials
Corporate Data Store 98
OpenWorks 101

RELATIVE_ROOT_PLACEHOLDER 113

Shared Message Server 92

5000.0.0 Index 130