Chapter 1 Introduction

This chapter provides an overall introduction to installing the ECXpert product. It covers the following topics:

Sun ONE Integration Server B2B Software Dependencies

The following sections describe the relationship between ECXpert, TradingXpert, and external software systems these two products depend on, and discuss possible ECXpert/TradingXpert configurations.

ECXpert Software Dependencies

To manage document exchange between trading partners, ECXpert depends on a number of external software systems. Figure 1-1 illustrates the relationship between ECXpert and the following systems:

Communications agent support Some ECXpert communications agents depend on additional software support that you must install. For example, if you’re using JMS, you need to install the Sun™ ONE Message Queue product; if you are using e-mail (SMTP) communications, then an external mail server is necessary; or, if you are using ebXML communications, you must install Sun ONE Secure Trading Agent (STA) software. For additional information, see Table 1-1.

Oracle DBMS An Oracle� database system is required to store data about members (users), trading partnerships, and the processing of document exchanges by ECXpert.

LDAP server (optional) You can also store member (user) information in an LDAP server instead of in the Oracle database.

Web server ECXpert uses a browser-based administration console that requires Web server support. A web server is also required for other HTTP-based ECXpert communication agents.

Data transformation software ECXpert uses two engines for transforming data exchanged by trading partners: a built-in XML Style Sheet Translator (XSLT) for transforming XML documents, and Mercator software, which is automatically installed, for transforming incoming Electronic Data Interchange (EDI) or XML formatted documents.

ECXpert 3.6.3 is supported on Solaris and Windows operating systems and platforms. The hardware and software requirements for these platfoms are specified in the platform certification matrix.

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-2:

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.

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.1).

The ECXpert 3.6.3 platform certification matrix available at http://docs.sun.com, contains information about the supported versions for TradingXpert software dependencies, including those illustrated in Figure 1-2.

TradingXpert 3.6.3 is supported on Solaris and Windows operating systems and platforms. The hardware and software requirements for these platfoms are specified in the ECXpert 3.6.3 platform certification matrix.

ECXpert/TradingXpert Configurations

When installing TradingXpert, there are two basic configurations (see Figure 1-3): TradingXpert and EECXpert 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.

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). Both machines in this setup need to run the same operating system.

About the Sun ONE Integration Server B2B Installer

The Sun ONE Integration Server B2B 3.6.3 Installer allows you to install the ECXpert and TradingXpert component products together or separately. The following sections describe dependent software you should install prior to installating the component products, and what the Sun ONE Integration Server B2B 3.6.3 Installer does when installing the two component products:

About the ECXpert Installer

You can install the ECXpert 3.6.3 product from the Sun ONE Integration Server, B2BEdition CD-ROM set. For detailed instructions, see the procedures in subsequent chapters.

Installer Dependencies

While a number of external software systems are needed to run ECXpert (see ECXpert Software Dependencies), the ECXpert installer requires only the Oracle database and a web server in order to complete successfully.

Nevertheless, it is strongly recommended that other software systems on which ECXpert depends be installed prior to running the ECXpert installer. This allows the installer to configure ECXpert to run with these systems. It is recommended, for example, that the following software be installed before installing ECXpert:

What the ECXpert Installer Does

About the TradingXpert Installer

You install the TradingXpert 3.6.3 product using the software distribution provided on the Sun ONE Integration Server, B2B Edition CD-ROM set. For detailed instructions, see the 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

If you plan on installing TradingXpert on a separate machine, make sure you have a functioning ECXpert installation (including its associated Oracle database). Otherwise, if you plan on installing ECXpert and TradingXpert on the same machine, you only need to have an Oracle database for the combined installation of ECXpert and TradingXpert.

For more information, see ECXpert/TradingXpert Configurations.

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

TradingXpert installation places TradingXpert files into two directory trees (see Installed TradingXpert Directory Structure). The installation modifies the TradingXpert configuration file (TXproperties) to point to the root TradingXpert installation directory and to the ECXpert configuration file. It also deploys the TradingXpert Web Archive File (TX.war) to the Sun ONE Application Server.

Once the TradingXpert installer completes its work, you have to manually perform the following configurations in TradingXpert Configuration Tasks.

Installed Sun ONE Integration Server B2B Software

Depending on your choice of components, the Sun ONE Integration Server Installer can install the following on your machine:

Installed ECXpert Software

ECXpert Software Modules

Table 1-1 ECXpert Software Modules
Module	Contents
Communications agents	Processes that enable document delivery between business partners over various communication protocols: FTP, SMTP, HTTP, JMS, ebXML and so forth.
Dispatcher	The central software engine that manages document translation and exchange between business partners.
Translator	Software used to translate documents being exchanged between business partners: Mercator is used to transform Electronic Data Interchange (EDI) documents, and an XSLT translator is used to transform XML documents.
Scheduler	Software used to schedule the receipt of input documents and the sending of output documents.
Database access software	Software that provides access to an Oracle database.
Administration	An administration server and cgi scripts used to support browser-based administration of ECXpert.
ECXpert SDK	A software development kit used by programmers to access ECXpert functions directly.

Installed ECXpert Directory Structure

Table 1-2 shows the installed directory stucture for an ECXpert installation. All subdirectories are under the directory referenced by the BDGHOME environment variable (See Table 3), namely:

where Root_ECX_install corresponds to the directory in which ECXpert was installed.

Table 1-2 Installed Directory Structure
Subdirectory	Contents
./UI	HTML files used principally for ECXpert’s browser-based administration
./bin	ECXpert binaries
./bin/jms	Sun ONE MQ implementation libraries for use by jms client that’s built in to ECXpert.
./bin/ebxml/	Files used by ebXML Agent demonstration program.
./bin/ebxml/test	ebXML Agent demonstration program.
./certificates	Location used for exported and imported certificate files
./cgi-bin	ECXpert cgi binaries used for ECXpert’s browser-based administration
./config	ECXpert configuration files, such as ecx.ini
./data	Contains subdirectories used to store temporary files. The most important subdirectories are: /log location for log files written by the administration server /work locations where work files are created and then deleted /input location of received files waiting to be translated /output location of translated files and other output files waiting to be sent
./dbadmin	Oracle SQL scripts
./ecxsdk	API library files, sdk binaries, documentation, and other files that comprise the ECXpert SDK
./legacy	Map files used for exchanges with legacy applications, such as SAP
./lib	ECXpert libraries
./maps	Mercator mapping files
./mercsdk	Mercator software program files (Solaris only)
./smtp	Files used by the SMTP communications agent
./snmp	Files used by an external management application for monitoring ECXpert resources
./servlet	Solaris only: servlets and other information required for exchanges using Automotive Industry Accreditation Group (AIAG) formats
./dtd	Solaris only: contains dtd’s required for exchanges using Automotive Industry Accreditation Group (AIAG) formats

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” on page 25.

TradingXpert Software Modules

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

Table 1-3 TradingXpert Software Modules
Module	Description
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 TradingXpert Directory Structure

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 (TXproperties).
./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.

ECXpert User Accounts

You must make sure that software is installed under user accounts that allow ECXpert to function properly with its dependent software. Default values for these accounts depend on the installation platform.

ECXpert admin user This is the account under which ECXpert is installed and administered. By default, the account name is ecxadmin.

Oracle administrator This is the account under which the Oracle database is installed and administered.

ECXpert Oracle user This is the account under which ECXpert accesses the Oracle database. By default, the account name is ECX36.

Web server administrator This is the account under which the Web server is installed and administered. It should be the same as the ECXpert administrator account.

SMTP mail user This is the account under which ECXpert accesses the SMTP (Pop3) mail server. On Solaris, if you use SendMail, you don’t need to set up this account.

Upgrading to ECXpert Version 3.6.3

3.6.3 is fully compatible with ECXpert 3.6.2 (except for Mercator data transformation issues). However, ECXpert 3.6.3 is generally not compatible with ECXpert 3.5 or earlier versions, largely because of changes in internal and external data formats and because of the version of Oracle database supported by ECXpert 3.6.3.

Appendix A, "Upgrading to ECXpert 3.6.3." describes the upgrade process from ECXpert 3.6.2 to ECXpert 3.6.3. Please consult the ECXpert Release Notes for additional information about upgrading from earlier versions.

When upgrading an earlier version of ECXpert to Version 3.6.3, you must be careful not to over-write important configuration and data files. ECXpert maintains configuration, membership, and partnership data, as well as information stored in the Oracle database tables, that will be lost if you are not careful about how you perform an upgrade. For this reason it is recommended that you not try to install ECXpert 3.6.3 over earlier versions, without first reading the detailed steps for performing an upgrade, as provided in Appendix A, "Upgrading to ECXpert 3.6.3."

For information on how to upgrade TradingXpert 3.6.2 to TradingXpert 3.6.3, see the ECXpert Release Notes.

Previous Contents Index Next
IS B2B: ECXpert and TradingXpert 3.6.3 Installation Guide