Chapter 10   HTML Templates




Setting up Login Pages for Different Domains

---

HTML templates can be edited to make substantive changes to layout or design of pages, or to add extra functionality, beyond the services possible through the Administration Console.

---

Note

Strong HTML skills as well as a thorough understanding of web servers, and server-side includes, are required to edit the template files. If a template file is corrupted, it may be necessary to restore the original files from the iPlanet Portal Server CD-ROM to recover and gain access to the system.

---

How Authentication Templates Work

HTML template files control the layout and source of the iPlanet Portal Server Desktop and of the other screens that users see. The templates are located on the Portal Server in the directory:

/etc/opt/SUNWips/auth/default

Templates for Customizing the Authentication Pages

These templates allow customizing the login, logout, and time-out screens.

In the /etc/opt/SUNWips/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.

---

Note	See the Chapter 6, "Pluggable Authentication API" for more information about <authentication-module>.properties files.

---

The login pages come from a set of template HTML files. The default set of these is located at /etc/opt/SUNWips/auth/default

To customize a login for different domains:

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

2. Create a directory named the same as the name of the domain.

3. Copy all the .properties, .html and .gif files into that directory.

4. Customize the files in that directory for that domain.

Any domain that does not have it's own directory of templates will use the default set in:

/etc/opt/SUNWips/auth/default

For example, if there are three domains: dm1, dm2, dm3, and the login will be customized for dm1, the directories will look like this:

/etc/opt/SUNWips/auth/default

/etc/opt/SUNWips/auth/dm1

Both would contain a full set of the properties/html/gif files. The login to dm1 would use the set in /etc/opt/SUNWips/auth/dm1/, and the other domains would use the default set in /etc/opt/SUNWips/auth/

The various files are:

Table 10-1 HTML Template Files 

File Name	Description
login_menu.html	Is sent when more than one authentication module is configured. This gives the iPlanet Portal Server 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_license_fail.html	Is sent when there are no more licenses. This page contains no required sections.
login_reauth_menu.html	Is sent when an iPlanet Portal Server end user's session has been inactive for the time set in the Administration Console. It contains a link for re authentication. Do not change the JavaScript in this page.
login_trustProxy_warning.html	Is presented to iPlanet Portal Server end users who log in to the iPlanet Portal Server Desktop using Netscape and do not have the browser configured to accept all cookies. In this case the end user cannot start the iPlanet Portal Server Java applets. If this page is not to be displayed because the end user is not allowed to run Java applets, replace the contents of this page with an HTML refresh tag that contains zero time-out and is redirected to /login/default.
login_template.html	Is sent for individual authentication modules such as RADIUS or UNIX. The seven subset text segments must remain after modification. This page is also sent when logging in to the iPlanet Portal Server Administration Console.
logout.html	Is called after the iPlanet Portal Server end user selects the logout link on the iPlanet Portal Server Desktop. It contains no required sections.
login_timeout_template.html	Is called during an authentication session if the iPlanet Portal Server end user does not submit the login form within the specified time. It has no required sections.
login_reauth_admin.html	Is sent when the administration session has expired. It contains a link for re authentication.
login_timeout_admin.html	Is called during an administration session if nothing is entered within the specified time. It has no required text.
login_fail_admin.html	Is sent when authentication has failed. This page contains no required text.
logout_admin.html	Is called after the iPlanet Portal Server administrator selects the logout link on the iPlanet Portal Server Administration Console. It contains no required sections.

How Desktop Templates Work

HTML template files control the layout and source of the iPlanet Portal Server Desktop and of the other screens that users see. The templates are located on the Portal Server in the directory /etc/opt/SUNWips/desktop.

Templates for Customizing the iPlanet Portal Server Desktop

HTML template files control the layout and source of the iPlanet Portal Server Desktop. The templates are:

advancedTemplate.html	Controls the Advanced page in the end user's iPlanet Portal Server Desktop. By default, it is set to allow an applet that downloads NetMail and installs it on a local client, but you can add other functionality of your choice.
feedbackTemplate.html	Controls the appearance and layout of the feedback form in the end user's iPlanet Portal Server Desktop.
prefTemplate.html	Controls the appearance and layout of the Edit Preferences page in the end user's iPlanet Portal Server Desktop.
userTemplate.html	Controls the Front Page in the end user's iPlanet Portal Server Desktop.

These files can be edited to change the appearance, the information presented, and the links. Add or remove various features according to the corporate policy or security policy. These files can also be copied to build new templates.

The following tag definitions are used in the Desktop Pages.

Tag Definition	Description
noCache	Various HTML directives to try and stop browser from caching pages.
productName	Replaced with Platform-productName attr.
openFrontPage	js code to return to front page.
style	Various style/class defs used by the templates (HTMl).
menubar	HTML for the black menubar on the dt pages.
banner	The desktop's banner (HTML).
title	On dt's edit provider page, is iwt<provider>-title attr.
providerName	Providers iwt<provider>-name attr.
inlineError	Place holder to insert an inline error msg in dt pages (blank if no error).
contentOptions	The content of the provider edit page that is generated by the provider.
errMessage	The actual text of the error message, inserted into the inline error template.
thinProviders	HTML for the "thin" providers.
wideProviders	HTML for the "wide" providers.
size	Width for provider columns.
provider_cmds	The menubar for the provider (the buttons).
content	Content for the provider.
providerTitle	iwt<provider>-title attr.
openURLInParent	js code to open a url.
popupMenubar	Menubar for the detached provider.
providerContent	Provider content in popup form.
arrangeProvider	js code.
removeProvider	js code to remove a provider.
performSub*	js code.
selectAll	js code to select all.
switchColumns	js code.
<left|center|right>UserProviderList	List boxes of providers.
launchPopup	js code to detach provider.
serviceTimeout	iwtDesktop-serviceTimeout attr.
layout<n>Checked	Indicates which layout option is checked.
help_link	Help link for a page.
resourceCount, resourceList, windwoOptions	Used dynamically by some edit pages.
bookmarks	The content for the bookmark provider iwtXXXXXX (in ui edit template); get subbed for that attr.
timezoneList	HTML list element.
timezones targetCount	Number of targets in netlet provider.
newRuleSelect	Indicator of new rule bing added in netlet provider.
targetList	List of targets for NP.
content	Content for the netlet provider.
apps	Content for the app provider.