About this Book

This handbook documents the conceptual, structural, and operational components of the iPlanet Partner Agent for ECXpert Server. It also provides a description of the functionality and guidelines for administering the system.

The following topics are discussed in this section:

• Before You Begin



• The ECXpert Documentation Set



• Audience and Roles



• Organization



• Conventions Used in This Guide

Before You Begin

---

This Handbook is written with the assumption that you understand the basics of TCP/IP communications and operating system on which you are running this software.

It is not necessary to be an expert concerning the technical intricacies of HTML or the World Wide Web, but it is helpful to understand the basic concepts of both.

Downloading Updated Documentation

We continuously update ECXpert documentation. Follow these steps to:

• Determine whether you have the latest version of any ECXpert document



• Download a copy of any ECXpert document



• Obtain a user ID and password for ProductTracker by SubscribNet.




If you do not know where to start, display the ProductTracker by SubscribNet home page at the URL below:



http://home.netscape.com/support/producttracker/index.html



The information provided on this page should let you determine the contact person at your company who can provide you with the user ID and password. If that person is you, and you have not received this information, call the Netscape Customer Support phone number that is provided.



• Display the ProductTracker by SubscribNet web page.




The URL is...
http://subscribnet.netscape.com/



• Enter your Subscribnet user ID and password.




The main Subscribnet page is displayed.



• Click the link in "Click here to access your software."




An index of the Netscape and iPlanet software registered for your user ID is displayed.



• Click the "iPlanet ECXpert" link.




A page is displayed that asks you to select the version and platform.



• Locate the link for your version, platform, and domestic vs. export combination.




First locate Version Beta, and then find Solaris, for Export or Domestic (US/CAN) sale, as appropriate.



• Click the link you have located.




A list of all the downloads available for ECXpert, including documentation, is displayed.



• Locate the title in the ECXpert document set that you want.



• Compare dates.




Compare the date for that title with the date in the footers in your copy of the same document.



If these dates are the same, you already have the latest version of the documentation.



• If your documentation is outdated, click the download link.




If the date in the footers of the documentation you have is earlier than the date for the same document on the screen, you should download the updated version.

Suggested Supplementary Reading

The following documents may be helpful as supplements to this handbook:

• The iPlanet Partner Agent for ECXpert Windows Client User's Guide, for information about installing and using the Partner Agent Windows Client



• For ECXpert technical support, always visit the iPlanet Online Support website at
  http://www.iplanet.com/support/online



• Your operating system manuals, particularly any pertaining to system security

The ECXpert Documentation Set

---

You may wish to refer to other ECXpert books for additional information. This section discusses each book in the ECXpert documentation set.

Release Note

After you receive the ECXpert software, before you do anything else, you should download the ECXpert Release Note. See "Downloading Updated Documentation" for instructions on downloading the latest release note.

The Release Note contains:

• A list of bugs fixed in the current release



• Warnings and workarounds for known problems



• Additional important information you should know before you install or use ECXpert

The Release Note is platform-specific, so make sure you have the right version for the platform you're using.

Getting Started Guide

The ECXpert Getting Started Guide is the book you use to install ECXpert. It includes preinstallation tasks—including basic instructions for installing or upgrading to the required version of Oracle—ECXpert installation steps, and information on additional tasks you may wish to perform after you install ECXpert. The Getting Started Guide is platform-specific, so make sure you have the right version for the platform you're using.

Administrator's Handbook

The ECXpert Administrator's Handbook is written for the ECXpert System's site administrator. This book provides an overview of the ECXpert system and uses specific examples, or "scenarios," to illustrate the different ways in which ECXpert can be used most effectively in a wide variety of different business situations. It also covers the ECXpert Server Administrative Interface in depth, discusses the ECXpert command line utilities, and explains how to integrate ECXpert with SAP and MQSeries.

Developer's Handbook

The ECXpert Developer Handbook book is written for C++ developers who want to customize ECXpert. It primarily documents the ECXpert APIs which give C++ applications full access to the database. This includes detailed documentation of each class, each method in each class, and code examples. It also documents the complete database schema.

Operations Reference Manual

If you ever have difficulty using ECXpert, the ECXpert Operations Reference Manual more than likely documents a quick resolution. This book contains basic troubleshooting guidelines for ECXpert, other Netscape products, and third-party products. It also includes a complete error message reference.

Audience and Roles

---

This handbook is written for the Partner Agent Server's site administrator. All documentation needed by Partner Agent Windows Client users is supplied in the Partner Agent for ECXpert Windows Client User's Guide.

Organization

---

This handbook is structured as follows:

Part 1:The Partner Agent Server

Chapter 1:Introducing the iPlanet Partner Agent for ECXpert Server

This chapter introduces the iPlanet Partner Agent for ECXpert family of applications and describes the major features and concepts of the Partner Agent Server.

Chapter 2:Command Line Utilities

This chapter describes Partner Agent Server's command line utilities.

Part 2:(Optional) Using the Server Administration System

Chapter 3:(Optional) Using the Administration System

This chapter describes the administration system that is used to configure and maintain Partner Agent Server.

Chapter 4:(Optional) Using the Master Server Controls

This chapter explains how to turn the Partner Agent Server on and off, control the display of messages to users, revert the Server configuration to a previous version, and control access to users by their account type.

Chapter 5:(Optional) Using the Server Access Controls

This chapter explains how to control access to the Partner Agent Server and the Partner Agent Server administration system.

Chapter 6:(Optional) Using the Server Security Controls

This chapter describes how to configure security settings for Partner Agent Server, enable or disable FTP commands, and perform audits.

Chapter 7:(Optional) Using the Server Statistics Controls

This chapter explains how to view server traffic, configure which statistics are logged, generate statistics, and view previously generated statistics.

Chapter 8:(Optional) Using the Server ActiveAgents

This chapter explains how to set up server side programs that are triggered by user activity on the Server.

Part 3:Appendices

Appendix A:(Optional) Installing a Stand-alone FileDrive Server

This chapter describes how to install the stand-alone FileDrive Server, which optionally can be used to exchange files with the Partner Agent Server, and consequently with ECXpert, through a firewall.

Appendix B:(Optional) Using the Partner Agent Server Command Line Client

This appendix explains how to install the Partner Agent Server Command Line Client, how to start the client, and the commands and options available.

Index

The index lists important terms and page numbers where information about those terms appears in the text.

Conventions Used in This Guide

---

The Partner Agent Server administration system is a series of HTML pages that are referred to as pages, for example the Active Agents page. Within each page are sections, where the various controls for setting up and configuring Partner Agent Server are located.

This guide is meant to be used as a reference, so there is some repetition of similar tasks. For example editing and deleting list entries is identical in many pages, but is described in each page's description.

The following conventions are used in this guide.

Generic Names

The Partner Agent Server and the Partner Agent Client are sometimes referred to as Partner Agent. The Partner Agent Server administration system is sometimes referred to as the admin system.

The base directory that houses all of the components of Partner Agent Server is, by default, $NSBASE/NS-apps/paserver, where the environment variable $NSBASE is the full path to the ECXpert installation directory. This location will be different if you install Partner Agent Server on a different machine than ECXpert.

Typographic Conventions

A number of typographic conventions are used throughout this manual to help you recognize special terms and instructions. These conventions are summarized in the table below.

Convention	Meaning	Example
numbered steps	higher level descriptions of tasks you perform (more detailed instructions follow)	1. Enter the group information. Enter the name in the Group Name field, and a short description in the Description field.
italics	key words, such as terms that are defined in the text	The notices posted on an electronic BBS are called articles.
	names of books	For more information, refer to the ECXpert Getting Started Guide.
	variables In command syntax, items in italics are not literals.	usrlogin=login You must substitute valid values for italicized items.
courier font	file names	The associated data is stored in the Dispatcher section of the bdg.ini file.
	text file content (HTML templates, config files)	<TITLE>Password Check</TITLE> <IMG SRC="/ui/icons/hd_svcs.gif">
	code samples and command line output	Syntax const char* getName() const
courier bold	command line input, to be entered by the user	Enter the following command: ls *.mle
# or fdx>	command line prompt	fdx> sslmode tun
square brackets, [...]	In command syntax, items within square brackets are optional.	In the following example: nsusrgrp [-v] insert [-l] -k key arguments -r act=relation action, usrid=ID | userlogin=login -v and -l are optional. You may specify either usrid or usrlogin. You must substitute valid values for italicized items.
vertical line (|)	In command syntax, items on either side are valid alternatives.
em dash (—)	"none" or "nothing"	Arguments      —