Chapter 1   Introduction

This chapter provides an overall introduction to installing the TradingXpert product. The topics covered are:

• "TradingXpert Software Dependencies"
• "TradingXpert/ECXpert Configurations"
• "Installed TradingXpert Software"
• "Upgrading to Version 3.6.2"

TradingXpert Software Dependencies

---

TradingXpert provides a browser-based front end for ECXpert. It is used to support ECXpert trading partners that do not have Electronic Data Interchange (EDI) processing capability. TradingXpert makes it possible for these partners to use ECXpert to submit HTML formatted documents to their partners and retrieve similarly formatted documents from them.

To perform these document exchange functions, TradingXpert has critical dependencies on a number of external software systems, as illustrated in Figure 1-1:

ECXpert    TradingXpert is a front end for ECXpert, submitting documents to ECXpert for processing and retrieving documents processed by ECXpert. TradingXpert relies upon the dispatching, data transformation, and partner management support provided by ECXpert.

Oracle DBMS    In addition to interacting with ECXpert to submit documents, TradingXpert accesses the ECXpert Oracle database (in which ECXpert partnership and tracking information is stored) to retrieve documents processed by ECXpert.

Figure 1-1    TradingXpert Software Dependencies

Application server    TradingXpert runs in an application server environment. (Note in the "TradingXpert 3.6.2 Product Support Matrix," Table 1-1, that both versions 6.5 and 7.0 of the Sun ONE Application Server are supported, resulting in some differences in the installed TradingXpert files.)

Web server    A web server is required to support the interaction of browser-based ECXpert partners with TradingXpert—for receiving and sending of HTML formatted documents. The web server can be integrated with the application server (as in Sun ONE Application Server 7.0) or be a stand-alone product (as in Sun ONE Web Server 6.0).

Table 1-1 shows the supported versions for TradingXpert software dependencies, including those illustrated in Figure 1-1.

Table 1-1    TradingXpert 3.6.2 Product Support Matrix 

Platform/Product	Used For	Supported Platform/Product Version1
ECXpert	Dispatching and transforming documents and managing trading partners.	ECXpert 3.6.2
Oracle database	ECXpert dependency: Storing partnership and process tracking data.	Oracle 8i, version 8.1.7
Application server	TradingXpert runtime environment	Sun ONE Application Server Enterprise Edition, 6.5 Standard Edition (SE), 7.0
Web browser	Accessing TradingXpert from a browser-based ECXpert partner	Netscape 4.79, 6.2, or higher
Sun ONE Application Server, Enterprise Edition, 6.5 Environment
Web server	Accessing TradingXpert from a browser-based ECXpert partner	Sun ONE Web Server, Enterprise Edition 6.0 SP5
Java Runtime Environment (JRE)	Application server support	JDK/JRE 1.3.1_022: Solaris 2.6, 7, and 8 Windows NT 4.0 SP 6a and Windows 2000 Professional and Server SP 3
Java Software Development Kit (JDK), Standard Edition	Compiling TradingXpert Java programs	Version 1.3.1_02: Solaris 2.6, 7, and 8 Windows NT 4.0 SP 6a and Windows 2000 Professional and Server SP 3
Sun ONE Application Server, Standard Edition, 7.0 Environment
Java Runtime Environment (JRE)	application server support	JDK/JRE 1.4.0_023: Solaris 2.6, 7, and 8 Windows NT 4.0 SP 6a and Windows 2000 Professional and Server SP 3
Java Software Development Kit (JDK), Standard Edition	Compiling TradingXpert Java programs	Version 1.4.0_02: Solaris 2.6, 7, and 8 Windows NT 4.0 SP 6a and Windows 2000 Professional and Server SP 3

1 Check the ECXpert Release Notes for any updates to supported versions 2 Download this JDK from: http://java.sun.com/j2se/1.3/index.html 3 Download this JDK from: http://java.sun.com/j2se/1.4/index.html

TradingXpert 3.6.2 is supported on Solaris and Windows operating systems and platforms. The hardware and software requirements for these platforms are specified in their respective platform-specific chapters of this book.

TradingXpert/ECXpert Configurations

---

When installing TradingXpert, there are two basic configurations (see Figure 1-2): TradingXpert and ECXpert installed on the same host machine or on different machines. If TradingXpert and ECXpert are running on different machines, then both must be running the same operating system platform: Solaris or Windows.

Figure 1-2    TradingXpert/ECXpert Configurations

Running TradingXpert on a machine different from ECXpert requires a few additional configuration tasks compared to running both on the same machine (see "Configuring TradingXpert to Run on a Different Machine from ECXpert" for the Solaris platform and "Configuring TradingXpert to Run on a Different Machine from ECXpert" for the Windows platform). Both machines need to run the same operating system.

About the TradingXpert Installer

---

You install the TradingXpert 3.6.2 product using the software distribution provided on the Sun ONE Integration Server, B2B Edition CD-ROM set. For detailed instructions, see the platform-specific procedures in subsequent chapters.

Installer Dependencies

The software systems on which TradingXpert depends should be installed prior to running the TradingXpert installer. This allows you to configure these systems to support TradingXpert. The following software should be installed before installing TradingXpert:

• ECXpert

Make sure you have a functioning ECXpert installation (including its associated Oracle database). See the ECXpert Installation Guide for more information.

• Application server

TradingXpert is deployed into an application server environment, making the application server a prerequisite to installing TradingXpert.

• Web server (should be independently installed if it is not already integrated with the application server—for example, Sun ONE Application Server 7.0 has a built in web server.)

What the TradingXpert Installer Does

There are two TradingXpert installers: one for Application Server 6.5 environments and one for Application Server 7.0 environments. Each of these installers performs different operations.

Application Server 6.5 Environment

The TradingXpert installer sets up a directory structure and copies TradingXpert files into those directories (see "TradingXpert Directory Structure: Application Server 6.5"). The installer also registers TradingXpert with the Application Server, and (on Solaris platforms) modifies the Application Server classpath.

However, the installer does not perform any configuration of TradingXpert to inter-operate with ECXpert or the web server. Once TradingXpert software is installed, therefore, you have to manually perform the following configurations (see "Configuration Tasks (Application Server 6.5)" for Solaris and "Configuration Tasks (Application Server 6.5)" for Windows):

• modify the TradingXpert configuration file (FXproperties) to point to the root TradingXpert installation directory and to the ECXpert configuration file
• configure the web server instance used by TradingXpert to use the "TX" URL prefix required by TradingXpert
• copy TradingXpert map files, as needed, to the appropriate ECXpert map directory
• optionally, configure TradingXpert to run on a different host machine from ECXpert (as shown in "TradingXpert/ECXpert Configurations").

Application Server 7.0 Environment

TradingXpert installation places TradingXpert files into two directory trees (see "TradingXpert Directory Structure: Application Server 7.0"). It also modifies the TradingXpert configuration file (FXproperties) to point to the root TradingXpert installation directory and to the ECXpert configuration file.

Once the TradingXpert installer completes its work, you have to manually perform the following configurations (see "Configuration Tasks (Application Server 7.0)" for Solaris and "Configuration Tasks (Application Server 7.0)" for Windows):

• Windows only: deploy the TradingXpert Web Archive File (TX.war) using Sun ONE Application Server 7.0 tools
• copy TradingXpert map files, as needed, to the appropriate ECXpert map directory
• optionally, configure TradingXpert to run on a different host machine from ECXpert (as shown in "TradingXpert/ECXpert Configurations").

Installed TradingXpert Software

---

The software installed by the TradingXpert installer consists of a number of different modules, as described in "TradingXpert Software Modules," below. These modules are placed in a directory structure outlined in "Installed Directory Structure".

TradingXpert Software Modules

Table 1-2 identifies the software modules included with the TradingXpert product.

Table 1-2    TradingXpert Software Modules 

Module	Contents
Forms	HTML forms used to view standard EDI document types. These use tags to insert data.
Graphical User Interface (GUI)	HTML templates and code used to implement browser screens in TradingXpert's Trade Center user interface.
Java programs	Programs (and corresponding source code) that enable TradingXpert operations. Many of these use the ECXpert API to submit documents to ECXpert and to access and update data in the ECXpert Oracle database.
ECXpert API	An implementation of the ECXpert API that is used by TradingXpert's Java programs.
Maps	Software used to transform EDI-formatted documents to TradingXpert format (name-value pairs) and visa versa.
Logger	Software that tracks, logs, and reports TradingXpert activity.

Installed Directory Structure

The placement of files by the TradingXpert installer depends upon the version of application server in which TradingXpert is deployed:

• Sun ONE Application Server 6.5
• Sun ONE Application Server 7.0

The following sections show the installed directory structure for each.

TradingXpert Directory Structure: Application Server 6.5

Table 1-3 shows the installed directory structure for a TradingXpert installation. All subdirectories are under the TX_HOME directory (see "Directory Variable Conventions" for the definition of TX_HOME).

Table 1-3    TradingXpert Installed Directory Structure 

Subdirectory	Contents
./common	Common Java programs (and source) used to support all TradingXpert operations, including access to ECXpert and the ECXpert Oracle database. Also includes the TradingXpert configuration file (FXproperties).
./document	Java programs (and source) used to retrieve, manage, and process documents in response to Trade Center button clicks. Also includes a working directory for processing document files.
./events	Java programs (and source) used to support e-mail notification of inbound and outbound documents that have reached their expiration dates.
./forms/en_us	HTML forms and data for displaying documents: /default Location for default forms (.html) representing EDI document types, as well as rules files (.rules) used for document turnarounds and order files (.order) used to assist ECXpert mapping. Subdirectories can contain files customized to various partners. /from_scratch_data Data files (.dat) used to provide default values for from-scratch documents.
./login	Java programs (and source) used to log in to ECXpert and return the opening Trade Center screen.
./maps_etc	Map files and other assorted files used to support TradingXpert operations: /customization Sample customization files demonstrating creation of a new "cinfo" document type for processing by TradingXpert. /import Data files containing ECXpert setup information (memberships, partnerships, and service lists) used in testing TradingXpert installation. /map_sources Source code (in .zip format) that can be used to customize TradingXpert maps. /maps/platform Maps for all document types supported (by default) by TradingXpert, where platform is nt and/or solaris. /newmember Java programs (and source) used to support new member self-registration. /reports Java programs (and source) used to support tracking and reporting of document status. /sampledata Example data files to demonstrate various TradingXpert customizations.
./profile	Java programs (and source) used to access and update ECXpert membership information.
./templates/en_us	Dynamic HTML templates used to implement screens in the Trade Center user interface.
./tradeCenter	Java programs (and source) used to implement operations in the main Trade Center screen.
./users	Location for user-specific information. User-specific subdirectories contain files such as document templates created by users in the Trade Center user interface.
./web/en_us	Static HTML templates used to implement screens in the Trade Center user interface.

TradingXpert Directory Structure: Application Server 7.0

TradingXpert files are installed in two separate locations: a J2EE module directory and a TradingXpert application directory. In this structure, the TradingXpert Java programs that enable TradingXpert operations are placed in a different location than their corresponding source code, and customizable files are separated from static user interface components.

J2EE Module Directory

The J2EE module directory is created automatically when the TradingXpert Web Archive file (TX.war) is deployed to the application server. It contains the subdirectories shown in Table 1-4 within the following application server directory path:

Root_AS_Install/domains/domain1/appServer_instance/applications/
   J2EE-modules/TX_1

where Root_AS_Install is the root installation directory for the application server and appServer_instance is the name of an application server instance you create to support TradingXpert.

Table 1-4    Installed J2EE Module Directory Structure 

Subdirectory	Contents
./web/en_us	Static HTML templates used to implement screens in the Trade Center user interface.
./WEB-INF	Contains a web.xml file that references files installed in the TradingXpert application directory (Table 1-5) plus the following subdirectories: /classes Java program files that enable TradingXpert operations /lib ECXpert API libraries (ecxsdkjni.jar) used by Java program files.

TradingXpert Application Directory

The TradingXpert application directory structure is created when you install TradingXpert into a TX_HOME directory of your choice. Table 1-5 shows the installed subdirectory structure under TX_HOME:

Table 1-5    Installed Application Directory Structure 

Subdirectory	Contents
./config	Contains the TradingXpert configuration file (FXproperties).
./document	Working directory for processing document files.
./forms/en_us	HTML forms and data for displaying documents: /default Location for default forms (XSL stylesheets) representing EDI document types, as well as rules files (.rules) used for document turnarounds and order files (.order) used to assist ECXpert mapping. Subdirectories can contain files customized to various partners. /from_scratch_data Data files (.dat) used to provide default values for from-scratch documents.
./lib	ECXpert API native libraries.
./maps_etc	Map files and other assorted files used to support TradingXpert operations: /customization Sample customization files demonstrating creation of a new "cinfo" document type for processing by TradingXpert. /import Data files containing ECXpert setup information (memberships, partnerships, and service lists) used in testing TradingXpert installation. /map_sources Source code (in .zip format) that can be used to customize TradingXpert maps. /maps/platform Maps for all document types supported (by default) by TradingXpert, where platform is nt and/or solaris. /newmember Java programs (and source) used to support new member self-registration. /reports Java programs (and source) used to support tracking and reporting of document status. /sampledata Example data files to demonstrate various TradingXpert customizations.
./src	Source code corresponding to Java programs that enable TradingXpert operations: /document Source code for Java programs used to retrieve, manage, and process documents in response to Trade Center button clicks. /events Source code for Java programs used to support email notification of inbound and outbound documents that have reached their expiration dates. /login Source code for Java programs used to log in to ECXpert and return the opening Trade Center screen. /profile Source code for Java programs used to access and update ECXpert membership information. /tradeCenter Source code for Java programs used to implement operations in the main Trade Center screen.
./templates/en_us	Dynamic XSL style sheets used to implement screens in the Trade Center user interface.
./users	Location for user-specific information. User-specific subdirectories contain files such as document templates created by users in the Trade Center user interface.

Upgrading to Version 3.6.2

---

TradingXpert 3.6.2 is fully compatible with TradingXpert 3.6.1 and earlier versions, unless it is installed in a Sun ONE Application Server 7.0 environment. In that case, the software is installed in a different location, and any previously customized forms will not only need to be copied to the new location, but will also need to be modified as described in the TradingXpert Release Notes.

TradingXpert 3.6.2 is also compatible with ECXpert 3.6.1 and earlier versions, and with their respective versions of Oracle database.

When upgrading an earlier version of TradingXpert to Version 3.6.2, you should first back up all customized files, install Version 3.6.2, and then place the customized files in their correct respective locations in the TradingXpert or ECXpert directory structure.