Provider README
This document describes the steps to add providers and channels into an
existing Sun JavaTM System Portal Server 7 system.
1. Put class files in the provider class base directory. The provider class
base directory is defined in the desktopconfig.properties file, in the "providerClassBaseDir"
property. By default, the value is /etc/opt/SUNWportal/desktop/classes. If the
provider is in a JAR file, add it to the root level of the provider class
base directory. If the provider is in a class, add it in the sub-directory
under the provider class base directory, based on the java class package.
2. If the provider has desktop templates or JSPs, create the proper directories
under the template base directory and copy the templates into the directories.
The template base directory is defined in the desktopconfig.properties file,
in the "templateBaseDir" property, by default is /etc/opt/SUNWportal/desktop.
The templates should be copied into the <templateBaseDir>/<desktop-type>/<providername>,
where <desktop-type> defaults to 'default', and <providername>
is the provider name given to the provider in the display profile. If the
template is used by a specific channel, and the template is modified based
on the channel's specific need, then the template should be copied to <templateBaseDir>/<desktop-type>/<channelname>,
where the <channelname> if the channel name given to the channel in
the display profile.
3. Put the provider's properties file, if any, in the provider class base
directory.
4. Put the channel on-line help files in the proper sub-directories under
portal server's web-src directory, by default it is /opt/SUNWportal/web-src/docs.
The on-line help files should be copied to <web-src-dir>/docs/desktop
and <web-src-dir>/docs/<locale>/desktop, where <locale>
is the supported locale for the portal server instance. The on-line help
files then should be deployed into the web container using the deploy command:
deploy redploy
5. Import the XML display profile provider and channel definitions using dpadmin
command. For example:
amadmin add -u amadminDN
-w password -g provider_displayprofile_name
amadmin add -u amadminDN
-w password -d <orgDN> channel_displayprofile_name
For complete information about the amadmin command, please see the
Sun JavaTM System Portal Server 7 Administrator's Guide.
5a. Another way to import the XML display profile is to use the Identity
Server administration console:
- Login to the administration console as the amadmin.
- Select the Service Configuration tab.
- Under Portal Server Configuration, click on the rightward arrow next
to "Desktop".
- Select Edit XML link on the right frame.
- Copy and paste the providers definition in the XML document, and then
press the Save button. Note that the provider definition should be inserted
inside the <Providers></Providers> XML bag.
- Select the Identity Management tab.
- Select Organizations in the View pull-down menu.
- Select the organization node where the channel definition should be
imported.
- Select Services in the View pull-down menu.
- Under Portal Server Configuration, click on the rightward arrow next
to Desktop.
- Select Edit XML link on the right frame.
- Copy and paste the channels definition in the XML document, and then
press the Save button. Note that the channel definition should be inserted
inside the <Channels></Channels> XML bag.
For more information about how to use the Identity Server administration
console, please see the Sun JavaTM System Portal Server 7 Administrator's Guide.
6. Use the Identity Server administration console to add a channel in an
existing container in the desktop:
- Select the Identity Management tab.
- Select Organizations in the View pull-down menu .
- Select the organization node where the channels definition should
be imported.
- Select Services in the View pull-down menu.
- Under Portal Server Configuration, click on the rightward arrow next
to Desktop.
- Select the Channel and Container Management link.
- Under Container Channels, select a container link where the new channel
should be added.
- Under Channel Management, select the channel from the Existing Channels
list, and click on the add button to add it to the "Available and Visible"
list box. Press the Save button.
For more information about how to use the Identity Server administration
console, please see the Sun JavaTM System Portal Server 7 Administrator's Guide.