Installation Guide

Convoy/DM®
3.7.2
WINDOWS 2000 and NT
DOCUMENT ID: DC36368-01-0372-01

LAST REVISED: January 2004

Copyright © 2001-2004 by Sybase, Inc. All rights reserved.

This publication pertains to Sybase software and to any subsequent release until otherwise indicated in new editions or technical notes.
Information in this document is subject to change without notice. The software described herein is furnished under a license agreement,
and it may be used or copied only in accordance with the terms of that agreement.

To order additional documents, U.S. and Canadian customers should call Customer Fulfillment at (800) 685-8225, fax (617) 229-9845.

Customers in other countries with a U.S. license agreement may contact Customer Fulfillment via the above fax number. All other
international customers should contact their Sybase subsidiary or local distributor. Upgrades are provided only at regularly scheduled
software release dates. No part of this publication may be reproduced, transmitted, or translated in any form or by any means, electronic,
mechanical, manual, optical, or otherwise, without the prior written permission of Sybase, Inc.

Sybase, the Sybase logo, AccelaTrade, ADA Workbench, Adaptable Windowing Environment, Adaptive Component Architecture,
Adaptive Server, Adaptive Server Anywhere, Adaptive Server Enterprise, Adaptive Server Enterprise Monitor, Adaptive Server
Enterprise Replication, Adaptive Server Everywhere, Adaptive Server IQ, Adaptive Warehouse, Anywhere Studio, Application
Manager, AppModeler, APT Workbench, APT-Build, APT-Edit, APT-Execute, APT-FORMS, APT-Translator, APT-Library, AvantGo,
AvantGo Application Alerts, AvantGo Mobile Delivery, AvantGo Mobile Document Viewer, AvantGo Mobile Inspection, AvantGo
Mobile Marketing Channel, AvantGo Mobile Pharma, AvantGo Mobile Sales, AvantGo Pylon, AvantGo Pylon Application Server,
AvantGo Pylon Conduit, AvantGo Pylon PIM Server, AvantGo Pylon Pro, Backup Server, BizTracker, ClearConnect, Client-Library,
Client Services, Convoy/DM, Copernicus, Data Pipeline, Data Workbench, DataArchitect, Database Analyzer, DataExpress, DataServer,
DataWindow, DB-Library, dbQueue, Developers Workbench, Direct Connect Anywhere, DirectConnect, Distribution Director, e-ADK,
E-Anywhere, e-Biz Integrator, E-Whatever, EC Gateway, ECMAP, ECRTP, eFulfillment Accelerator, Embedded SQL, EMS, Enterprise
Application Studio, Enterprise Client/Server, Enterprise Connect, Enterprise Data Studio, Enterprise Manager, Enterprise SQL Server
Manager, Enterprise Work Architecture, Enterprise Work Designer, Enterprise Work Modeler, eProcurement Accelerator, EWA,
Financial Fusion, Financial Fusion Server, Gateway Manager, GlobalFIX, ImpactNow, Industry Warehouse Studio, InfoMaker,
Information Anywhere, Information Everywhere, InformationConnect, InternetBuilder, iScript, Jaguar CTS, jConnect for JDBC, Mail
Anywhere Studio, MainframeConnect, Maintenance Express, Manage Anywhere Studio, M-Business Channel, M-Business Network,
M-Business Server, MDI Access Server, MDI Database Gateway, media.splash, MetaWorks, My AvantGo, My AvantGo Media Channel,
My AvantGo Mobile Marketing, MySupport, Net-Gateway, Net-Library, New Era of Networks, ObjectConnect, ObjectCycle,
OmniConnect, OmniSQL Access Module, OmniSQL Toolkit, Open Biz, Open Client, Open ClientConnect, Open Client/Server, Open
Client/Server Interfaces, Open Gateway, Open Server, Open ServerConnect, Open Solutions, Optima++, Orchestration Studio, PB-Gen,
PC APT Execute, PC Net Library, PocketBuilder, Pocket PowerBuilder, Power++, power.stop, PowerAMC, PowerBuilder,
PowerBuilder Foundation Class Library, PowerDesigner, PowerDimensions, PowerDynamo, PowerJ, PowerScript, PowerSite,
PowerSocket, Powersoft, PowerStage, PowerStudio, PowerTips, Powersoft Portfolio, Powersoft Professional, PowerWare Desktop,
PowerWare Enterprise, ProcessAnalyst, Rapport, Report Workbench, Report-Execute, Replication Agent, Replication Driver,
Replication Server, Replication Server Manager, Replication Toolkit, Resource Manager, RW-DisplayLib, S-Designor, SDF, Secure SQL
Server, Secure SQL Toolset, Security Guardian, SKILS, smart.partners, smart.parts, smart.script, SQL Advantage, SQL Anywhere, SQL
Anywhere Studio, SQL Code Checker, SQL Debug, SQL Edit, SQL Edit/TPU, SQL Everywhere, SQL Modeler, SQL Remote, SQL
Server, SQL Server Manager, SQL SMART, SQL Toolset, SQL Server/CFT, SQL Server/DBM, SQL Server SNMP SubAgent, SQL
Station, SQLJ, STEP, SupportNow, S.W.I.F.T. Message Format Libraries, Sybase Central, Sybase Client/Server Interfaces, Sybase
Financial Server, Sybase Gateways, Sybase MPP, Sybase SQL Desktop, Sybase SQL Lifecycle, Sybase SQL Workgroup, Sybase User
Workbench, SybaseWare, Syber Financial, SyberAssist, SyBooks, System 10, System 11, System XI (logo), SystemTools, Tabular Data
Stream, TotalFix, TradeForce, Transact-SQL, Translation Toolkit, UltraLite.NET, UNIBOM, Unilib, Uninull, Unisep, Unistring, URK
Runtime Kit for UniCode, Viewer, Visual Components, VisualSpeller, VisualWriter, VQL, WarehouseArchitect, Warehouse Control
Center, Warehouse Studio, Warehouse WORKS, Watcom, Watcom SQL, Watcom SQL Server, Web Deployment Kit, Web.PB,
Web.SQL, WebSights, WebViewer, WorkGroup SQL Server, XA-Library, XA-Server and XP Server are trademarks of Sybase, Inc.
07/03
Unicode and the Unicode Logo are registered trademarks of Unicode, Inc.

All other company and product names used herein may be trademarks or registered trademarks of their respective companies.

Use, duplication, or disclosure by the government is subject to the restrictions set forth in subparagraph (c)(1)(ii) of DFARS 52.227-
7013 for the DOD and as set forth in FAR 52.227-19(a)-(d) for civilian agencies.

Sybase, Inc., One Sybase Drive, Dublin, CA 94568.

Contents

About This Book ............................................................................................................................ v

CHAPTER 1 Borland Database Engine (BDE) Setup......................................... 1

Installing BDE................................................................................... 1
Manual BDE configuration ............................................................... 2

CHAPTER 2 Convoy/DM Installation .................................................................. 7

Preparing for a Windows installation ................................................ 7
Required software ..................................................................... 7
Verifying the database environment .......................................... 8
Uninstalling previous releases................................................. 10
Installing Convoy/DM ..................................................................... 10

CHAPTER 3 Convoy/DM Database Setup ........................................................ 13

Overview ........................................................................................ 13
Before you begin ..................................................................... 13
Starting DB_Installer ............................................................... 14
Automatic setup steps .................................................................... 15
Create a BDE alias .................................................................. 15
Informix and DB2 setup ........................................................... 16
Database login information...................................................... 17
SQL Scripts ............................................................................. 20
Database populate .................................................................. 23
Convoy/DM reports ................................................................. 23
Manual setup steps ........................................................................ 24
Convoy/DM setup .................................................................... 25
Informix and DB2 setup ........................................................... 25
Convoy/DM database login steps............................................ 26
Informix database install instructions ...................................... 26
DB2 database install instructions ............................................ 26
Specify the parameters for your database environment.......... 27
SQL Scripts ............................................................................. 29
Convoy/DM reports ................................................................. 30

Installation Guide iii

Contents

CHAPTER 4 Loading PeopleSoft Metadata ...................................................... 31

Extracting Metadata from PeopleSoft ............................................ 31
The #include File - ccenv.inc................................................... 31
Extract SQR - CSPSEX.SQR .................................................. 32
Executing the SQR.................................................................. 32
Files produced......................................................................... 33
Loading PeopleSoft metadata into Convoy/DM ............................. 33

CHAPTER 5 Additional Workstations ............................................................... 35

Setting up additional workstations.................................................. 35

AP PE ND IX A File Server Install of Convoy/DM.................................................. 37

File server installation .................................................................... 37

Index ............................................................................................................................................. 39

iv Convoy/DM
About This Book

New Era of Networks, Inc. is a wholly owned subsidiary of Sybase, Inc.

Any references to “NEON” that appear in this document are understood
to refer to New Era of Networks, Inc. New Era of Networks and Sybase
are not affiliated with Neon Systems, Inc., or any other entity using the
name “NEON.” New Era of Networks is in the process of changing all
product names using the acronym “NEON” to the name “New Era of
Networks.”
Audience This document describes how to install Convoy/DM. The primary user of
this document is the database administrator who is responsible for the
environment configuration and the system administrator who is
responsible for the installation and configuration of the server and client
workstations used for Convoy/DM.
After installation, the system administrator must configure Convoy/DM to
use the established Convoy/DM APIs.
How to use this book The guide is organized into the following chapters:
• “About This Book” lists supported code sets and locales, platforms
and compilers, disk space and memory requirements and provides
documentation, technical support, and product education
information.
• Chapter 1, “Borland Database Engine (BDE) Setup,” provides BDE
installation and configuration information.
• Chapter 2, “Convoy/DM Installation,” provides the steps required to
prepare for and execute a Windows installation.
• Chapter 3, “Convoy/DM Database Setup,” provides information on
starting and using the Convoy/DM database installer.
• Chapter 4, “Loading PeopleSoft Metadata,” provides information on
extracting, loading and updating metadata from PeopleSoft into
Convoy/DM.
• Chapter 5, “Additional Workstations,” provides information on
setting up additional client workstations.

Installation Guide v
 • Appendix A, “File Server Install of Convoy/DM,” provides information
on installing Convoy/DM client on a file server.
Integration Server Convoy/DM is compatible with the following integration servers:
Support
• e-Biz Integrator, release 2.1, 3.1 and 3.1.1
• New Era of Networks Rules and Formatter, release 5.1
• e-Biz 2000, release 3.3
• New Era of Networks Rules, Formatter, and Messaging, release 4.1.1
• MQSeries Integrator, version 1.1, 2 and 2.0.2
Supported Platforms Table 1: Server
Operating System DBMS Compiler
Windows NT 4.0 (Service MS SQL Server 7 Microsoft
Pack 5) Oracle 8i Enterprise Edition Version 6.0 C++
Release 8.0.6 or 8.1.5
DB2 6.1
Windows 2000 Professional MS SQL Server 7 Microsoft
Oracle 8i Enterprise Edition Version 6.0 C++
Release 8.0.6 or 8.1.5
DB2 6.1

Disk Space and Installation Media: CD-ROM

Memory
Requirements
Hardware Disk space: 75 MB for Convoy/DM database installation
Requirements
50 MB for Convoy/DM executables
Memory: 256 MB
Convoy/DM This section describes the documentation available for Convoy/DM.
Documentation Set
Cross-Platform Documentation The Convoy/DM documentation set
includes:
• Installation Guide
• User Guide

vi Convoy/DM
 About This Book

Related Documentation Related documentation is available from New Era

of Networks, Inc., Sybase, and IBM. Refer to other documentation from each
of these companies for more detail about use of applications relevant to this
product. To access the Technical Library Product Manuals Web site, go to
Product Manuals at http://www.sybase.com/support/manuals.

Document The following document conventions are used in this guide.

Conventions
Text Convention Example
code courier <user ID> <password>
command line display courier The message successfully
parsed.
command line entry courier bold NNFAD-t
command line prompt courier Enter the input file name:
book names italic User Guide

Other sources of Use the Sybase Getting Started CD, the Sybase Technical Library CD and the
information Technical Library Product Manuals Web site to learn more about your product:
• The Getting Started CD contains release bulletins and installation guides
in PDF format, and may also contain other documents or updated
information not included on the Technical Library CD. It is included with
your software. To read or print documents on the Getting Started CD you
need Adobe Acrobat Reader (downloadable at no charge from the Adobe
Web site, using a link provided on the CD).
• The Technical Library CD contains product manuals and is included with
your software. The DynaText reader (included on the Technical Library
CD) allows you to access technical information about your product in an
easy-to-use format.
Refer to the Technical Library Installation Guide in your documentation
package for instructions on installing and starting the Technical Library.
• The Technical Library Product Manuals Web site is an HTML version of
the Technical Library CD that you can access using a standard Web
browser. In addition to product manuals, you will find links to
EBFs/Updates, Technical Documents, Case Management, Solved Cases,
newsgroups, and the Sybase Developer Network.
To access the Technical Library Product Manuals Web site, go to Product
Manuals at http://www.sybase.com/support/manuals/.

Sybase certifications Technical documentation at the Sybase Web site is updated frequently.
on the Web

Installation Guide vii

 ❖ Finding the latest information on product certifications
1 Point your Web browser to Technical Documents at
http://www.sybase.com/support/techdocs/.

2 Select Products from the navigation bar on the left.

3 Select a product name from the product list and click Go.
4 Select the Certification Report filter, specify a time frame, and click Go.
5 Click a Certification Report title to display the report.

❖ Creating a personalized view of the Sybase Web site (including support

pages)
Set up a MySybase profile. MySybase is a free service that allows you to create
a personalized view of Sybase Web pages.
1 Point your Web browser to Technical Documents at
http://www.sybase.com/support/techdocs/.

2 Click MySybase and create a MySybase profile.

Sybase EBFs and
software
maintenance

❖ Finding the latest information on EBFs and software maintenance

1 Point your Web browser to the Sybase Support Page at
http://www.sybase.com/support.

2 Select EBFs/Maintenance. Enter user name and password information, if

prompted (for existing Web accounts) or create a new account (a free
service).
3 Select a product.
4 Specify a time frame and click Go.
5 Click the Info icon to display the EBF/Maintenance report, or click the
product description to download the software.
If you need help Each Sybase installation that has purchased a support contract has one or more
designated people who are authorized to contact Sybase Technical Support. If
you cannot resolve a problem using the manuals or online help, please have the
designated person contact Sybase Technical Support or the Sybase subsidiary
in your area.
For more information on Support Services, education, and consulting services,
refer to the Customer Services Reference Guide.

viii Convoy/DM
CH A PTE R 1 Borland Database Engine (BDE)
Setup

Before installing Convoy/DM on Windows, you must install and

configure the third-party software, Borland Database Engine (BDE).
This chapter includes the following information:
Topic Page
Installing BDE 1
Manual BDE configuration 2

Note If you are upgrading from Convoy/DM 3.5, it is not necessary to

perform the steps provided in this chapter. Proceed to Chapter 2,
“Convoy/DM Installation” to begin the Convoy/DM installation process.

Installing BDE
If you are not upgrading your Convoy/DM 3.5 software, perform the
following steps to install the Borland Database Engine:
1 Insert the CD-ROM into the CD-ROM drive of your Windows
machine. If your Windows machine is configured to autorun from the
CD-ROM, InstallShield Wizard automatically starts. Exit from the
install and run setup.exe located in the Bde50 folder on the
Convoy/DM install CD-ROM.
2 The Borland Database Engine Setup Welcome screen appears. Click
Next.

Installation Guide 1
Manual BDE configuration

3 The Start Copying Files screen appears. Click Next to begin BDE
installation.

Note The third-party BDE software is copied into the following target
directory:
C:\Program Files\Common Files\Borland Shared\BDE.

4 When the files have completed copying, the Setup Complete screen
appears. Click Finish to complete the installation process.

Manual BDE configuration

The BDE is configured automatically during installation, perform the
following steps if there is a need to the manually configure the BDE:
1 Launch the BDE Administrator utility located in Start|Settings|Control
Panel.

2 Convoy/DM
 CHAPTER 1 Borland Database Engine (BDE) Setup

2 Select the Configuration tab, then select Drivers | Native. The BDE
Administrator window is shown with the following parameters:.

3 Verify the following parameters for your specific database:

• Driver: SYBASE
DLL32: SQLSSC32.DLL
• Driver: DB2
DLL32: SQLDB232.DLL
DLL32: SQLDBV5.DLL
• Driver: INFORMIX
DLL32: SQLINF32.DLL
• Driver: MSSQL
DLL32: SQLMSS32.DLL
• Driver: ORACLE
DLL32: SQLORA32.DLL

Installation Guide 3
Manual BDE configuration

VENDOR INIT: ORANT71.DLL for Windows NT

VENDOR INIT: ORA73.DLL for Windows 95/98
VENDOR INIT: ORA803.DLL for Windows NT/95/98 ORACLE
803
ORA804.DLL for Windows NT/95/98 ORACLE 804
ORA805.DLL for Windows NT/95/98 ORACLE 805
OCI.DLL for Windows NT/95/98 ORACLE 8.1.n
4 Click on the Database tab and the following window is shown.

5 Select: Object | New to bring up the New Database Alias window..

6 Select your database driver from the drop down menu, and click OK.

4 Convoy/DM
 CHAPTER 1 Borland Database Engine (BDE) Setup

7 Enter a name for this Database Alias. (for example, CONVOY_ORACLE.)

8 Set the parameters for Server Name or DSN.

❖ For SYBASE, MS SQL, INFORMIX:

Set the Server Name, Database Name and User Name.
1 Select Object | Apply to make sure the changes are saved in the
configuration file.
2 Select Object | Close to exit the BDE Administrator utility.

❖ For Oracle:
The Server Name must be the same as the Oracle Alias defined in SQL NET
EZ Configuration program. The Net Protocol must be TNS and set the User
Name.
1 Select Object | Apply to make sure the changes are saved in the
configuration file.
2 Select Object | Close to exit the BDE Administrator utility.

❖ For DB2:
1 Enter the DB2 DSN Name for your system and set the User Name.
2 Select Object | Apply to make sure the changes are saved in the
configuration file.
3 Select Object | Close to exit the BDE Administrator utility.

Installation Guide 5
Manual BDE configuration

6 Convoy/DM
CH A PTE R 2 Convoy/DM Installation

This chapter describes how to prepare for and run an installation on

Windows NT or Windows 2000. It includes the installation of all
components, including database components.
The installation process includes the following steps:
Topic Page
Preparing for a Windows installation 7
Installing Convoy/DM 10

Preparing for a Windows installation

This section presents the steps you should take before you run the
installation procedure:

Note Review the printed readme.txt document included with this package
for any last-minute updates to this Installation Guide. A soft copy of this
readme.txt file is located in the nnsy/books directory.

Required software
The following software is required on the server:
• Windows operating system
• DBMS server database application
• Complier, if you plan to write any of your own code

Installation Guide 7
Preparing for a Windows installation

• Borland Database Engine (BDE).

Warning! If you are not upgrading from Convoy/DM 3.5, be sure to complete
the steps in Chapter 1, “Borland Database Engine (BDE) Setup,” before doing
the Windows installation or the following severe error appears.

Verifying the database environment

Convoy/DM accesses a designated database through the BDE or ODBC
connection. Verify that you can connect to this database before installing
Convoy/DM software.

On Sybase
New Era of Networks installation procedures assume that the following are
complete:
• Installation of the database software.
• Setting of the database environment variables according to the DBMS
software manufacturer instructions.
Confirm the following:
• Database server is running in the target environment.
• Connection can be made to the database server using interactive query
tools, such as ISQL.

On Microsoft SQL Server

New Era of Networks installation procedures require that the following have
been completed:

8 Convoy/DM
 CHAPTER 2 Convoy/DM Installation

• Installation of the database software, including configuring the SQL

Server with a case sensitive sort order.
• Setting of database environment variables according to the DBMS
software manufacturer instructions.
Confirm the following:
• Database server is running in the target environment.
• Connection can be made to the database server using interactive query
tools, such as Query Analyzer or ISQL.
Determine the following values for use during the database setup:
• Database server name
• System Administrator (sa) userid
• System Administrator (sa) password

On Oracle
New Era of Networks installation procedures assume that the following are
complete:
• Installation of the database software.
• Setting of database environment variables according to the DBMS
software manufacturer instructions.
Confirm the following:
• Database server is running in the target environment.
Determine the following values for use during the database setup:
• Database server name
• Sys userid

• Password for Sys userid

On DB2
New Era of Networks installation procedures assume that the following are
complete:
• Installation of the database software.

Installation Guide 9
Installing Convoy/DM

• Setting of the database environment variables according to the DBMS

software manufacturer instructions.
• Creation of an operating system group called NNSYGRP that resides on
the DB2 server machine.
• Creation of a user account that was added to the NNSYGRP and will
become the New Era of Networks database object owner.
Confirm the following:
• Database server is running in the target environment.
• Connection can be made to the database server using the interactive query
tool, DB2 CLP.
• You are currently logged in as the DB2 instance owner on the machine
from which you will run the installation.

Uninstalling previous releases

If you currently have a previous release of Convoy/DM installed, you may
want to uninstall that version before installing the current release. Installation
of the current release does not overwrite the previous installation and does not
affect any files you may have added.

Installing Convoy/DM
Installing Convoy/DM involves installing the necessary files and scripts that
are required for creating adapters for use in coordination with core
infrastructure. Once installed, Convoy/DM can be used against a format and
rules repository.

10 Convoy/DM
 CHAPTER 2 Convoy/DM Installation

❖ To install Convoy/DM using the InstallShield Wizard

1 Insert the CD-ROM into the CD-ROM drive of your Windows machine.
If your Windows machine is configured to autorun from the CD-ROM,
InstallShield Wizard automatically starts.

Note If InstallShield Wizard does not automatically start, open the

Windows NT explorer, select the CD-ROM drive, open the n0cvy371_3
folder on the CD and double click setup.exe.

2 Click Next on the New Era of Networks Components Installer Welcome

window to initiate the installation process.
The New Era of Networks Components window appears for component
selection.
3 Click Select All, if all components are not already selected.
The documentation for each applicable component is included in the
installation for that component.
Click Next.
4 The Setup Type window appears for each component being installed. The
options are:
• Typical install for all components.
• Customize selected component installs.
The default and preferred method to install the full Convoy/DM group of
packages is Typical.
Click Next to begin the installation of all components of Convoy/DM.
5 The Select Components Program folder appears for identification of the
Start menu’s program folder. It is suggested that all New Era of Networks
products appear under the default folder:
New Era of Networks
Click Next to accept the default folder name.
6 Click Next on the Select Components Root Path window to accept the
default location for the installation of Convoy/DM and its dependencies.
C:\nnsy

Installation Guide 11
Installing Convoy/DM

This is the default location for all New Era of Networks products.

Note All New Era of Networks products should be installed in the same
directory.

7 Respond to the following window prompts if you are performing a

Customized Install.
a The Setup window appears for each component being installed. The
options are:
• Typical – installing all the required parts of the component.
• Custom – allowing the user to decide what parts of the
component to install.
The default and preferred method is Typical. Click Next to begin the
installation of that component.
b Click Next to accept the selected setup type for each component when
the window appears.
8 When the Setup Complete window appears, click Finish.
9 The software is now installed in the specified installation directory. The
Convoy/DM software is now installed in the C:\nnsy\ directory.
The C:\nnsy\ directory should contain the following subdirectories:
Table 2-1: C:\nnsy\
Subdirectory Description
Bde50\ BDE setup executable
Books\ user documentation
ConvoyDM\ setup program for Convoy/DM database

The C:\nnsy\ConvoyDM directory should contain the following

subdirectories:
Table 2-2: C:\nnsy\ConvoyDM
Subdirectory Description
bin\ executable and shared libraries for New Era of Networks
products
DB_Installer\ setup program for Convoy/DM database
Support\ Convoy/DM scripts and include files.
Utils\ utilities not supported by New Era of Networks

12 Convoy/DM
CH A PTE R 3 Convoy/DM Database Setup

This chapter describes how to start and use the Convoy/DM database
installer.
Topic Page
Overview 13
Automatic setup steps 15
Manual setup steps 24

Overview
The Convoy/DM DB_Installer is used to:
• Build the Convoy/DM database
Oracle users must have pre-existing instance.
• Populate the Convoy/DM database with initial data
• Register the software
This procedure is done once by the database administrator.
This chapter takes you through each screen of DB_Installer and explain
the options available particular to your specific database environment.

Before you begin

Before starting DB_Installer, verify that:
• You have DBA privileges to access your database.
• You can connect to your database using the appropriate client tool,
such as, Oracle SQL*Plus.
• The BDE Administrator, installed with the Convoy/DM client
software, appears in the Control Panel.

Installation Guide 13
Overview

Starting DB_Installer
To start DB_Installer, run CDM30su.exe located in the
C:\nnsy\ConvoyDM\DB_Installer directory. The Welcome screen appears.
Figure 3-1: Welcome Screen

The Welcome screen prompts you to select the type of setup you wish to run:
• Automatic – Select this option if this is the first time you are setting up the
database. Click Next to proceed to the Database Type Screen.
• Manual – Select this option if you have run Convoy/DM Setup before and
wish to change settings or complete the set up. Click Next to open Convoy
D/M Setup to choose setup option.

Note DB2 and Informix require Manual mode install. Refer to “Manual
setup steps” on page 24, for manual setup instructions.

Button Options • Next – to proceed as determined by the setup type.

• Back – to return to the previous screen of DB_Installer.
• Exit – to cancel the DB_Installer program. Any changes you made are
saved and appear the next time you run DB_Installer.

14 Convoy/DM
 CHAPTER 3 Convoy/DM Database Setup

Automatic setup steps

Select your database from the pull-down menu provided. Convoy/DM supports
Sybase, Oracle, MS SQL, Informix, and DB2. If your database is on UNIX,
check the appropriate box.
Figure 3-2: Database Type Screen

Create a BDE alias

This screen is used to set up the Inprise Database Engine (BDE). For most
databases you are asked to provide the following:
• Alias Name – An alias for the BDE, such as Convoy.
• Server Name – Server name, such as the name of the RDBMS server or
appropriate database alias such as the aliases used by Oracle TNS names)
If you are using Oracle, you also need to indicate which Oracle DLLs are
present on your workstation by using the pull–down menu, or by entering it in
the edit box.

Note Please refer to Chapter 1, “Borland Database Engine (BDE) Setup,” for
the correct DLL for each version of Oracle.

Installation Guide 15
Automatic setup steps

Click the Create Alias button before proceeding to the next screen.
Figure 3-3: Create BDE Alias Screen

Informix and DB2 setup

If you are using Informix or DB2, you are presented with instructions on how
to proceed with the installation. Print out a copy of these instructions for
reference. Once you have completed the steps described in this screen, re-start
the DB_Installer application and use the Manual Setup option to populate the
database (DB Populate option in Manual setup).
• DB Populate – Load data into the Convoy/DM database. Clicking Next
opens the Convoy/DM Database Login screen.
• Load Reports – Select the reports to be loaded.

16 Convoy/DM
 CHAPTER 3 Convoy/DM Database Setup

Once you have completed the steps for installing under Informix or DB2, as
described in the Installation Wizard, click DB Populate followed by Load
Reports.

Note For DB2 client Version 5, you need to execute the Setup.exe located on
the Convoy CD under the subdirectory BDE50. An Install Wizard leads you
through the screens from the “Select Components” screen, select the option to
“Install in place over existing files”. In the second “Select Components”
screen, select the DB/2 V5 component.

Database login information

You must enter the database administrator login name and password for your
database server. The initial Convoy/DM user must be created with all database
rights. Click Next to proceed and specify the parameters for your database
environment.

Installation Guide 17
Automatic setup steps

Figure 3-4: Database Login Screen

Specify the parameters for your database environment

You must provide the following information on your database in order to
populate the database. The Use Default button populates these fields with the
standard settings, which you can edit to your environment.
MSSQL and Sybase Description
Convoy/DM Database Name Name of the Convoy/DM database
Convoy/DM Login Login for the Convoy/DM database
Convoy/DM User Group User group for the Convoy/DM database
Convoy/DM Login Password Password for the Convoy/DM database
Convoy/DM User Convoy/DM username
Data Device Device allocated to the Convoy/DM database
Data Size Size allocated to the Convoy/DM database
Data Filename Filename for the Convoy/DM database
Log Device Log device for the Convoy/DM database
Log Size Size of the log file for the Convoy/DM database
Log Filename Filename for the log for the Convoy/DM database
Device File Path Pathname for the Convoy/DM database

18 Convoy/DM
 CHAPTER 3 Convoy/DM Database Setup

Oracle Description
Convoy/DM DB Name Name of the Convoy/DM database
Convoy/DM User Name User Name for the Convoy/DM database
Convoy/DM User Password Password for the Convoy/DM database defaulted to
CONVOY
Data Tablespace Tablespace to contain the Convoy/DM database
Size Size allocated to the Convoy/DM database
Data Filename Pathname for the Convoy/DM database
Index Tablespace Tablespace to contain the Index of the Convoy/DM
database
Size Size allocated to the Index of the Convoy/DM
database
Index Filename Filename for the Index of Convoy/DM database
Device File Path Pathname for the file for the Index of the
Convoy/DM database.

Installation Guide 19
Automatic setup steps

Figure 3-5: Database Parameters Entry Screen

SQL Scripts
You must run four SQL scripts. Once each is completed, the next appears in the
list and you have to select it to run. The SQL generated by DB_Installer
depends on information entered in the previous screen. Sybase recommends
that you save a copy of the SQL using Save SQL, or print it out using Print SQL
for reference. The original scripts, which use variable information, may be
found in the appropriate database subdirectory of DB_Installer (such as
DB_Installer\Sybase).
The four scripts perform the following tasks:
• Create the Convoy/DM database.
• Create the Convoy/DM database user.
• Create the tables for the Convoy/DM database.
• Add constraints, such as foreign keys, to the Convoy/DM database.
Click Run SQL to run the selected SQL script. If one script fails, you are not
allowed to proceed to the next script. Once all four scripts have been
completed, you may proceed to the next screen.

20 Convoy/DM
 CHAPTER 3 Convoy/DM Database Setup

Figure 3-6: SQL Scripts: create DB & devices

For Oracle database installs, this script needs to be edited to reflect the name
of the your Temporary table.
Figure 3-7: SQL Scripts: Create user screen

Installation Guide 21
Automatic setup steps

Figure 3-8: SQL Scripts: Create tables screen

Figure 3-9: SQL Scripts: Create constraints

22 Convoy/DM
 CHAPTER 3 Convoy/DM Database Setup

Database populate
DB Populate populates the Convoy/DM tables with default data. After you click
Next on the above Create Constraints screen, the following screen appears.
Figure 3-10: Database Table Population screen

Click Next and the Convoy/DM Reports screen appears.

Convoy/DM reports
Convoy/DM reports can be selected and loaded into the database. Select any
combination by clicking on the box appearing to the left of the report name
listed in the Convoy/DM Reports screen. You can also choose all reports or
clear the selections using Select All and Deselect All, respectively. The reports
are listed in Figure 3-11, Convoy/DM Reports screen.
Click Load Reports when finished. If one script fails, you are not allowed to
proceed to the next script. After all selected reports are loaded, you may
proceed to the next screen.

Installation Guide 23
Manual setup steps

Figure 3-11: Convoy/DM Reports screen

Click Next to complete Convoy/DM setup.

Manual setup steps

If you select Manual as the setup type, the Convoy/DM Setup screen is
displayed.

24 Convoy/DM
 CHAPTER 3 Convoy/DM Database Setup

Figure 3-12: Convoy/DM manual setup screen

Convoy/DM setup
1 Select the Database Type from the pull down menu.
2 Select the option you wish to complete; only one can be chosen.
• Create BDE alias – to create the Borland Database Engine alias.
Clicking Next opens the Create BDE Alias screen.
• SQL Scripts – to specify run the SQL scripts. Clicking Next opens the
Specify the Parameters for your Database Environment screen.
• DB Populate – to load data into the Convoy/DM database. Clicking
Next opens the Convoy/DM Database Login screen.
• Load Reports – to select the reports to be loaded.

Informix and DB2 setup

If you have completed the steps for installing under Informix or DB2, as
described in the Installation Wizard, click Next on DB Populate and Load
Reports.

Installation Guide 25
Manual setup steps

Convoy/DM database login steps

In this screen you are asked to specify the following:
• BDE alias: you may use the pull-down menu or you may create a new alias
by selecting the New button.
• DBA login name: login for the database administrator.
• DBA password: password for the database administrator.
• Convoy/DM Setup, to select another setup option.
• SQL Scripts: to run the SQL scripts to create and populate the database.

Informix database install instructions

Automatic creation of Informix databases is not supported. After creating the
BDE Alias, continue the install as described below to create the Convoy/DM
Database on your Informix server.
1 Create a DBSPACE using the -onspaces utility.
2 Create a CONVOYDM database.
3 Create a CONVOY USER and grant ALL (DBA Privileges) on the USER.
4 Copy the creatbls.sql and creacons.sql SQL scripts located in the
C:\CONVOYDM\INSTALLER\SERVER\INFORMIX directory to your
Informix Server.
5 Login into the CONVOYDM database using CONVOY USER.
6 Run the SQL scripts in the following order:
creatbls.sql
creacons.sql

7 Come back to the (cdm35su.exe) Installer application and re-run using the
Manual Setup. In the Manual Setup choose “DB Populate” and follow the
prompts.

DB2 database install instructions

Automatic creation of DB2 databases is not supported. After creating the BDE
Alias, continue the install as described below to create the Convoy/DM
Database on your DB2 server.

26 Convoy/DM
 CHAPTER 3 Convoy/DM Database Setup

1 Create a CONVOYDM database.

2 Create a CONVOY USER and grant ALL (DBA Privileges) on the USER.
3 Copy the creatbls.sql and creacons.sql SQL scripts located in the
C:\CONVOYDM\INSTALLER\SERVER\DB2\DB2_6000 or
C:\CONVOYDM\INSTALLER\SERVER\DB2\DB2_MVS directory to your
DB2 Server.
4 Login into the CONVOYDM database using CONVOY USER.
5 Run the SQL scripts in the following order:
creatbls.sql
creacons.sql

6 Come back to this (CDM30su.exe) Installer application and re-run using

the Manual Setup. In the Manual Setup choose “DB Populate” and follow
the prompts.

Specify the parameters for your database environment

You must provide the following information on your database in order to run
the SQL scripts used to create and populate the database:
MSSQL and Sybase Description
Convoy/DM Database Name Name of the Convoy/DM database
Convoy/DM Login Login for the Convoy/DM database
Convoy/DM User Group User group for the Convoy/DM database
Convoy/DM Login Password Password for the Convoy/DM database
Convoy/DM User Convoy/DM username
Data Device Device allocated to the Convoy/DM database
Data Size Size allocated to the Convoy/DM database
Data Filename Filename for the Convoy/DM database
Log Device Log device for the Convoy/DM database
Log Size Size of the log file for the Convoy/DM database
Log Filename Filename for the log for the Convoy/DM
database
Device File Path Pathname for the Convoy/DM database

Oracle Description
Convoy/DM DB Name Name of the Convoy/DM database
Convoy/DM User Name User Name for the Convoy/DM database

Installation Guide 27
Manual setup steps

Oracle Description
Convoy/DM User Password Password for the Convoy/DM database defaulted
to CONVOY
Data Tablespace Tablespace to contain the Convoy/DM database
Size Size allocated to the Convoy/DM database
Data Filename Pathname for the Convoy/DM database
Index Tablespace Tablespace to contain the Index of the Convoy/DM
database
Size Size allocated to the Index of the Convoy/DM
database
Index Filename Filename for the Index of Convoy/DM database
Device File Path Pathname for the file for the Index of the
Convoy/DM database.

28 Convoy/DM
 CHAPTER 3 Convoy/DM Database Setup

Figure 3-13: Database Parameters Entry Screen

SQL Scripts
There are four SQL scripts to be run. Once one is completed, the next appears
and you may select it to run. The SQL generated depends on information
entered in the previous screen. Sybase recommends that you save a copy of the
SQL using Save SQL, or print it out using Print SQL for reference. The original
scripts may be found in the appropriate database subdirectory of DB_Installer,
such as DB_Installer\Sybase.
The four scripts perform the following tasks:
• Create the Convoy/DM database.
• Create the Convoy/DM database user.
• Create the tables for the Convoy/DM database.
• Add constraints, such as foreign keys, to the Convoy/DM database.
Click Run SQL to run the highlighted SQL script. If one script fails, you are
not allowed to proceed to the next script. Once all four scripts have been
completed, you may proceed to the next screen.

Installation Guide 29
Manual setup steps

Convoy/DM reports
Convoy/DM reports can be selected and loaded into the database. Select any
combination by clicking on the box appearing to the left of the report name
listed in the Convoy/DM Reports screen. You can also choose all reports or
clear the selections using Select All and Deselect All, respectively. The reports
are listed in Figure 3-14: Convoy/DM Reports Screen.
Click Load Reports when finished. If one script fails, you are not allowed to
proceed to the next script. After all selected reports are loaded, you may
proceed to the next screen.
Figure 3-14: Convoy/DM Reports Screen

30 Convoy/DM
CH A PTE R 4 Loading PeopleSoft Metadata

This chapter describes how to extract, load and update metadata from
PeopleSoft into Convoy/DM.
This chapter contains the following information:
Topic Page
Extracting Metadata from PeopleSoft 31
Loading PeopleSoft metadata into Convoy/DM 33

Extracting Metadata from PeopleSoft

Convoy/DM-supplied files are required for the extract and load. These are
located in:
• C:\nnsy\ConvoyDM\Support\SQRScripts\Extract and
• C:\nnsy\ConvoyDM\Support\SQRScripts\Include
Before beginning, copy all the files from the two directories into a
temporary directory such as C:\temp.

Note You are modifying these files to make them specific to your system
you need to set the values specific to your system configuration.

The #include File - ccenv.inc

The file CCENV.INC is an SQR #include file that has settings particular to
your environment, including operating system. Pay particular attention to
the following #DEFINE settings:
• OP_SYS – Set to correct operating system. The valid values are PC,
UNIX, or MVS

Insallation Guide 31
Extracting Metadata from PeopleSoft

• DBMS – Set to your PeopleSoft database vendor. The Valid values are:
Sybase, Oracle, DB2, Informix, or MSQL.
• FILE_PREFIX – Set to the temp directory for your platform. Generally,
editing is not needed.
• PSTOOLS_OWNER – If necessary, set this to the owner of the PeopleSoft
tables. This is necessary if you log on with an ID other than the owner of
the tables, and the ID you logon with does not have aliases or synonyms
set up to access the PeopleTools tables. If this is set, include a period (.) at
the end, as the owner is concatenated to the table name:
PSTOOLS_OWNER.Table_Name
• CONVOY_OWNER – Required for MSSQL SERVER or SYBASE. Add a
period and the database user name. The default is uppercase CONVOY.

Extract SQR - CSPSEX.SQR

This is the SQR that reads the PeopleSoft catalogs and produces several files
that are later loaded into the Convoy/DM Dictionary. In B010-Program-Init
procedure there is one variable you have to change:
$App_Name – This is an acronym for your PeopleSoft application. Keep it to
just a few characters, such as PSHR or PSFin.

Executing the SQR

1 Logon to your PeopleSoft database.
2 Put the include file ccenv.inc in the same directory as the include files
ccval1.inc, ccval2.inc and ccvalpld. You can choose to put them in a
different directory from the four SQRs:
• CSPSEX.SQR

• CSPSEX81.SQR

• CSPSLD.SQR

• CSPSLD81.SQR

Note Make sure you call the SQR with the -I switch, and specify the
path to the include file.

32 Convoy/DM
 CHAPTER 4 Loading PeopleSoft Metadata

3 Run CSPSEX.SQR

Note Make sure you run it against the PeopleSoft database (not the
Convoy/DM database).

4 Connect with a userid/password that has access to the PeopleTools tables.

Files produced
The CSPSEX.SQR produces the following files in the directory specified by
FILE_PREFIX in ccenv.inc:
• csexrnt.txt
• csexrec.txt
• csexfld.txt

Loading PeopleSoft metadata into Convoy/DM

1 Invoke Convoy/DM from the Windows Start menu.
2 Go to the menu option File | New | Application.
3 Create the PeopleSoft application using the name given in the
$App_Name entered in the CSPSEX.sqr from the previous procedure as
follows:
• Access the FILE menu, select option NEW, fill out the application
name and type.
• Save the application using the save button directly above the
application name.
Then, using the SQR executable, logon to the Convoy database. The
Convoy/DM supplied file required for the load is located in
C:\nnsy\ConvoyDM\\Support\SQRScripts\Extract.
• CSPSLD.SQR or CSPLD81.SQR

This is the SQR that reads the files created by the PeopleSoft Extract SQR,
cspsex.sqr and populates the Convoy/DM Dictionary. Refer to the section,
“Executing the SQR” on page 32.

Insallation Guide 33
Loading PeopleSoft metadata into Convoy/DM

34 Convoy/DM
CH A PTE R 5 Additional Workstations

This chapter provides information on setting up additional workstations.

The chapter contains the following:
Topic Page
Setting up additional workstations 35

Setting up additional workstations

After the first Convoy workstation has been installed and the Convoy
database has been created, you are ready to setup additional workstations
with the Convoy/DM CD-ROM. The workstation must have previous
connectivity to the database.

❖ Set Up Instructions
1 Run the Convoy/DM CD-ROM as in Chapter 2, “Convoy/DM
Installation.”
2 Choose to install all components.
3 After the CD-ROM installation is complete, from the Windows Start
menu, select Programs | Convoy | DB Install option.
4 Select Manual Mode and click Next.
5 Enter the Database type.
6 Under Options select Create BDE Alias and click Next.
7 Enter the required BDE parameters and click Create Alias button.
8 Exit the DB Install Utility.
The additional workstation is now configured.

Installation Guide 35
Setting up additional workstations

36 Convoy/DM
A P PE N DI X A File Server Install of
Convoy/DM

This appendix provides information on installing Convoy/DM on a file

server.

File server installation

There are two places within the Convoy install wizard where you need to
change the drive assignment to indicate your file server drive.
1 When you are prompted with the path assignment indicating the local
workstation’s root directory, change the path to the location of the file
server.
2 When you are prompted for the path assignment of the Borland
Database Engine, change the drive to the location of the file server.
The folders and the paths need to look like this:
<driveletter>:\Program Files\Borland\Common Files\BDE. Convoy
expects to be to be able to find the BDE at this path location.

Warning! If there is an existing BDE install on the target file server,

choose the root as the install location. The BDE install automatically
searches from the assigned directory down, through all existing
subdirectories for existing BDE installs which, if found, are upgraded.
This is necessary to avoid multiple installs of BDE. If there is an existing
BDE on the workstations that will implement Convoy it is best to install
the Convoy locally and not implement a file server install. Multiple BDE
entries in the Windows registry causes numerous problems.

To configure workstations to access the file server install of Convoy,

invoke the NETBDE.EXE from each workstation. This program is located
in the UTILS subdirectory of the Convoy directory.

Installation Guide 37
File server installation

In the open dialog box of the SETUP BDE tab, indicate the path to the
IDAPI32.cfg file that is installed as part of the Convoy Installation. Click OK,
the system will write the necessary file assignments to the local Window
Registry.

Warning! If there is an existing BDE install on the local workstation drive,

please choose to do a local Convoy installation for that machine to avoid
multiple Windows Registry path assignments for the BDE access. BDE install
automatically searches from the assigned directory down, through all existing
subdirectories for existing BDE installs which, if found, are upgraded.

Create a shortcut to the Convoy/DM.exe and place it on the local desktop.

38 Convoy/DM
Index

A verify database environment for MS SQL server 8

verify database environment for Oracle 9
adding
verify database environment for Sybase 8
workstations 35
Windows install 7
alias
create
create for BDE 15
BDE alias 15
automatic setup 15

B D
database
BDE See boreland database engine
INFORMIX install 26
boreland database engine
install DB2 26
configure DB2 5
specify parameters 18, 27
configure INFORMIX 5
database administrator
configure MS SQL 5
login 17
configure Oracle 5
database setup
configure Sybase 5
Convoy/DM 13
installing 1
DB Populate
manual configuration 2
populates Convoy/DM tables 23
setup 1
DB_installer 14
DB2
configure boreland database engine 5
C install database 26
manual setup for Convoy/DM 25
configure setup 16
boreland database engine manually 2 verify database environment for convoy/DM 9
DB2 for boreland database engine 5 DBA See database administrator
INFORMIX for boreland database engine 5
MS SQL for boreland database engine 5
Sybase for boreland database engine 5
Convoy/DM E
adding workstations 35
extracting
database setup 13
PeopleSoft metadata 31
install 7, 10
manual setup 24
populate tables 23
reports 23, 30 F
verify database environment 8
file server
verify database environment for DB2 9
install Convoy/DM 37

Installation Guide 39
Index

I P
INFORMIX parameters
configure boreland database engine 5 specify for database 27
install database 26 specify for database environment 18
manual setup for Convoy/DM 25 PeopleSoft
setup 16 loading metadata 31
install previous releases
boreland database engine 1 uninstall 10
Convoy/DM 7, 10
Convoy/DM for Windows 7
DB2 database 26
file server 37 R
INFORMIX database 26 reports
Convoy/DM 23, 30

L
loading S
PeopleSoft metadata 31 scripts
login SQL 20, 29
database administrator 17 set
boreland database engine 1
setup
automatic steps 15
M Convoy/DM manually 24
manual configuration database Convoy/DM 13
boreland database engine 2 DB2 16
manual setup INFORMIX 16
Convoy/DM 24 SQL
DB2 for Convoy/DM 25 scripts 20, 29
INFORMIX for Convoy/DM 25 Sybase
metadata configure for boreland database engine 5
extracting 31 verify database environment for Convoy/DM 8
loading PeopleSoft 31
MS SQL
configure for boreland database engine 5
MS SQL server U
verify database environment for Convoy/DM 8 uninstall
previous releases 10

O
Oracle V
configure boreland database engine 5 verify
verify database environment for Convoy/DM 9 database environment for Convoy/DM 8

40 Convoy/DM
 Index

database environment for Convoy/DM for DB2 9

database environment for Convoy/DM for MS SQL
server 8
database environment for Convoy/DM on Oracle
9
database environment for Convoy/DM on Sybase
8

W
Windows
install Convoy/DM 7
workstations
adding 35

Installation Guide 41
Index

42 Convoy/DM