Complete Contents
Preface
Chapter 1 Gateway Features
Chapter 2 Setting Up the Gateway
Chapter 3 Gateway Localization
Chapter 4 Files Controlling Gateway Functionality
Chapter 5 Entry Types and Object Class Attributes
Chapter 6 Search Attributes, Features, and Results
Chapter 7 Customizing Color and Graphics
Appendix A .conf Parameters
Appendix B Gateway Directives Reference
Appendix C CGI Usage
Appendix D Gateway User Help
Previous Next Contents Index


Chapter 4 Files Controlling Gateway Functionality

This chapter describes gateway components. Topics covered include:


An Overview of Gateway File Types
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 LDAP 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 4.1.

Table 4.1 Gateway File Types and Locations

File Types
What They Do
Location
Gateway .conf files
Define basic configuration parameters for the gateway and specifies the HTML and template directory.
<NSHOME>/dsgw/context

Gateway search configuration files
Define how the gateway performs searches in the Directory.
<NSHOME>/dsgw/config
Gateway search result templates
Define the filters used to display search results to the user.
<NSHOME>/dsgw/config
Object class templates
Define object classes and attributes for entry types.
<NSHOME>/dsgw/config
Gateway script files
Contain scripts used to communicate instructions to the Directory Server over HTTP.
<NSHOME>/dsgw/config
Banner files
Define appearance of colors, background, graphics on gateway forms.
<NSHOME>/dsgw/html


Gateway .conf Files
A gateway's .conf file describes the gateway's instance. A gateway's .conf file controls the host, port, root suffix, and Directory Manager to use when communicating with the Directory Server. It also controls

 dsgw.conf

The configuration file for the default gateway, dsgw.conf, is invoked at

http://<adminhost:adminport>/dsgw/bin/lang?context=dsgw

pb.conf

The configuration file for Directory Express, pb.conf, is a gateway customized as a directory lookup tool. pb.conf is invoked at

http://<adminhost:adminport>/dsgw/bin/search?context=pb

See Also

Gateway configuration parameters are defined in Appendix A, ".conf Parameters."


Gateway Search Configuration Files
Gateway search configuration files determine how the gateway queries information in the Directory and returns search results to users. gateway search configuration files are stored in the dsgw/config directory. All gateway instances for a Directory Server use these common search configuration files.

 dsgwsearchprefs.conf

The object classes and object class attributes than can be searched are specified in dsgwsearchprefs.conf.

See Also

dsgwsearchprefs.conf is discussed in Chapter 6, "Search Attributes, Filters, and Results."

dsgwfilter.conf

The search filters used to search for a particular object class are specified in dsgwfilter.conf. The gateway uses this file when performing a standard search operation.

See Also

dsgwfilter.conf is discussed in Chapter 6, "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.

See Also

Modifying template files is discussed in Chapter 5, "Entry Types and Object Class Attributes."

Default gateway object class templates stored in the dsgw/conf directory are listed in Table 4.2.

Table 4.2 Default Template Files and Related Object Classes

Template File
Related Object Class
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 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 identified in Table 4.3.

Table 4.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
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 dsgw/config directory during Directory Server installation are shown in Table 4.4.

Table 4.4 Default Search Result Templates

Search Result Template
Related Object Class
list-Anything.html
Anything
list-Auth.html
Auth (internal)
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

See Also

Chapter 6, "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 4.5 are used to specify the banner and button images that appear in gateway forms.

Table 4.5 Banner Files Controlling Appearance of Gateway Forms

Banner Files
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

See Also

Chapter 7, "Customizing Graphics and Color," describes how to alter the color schemes and images appearing on gateway forms.

 

© Copyright 1999 Netscape Communications Corporation