Chapter 3   Display Profile Channel Definitions


This chapter contains information on the channel display profile definitions that ship with Sun™ ONE Portal Server.

This chapter contains the following section:

• Display Profile Definitions for Existing Channels

Display Profile Definitions for Existing Channels

---

The provider definition is the template that decides the properties for a channel. However, the display profile channel definition ultimately decides the values for the channel attributes. The display profile channel definition can define properties that overwrite the properties defined by the provider definition.

To facilitate understanding of what display profile channel definitions look like and how they work, this chapter contains the display profile channel definitions for the following channels that ship with the product:

• Bookmark Channel

• Notes Channel

• Applications List Channel

• User Information Channel

• Mail Check Channel

• URL Scraper Channel

• RSS Channel

• XML Channel

• JSP Channel

• Search Channel

• Simple Web Service Channel

• Simple Web Service Configurable Channel

• Login Channel

Bookmark Channel

The bookmark channel enables users to store URLs.

Code Example 3-1 shows the display profile definition for the bookmark channel.

---

Code Example 3-1    Display Profile Definition for the Bookmark Channel

<Channel name="Bookmark" provider="BookmarkProvider">

<Properties>

<String name="title" value="My Bookmarks #2"/>

<String name="refreshTime" value="600"/>

<Collection name="targets">

<String value="Sun home page|http://www.sun.com"/>

<String value="Everything you want to know about Sun ONE ...| http://www.sun.com/software/products/portal_srvr/home_portal.html"/>

<String value="Sun ONE home page|http://www.sun.com/software"/>

</Collection>

</Properties>

</Channel>

Table 3-1 lists the properties specific to the bookmark channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-1    Bookmark Channel Specific Properties  

Property	Value
title	My Bookmarks #2
refreshTime	600
targets	Three URLs: http://www.sun.com, http://www.sun.com/software/products/portal_srvr/home_portal.html, and http://www.sun.com/software.

These channel-defined properties overwrite the corresponding properties in BookmarkProvider. Properties not defined in the channel are picked up from BookmarkProvider. See "BookmarkProvider" for more information.

Notes Channel

The notes channel enables users to post messages to other users' notes channel on their Desktop.

Code Example 3-2 shows the display profile definition for the notes channel.

---

Code Example 3-2    Display Profile Definition for the Notes Channel

<Channel name="Notes" provider="NotesProvider">

<Properties>

<String name="refreshTime" value="600"/>

<String name="title" value="Notes"/>

<String name="description" value="Notes Channel Description"/>

<String name="lines" value="4"/>

<String name="maxLines" value="4"/>

</Properties>

</Channel>

Table 3-2 lists the properties specific to the notes channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-2    Notes Channel Specific Properties  

Property	Value
refreshTime	600
title	Notes
description	Notes Channel Description, which appears in the Content page.
lines	4, which starts the channel with four lines of notes.
maxLines	4, which provides for a maximum of four lines of notes.

These channel-defined properties overwrite the corresponding properties in NotesProvider. Properties not defined in the channel are picked up from NotesProvider. For example, NotesProvider sets the isEditable property to false, so that no edit view is provided and users cannot customize the channel. NotesProvider also sets the help URL. See "NotesProvider" for more information.

The notes themselves are stored and read in a text file in the following format:

userid | date | message

where | is the delimiter and date is long value which denotes the time elapsed in milliseconds since Jan. 1, 1970. Here is a sample of what may be included in the notes.txt file:

User1|1007159465858|Message to Portal Desktop Team : Lets meet today at 2PM

User2|1007159465858|Information related to the project is availble at home page

Applications List Channel

The applications list channel enables a user to add or remove applications from a list of applications.

Code Example 3-3 shows the display profile channel definition for the applications list channel.

---

Code Example 3-3    Display Profile Definition for the Applications List Channel

<Channel name="App" provider="AppProvider">

<Properties>

<String name="refreshTime" value="600"/>

<Collection name="targets">

<String value="NetMail Lite|NetMailServlet?nsid=newHTMLSession"/

<String value="NetMail|NetMailServlet?nsid=newAppletSession"/>

</Collection>

<Collection name="userApps">

<String value="NetMail Lite">

<String value="NetMail">

</Collection>

<String name="title" value="My Applications">

</Collection>

<String name="title" value="My Applications">

</Properties>

</Channel>

Table 3-3 lists the properties specific to the applications list channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-3    Applications List Channel Specific Properties  

Property	Value
refreshTime	600
Three collections	targets, userApps, and My Applications
title	My Applications

These channel-defined properties overwrite the corresponding properties in AppProvider. Properties not defined in the channel are picked up from AppProvider. For example, AppProvider sets the isEditable property to true, so an edit view for the channel is provided and user can customize the channel. AppProvider also sets the help URL. See "AppProvider" for more information.

User Information Channel

The user information channel displays a greeting, the user's name, time zone, locale and has access to the user's IMAP and SMTP data. The user information channel enables users to view and edit user information.

Code Example 3-4 shows the display profile definition for the user information channel.

---

Code Example 3-4    Display Profile Definition for the User Information Channel

<Channel name="UserInfo" provider="UserInfoProvider">

<Properties>

<String name="refreshTime" value="60"/>

<String name="title" value="User Information"/>

<String name="description" value="View/Edit User Information"/>

</Properties>

</Channel>

In this example, only refreshTime, title, and description properties are defined. All other properties for the user information channel are defined in UserInfoProvider. See "UserInfoProvider" for more information.

Mail Check Channel

The mail check channel gives information about a user's mail status.

Code Example 3-5 shows the display profile definition for the mail check channel.

---

Code Example 3-5    Display Profile Definition for the Mail Check Channel

<Channel name="MailCheck" provider="MailCheckProvider">

<Properties>

<String name="refreshTime" value="120"/>

<String name="Title" value="My Unread Mail Count"/>

<String name="IMAPServerName" value=""/>

<String name="IMAPUserId" value=""/>

<String name="IMAPPassword" value=""/>

</Properties>

</Channel>

Table 3-4 lists the properties specific to the mail check channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-4    Mail Check Channel Specific Properties  

Property	Value
refreshTime	120
title	My Unread Mail Count
IMAPServerName	null
IMAPUserId	null
IMAPPassword	null

These channel-defined properties overwrite the corresponding properties in MailCheckProvider. Properties not defined in the channel are picked up from MailCheckProvider. For example, MailCheckProvider sets the defaultConfigParameter property to true, which causes the server name, user ID and password to be read from the NetMail service definition. MailCheckProvider also sets the help URL. See "MailCheckProvider" for more information.

URL Scraper Channel

The URL scraper channel takes a URL, opens a connection to the URL, and reads the contents into a buffer. The contents are then sent to the Desktop Servlet, which displays it. URLScraperProvider uses the Rewriter to construct the URL information as long as the MIME type of the file is one that the Rewriter supports. (Rewriter rules are expressed using an XML document but the URL scraper channel does not use an XML file to describe how to display it.)

Code Example 3-6 shows the display profile definition for the URL scraper channel.

---

Code Example 3-6    Display Profile Definition for the URL Scraper Channel  

<Channel name="SampleURLScraper" provider="URLScraperProvider">

<Properties>

<String name="refreshTime" value="600"/>

<String name="url" value="file:///etc/opt/SUNWps/desktop/default/SampleURLScraper/ipinfo.html"/>

<String name="title" value="URL Scraper Channel"/>

</Properties>

</Channel>

Table 3-5 lists the properties specific to the URL scraper channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-5    URL Scraper Channel Specific Properties  

Property	Value
refreshTime	600
url	Set to a test URL, file:///etc/opt/SUNWps/desktop/default/SampleURLScraper/ipinfo.html, you would include with your own URL here by: directly editing the display profile in the iPlanet™ Directory Server Access Management Edition admin console; using the Edit Channels link in the iPlanet Directory Server Access Management Edition admin console; or editing then deploying the display profile on a Solaris™ system.

These channel-defined properties overwrite the corresponding properties in URLScraperProvider. Properties not defined in the channel are picked up from URLScraperProvider. For example, URLScraperProvider sets the isEditable property to false; no edit view for users is provided, as the URL scraper channel is not editable and there are no getEdit() and processEdit() methods defined for this provider. See "URLScraperProvider" for more information.

Creating a URL scraper channel is a quick and simple way to add content to the Desktop, as no coding is required. However, the following scenarios are inappropriate for the URL scraper channel:

• If the site being scraped requires HTTP basic authentication.

• If an edit function is required so that users can customize the channel.

• If the data comes form a non-HTML, non-web server source, for example, a database or mail server.

• If the data needs to be reformatted in some way for the channel.

• If a more efficient solution is required. The URL scraper channel does a request and look up for every Desktop display and user.

For situations similar to these, use the PAPI. See the Sun ONE Portal Server 6.0 Developer's Guide for more information.

RSS Channel

The RSS channel uses an XSLT (style sheet) file to transform the RSS XML file into HTML. By using different XSL files the same output can be changed and presented differently for different channels.

Code Example 3-7 shows the display profile definition for the RSS channel.

---

Code Example 3-7    Display Profile Definition for the RSS Channel

<Channel name="SampleRSS" provider="XMLProvider">

<Properties>

<String name="title" value="Sun One Information"/>

<String name="description" value="RSS Description"/>

<Integer name="timeout" value="100"/>

<String name="width" value="thin"/>

<Boolean name="isEditable" value="false"/>

<String name="helpURL" value="desktop/rsschann.htm"/>

<String name="fontFace1" value="Sans-serif"/>

<String name="productName" value="Sun ONE Portal Server"/>

<String name="refreshTime" value="600"/>

<String name="description" value="Company News"/>

<String name="url" value="file:///etc/opt/SUNWps/desktop/default/SampleRSS/SampleRSS.rss" />

<String name="xslFileName" value="/etc/opt/SUNWps/desktop/default/rss/rss.xsl"/>

</Properties>

</Channel>

Table 3-6 lists the properties specific to the RSS channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-6    RSS Channel Specific Properties  

Property	Value
title	Sun ONE Information
description	RSS Description (appears in the Content page)
timeout	100
width	thin
isEditable	false
helpURL	desktop/rsschann.htm
fontFace1	Sans-serif
productName	Sun ONE Portal Server
refreshTime	600
url	file:///etc/opt/SUNWps/desktop/default/SampleRSS/SampleRSS.rss
xslFileName	/etc/opt/SUNWps/desktop/default/rss/rss.xsl

The RSS channel sets many more properties than most channels, due to the fact that there is no RSS provider and the channel uses XMLProvider. Because of this, the RSS channel needs to override most of the properties set by XMLProvider. See "XMLProvider" for more information.

You cannot set isEditable to true for the RSS channel, as the channel is not editable and there are no getEdit() and processEdit() methods defined.

XML Channel

The XML channel provides a flexible way to include XML content in the Desktop, enabling an XML document to be transformed into HTML using an XSL (style sheet) file.

Code Example 3-8 shows the display profile definition for the XML channel.

---

Code Example 3-8    Display Profile Definition for the XML Channel

<Channel name="SampleXML" provider="XMLProvider">

<Properties>

<String name="refreshTime" value="600"/>

<String name="title" value="XML Test Channel"/

<String name="description" value="This is a test of the XML Provider system"/>

<String name="url" value="file:///etc/opt/SUNWps/desktop/default/SampleXML/getQuotes.xml"/>

<String name="xslFileName" value="html_stockquote.xsl"/>

</Properties>

Table 3-7 lists the properties specific to the XML channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-7    RSS Channel Specific Properties  

Property	Value
refreshtime	600
title	XML Test Channel
description	This is a test of the XML Provider system
url	file:///etc/opt/SUNWps/desktop/default/SampleXML/getQuotes.xml
xslFileName	html_stockquote.xsl

These channel-defined properties overwrite the corresponding properties in XMLProvider. Properties not defined in the channel are picked up from XMLProvider. For example, XMLProvider sets the isEditable property to false; no edit view for users is provided, as the XML channel is not editable and there is no getEdit() and processEdit() methods defined for this provider. See "XMLProvider" for more information.

JSP Channel

A JSP channel uses JSP pages rather than Desktop templates to define the channel. You can therefore make changes to the channel and the provider without having to restart the server.

Code Example 3-9 shows the display profile definition for the JSP channel.

---

Code Example 3-9    Display Profile Definition for the JSP Channel 

<Channel name="SampleJSP" provider="JSPProvider">

<Properties>

<String name="title" value="Sample JSP Provider"/>

<String name="description" value="This is the sample for the Jsp Provider"/>

<Locale language="en" country="US">

<String name="title" value="Sample JSP Channel"/>

<String name="description" value="This is the sample for the Jsp Provider" />

</Locale>

<Boolean name="isEditable" value="true"/>

</Properties>

</Channel>

Table 3-8 lists the properties specific to the JSP channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-8    JSP Channel Specific Properties  

Property	Value
title	Sample JSP Provider
description	This is the sample for the Jsp Provider
Locale	en, country=US
isEditable	true

These channel-defined properties overwrite the corresponding properties in JSPProvider. Properties not defined in the channel are picked up from JSPProvider. For example, JSPProvider sets the JSPs needed by the provider. See "JSPProvider" for more information.

Search Channel

The search channel can provide three interfaces:

• Basic search - Enables users to type keywords in a search box. Document and category matches are then displayed.

• Advanced search - Enables users to search for documents based on author, title, and URL. Users can also search on the last-modified date of a document. Advanced search is a more complex user interface, and supports customization. See Chapter 7 "Customizing the Search Provider" for more information.

• Browse - Enables users to browse the category tree and search within categories.

Code Example 3-9 shows the display profile definition for the search channel.

---

Code Example 3-10    Display Profile Definition for the Search Channel 

<Channel name="Search" provider="SearchProvider">

<Properties>

<String name="title" value="Search"/>

<String name="description" value="This is a search provider example"/>

<String name="searchServer" value=""/>

<String name="width" value="full_top"/>

</Properties>

</Channel>

Table 3-9 lists the properties specific to the search channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-9    Search Channel Specific Properties  

Property	Value
title	Search
description	This is a search provider example
searchServer	By default this is empty; you would fill in the name of the Search server.
width	full_top

These channel-defined properties overwrite the corresponding properties in SearchProvider. Properties not defined in the channel are picked up from SearchProvider. For example, SearchProvider sets what type of search is available to the user. See "SearchProvider" for more information.

Simple Web Service Channel

The Simple Web Service channel makes simple web services available to an end user channel. This preconfigured channel is always bound to a single web service and associated method by using channel initialization properties. This channel type enables end users to cache (or store) default values for the web service input parameters by using the Edit button functionality on the channel.

Code Example 3-11 shows the display profile definition for the simple web service channel.

---

Code Example 3-11    Display Profile Definition for the Simple Web Service Channel  

Channel name="SampleSimpleWebService" provider="SimpleWebServiceProvider"

<Properties>

<String name="title" value="Pre-Configured Web Service Channel"/>

<String name="description" value="This is a sample pre-configured Simple Web Service Channel"/>

<String name="wsdlURL" value="file:///etc/opt/SUNWps/desktop/default/SampleSimpleWebService/CurrencyE xchangeService.wsdl"/>

<String name="editPage" value="webserviceInputEdit.jsp"/>

<String name="methodName" value="getRate"/>

<Boolean name="isDefaultShowOutput" value="false"/>

<Boolean name="isDefaultAvailable" value="true"/>

<Collection name="defaultInput">

<String name="country1" value="usa"/>

<String name="country2" value="japan"/>

</Collection>

</Properties>

</Channel>

Table 3-10 lists the properties specific to the simple web service channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-10    Simple Web Service Channel Specific Properties  

Property	Value
wsdlURL	file:///etc/opt/SUNWps/desktop/default/SampleSimpleWebService/CurrencyExchangeService.wsdl
editPage	webserviceInputEdit.jsp
methodName	getRate
isDefaultShowOutput	false
isDefaultAvailable	true
Collection name	defaultInput, with two values, country1 (usa) and country2 (japan)

These channel-defined properties overwrite the corresponding properties in SimpleWebServiceProvider. Properties not defined in the channel are picked up from SimpleWebServiceProvider. For example, SearchProvider sets the channel refresh time. See "SimpleWebServiceProvider" for more information.

Simple Web Service Configurable Channel

The Simple Web Service Configurable channel is similar to the Simple Web Service channel, except that it permits users to use the Edit function to change URLs and methods, hence, it is configurable. This channel does not enable end users to cache (or store) default values for the web service input parameters.

Code Example 3-12 shows the display profile definition for the simple web service configurable channel.

---

Code Example 3-12    Display Profile Definition for the Simple Web Service Configurable Channel  

<Channel name="SampleSimpleWebServiceConfigurable" provider="SimpleWebServiceConfigurableProvider">

<Properties>

<String name="title" value="Sample Configurable Simple Web Service Channel"/>

<String name="description" value="This is a sample configurable Simple Web Service Channel"/>

<String name="wsdlURL" value="file:///etc/opt/SUNWps/desktop/default/SampleSimpleWebServiceConfigurab le/CurrencyExchangeService.wsdl"/>

<String name="methodName" value="getRate"/>

</Properties>

</Channel>

Table 3-11 lists the properties specific to the simple web service configurable channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-11    Simple Web Service Configurable Channel Specific Properties  

Property	Value
wsdlURL	file:///etc/opt/SUNWps/desktop/default/SampleSimpleWebServiceConfigurable/CurrencyExchangeService.wsdl
methodName	getRate

These channel-defined properties overwrite the corresponding properties in SimpleWebServiceConfigurableProvider. Properties not defined in the channel are picked up from SimpleWebServiceConfigurableProvider. For example, SimpleWebServiceConfigurableProvider sets the channel refresh time. See "SimpleWebServiceConfigurableProvider" for more information.

Login Channel

The login channel shows up in the anonymous user's Desktop, enabling users to log in. You can select one out of the three methods to enable users to log in: LDAP, Membership, or Unix.

Code Example 3-12 shows the display profile definition for the login channel.

---

Code Example 3-13    Display Profile Definition for the Login Channel

<Channel name="Login" provider="LoginProvider">

<Properties>

<String name="refreshTime" value="600" advanced="true"/>

<String name="title" value="Login "/>

<String name="description" value="Login Information"/>

<String name="fontFace1" value="Arial"/>

<String name="width" value="thin" advanced="true"/>

</Properties>

</Channel

Table 3-12 lists the properties specific to the login channel. This two column table lists the properties in the first column and the values in the second column.

Table 3-12    Login Channel Specific Properties  

Property	Value
refreshTime	600
title	Login
description	Login Information
fontFace1	Arial
width	thin

These channel-defined properties overwrite the corresponding properties in LoginProvider. Properties not defined in the channel are picked up from LoginProvider. For example, LoginProvider sets the isEditable property to true, so an edit view for the channel is provided and user can customize the channel. See "LoginProvider" for more information.