Preface
This book explains how to install Sun™ Open Net Environment (Sun ONE) Integration Server, B2B Edition software (ECXpert 3.6.2). This preface contains the following sections:
Audience for This Guide
The audience for this guide is ECXpert administrators who wish to install an ECXpert system.
Organization of This Guide
All users should read the introduction and then the appropriate platform-specific chapter. The following table briefly describes the contents of each chapter.
Conventions
This section provides information about the conventions used in this document.
Text Conventions
Table 2 Document Conventions
|
Format
|
Description
|
|
italics
|
Italicized text represents a placeholder. Substitute an appropriate clause or value where you see italic text. Italicized text is also used to designate a document title, for emphasis, or for a word or phrase being introduced.
|
monospace
|
Monospace text represents example code, commands that you enter on the command line, directory, file, or path names, error message text, class names, method names (including all elements in the signature), package names, reserved words, and URL's.
|
[]
|
Square brackets to indicate optional values in a command line syntax statement.
|
|
ALL CAPS
|
Text in all capitals represents file system types (GIF, TXT, HTML and so forth), environment variables (IMQ_HOME), or acronyms (ECXpert, JSP).
|
|
Key+Key
|
Simultaneous keystrokes are joined with a plus sign: Ctrl+A means press both keys simultaneously.
|
|
Key-Key
|
Consecutive keystrokes are joined with a hyphen: Esc-S means press the Esc key, release it, then press the S key.
|
Environment Variable Conventions
ECXpert documentation makes use of a directory variable whose value depends on the platform on which ECXpert is installed. Table 3 describes this variable and explains how it is used.
Table 3 ECXpert Environment Variables
|
Variable
|
Description
|
|
BDGHOME
|
This is an ECXpert environment variable that specifies the location of the ECXpert installed software.
BDGHOME = Root_ECX_Install/NS-apps/ECXpert
Root_ECX_Install is the root installation directory of ECXpert software.
On Windoes NT or Windows 98, if you installed ECXpert in the C:\Apps\ directory, the value of BDGHOME would be
C:\Apps\NS-apps\ECXpert
On Solaris, if you installed ECXpert in the directory MyECX, the value of BDGHOME would be
/MyECX/NS-apps/ECXpert
|
In this guide, BDGHOME is shown without platform-specific environment variable notation or syntax (for example, $BDGHOME on UNIX).
Other Documentation Resources
In addition to this guide, ECXpert provides additional documentation resources.
The ECXpert Documentation Set
The documents that comprise the ECXpert documentation set are listed in Table 4 in the order in which you would normally use them.
Table 4 ECXpert Documentation Set
|
Document
|
Audience
|
Description
|
|
ECXpert Installation Guide
|
Administrators
|
Explains how to install ECXpert software on Solaris and Windows platforms.
|
|
ECXpert Release Notes
|
Administrators and developers
|
Includes descriptions of new features, limitations, and known bugs, as well as technical notes.
|
|
ECXpert Administrator's Guide
|
Users, administrators, developers
|
Explains the concepts, structure, and operation of ECXpert. It also describes ECXpert functions and provides guidelines for administering the system.
|
|
ECXpert Developer's Guide
|
Developers
|
Describes the concepts, interface and underlying data organization of the ECXpert Software Developer's Kit and the Java™ Native Interface API Class Library.
You only need to use this manual if you are running command line utilities or you are developing C++ programs that submit files to ECXpert or access the ECXpert database.
|
|
ECXpert Operations Reference Guide
|
Adminstrators
|
Explains the operational issues in managing ECXpert. It also provides a reference on error messages that can be generated by ECXpert or passed through from third-party software components that ECXpert uses.
|
