"SSA INTEGRATION PACK FOR SSA ERP LN - VERTEX O SERIES" - INSTALLATION INSTRUCTIONS
-----------------------------------------------------------------------------------
Prerequisites
-------------
Java Runtime Environment 1.4
SSA Technology Architecture OpenWorld Adapter Suite Connector for Java with a
 license for its server component
Vertex O-Series 2.1 with web-service component installed and running.

General
-------
You are reading this file, therefore you hava already managed to expand the
archive containing the bridge objects.
Move the directory that contains the directory containing this file (the
directory that was produced when expanding the archive) to the place where you
want the 'SSA Integration Pack for SSA ERP LN - Vertex O Series' to reside. 
We will call this the installation directory in the rest of this document or 
<installDir> for short. As a check to make sure we are all on the same page: 
the <installDir> directory should contain the following directories and files.

  bin/
  doc/
  etc/
  lib/
  README
  version.txt

The software needs to be made aware of the other software that it depends on.
There are two ways of doing this:

 1. Set environment variables to point to the relevant installation directories:
    BAANHOME         The SSA License Manager installation directory. In
                     particular, the following file should exist (amongst
                     others):
                       <BAANHOME>/java/com_baan_bclm.jar

    OW_C4JAVA_HOME   The Connector for Java installation directory. In particular
                     the following file should exist (amongst others):
                       <OW_C4JAVA_HOME>/java/b3.jar

 2. Create/edit a configuration file or script to tell the software where the
    other components are installed. This is accomplished in different ways
    depending on the platform you are installing on. They are listed below. This
    is the preferred way of setting up your system.

Windows
-------
Edit the <installDir>/bin/setEnv.bat file by uncommenting the appropriate lines
and filling out appropriate values.

Unix (or Linux)
---------------
There are two ways to configure the SSA Integration Pack for SSA ERP LN - Vertex O Series's software dependencies
on Unix platforms:

 1. System-wide
    This involves setting up a file /etc/owTpBridge

 2. User-specific
    This involves setting up a file ${HOME}/.owTpBridge

The user-specific variant takes precedence over a system-wide file. The syntax
of the two files is exactly the same. In fact, they are sourced in from a shell
script. A template can be found in <installDir>/etc/owTpBridge.template.
The template can be used by uncommenting the appropriate lines and filling out
appropriate values.


STARTING THE SSA INTEGRATION PACK FOR SSA ERP LN - VERTEX O SERIES
--------------------------------
Starting the SSA Integration Pack for SSA ERP LN - Vertex O Series is similar 
on all supported platforms. The SSA Integration Pack for SSA ERP LN - Vertex O Series 
will probably fail to start if you do not configure it first.
Configuration options are explained in the configure.txt document. At a
minimum you will probably need to add a bus component to your OpenWorld
installation and you will need to configure the 'address.lookup.tax.areas' and
'address.calculate.tax' properties in the <installDir>/vertex.properties file.

Windows
-------
Run the batch file:
  > <installDir\bin\startBridge

Unix
----
Run the script:
  $ <installDir>/bin/startBridge

Specifying a bus component
--------------------------
On both Windows and Unix platforms you can optionally specify the bus component
to listen on for incoming requests from SSA ERP. For example on a Unix machine:
  $ <installDir>/bin/startBridge myBusComponent
If no bus component is specified, the bus component set in the configuration
files is used (see configure.txt).

STOPPING THE SSA INTEGRATION PACK FOR SSA ERP LN - VERTEX O SERIES
--------------------------------
This is achieved by killing the bridge process, i.e. by typing CTRL-C or by
sending a hangup (HUP) signal to the process:
  $ kill <processId>

TESTING THE SSA INTEGRATION PACK FOR SSA ERP LN - VERTEX O SERIES
-------------------------------
As part of this delivery, some tools are packaged that allow you to test whether
Vertex is up and running and whether the SSA Integration Pack for SSA ERP LN - Vertex O Series 
is up an running. These are described in the tools.txt document.

RUNNING THE SSA INTEGRATION PACK FOR SSA ERP LN - VERTEX O SERIES AS A SERVICE
--------------------------------------------
This is left as an exercise for the user.

DIAGNOSING PROBLEMS
-------------------
The log file is your friend. The standard configuration produces a log file in
your home directory that records the main input/output events in the Tax
Provider Bridge and prints errors and warnings to the console. If you want more
detail, read the section on logging configuration in the configure.txt document.
Other places to look for information are the OpenWorld log file(s) (both on the
ERP machine as on the SSA Integration Pack for SSA ERP LN - Vertex O Series machine) 
and the Vertex log file(s).
