Bookshelf v7.8: About Using the Thread Bar in Templates

Configuring Siebel eBusiness Applications > Overview of Web Templates and Siebel Tags >

About Using the Thread Bar in Templates

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

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 above example.

A thread button may have a hyperlink that leads the user to a previous page. The hyperlink requires a new SWE Command: GotoBookmarkView. The hyperlink for each thread button should contain at least the following parameters:

SWECmd=GotoBookmarkView&SWEBMCount=2SWECount =3

The SWEBMCount = 2 indicates that bookmark #2 will be 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 A.K. Parker will be 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 with the above bookmark ID assignment policy. By default, the system keeps the most recently created 20 bookmarks and deletes 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 what is in the user request is deleted.

The behavior of the HTML threadbar is summarized below:

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 drilldown link, a new step is appended on the thread bar for the view requested.
When a thread button is clicked, all the thread buttons to the right of it are all deleted.
Some views may not have a thread applet or thread field defined. Showing these views do not cause the thread button to be updated.

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

The following three swe tags are defined to create an HTML thread bar. The usage of these swe tags is very similar to that of the screen bar and view bar tags.

<swe:threadbar> Indicates the start and finish of the thread bar section.
<swe:threadlink> Indicates the definition of a thread button on the thread bar. This tag has two properties defined:
- FormattedHtml property. Indicates that HTML hyperlink should be included.
- Title property. Indicates that the title/value pair of the thread button should be displayed.
<swe:stepseparator> Specifies the symbol used to separate thread buttons.

The <swe:threadlink> and <swe:stepseparator> tags should only be used within the <swe:threadbar> tag.

To use a thread bar, insert thread bar definitions into an appropriate SWT file by using the tags defined above. An example is given below:

</td>

<swe:threadbar>

<swe:threadlink property="FormattedHtml">

</swe:threadlink>

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

</swe:threadbar>

</td>

</tr>

</table>

This creates a thread bar as shown below:

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 "Viewbar" frame swt file or View frame swt file.

Configuring Siebel eBusiness Applications