Netscape logo Gateway Customization Guide
Netscape Directory Server                                                                                                                                  

Previous
Contents
Index
DocHome Next

 

Chapter 4      File Controlling Gateway Functionality

This chapter provides examples of customized gateways. The chapter contains the following sections:


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:

Files that control gateway functionality are described in Table 3-1.

Table 3-1    Gateway Files Types and Locations

Files

Function

Location

Gateway .conf files

Define basic configuration parameters for the gateway and specify the HTML and template directory. (See Gateway .conf Files.)

  serverRoot/clients/dsgw/context

Gateway search configuration files

Define how the gateway performs searches in the Directory. (See Gateway Search Configuration Files.)

serverRoot/clients/dsgw/config

Object class templates

Define object classes and attributes for entry types. (See Object Class Templates.)

serverRoot/clients/dsgw/config

Gateway script files

Contain scripts used to communicate instructions to the Directory Server over HTTP. (See Gateway Script Files.)

serverRoot/clients/dsgw/config

Gateway search result templates

Define the filters used to display search results to the user. (See Gateway Search Result Templates.)

serverRoot/clients/dsgw/config

Banner files

Define appearance of colors, background, graphics on gateway forms. (See Banner Files.)

serverRoot/clients/dsgw/html


Gateway .conf Files


A gateway's configuration file (.conf file) describes an instance of the gateway. The file controls the host, port, root suffix, and Directory Manager when communicating with the Directory Server. The file also controls:


dsgw.conf

dsgw.conf is the configuration file for the default gateway. dsgw.confis invoked at:

http://adminHost:adminPort/clients/dsgw/bin/lang?context=dsgw


pb.conf

pb.conf is the configuration file for Directory Express, a gateway customized as a directory lookup tool. pb.conf is 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.

The dsgwsearchprefs.conf and dsgwfilter.conf files are discussed in chapter 5, "Search Attributes, Filters, and Results."


Object Class Templates


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 Styles and Related Object Classes

Template File

Related Object Class

display-dc.html

domain

display-country.html

country

display-group.html

groupOfNames

display-groupun.html

groupOfUniqueNames

display-ntgroup.html

ntGroup

display-ntperson.html

ntUser

display-org.html

organization

display-orgperperson.html

inetOrgPerson

display-orgunit.html

organizationalUnit

display-person.html

person


Gateway Script Files


Script files are used to generate HTML forms dynamically 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

Set of Forms

Corresponding Script Files

Authentication forms

authPassword.html
authSearch.html

Standard search forms

searchString.html

Advanced search forms

csearchAttr.html
csearchBase.html
csearchMatch.html
csearchString.html
csearchType.html

Newentry forms

newentry.html
newentryType.html
newentryName.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

Search Result Template

Related Object Class

list-Anything.html

Anything

list-Auth.html

Auth (internal)

listDomaincomponent.html

Domain

list-Groups.html

Groups

list-NT-Groups.html

NT-Groups

list-NT-People.html

NT-People

list-Org-Units.html

Org-Units

list-Organizations.html

Organization

list-People.html

People

Chapter 5, "Search Attributes, Filters, and Results," describes how search result templates can be edited to modify the display of search results.


Banner Files


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 the Appearance of Gateway Forms

 

Banner File

Controls Appearance of Banner and Buttons in ...

maintitle.html

Main form

authtitle.html

Authentication form

csearchtitle.html

Advanced search forms

newentrytitle.html

New entry forms

searchtitle.html

Standard search form

display-*.html

View or edit entry forms

Chapter 6, "Banner Image," describes how to alter the color schemes and images appearing on gateway forms.



Previous
Contents
Index
DocHome Next

© 2001 Sun Microsystems, Inc. Portions copyright 1999, 2002-2004 Netscape Communications Corporation. All rights reserved.
Read the Full Copyright and Third-Party Acknowledgments.

last updated November 26, 2004