Directory Server Access Management Edition Programmer's Reference Guide: Chapter 3 HTML Templates

Previous Contents DocHome Next

Directory Server Access Management Edition Programmer's Reference Guide

Chapter 3 HTML Templates

This chapter provides information on how to customize the authentication login, logout, and timeout pages for different organizations in DSAME console, and gives some information on how authentication templates work.

Setting up Login Pages for Different Organizations

You can edit HTML templates to make substantive changes to the layout or design of pages, or to add extra functionality, beyond the services possible through the DSAME console.

Note
Strong HTML skills as well as a thorough understanding of Web servers are required to edit the template files.
It is recommended that you make backups of the templates files before making modifications to them; then you can restore your files from the backups.
Alternatively, if a template file is corrupted, you can restore the original files from the iPlanet Directory Server Access Management Edition CD-ROM to recover and gain access to the system.

How Authentication Templates Work

HTML template files control the layout of the iPlanet Directory Server Management Access Edition console pages and of the other screens that users see. The templates are located on the iPlanet Directory Server Management Access Edition in the directory:
dsame_root/SUNWam/web-apps/services/WEB-INF/config/auth/default

Templates for Customizing the Authentication Pages

These templates allow you to customize the login, logout, and time-out screens.
In the DSAME_root/SUNWam/web-apps/services/WEB-INF/config/auth/
default directory, there are .html files that control the overall appearance and .properties files that control the sequence of prompts and the exchange of information between the user and the authentication module.
The login pages come from a set of template HTML files. The default set of these is located at DSAME_root/SUNWam/web-apps/services/WEB-INF/config/
auth/defaults directory.

To Customize a Login for Different Organizations:

Go to the server machine (do the same to all server machines if there are multiple servers).

cd DSAME_root/SUNWam/web-apps/services/WEB-INF/config/auth

Create a directory with the name of the organization; this should be a DN (distinguished name), and should be the same name that appears in the DSAME console.

Copy all the .properties and .html files (and .gif files, if they exist) into that directory.

Customize the files in that directory for that organization.
Any organization that does not have its own directory of templates will use the default set in:

DSAME_root/SUNWam/web-apps/services/WEB-INF/config/
auth/default

For example, if there are three organizations—org1, org2, org3—and you are customizing the login for org1, the directories will look like this:

DSAME_root/SUNWam/web-apps/services/WEB-INF/config/auth/
default

DSAME_root/SUNWam/web-apps/services/WEB-INF/config/auth/
org1

Both would contain a full set of the properties, html and gif files. The login to org1 would use the set in DSAME_root/SUNWam/web-apps/services/WEB-INF/config/auth/
org1/, and the other organizations would use the default set in DSAME_root/SUNWam/web-apps/services/WEB-INF/config/auth/
default
The HTML template files are described in Table 3-1.

Table 3-1 HTML Template Files

File Name

Description

login_menu.html

Is sent when more than one authentication module is configured. This gives the iPlanet Directory Server Access Management Edition end user a choice of which module to use for authentication. The text <subst data="rows">No menu?</subst> must be somewhere in the document. It generates a list of URLS to the authentication modules.

login_fail_template.html

Is sent when authentication has failed. This page contains no required sections.

login_reauth_menu.html

Is sent when a DSAME end user's session has been inactive for the time set in the DSAME console. It contains a link for re-authentication. Do not change the Javascript in this page.

login_template.html

Is sent for individual authentication modules such as RADIUS. The seven subset text segments must remain after modification. This page is also sent when logging in to the iPlanet Directory Server Access Management Edition Administration Console.

logout.html

Is called after the DSAME end user selects the logout link on the DSAME DSAME console. it contains no required sections.

login_timeout_template.html

Is called during an authentication session if the iPlanet Directory Server Access Management Edition end user does not submit the login form within the specified time. It has no required sections.

invalidPassword.html

Error page for invalid password length in self-registration page.

login_denied.html

Error page if user does not have a profile entry in this DSAME installation.

login_fail_admin.html

Login to DSAME console failed.

login_menu.html

Template used to display user login page when multiple authentication modules are enabled for an organization.

login_menu_modules.html

Used for single authentication module within login_menu.html

login_prompt.html

When user-based authentication is enabled, this page is used to ask for user login id

login_reauth_admin.html

Administration Console session has expired.

login_template.html

Template for the login page

login_timeout_admin.html

Timeout page for login to DSAME console

login_timeout_template.html

Login timeout template

logout_admin.html

User logout from DSAME console

membership.html

Self-registration login page

missingReqField.html

Error page when user is not allowed to use this authentication module.

module_denied.html

Error page when user is not allowed to use this authentication module

noConfirmation.html

Error page if no confirmation password entered in self-registration page

noPassword.html

Error page if no password entered in self-registration page

noUserName.html

Error page if no user name entered in self-registration pgae

noUserProfile.html

Error page if no matching user found when using self-registration to log in.

org_inactive.html

Error page if the matching user found when using self-registration to log in

password_mismatch.html

Error page if confirmation password does not match in self-registration page

register.html

Self-registration page

session_timeout.html

Error page if user session times out

userExists.html

Error page when trying to register a user that already exists in self-registration module

userPasswordSame.html

Error page when user enters a password that is the same as user ID in self-registration page

user_inactive.html

Error page if user login is disabled (not allowed to login)

wrongPassword.html

Error page if user enters invalid password when using self-registration module to log in

File Name	Description
login_menu.html	Is sent when more than one authentication module is configured. This gives the iPlanet Directory Server Access Management Edition end user a choice of which module to use for authentication. The text <subst data="rows">No menu?</subst> must be somewhere in the document. It generates a list of URLS to the authentication modules.
login_fail_template.html	Is sent when authentication has failed. This page contains no required sections.
login_reauth_menu.html	Is sent when a DSAME end user's session has been inactive for the time set in the DSAME console. It contains a link for re-authentication. Do not change the Javascript in this page.
login_template.html	Is sent for individual authentication modules such as RADIUS. The seven subset text segments must remain after modification. This page is also sent when logging in to the iPlanet Directory Server Access Management Edition Administration Console.
logout.html	Is called after the DSAME end user selects the logout link on the DSAME DSAME console. it contains no required sections.
login_timeout_template.html	Is called during an authentication session if the iPlanet Directory Server Access Management Edition end user does not submit the login form within the specified time. It has no required sections.
invalidPassword.html	Error page for invalid password length in self-registration page.
login_denied.html	Error page if user does not have a profile entry in this DSAME installation.
login_fail_admin.html	Login to DSAME console failed.
login_menu.html	Template used to display user login page when multiple authentication modules are enabled for an organization.
login_menu_modules.html	Used for single authentication module within login_menu.html
login_prompt.html	When user-based authentication is enabled, this page is used to ask for user login id
login_reauth_admin.html	Administration Console session has expired.
login_template.html	Template for the login page
login_timeout_admin.html	Timeout page for login to DSAME console
login_timeout_template.html	Login timeout template
logout_admin.html	User logout from DSAME console
membership.html	Self-registration login page
missingReqField.html	Error page when user is not allowed to use this authentication module.
module_denied.html	Error page when user is not allowed to use this authentication module
noConfirmation.html	Error page if no confirmation password entered in self-registration page
noPassword.html	Error page if no password entered in self-registration page
noUserName.html	Error page if no user name entered in self-registration pgae
noUserProfile.html	Error page if no matching user found when using self-registration to log in.
org_inactive.html	Error page if the matching user found when using self-registration to log in
password_mismatch.html	Error page if confirmation password does not match in self-registration page
register.html	Self-registration page
session_timeout.html	Error page if user session times out
userExists.html	Error page when trying to register a user that already exists in self-registration module
userPasswordSame.html	Error page when user enters a password that is the same as user ID in self-registration page
user_inactive.html	Error page if user login is disabled (not allowed to login)
wrongPassword.html	Error page if user enters invalid password when using self-registration module to log in

Previous Contents DocHome Next
Copyright © 2001 Sun Microsystems, Inc. Some preexisting portions Copyright © 2001 Netscape Communications Corp. All rights reserved.

Last Updated December 05, 2001