Siebel Developer's Reference > Siebel Web Engine Tags >

swe:threadbar, swe:for-each-thread, swe:threadlink, swe:stepseparator

The thread bar is used to track user navigation among the views. A thread bar in HTML text format has been implemented. An example of the thread bar is as follows:

     Home > Consumer:PCs > PCs:Laptops > Laptops:Pentium III

where Home, Consumer:PCs, and so on, are the thread buttons. The thread buttons are displayed in title: value format, and either title or value can be omitted when appropriate. The thread button may contain a hyperlink, which leads the user to a previous page. The thread buttons are separated by separators. In the preceding example, the right-angle bracket (>) is the separator.

For thread buttons that include a hyperlink, the hyperlink requires a new SWE Command: GotoBookmarkView. The hyperlink for each thread button must contain at least the following parameters:

SWECmd=GotoBookmarkView&SWEBMCount=2SWECount =3

The SWEBMCount = 2 indicates that bookmark #2 is used to create the view. SWECount=3 is the bookmark ID for the current view. With the definition of the SWE tags and thread link format, a thread button for account AK Parker is translated into HTML format as:

<a href = "www.siebel.com/start.swe?SWECmd=GotoBookmarkView&SWEBMCount=2& SWECount=3> Account: AK Parker </a>

A new bookmark is created when the user clicks the thread button and brings back a bookmarked view. The bookmark ID for the new view is the current SWE count (the count passed to the server in the request) increased by 1.

Bookmark deletion policy is not modified by the bookmark ID assignment policy. By default, the system keeps the 20 most recently created bookmarks and delete previous ones. If the SWE count in the user request is less than the SWE count on the server side, all the bookmarks with a SWE count larger than that in the user request are deleted.

The HTML thread bar is based on the same configuration that was used previously to display the client thread bar. The behavior of the thread bar also remains unchanged, and is summarized here:

• When a new screen is requested, a new thread is created to replace the current thread.
• When a view button is clicked, the last thread step is replaced by that of the new view requested.
• When the user follows a drill-down link, a new step is appended to the thread bar for the view requested.
• When a thread button is clicked, all the thread buttons to the right of it are deleted.
• Some views may not have a thread applet or thread field defined. Showing these views does not cause the thread button to be updated.

When a thread button is clicked, the thread is truncated up to the step view indicated by SWEBMCount.

Syntax

The following three new SWE tags are defined to create an HTML thread bar: swe:for-each-thread, swe:threadlink, and swe:stepseparator. The usage of these SWE tags is very similar to that of the screen bar and view bar tags.

swe:for-each-thread

This tag iterates over each of the thread steps to show its contents.

swe:threadlink

This tag indicates the definition of a thread button on the thread bar.

Usage

<swe:threadlink property="xxx" title="yyy">...</swe:threadlink>

Attributes

FormattedHtml. Indicates that HTML hyperlink must be included.

Title. Indicates that the title=value pair of the thread button must be displayed.

swe:stepseparator

This tag specifies the symbol used to separate thread buttons. Include at the beginning or the end of the swe:threadbar block.

Usage

<swe:stepseparator> separator_symbol </swe:stepseparator>

Attributes

None

NOTE:  Use the swe:threadlink and swe:step separator tags only within the swe:threadbar tag.

Example

To use a thread bar, insert thread bar definitions into an appropriate SWT file as in the following example:

<swe:threadbar>

... HTML ...

<swe:for-each-thread>

... HTML...

<swe:threadlink property="FormattedHtml">

<span class="threadbar"><nobr><swe:this property="Title"/></nobr></span>

</swe:threadlink>

... HTML ...

<swe:stepseparator>

<span class="threadbardiv">&nbsp;&gt;&nbsp;</span>

</swe:stepseparator>

... HTML ...

</swe:for-each-thread>

... HTML ...

</swe:threadbar>

This creates a thread bar as shown:

Home > Consumer:PCs > PCs:Laptops

For applications without frames, put the definition in a container page such as CCPageContainer.swt; for applications with frames, insert it in the view bar frame swt file or the view frame swt file.