Gateway Customization GuideRed Hat Directory ServerVersion 7.1April 2005
10 Red Hat Directory Server Gateway Customization Guide • April 2005Arguments for ELSE and ENDIF . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction108 Red Hat Directory Server Gateway Customization Guide • April 2005Structure of an HTML TemplateDirectory entry display, edit, and add t
Context-Related DirectivesAppendix B Gateway Directives 109Context-Related DirectivesThe context-related directives GCONTEXT and PCONTEXT appear withi
Entry-Related Directives110 Red Hat Directory Server Gateway Customization Guide • April 2005Entry-Related DirectivesEntry-related directives are supp
Entry-Related DirectivesAppendix B Gateway Directives 111type=how-to-display. Renders the attribute on-screen in a particular format. Legal values des
Entry-Related Directives112 Red Hat Directory Server Gateway Customization Guide • April 2005defaultvalue=default-value. Supplies a default value for
Entry-Related DirectivesAppendix B Gateway Directives 113cols=number, cols=+number, cols=>number. Controls the width of the displayed attribute. If
Entry-Related Directives114 Red Hat Directory Server Gateway Customization Guide • April 2005DS_OBJECTCLASSDescribes the type of directory entries for
Entry-Related DirectivesAppendix B Gateway Directives 115DS_SORTENTRIESSpecifies that entries should be sorted; typically used within list templates.
Entry-Related Directives116 Red Hat Directory Server Gateway Customization Guide • April 2005DS_EDITBUTTONDisplays a button which, when clicked, bring
Entry-Related DirectivesAppendix B Gateway Directives 117<!-- DS_SAVEBUTTON "checksubmit=formDataValid()" -->DS_EDITASBUTTONDisplays a
11domodify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Entry-Related Directives118 Red Hat Directory Server Gateway Customization Guide • April 2005DS_OLDPASSWORDDisplays an HTML password field for the old
Entry-Related DirectivesAppendix B Gateway Directives 119ArgumentsNone.DS_END_ENTRYFORMCauses the gateway to emit a </FORM> tag. This directive
Entry-Related Directives120 Red Hat Directory Server Gateway Customization Guide • April 2005ArgumentsNone.DS_ATTRVAL_SETDisplay an attribute based on
Entry-Related DirectivesAppendix B Gateway Directives 121Examples<!-- IF "!DirectoryIsLocalDB" -->The entry was last modified by <!
Miscellaneous Directives122 Red Hat Directory Server Gateway Customization Guide • April 2005Miscellaneous DirectivesBODYEmit HTML <BODY> elemen
Miscellaneous DirectivesAppendix B Gateway Directives 123ENDHTMLEmit </BODY></HTML> sequenceArgumentsNone.HELPBUTTONDisplay a Help button
Miscellaneous Directives124 Red Hat Directory Server Gateway Customization Guide • April 2005Argumentsfilename. The name of the file to include. This
Miscellaneous DirectivesAppendix B Gateway Directives 125DS_GATEWAY_VERSIONEmit a string containing the version of the directory gateway CGI being exe
Miscellaneous Directives126 Red Hat Directory Server Gateway Customization Guide • April 2005
127Appendix CCGI UsageThis appendix provides regular expression-type descriptions of the ways to invoke the CGIs in script files. Each regular express
12 Red Hat Directory Server Gateway Customization Guide • April 2005
128 Red Hat Directory Server Gateway Customization Guide • April 2005searchType = SEARCHTYPEsearchAttr = SEARCHATTRunauthunauth[?conetxt=CONTEXT]dnedi
Appendix C CGI Usage 129newentrynewentry[?context=CONTEXT[&file=FILE]]entrytype = ETentryname = ENrdntag = RDNTAGselectLocation = SLdnsuffix = DNS
130 Red Hat Directory Server Gateway Customization Guide • April 2005
131IndexAAdvanced searchattributes for 69example of pop-up menu 71Attributesadding to object classes 61deleting from object classes 61auth CGI 127Auth
132 Red Hat Directory Server Gateway Customization Guide • April 2005DS_ATTRVAL_SET 120DS_BEGIN_DNSEARCHFORM 120DS_BEGIN_ENTRYFORM 119DS_CLOSEBUTTON 1
Index 133setting suffix for adding entries 39setting up SSL support 40Gateway configuratoncustomizing Communicator’s LDAP settings 42Gateway files.con
134 Red Hat Directory Server Gateway Customization Guide • April 2005NName translation mapping 33newentry CGI 129newtype parameter 56, 100NLS paramete
Index 135creating new 75Search preferencesextending 74Search result templatescustomizing 78default templates and related object classes 53modifying 80
136 Red Hat Directory Server Gateway Customization Guide • April 2005
List of Tables 13List of TablesTable 2-1 Location of Gateway Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17PrefaceThe descriptions, instructions, and examples in this guide can be used to create and modify a gateway instance to suit the needs of users in
14 Red Hat Directory Server Gateway Customization Guide • April 2005
Gateway Customization Guide April 2005iExamplesHTML and configuration directories specified in pb.conf ... 6Emb
ii Red Hat Directory Server Gateway Customization Guide
Conventions Used in This Book18 Red Hat Directory Server Gateway Customization Guide • April 2005Conventions Used in This BookThis section explains th
Related InformationPreface 19• Red Hat Directory Server Deployment Guide. Provides an overview for planning your deployment of the Directory Server. I
Related Information20 Red Hat Directory Server Gateway Customization Guide • April 2005
21Chapter 1IntroductionThis chapter describes the gateway functionality of Red Hat Directory Server (Directory Server). The chapter contains the follo
What Is a Gateway?22 Red Hat Directory Server Gateway Customization Guide • April 2005Gateways Installed with Directory ServerTwo gateway instances ar
Directory Express and Default GatewayChapter 1 Introduction 23Directory ExpressThe configuration file for Directory Express is serverRoot/clients/dsgw
Red Hat, Inc.1801 Varsity Drive Raleigh NC 27606-2072 USA Phone: +1 919 754 3700 Phone: 888 733 4281 Fax: +1 919 754 3701 PO Box 13588 Research Triang
Directory Express and Default Gateway24 Red Hat Directory Server Gateway Customization Guide • April 2005Figure 1-1 Directory Express: Search Result F
Support for Multiple Gateway InstancesChapter 1 Introduction 25Default Gateway (dsgw.conf)In addition to the standard search form, the default gateway
Support for Multiple Gateway Instances26 Red Hat Directory Server Gateway Customization Guide • April 2005Specifying Gateway Configuration to Gateway
Anonymous and Non-Anonymous SearchingChapter 1 Introduction 27http://adminHost:adminPort/clients/dsgw/bin/lang?context=<context>The default gate
Automatic Updates to Directory Configuration28 Red Hat Directory Server Gateway Customization Guide • April 2005The updatedsgw script runs automatical
29Chapter 2Setting Up the GatewayThis chapter describes the planning decisions and tasks required to install and initially configure a gateway for acc
Gateway Installation Planning30 Red Hat Directory Server Gateway Customization Guide • April 2005Two gateway instances are installed during Directory
Gateway Installation PlanningChapter 2 Setting Up the Gateway 31Protecting Bind DN and PasswordThe gateway configuration files reference files that co
HTTP Server Configuration32 Red Hat Directory Server Gateway Customization Guide • April 2005There are many factors affecting gateway performance on a
HTTP Server ConfigurationChapter 2 Setting Up the Gateway 33Name Translation MappingThe HTTP server uses Name Translation mapping to translate a virtu
3ContentsList of Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HTTP Server Configuration34 Red Hat Directory Server Gateway Customization Guide • April 20052. Adding the following CGI directories (under Program Ma
HTTP Server ConfigurationChapter 2 Setting Up the Gateway 352. Add an additional document directory.Adding an additional document directory is necessa
Creating a New Gateway Instance36 Red Hat Directory Server Gateway Customization Guide • April 2005http://webserverHost:webserverPort/clients/dsgw/bin
Gateway .conf File ConfigurationChapter 2 Setting Up the Gateway 377. To access the new gateway instance (in this example, example.conf) navigate the
Gateway .conf File Configuration38 Red Hat Directory Server Gateway Customization Guide • April 2005It is strongly recommended that you use a differen
Gateway .conf File ConfigurationChapter 2 Setting Up the Gateway 39Figure 2-1 Authenticating as Directory Manager Setting Up the Suffix for Adding Ent
Configuring Gateway Clients40 Red Hat Directory Server Gateway Customization Guide • April 2005Enabling SSL communications on the Directory Server is
Configuring Gateway ClientsChapter 2 Setting Up the Gateway 41Language Support for HTTP ClientsWhen a user accesses information in the directory from
Configuring Gateway Clients42 Red Hat Directory Server Gateway Customization Guide • April 2005Customizing Communicator’s LDAP SettingsAdministrators
43Chapter 3Gateway LocalizationThis chapter describes gateway localization and identifies the tasks required to set up additional gateway locales. The
4 Red Hat Directory Server Gateway Customization Guide • April 2005Chapter 2 Setting Up the Gateway . . . . . . . . . . . . . . . . . . . . . . . . .
How the Gateway Selects a Character Set44 Red Hat Directory Server Gateway Customization Guide • April 2005How the Gateway Selects a Character SetThe
Special CharactersChapter 3 Gateway Localization 45HTTP Clients that Do Not Request UTF-8For browsers that do not request UTF-8 by default, the gatewa
Gateway Locales46 Red Hat Directory Server Gateway Customization Guide • April 2005This works around a problem with Japanese NT, which garbles environ
Setting Up Locales for TranslationChapter 3 Gateway Localization 47dsgw-l10n.confdsgw-l10n.conf provides translation in the Search and Advanced Search
Setting Up Locales for Translation48 Red Hat Directory Server Gateway Customization Guide • April 2005
49Chapter 4File Controlling Gateway FunctionalityThis chapter provides examples of customized gateways. The chapter contains the following sections:•
Gateway .conf Files50 Red Hat Directory Server Gateway Customization Guide • April 2005Files that control gateway functionality are described in Table
Gateway Search Configuration FilesChapter 4 File Controlling Gateway Functionality 51• The locations where new entries can be created within the direc
Object Class Templates52 Red Hat Directory Server Gateway Customization Guide • April 2005Object Class TemplatesThe gateway contains a template file f
Gateway Search Result TemplatesChapter 4 File Controlling Gateway Functionality 53Gateway Search Result TemplatesSearch result templates control how t
5Setting Up Locales for Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Banner Files54 Red Hat Directory Server Gateway Customization Guide • April 2005Chapter 6, “Search Attributes, Filters, and Results,” describes how se
55Chapter 5Editing Entry TypesThis chapter describes how entry type formats — defined by object classes and their attributes — can be controlled by ed
Entry Types (Object Classes)56 Red Hat Directory Server Gateway Customization Guide • April 2005templateThe template parameter is used to map the gate
Mapping Locations and Entry TypesChapter 5 Editing Entry Types 57Considerations for Adding New Entry TypesBefore adding support for a new entry type (
Mapping Locations and Entry Types58 Red Hat Directory Server Gateway Customization Guide • April 2005In the example, locations defined in the newtype
Object Class Attributes in Template FilesChapter 5 Editing Entry Types 59UID-Based DNWhen a person or Windows person entry is added to the directory,
Object Class Attributes in Template Files60 Red Hat Directory Server Gateway Customization Guide • April 2005Default Gateway Object ClassesThe default
Object Class Attributes in Template FilesChapter 5 Editing Entry Types 61Adding Attributes to Object ClassesAdding an attribute to an object class req
Object Class Attributes in Template Files62 Red Hat Directory Server Gateway Customization Guide • April 20052. Insert a null pair to replace the dele
Object Class Attributes in Template FilesChapter 5 Editing Entry Types 632. Edit the third line in the template file to indicate the name of the new d
6 Red Hat Directory Server Gateway Customization Guide • April 2005Modifying Search Attributes for Advanced Searches . . . . . . . . . . . . . . . .
Object Class Attributes in Template Files64 Red Hat Directory Server Gateway Customization Guide • April 20056. Define a template parameter in dsgw.co
67Chapter 6Search Attributes, Filters, and ResultsThis chapter describes the files that control how the gateway searches for objects and describes how
Changing Search Scope68 Red Hat Directory Server Gateway Customization Guide • April 2005• The label of the search attribute as it is displayed in the
Modifying Search Attributes for Advanced SearchesChapter 6 Search Attributes, Filters, and Results 69Modifying Search Attributes for Advanced Searches
Modifying Search Attributes for Advanced Searches70 Red Hat Directory Server Gateway Customization Guide • April 2005Figure 6-1 Advanced Search Form:
Modifying Search Attributes for Advanced SearchesChapter 6 Search Attributes, Filters, and Results 71Figure 6-2 Advanced Search Form: Entry Type Figur
Modifying Search Attributes for Advanced Searches72 Red Hat Directory Server Gateway Customization Guide • April 2005Figure 6-4 Advanced Search Form:
Modifying Search Attributes for Advanced SearchesChapter 6 Search Attributes, Filters, and Results 73The third column contains a string of six bits. E
Adding Search Support for a New Object74 Red Hat Directory Server Gateway Customization Guide • April 2005"dsgw-people"subtree"full nam
Adding Search Support for a New ObjectChapter 6 Search Attributes, Filters, and Results 75People"""Search for":"(&(object
7Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modifying Default Search Filters76 Red Hat Directory Server Gateway Customization Guide • April 2005not-used-by-dsgwnot-used-by-dsgwsubtree"name&
Modifying Default Search FiltersChapter 6 Search Attributes, Filters, and Results 77• Search Filters for User Data Patterns• Specifying a Search Filte
Customizing Search Result Templates78 Red Hat Directory Server Gateway Customization Guide • April 2005Customizing Search Result TemplatesThe followin
Customizing Search Result TemplatesChapter 6 Search Attributes, Filters, and Results 79Figure 6-5 Search Results Table 6-3 lists the default gateway s
Customizing Search Result Templates80 Red Hat Directory Server Gateway Customization Guide • April 2005A new search result template is required for ea
Customizing Search Result TemplatesChapter 6 Search Attributes, Filters, and Results 81<!-- DS_ATTRIBUTE "attr=title" --></TD>&l
Customizing Search Result Templates82 Red Hat Directory Server Gateway Customization Guide • April 2005
83Chapter 7Customizing Graphics and ColorThis chapter describes how to change the appearance of default gateway forms. The chapter contains the follow
Button Images84 Red Hat Directory Server Gateway Customization Guide • April 2005Updating the Banner Image (title.gif)The following sections describe
Button ImagesChapter 7 Customizing Graphics and Color 85Updating Button ImagesThe default button images have a height of 24 pixels and a width of 122
8 Red Hat Directory Server Gateway Customization Guide • April 2005Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Color Schemes86 Red Hat Directory Server Gateway Customization Guide • April 2005Color SchemesChanging the color schemes for a form requires editing t
Color SchemesChapter 7 Customizing Graphics and Color 87Changing Colors Using BODY TagTable 7-3 lists the five standard color attributes that can be c
Changing Table Colors88 Red Hat Directory Server Gateway Customization Guide • April 2005In the example, the attribute is a standard HTML %color attri
Changing Table ColorsChapter 7 Customizing Graphics and Color 89Changing Color of Table HeadingsTo change the color of table heading text, edit the fo
Changing Table Colors90 Red Hat Directory Server Gateway Customization Guide • April 2005
91Appendix AParameters Defined in the .conf FileThe dsgw.conf and pb.conf files are installed during Red Hat Directory Server (Directory Server) insta
baseurl92 Red Hat Directory Server Gateway Customization Guide • April 2005baseurlSpecifies the host name and port number used to contact the Director
changeHTMLAppendix A Parameters Defined in the .conf File 93Formatbinddnfile binddn_filenameExamplebinddnfile /export/TEST/binddnfilechangeHTMLUsed by
configdir94 Red Hat Directory Server Gateway Customization Guide • April 2005More information: “ignoreAcceptCharsetFrom,” on page 97Formatcharset char
enable-aim-presenceAppendix A Parameters Defined in the .conf File 95Exampledirmgr "cn=Directory Manager, o=example.com"For information on t
9Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
gwnametrans96 Red Hat Directory Server Gateway Customization Guide • April 2005,<!-- DS_ATTRIBUTE "attr=nsaimstatustext" "options=qu
htmldirAppendix A Parameters Defined in the .conf File 97htmldirSpecifies the location of the HTML files for the gateway. These include the HTML files
location98 Red Hat Directory Server Gateway Customization Guide • April 2005locationDefines the location choices selectable from the gateway when addi
location-suffixAppendix A Parameters Defined in the .conf File 99location-suffixIdentifies the directory suffix used to create new entries in the dire
NLS100 Red Hat Directory Server Gateway Customization Guide • April 2005rdnattr. The attribute used to name entries of this type. For example, the def
securitypathAppendix A Parameters Defined in the .conf File 101The orgchart-attrib-farleft-rdn attribute is the same as the one included in the Org Ch
url-orgchart-base102 Red Hat Directory Server Gateway Customization Guide • April 2005template orgperson person inetorgpersonurl-orgchart-basePoints t
vcard-propertyAppendix A Parameters Defined in the .conf File 103Formatvcard-property vcardprop syntax ldapattr [ldapattr2...]vcardprop. The name of a
vcard-property104 Red Hat Directory Server Gateway Customization Guide • April 2005syntax. A string that describes the nature of the vCard information
107Appendix BGateway DirectivesThis appendix describes directives used in gateway HTML object class and search result templates. The appendix contains
Commenti su questo manuale