test

Sun Java System Portal Server 7.1 Developer Sample Guide

Modifying the Desktop End-User Online Help HTML files

You can customize the end-user online help by editing the existing HTML online help files or by creating new HTML files.

Editing An Existing Help File

You can edit an existing help file to customize the content to meet specific requirements of your organization. For example, you can remove or change the SunONE.jpg image or meta text that is currently displayed on the sample help files, or replace the help file completely with a file of the same name.

After modifying the file, run the PortalServer-base/bin/psadmin redeploy --adminuser amadmin --passwordfile passwordfile --portal portal-ID command to deploy the file into the web-app location.

This method of modifying the online help files is useful if you use the sample providers that are shipped with the Portal Server software.

For example, if you use the UserInfoProvider that ships with the Portal Server product, the display profile for that provider already defines the helpURL value as desktop/userinfo.htm. By editing the help file userinfo.htm, no changes to the display profile are necessary.

Creating a New Help File

You can create a new help file by creating a new HTML file. This method of customizing the online help is useful if, for example, you add a new provider to the Desktop. When you create a new help file, you must modify the display profile to contain the new helpURL value.

ProcedureTo Create a New Online Help File and to Define the helpURL Value

  1. Create an HTML file for the provider you want to document.

  2. Place your file in the appropriate directory.

    You can place your custom help files under the web server document root, in the directory specified as root by the display profile:


    PortalServer-base/web-src/docs/locale/desktop

    Or, you can deploy them in a custom web application archive. See the web server documentation for information on how to deploy a web application archive.

  3. Run the PortalServer-base/bin/psadmin deploy subcommand to deploy the file.

  4. Define the helpURL value for that file in the display profile.

    To define the helpURL value for a new online help file, use the format described in the section Overview of the Desktop End-User Online Help.

  5. Use the psadmin subcommand to load the display profile into LDAP.

  6. Verify that the new help file is displayed correctly.