|
| Sun ONE Meta-Directory 5.1 Configuration and Administration Guide |
About This GuideThe Sun ONE Meta-Directory Configuration and Administration Guide describes how to set up and manage the Sun ONE Meta-Directory software. This includes installing and configuring the join engine and any connectors needed to integrate your choice of external data sources as well as information on how manage the system. This preface contains the following sections:
- What You are Expected to Know
- The Sun ONE Meta-Directory Documentation Set
- Organization of This Guide
- Documentation Conventions
- Where to Find Additional Information
What You are Expected to Know
This Configuration and Administration Guide is intended for use by system administrators. Before reading this guide, you should be familiar with Lightweight Directory Access Protocol (LDAP) as well as the Windows NT or the Solaris operating environment on the servers on which Meta-Directory is installed.
Before beginning to configure the Sun ONE Meta-Directory software, it is also assumed that you read the Sun ONE Meta-Directory Deployment Guide and install Meta-Directory software according to the instructions in the Sun ONE Meta-Directory Installation Guide.
The Sun ONE Meta-Directory Documentation Set
The Sun ONE Meta-Directory 5.1 documentation set includes the following materials:
- Sun ONE Meta-Directory Deployment Guide describes the Sun ONE Meta-Directory software and how to plan and implement a Sun ONE Meta-Directory software solution.
- Sun ONE Meta-Directory Installation Guide gives instructions on how to install the Sun ONE Meta-Directory software on both Solaris and Windows NT systems.
- Sun ONE Configuration and Administration Guide (this guide) documents how to set up and manage the Sun ONE Meta-Directory software. Configuring the join engine and components as well as managing the system from the console and the command-line are addressed.
- Release Notes include information about what is new in this release, last minute installation tips, known software limitations, and how to report problems.
Note Be sure to check the Meta-Directory documentation web site for updates to the release notes and for revisions of guides. Updated documents will be marked with the revision date.
Organization of This Guide
The Configuration and Administration Guide (this guide) has five parts:
- "Getting Started," gives an overview of Meta-Directory as well as the essential steps needed to configure the software. It also includes a sample configuration and a comparison of the graphical user interface for the Sun ONE Meta-Directory software and related Sun ONE products.
- "The Join Engine," explains the join engine and how to configure it to flow data. This includes a discussion of the join process, the join process rules and the data views necessary to implement them. There is also a chapter on procedures related directly to the Directory Server to which Meta-Directory is connected.
- "Meta-Directory Connectors," explains how to configure the data connectors provided with Meta-Directory. The concept and configuration of both indirect and direct connectors are discussed.
- "System Management," explains how to manage your Meta-Directory system. Logging and statistics, command-line administration, utilities, data servers and access permissions are included.
- "Appendices," contains reference information on the join process operators, the administration protocol, error messages and troubleshooting.
The table below lists and briefly describes the content of the Configuration and Administration Guide.
Documentation Conventions
In all Sun ONE Meta-Directory documentation, certain typographic conventions and terminology are used to simplify discussion and to help better understand the material.
Typographic Conventions
This book uses the following typographic conventions:
- Italic type is used within text for book titles, new terminology, emphasis, and words used in the literal sense.
- Monospace font is used for sample code and code listings, API and language elements (such as function names and class names), filenames, pathnames, directory names, HTML tags, and any text that must be typed on the screen.
- Italic serif font is used within code and code fragments to indicate variable placeholders. For example, the following command uses filename as a variable placeholder for an argument to the gunzip command:
gunzip -d filename .tar.gz
Terminology
Below is a list of the general terms that are used in the Sun ONE Meta-Directory documentation set:
- Meta-Directory refers to Sun ONE Meta-Directory software and any installed instances of the Sun ONE Meta-Directory software.
- Meta-Directory components refers to the collective set of Sun ONE Meta-Directory components and software you have installed and running on your system, including the join engine and any external data source connectors.
- External data source refers to any user data that originates outside of the core Meta-Directory components, whether the data is coming from another database, directory server, data file, or other source of data.
- Directory Server refers to an installed instance of Sun ONE Directory Server, iPlanet Directory Server and Netscape Directory Server.
The Sun ONE Meta-Directory software can synchronize data using any LDAPv2 and LDAPv3-compliant directory server, as long as the LDAP server supports a change log mechanism similar to the one implemented in Netscape Directory Server 4.1x. The term Directory Server refers to the instances of iPlanet Directory Server and Netscape Directory Server that you have installed to work with iPlanet Meta-Directory.
- Similarly the term Administration Server refers to an installed instance of iPlanet Administration Server, whether it be used with the Meta-Directory components or another iPlanet or Sun ONE server.
- NETSITE_ROOT is a variable placeholder for the home directory where you have installed the Sun ONE Meta-Directory software and any other iPlanet or Sun ONE servers installed into the same server group.
- The term flow is used rather loosely to refer to the process of synchronizing data between an external data source and the meta view. You "flow" data through a connector to the connector view and then "flow" it to the meta view. The contrary is also true, you "flow" data from the meta view back to the connector views and out to the external data sources.
Where to Find Additional Information
In addition to the Sun ONE Meta-Directory documentation set, you should be familiar with the documentation for products that are used in conjunction with it. Of particular interest are the Sun ONE Console and Sun ONE or iPlanet Directory Server documentation sets. This section lists additional sources of information you may find helpful as you use the Sun ONE Meta-Directory software.
Sun ONE Console Documentation
You can find the Sun ONE Console documentation at the following site:
http://docs.sun.com/db/prod/s1.ipconsole.2
iPlanet Directory Server Documentation
You can find the iPlanet Directory Server documentation at the following site:
http://docs.sun.com/db/prod/s1.ipdirs
Directory Server Developer Information
In addition to the Directory Server documentation, you can find information on Meta-Directory, LDAP, the iPlanet Directory Server, and associated technologies at the following Sun ONE developer sites:
http://www.sun.com/developers/
Other iPlanet or Sun ONE Product Documentation
Documentation for all iPlanet or Sun ONE servers and technologies can be found at the following web site:
http://docs.sun.com/db/prod/sunone
Sun ONE Technical Support
you can contact Sun ONE Technical Support through the following location: