|
Gateway Customization Guide Netscape Directory Server |
|
||
|
|
Chapter 3 File Controlling Gateway Functionality
This chapter provides examples of customized gateways. The chapter contains the following sections:
- Files Controlling Gateway Functionality
- Gateway .conf Files
- Gateway Search Configuration Files
- Object Class Templates
- Gateway Script Files
- Gateway Search Result Templates
- Banner Files
Files Controlling Gateway Functionality
To the gateway user, the gateway is a set of HTML forms that can be accessed from a web browser to communicate directly with the Directory Server over HTTP.
To the gateway administrator, the gateway is controlled by a set of files installed during Directory Server installation. These files can be edited to:
- Create new gateway instances
- Edit the object class attributes that define the entries users can add to the Directory
- Edit the search object class attributes that define how people search for and view entries in the LDAP directory
- Change the appearance of gateway forms
- Update the gateway with changes to Directory Server configuration
Files that control gateway functionality are described in Table 3-1.
Table 3-1 Gateway File Types and Locations
Define basic configuration parameters for the gateway and specifies the HTML and template directory. (See "Gateway .conf Files".)
Define how the gateway performs searches in the Directory. (See "Gateway Search Configuration Files".)
Define object classes and attributes for entry types. (See "Object Class Templates".)
Contain scripts used to communicate instructions to the Directory Server over HTTP. (See "Gateway Script Files".)
Define the filters used to display search results to the user. (See "Gateway Search Result Templates".)
Define appearance of colors, background, graphics on gateway forms. (See "Banner Files".)
A gateway's configuration file (
.conffile) describes an instance of the gateway. The file controls the host, port, root suffix, and Directory Manager to use when communicating with the Directory Server. The file also controls:
- The locations where new entries can be created within the directory
- The types of entries that can be created
- The search base
- Whether the gateway uses SSL communications
dsgw.confis the configuration file for the default gateway.dsgw.confis invoked at:http://adminHost:adminPort/clients/dsgw/bin/lang?context=dsgw
pb.confis the configuration file for Directory Express, a gateway customized as a directory lookup tool.pb.confis invoked at:http://adminHost:adminPort/clients/dsgw/bin/search?context=pb
Gateway configuration parameters are defined in Appendix A "Parameters Defined in the .conf File."
Gateway Search Configuration Files
Gateway search configuration files determine how the gateway queries information in the directory and returns search results to the users. Gateway search configuration files are stored in the serverRoot/clients/dsgw/config directory. All gateway instances for a Directory Server use these common search configuration files.
dsgwsearchprefs.conf
- This file specifies the object classes and object class attributes than can be searched.
dsgwfilter.conf
- This file specifies the search filters used to search for a particular object class. The gateway uses this file when performing a standard search operation.
The
dsgwsearchprefs.confanddsgwfilter.conffiles are discussed in Chapter 5 "Search Attributes, Filters, and Results."
The gateway contains a template file for each object class defined in the gateway. To modify how the gateway displays an entry type, edit the corresponding template file. To add gateway support for a new object class, create a new template file, or modify an existing one.
Modifying template files is discussed in Chapter 4 "Editing Entry Types."
Default gateway object class templates stored in the serverRoot/clients/dsgw/config directory are listed in Table 3-2.
Table 3-2 Default Template Files and Related Object Classes
Script files are used to dynamically generate HTML forms for the user, based on information supplied by the user and information retrieved from the Directory Server. Script files contain directives the gateway uses to construct the HTML for a page.
Script files can be modified to change the appearance of text that appears in fields, buttons, and prompts on gateway forms.
Script files used to modify the information provided on gateway forms are stored in the serverRoot/clients/dsgw/config directory and are identified in Table 3-3.
Table 3-3 Gateway Forms and Corresponding Script Files
csearchAttr.html
csearchBase.html
csearchMatch.html
csearchString.html
csearchType.html
Gateway Search Result Templates
Search result templates control how the results of a standard or advanced search are displayed when more than one entry is found. A separate search result file exists for each search object defined in
dsgwsearchprefs.conf.The default search result files installed in the serverRoot/clients/dsgw/config directory during Directory Server installation are shown in Table 3-4.
Table 3-4 Default Search Result Templates
Chapter 5 "Search Attributes, Filters, and Results" describes how search result templates can be edited to modify the display of search results.
Banner files identified in Table 3-5 are used to specify the banner and button images that appear in gateway forms.
Table 3-5 Banner Files Controlling Appearance of Gateway Forms
Chapter 6 "Customizing Graphics and Color" describes how to alter the color schemes and images appearing on gateway forms.
© 2001 Sun Microsystems, Inc. Portions copyright 1999, 2002-2003 Netscape Communications Corporation. All rights reserved.
Read the Full Copyright and Thrid-Party Acknowledgments.
Last Updated October 31, 2003