7Siebel Web Engine Tags
About OD Tags
An Object Definition (OD) tag is an HTML tag that you can insert in a Siebel Web Template. It specifies how to format and display a repository object that resides in an HTML page in the client. For more information, see Configuring Siebel Business Applications.
An OD tag includes the following prefix:
od-
For brevity, this chapter includes this prefix only in the format description and code example.
Applet Tags
This topic describes tags that you can use to configure how OD displays an applet. It includes the following topics:
Applet Tag
The applet tag references an applet that OD displays in a view. It uses the following format:
<div od-type="applet" id="1" var="Parent"/>
where:
id.References an applet that uses the View Web Template Item list.
var. Allows you to use a variable in the applet template that configures the <div od-if="Context, <>"> tag to conditionally display HTML. For example, you can use the applet tag to display the Applet Title in the applet template only if the applet is a top (highest level) applet.
You can use the applet tag only in a view Web template.
Applet Layout Tag
The applet layout tag controls the layout of an applet. You can use it to determine the HTML content that SWE displays according to the current view layout mode and layout preferences. It uses the following format. You must specify at least one attribute:
<div od-type="layout" viewDisplayMode="view_mode" appletDisplayMode="applet_mode" appletDisplaySize="size"/>
where:
viewDisplayMode. Optional. You can use one of the following values:
Layout. OD displays the tag only if Siebel CRM is in Edit View Layout mode.
Show. OD displays the tag only if Siebel CRM is not in Edit View Layout mode.
If you do not include the viewDisplayMode attribute, then OD displays the tag regardless of the Edit View Layout mode.
appletDisplayMode. Optional. You can use one of the following values:
Show. OD displays the tag only if the applet is visible.
Hide. OD displays the tag only if the applet is hidden.
If you do not include the appletDisplayMode attribute, then OD displays the tag regardless of applet visibility.
appletDisplaySize. Optional. You can use one of the following values:
Min. OD displays the tag only if the applet is minimized.
Max. OD displays the tag only if the applet is maximized.
If you do not include the appletDisplaySize attribute, then OD displays the tag regardless of applet display size.
Control Tag
The control tag provides a placeholder in an applet Web template for a control or list column. It uses the following format:
<div od-type="control" id="1" property="property_name"/>
where:
id. Maps a child applet, control, or list column to this placeholder tag.
property. Optional. If you include this attribute, then it identifies the property of the control or list item that OD displays on the Web page.
You can use this tag only in an applet Web template of type Base, Edit, New, or Query.
You cannot nest the control tag. For example, SWE does not support following usage:
<div od-type="control" id = "1"> <!--the "parent" control <div od-property="displayname"/> <div od-property="FormattedHtml"/> <div od-type="control" id = "2" property="formattedHtml"> <!-- A child control gets context or gets properties from its "parent> <!--od section control close–> <!--End of parent -->
Defining the Property Attribute of the Control Tag
The following table describes the values that you can use for the property attribute. You can use this attribute only in a singleton tag. A singleton tag is a tag that does not include a required end tag.
If you do not include this attribute, then:
This tag displays the body only if the ID attribute maps the control ID.
You can use the following tag to display this user property in the body of the control tag:
od-property
Table Values You Can Use for the Property Attribute
| Value | Description |
|---|---|
| FormattedHtml |
Displays the data for a control or list item in HTML. |
| DisplayName |
Displays the caption property of the control or list item. |
| ListHeader |
Displays a column header for a list column that includes links that the user can use to sort the column. You can use this value only with a control tag that Siebel CRM maps to a list column that resides in the Base template of a list applet. |
| RequiredIndicator |
Displays an icon if the control is required. For example, assume the user must enter a value for the control before Siebel CRM can save the record to the database. The RequiredIndicator parameter that resides in the OD section of the application configuration file identifies this icon. |
Form Applet Layout Tag
The form-applet-layout tag contains the controls that reside in the main body of a form applet. It uses the following format:
<div od-type="form-applet-layout"> <!--od section form-applet-layout close–>
This tag does not include any attributes. You cannot use the idgroup tag in this template. For more information, see Map Siebel Object to OD Tag.
Master and Detail Applet Tags
The <div od-iterator=childIterator> and <div od-iterator=child-appletIterator> tags display a view that includes master and detail applets. This view is similar to the layout that a catalog uses. SWE can interweave the records that it displays in these applets instead displaying only master records in the master applet and only detail records in the detail applet.
You can configure the master and detail applets as list applets to create a layout that is similar to a catalog. To define a relationship between these applets, you can use the Position attribute of the view web template item. This attribute is similar to the Position attribute of a tree node:
The master applet uses a first-level position value, such as 1 or 2.
A child applet uses a second-level position value, such as 1.1 or 1.2.
A grandchild applet uses a third-level position value, such as 1.1.1 or 1.1.2.
SWE can display more than one set of master and detail relationships in a view where more than one master applet can exist.
Siebel CRM only maps the master applets to the applet tags that the view template contains. It does this mapping in the view web template item. It does not assign IDs to the other applets that the view web template item contains. It specifies the layout of nonmaster applets in the applet template of the master applet. It does not specify this layout in the view template.
Siebel CRM supports this layout only for an applet that is in base mode.
Example of Using Master and Detail Applet Tags
In the example that this topic describes, assume a master and detail view includes the Category Items List Applet as the master applet and the Sub Category Items List Applet as the detail applet. The following table lists the view web template items that this view uses.
| New Identifier | Applet | Applet Mode | Position |
|---|---|---|---|
| 101 |
Category Items List Applet |
Base |
1 |
| Sub Category Items List Applet |
Base |
1.1 |
The base template for the Category Items List Applet contains the following code:
<table>
<div od-iterator="row">
<tr>
<td>
<div od-type=control id ="5001" /> </td><!-- field value similar to "Small Business" -->
<td>
<div od-iterator=childIterator>
<div od-type=child-applet> <!-- Display the child applet-->
<!--od section child-applet close–>
</td>
</tr>
<!--od section iterator close–>
</table>
The base template for the Sub Category Items List Applet contains the following code:
<table><tr> <div od-iterator="row"> <td> <div od-type=control id="5001"/> </td><!-- field value similar to "Desktop" --> <!--od section iterator close–> </tr></table>
Iterate Child Applets Tag
The <div od-iterator=childIterator> tag iterates each of the child applets that Siebel CRM defines for this applet according to the position value of the view web template that resides in the view that references this applet. It uses the following format:
<div od-iterator=childIterator>> ...... <!--od section iterator close–>
SWE can use this tag only in the base template of an applet. If the applet does not contain a child applet, then SWE ignores this tag.
Child Applet Tag
The child-applet tag places a child applet in a parent applet. The base template of this child displays the child at the point where SWE places this tag.
The child-applet tag uses the following format:
<div od-type=child-applet/>
You can set the HTML Number of Rows property of the Sub Category Items List Applet to the number of values that SWE must display in each category.
You must configure the appropriate drilldown objects to allow the user to drill down from the category and subcategory values.
Select Row Tag
The select-row tag displays check boxes in a multiselect list applet. This applet allows the user to choose multiple items for a transaction. To make these choices, the user clicks the check boxes that SWE displays in the first column.
This tag uses the following format:
<div od-type=select-row property="FormattedHtml"/>
where:
property. If the applet is enabled for multirecord selection in Siebel Tools, and:
If you set the property attribute to FormattedHtml in the select-row tag or in this tag, then SWE displays the check box. For more information, see This Tag.
If you do not include the property attribute, then SWE displays the body of this select-row tag.
For example:
<div od-type=select-row property="FormattedHtml"/>
For example:
<div od-type=select-row> <div od-property="FormattedHtml"/> <!--od section select-row close–
You can set the HTML Multi Row Select property of the list object of the applet to TRUE to enable multirecord selection in Siebel Tools.
Using the Select Row Tag
You can use the select-row tag to create a generic list applet template that SWE can use with a list applet that does or does not support multirecord selection in the following locations:
In the list header. You can use the select-row tag to conditionally add a td tag for the header for the row selection check box column.
In the list body. You can use the select-row tag with the this tag to conditionally add a td tag that contains the check box.
You must place list applet controls and list columns in a form tag when you enable multirecord selection. Any method that resides on the applet requires that SWE submit the form that contains the row selection check boxes. For more information, see Form Tag.
If the user chooses multiple records, then Siebel CRM does not disable a control that does not support calling a method. This situation occurs because Siebel CRM does not call the Siebel Server if the user chooses multiple records. Instead, if the control is activated, then Siebel CRM sends a message to the user that states that it cannot do the action if multiple records are chosen.
How the Select Row Tag Positions the Current Record
The select-row tag positions the current record differently than how the PositionOnRow control positions this record. A single list applet can contain the PositionOnRow control and the Multiple Row Selection. Siebel CRM chooses the record where the business component is currently positioned when the user navigates to a list applet. The user can use the check box to remove the check mark for this record.
Unlike PositionOnRow, no round trip occurs to the Siebel Server when the user uses a check box to choose rows. Siebel CRM identifies the records as chosen on the business component only if it calls a method that resides on the applet. The user can choose records across multiple pages. The user can use the Next and Previous controls and can also choose records from different working sets.
How the HTML Client Framework Chooses Records
If Siebel CRM calls a method that resides on an applet, then the HTML Client framework sets the chosen records in the business component. This configuration occurs in the PrepareToInvokeMethod method before it calls the DoInvokeMethod method. These methods reside in the CSSSWEFrame class. Siebel CRM does the following work when the framework uses a command to call a method that resides on an applet:
Positions the parent business component of the applet, if it exists, on the correct records.
Positions the business component that the applet references in the currently active record, if necessary.
If Siebel CRM identifies multiple records, then it calls the SelectRowById method of the CSSBusComp class to choose these records in the business component.
To call the method on the applet, Siebel CRM calls the DoInvokeMethod method of the CSSSWEFrame class.
The CSSSWEFrame class does not include any methods that support multiple records. If a specialized applet supports this feature, then the DoInvokeMethod method must be specialized. The DoInvokeMethod method calls the IsMultiRecSelected method of the CSSSWEFrame class to determine if multiple records are chosen. If TRUE, then it calls the EnumAllSelections of the CSSBusComp class to get all the records that are currently chosen in the business component. For important caution information, see Using Specialized Classes.
Form and Web Page Tags
This topic describes tags that you can use to configure how SWE displays a form and how it uses a web page. It includes the following topics:
Form Tag
The form tag creates an HTML form that allows the user to input information. It uses the following format:
<div od-type=form name="form_name" htmlAttr="attribute_names"> ... <!--od section form close–>
where:
name.Optional. Specifies the HTML form name. If not specified, then SWE uses a name that it creates internally.
htmlAttr. Optional. The value for this attribute must contain the names of valid attributes that the HTML form tag contains. SWE applies these attributes to the HTML form that it creates. You cannot use the following values:
method
name
action
Web Page Item Tag
The pageitem tag provides a placeholder in a web page for a web page item. It uses the following format:
<div od-type=pageitem id="1" property="FormattedHTML"/>
where:
id. Identifies a web page item.
property. Optional. Identifies the property of the Web page item that SWE displays on the Web page. You can use this attribute only in a singleton tag.
You can use one of the following values.
FormattedHtml. Display the data for the Web page item in HTML.
DisplayName. Display the caption property of the Web page item that the repository contains.
If you do not include the property attribute, then:
SWE displays the body only if the Web page item ID is mapped.
SWE can use the this tag to display the property in the body of the pageitem tag. For more information, see This Tag.
You can use this tag only in a Web page.
Frame Tags
This topic describes tags that you can use to configure how SWE uses frames. It includes the following topics:
The frame tags allow SWE to control how it refreshes URLs. You can use them in the following situations:
Container page template. Creates the frame definition document for SWE. Note the following:
It is recommended that you define the contents of the frame that uses the include tag, but it is not required. You can place these contents in the body of the frame tag. For more information, see Include Tag.
The contents of the frame tag must include the entire HTML document. It must include the HTML document structure tags, such as the html, head, and body tags, and so on. This content must include the view templates.
If the type is View, then the contents of the frame tag must contain only the current-view tag. For more information, see Current View Tag.
View template. Used in a View template to create a frame definition document that displays the applets that the view contains. SWE refreshes these frames only if one or more of these applets contains new data. Note the following:
SWE can use a frame in a View template only if it also uses this frame in the container page, and only if a separate frame exists in the container page for the View.
If you place an applet in a frame, then you must make sure that Siebel CRM maps at least one applet tag in this frame to an applet. If you do not do this, then an empty frame might occur. For more information, see Applet Tag.
If a frame tag contains an applet tag, then you must set the type attribute of this tag to Applet.
Frame Tag
The frame tag identifies the beginning and end of the contents that SWE places in a frame. SWE displays this tag as an HTML frame tag, with the src attribute of this tag set to a SWE URL that gets the contents of the frame.
The frame tag uses the following format:
<div od-type=frame type="frame_type" name="frame_name"> .... <!--od section frame close–>
where:
type. Identifies the frame type. SWE uses this information to determine when to refresh this frame. You can use one of the values that the following table describes.
| Value | Description |
|---|---|
Screenbar |
In a container page template, specifies that the frame contains the primary tab bar. |
Viewbar |
In a container page template, specifies that the frame contains Siebel CRM menus, a visibility drop-down list, and a search drop-down list. |
View |
In a container page template, specifies that the frame contains the current view that includes the content area. |
Page |
In a container page template, specifies that the frame contains a Web page. SWE does not refresh these frames after initial loading. |
Applet |
In a View template, specifies that the frame contains an applet. |
Content |
Creates a frameset that includes view frames. It supports how Siebel CRM displays multiple views in some features, such as Search Center. The Content frame typically includes a frameset that contains only the View frame. Other content frames can include framesets that include two or more frames, the View frame, and frames that display other views, such as the Search View. |
AltView |
Configures subframes to display one or more alternate views in the content frame, such as Search Center, in addition to the view in the View frame. |
name. Optional. Specifies a name for the frame. You can use this attribute only if the type of the frame is Page. SWE creates a typical name for other frame types.
You must place the frame tag in the body of the frameset tag.
SWE can support a nested frameset where:
The frame tag contains a frameset tag.
the Type attribute of the outer frame tag is Page.
Frameset Tag
The frameset tag defines the set of frames that the document contains. It uses the following format:
<div od-type=frameset htmlAttr="attribute_names"> ... <!--od section frameset close–>
where:
htmlAttr. Specifies the attributes for the HTML frameset tag.
SWE displays the frameset tag as an HTML frameset tag. The body of the frameset tag can only contain frame tags.
Program Logic Tags
This topic describes tags that you can use to control program logic, such as how SWE handles errors or does conditional branching. It includes the following topics:
Error Tag
The error tag displays an error message. If an error occurs on the Siebel Server when Siebel CRM:
Submits a form. SWE displays the same page again and it includes the error message.
Does not submit a form. SWE continues to use the application error page.
You can use one of the following formats:
Format one:
<div od-type=error>
Format two:
<div od-type=error property="FormattedHtml"/>
Format three:
<div od-type=error> <div od-property=FormattedHtml"/><!--od section error close–>
For example:
<div od-type=form> <div od-type=error> <b> <font color="red"> <div od-property="FormattedHtml"/> </font> </b> <!--od section error close–> .....<!--od section form close–>
Note the following:
You can use the error tag in any form tag.
If you do not use an error tag in a Siebel Web template, then the code creates a CSSSWEErrorSWX instance as an error node. It inserts this error node as the first child of the enclosing page or form node.
If no errors exist when SWE displays a form, then it ignores the contents of the error tag.
SWE displays the error message in plain text in a new paragraph. If the error message font uses the same color as the background, then it is not visible. You can use the enclosing HTML tags to modify the font and style that Siebel CRM uses for the error message.
Siebel CRM uses a dialog box to display an error.
You must use the error tag instead of using the pageitem tag mapped to the _SWEErrMsg item in the application error page. Siebel CRM does not support the _SWEErrMsg item. For more information, see Web Page Item Tag.
JavaScript Tag
The scripts tag specifies where to place any JavaScript that SWE creates for the page. It uses the following format:
<div od-type=scripts/>
This tag does not include any attributes.
Note the following:
SWE includes some JavaScript code in every page that it sends to the browser. This code must occur after all the Siebel content that the page contains, and it must reside in the HTML body tag.
The scripts tag must be the last Siebel SWE tag that the template contains, and it must reside in the HTML body tag.
SWE determines the correct placement of this tag, repositions it, if necessary, and removes any scripts tags that it does not require.
If you do not specify the scripts tag, then SWE places the JavaScript code immediately after the last tag that the page contains, by default. In some situations, this configuration might occur in an HTML formatting tag that is similar to td … /td. This configuration might cause a minor formatting problem when the browser displays the page.
If Tag
The if tag implements a simple IF THEN conditional branch. It uses the following format:
<div od-if condition="business_service,business_service_method,argument1:value1,argument2:value2,..."> ... <!--od section if close–>
where:
condition. Defines the condition.
argument:value defines an argument and value pair.
If SWE evaluates the condition to:
TRUE. It processes the body of the if tag.
FALSE. It ignores the body of the if tag.
You can use the if tag with any business service, such as a custom business service that examines an HTTP header. The output arguments for this business service must contain a property that includes the name of the business service method and a value of 1 or 0 that indicates if the condition is true or false.
The predefined Web Engine State Properties business service supports the following conditions:
IsEvenRow
IsOddRow
IsCurrentRow
IsErrorRow
IsRowMultipleOf
IsRowPositionOf
IsLastDisplayedRow
IsHighInteractive
IsHighInteractiveApplet
IsLowInteractive
Invalid
Iterate Tag
The <div od-prefix> tag iterates a tag according to the number of times that you specify. It can reduce the size of template files if SWE uses the same HTML tags, and if Siebel tags contain controls or page items that include different values for the ID parameter.
This tag uses the following format:
<div od-prefix od-id="startValue:count" od-iterator="iterator_Name"/>
where:
count. Specifies the number of times the tag iterates the tag contents.
iteratorName. Specifies the name of the iterator. You can use the following format to get the value of the iterator during the iteration:
od-iterator="iterator_Name"
You must replace the iteratorName attribute with the actual name of the iterator. For example, if you set the value of the iteratorName to CurrentID, then you must use the following format:
od-iterator=CurrentID
startValue.Specifies the value that SWE assigns to the iterator at the start of the iteration. To do the iteration, SWE assigns this start value to the iterator, and then increments the iterator by one for each iteration.
Iterate Rows Tag
The <div od-iterator=row> tag iterates each record that SWE displays in a list applet. It creates columns of data that SWE displays in a list applet. It uses the following format:
<div od-iterator=row od-id=[0:<count-1>]/>
where:
count.Specifies the maximum number of records to iterate. If the number of records that the list applet contains is less than this count, then the tag only iterates for the number of records that the list applet contains.
You can use this tag only in a Base template for a list applet.
Switch, Case, and Default Tags
The switch, case, and default tags provide conditional branching that is similar to the switch, case, and default statements in the C++ language. For example, they can use the following format:
<div od-switch>
<div od-case condition="case_tag_attribute">
...
</div od-case>
<div od-case condition="case_tag_attribute">
...
<!--od section case close–>
<div od-default>
...
</!--od section default close–>
<!--od section switch close–>
where:
condition. Is an attribute of the case tag that specifies the condition that SWE examines. The condition attribute uses the same format that the if tag uses. If any case tag:
Satisfies the condition. SWE ignores all subsequent case tags and default tags. It processes the body of the if tag.
Does not satisfy the condition. SWE processes the body of the default tag.
For more information, see If Tag.
Note the following:
The switch tag is a container tag that SWE uses for the case and default tags. SWE ignores any other type of tag that the body of the switch tag contains.
SWE examines the case tags starting with the first case tag it encounters.
SWE allows only one default tag in the body of a switch tag.
Referential Tags
This topic describes tags that you can use to configure SWE to reference objects. It includes the following topics:
Include Tag
The include tag includes another template in the current template file. It uses the following format:
<div od-include="_name"/>
where:
include. Identifies the name of the template that SWE must include.
Map Siebel Object to OD Tag
The idgroup tag maps a Siebel object to OD. It uses the following format:
<div od-type=idgroup name="namespace_ID">
where:
name. Identifies the namespace ID. You must identify the namespace to support mapping.
SWE can apply the namespace to other mappings, such as an applet or page item.
Example of Mapping Siebel Objects to OD
For example, assume Siebel CRM must display an applet that includes a DHTML menu in Internet Explorer 5.0, and that it must use regular controls instead of the menu that other browsers use. All other controls that the applet contains are the same for all browsers. To use mappings that are specific to the browser, you can include each mapping in an idgroup tag. For example:
<div od-switch>
<div od-case condition="Web Engine User Agent, IsMemberVirtualUA,
'VirtualAgent:IE5'">
<div od-type=idgroup name="IE5">
<div od-type=menu>
...
<!--od section menu close–>
<!--od section idgroup close–>
<!--od section case close–>
<div od-default>
<div od-type=idgroup name="NonIE5">
<div od-type=control id="1" ..>
<div od-type=control id="2" ..>
<!--od section idgroup close–>
<!--od section default close–>
<!--od section switch close–>
<div od-type=control id="3" ..>
<div od-type=control id="4" ..>
In this situation, the NonIE5 namespace identifies the 1 and 2 IDs when SWE maps applet controls to the control tags. The Namespace property of the applet web template item stores the namespace value. The Web Layout Editor in Siebel Tools automatically populates this attribute. The mappings to the control tags that include IDs 3 and 4 reside outside of the namespace. This attribute is empty for these mappings. For more information, see Control Tag.
This Tag
The this tag references the object that contains it:
If it is nested in another tag, then it references a property of the parent tag.
If it resides outside of a tag, then it references the property of an applet, view, or application according to the type of the template where it resides.
This tag uses the following format:
<div od-type=control id="1" > <td> <div od-property="DisplayName"/>: </td> <td> <div od-property="FormattedHtml"/> </td> <!--od section control close–>
where:
property. Identifies the name of the property that this tag references. You can use this tag in any OD tag that includes a property attribute.
The following table describes how you can use the this tag. You can use this tag only as a singleton tag except when it references a viewlink tag or a screenlink tag. For more information, see View Tags.
Table How You Can Use the This Tag
| Where the This Tag Resides | What it References | Property Attribute Values |
|---|---|---|
| Applet Web Template |
Applet |
The property attribute can contain the following values:
|
| View Web Template |
View |
The property attribute can contain the following values:
|
| Web Page |
Application |
The property attribute can contain the following values:
|
This Id Tag
The this.Id tag creates scrollable tab bars for a screen or view. It creates a unique ID for the HTML td tag that contains each tab. It uses the following format:
<div od-type=screenlink> <td id="od-context-Id" ...> ... </td> <!--od section screenlink close–>
You can use this tag only in the HTML td tag that contains a screen, view, or subview tab. You can add it to any one of the following tags:
This.TableId Tag
The this.TableId tag creates scrollable tab bars for a screen or view. It creates a unique ID for the HTML table tag that contains the tabs. It uses the following format:
<div od-type=screenbar>
...
<table ID="od-context-TableId" ...>
<div od-iterator=screenIterator>
...
<!--od section iterator close–>
</table>
...
<!--od section screenbar close–>
You can use the this.TableId tag only in the HTML table tag that contains the screen, view, or subview tabs. You can add it any one of the following tags:
Threadbar Tags
This topic describes tags that you can use to configure the threadbar. It includes the following topics:
The threadbar tracks user navigation among views. The following is an example of the threadbar. The right-angle bracket (>) is a separator:
Home > Consumer:PCs > PCs:Laptops > Laptops:Pentium III
where:
Home, Consumer:PCs, and so on, are the thread buttons.
About Threadbar Behavior
If the user clicks the thread button, then SWE creates a new bookmark, and then displays a bookmarked view. The bookmark ID for the new view is the current SWE count plus 1. Siebel CRM sends this count to the Siebel Server in the request. The threadbar does the following:
If Siebel CRM requests a new screen, then SWE creates a new thread that replaces the current thread.
If a user clicks a view button, then SWE replaces the last thread step with the view that the user requests.
If the user clicks a link, then SWE appends a new step to the threadbar for the view that the tag references.
If the user clicks a thread button, then SWE deletes all the thread buttons that exist after the button that the user clicks. It deletes the thread up to the step view according to the value of the SWEBMCount parameter.
If a thread applet or thread field is not defined for a view, and if Siebel CRM displays this view, then SWE does not update the thread button.
The bookmark ID assignment policy does not modify the bookmark deletion policy. Siebel CRM keeps the 20 bookmarks that it created most recently and deletes previous bookmarks, by default. If the SWE count in the user request is less than the SWE count on the Siebel Server, then Siebel CRM deletes all the bookmarks that contain a SWE count that is larger than the count in the user request.
Usage for the threadbar tags is similar to behavior of the following tags:
For Each Thread Tag
The <div od-iterator=threadIterator> tag iterates each of the thread steps to display the contents of these steps. It uses the following format:
<div od-iterator=threadIterator>
Thread Separator Tag
The threadseparator tag specifies the symbol that separates thread buttons. You include it at the beginning or the end of the threadbar tag. It uses the following format:
<div od-type=threadseparator> separator_symbol <!--od section threadseparator close–>
You can use the threadlink and step separator tags only in the threadbar tag.
Thread Link Tag
The threadlink tag identifies the thread button on the threadbar. It uses the following format:
<div od-type=threadlink property="value" title="value">...<threadlink>
where:
formattedhtml. Include an HTML link.
title. Display the title=value pair of the thread button.
Example of Using the Threadbar Tags
To use a threadbar, you insert threadbar tags in an appropriate web template. For example:
<div od-type=threadbar>
... HTML ...
<div od-iterator=threadIterator>
... HTML ...
<div od-type=threadlink property="FormattedHtml">
<span class="threadbar"><nobr><div od-property="Title"/></nobr></span>
<!--od section threadlink close–>
... HTML ...
<div od-type=threadseparator>
<span class="threadbardiv"> > </span>
<!--od section iterator close–>
... HTML ...
<threadseparator>
... HTML ..
<!--od section threadbar close–>
This code creates the following threadbar:
Home > Consumer:PCs > PCs:Laptops
If your Siebel Business Application:
Uses frames. Put the tags in the web template that contains the view bar frame or the web template that contains the view frame.
Does not use frames. Put the tags in a container page, such as the PageContainer web template.
Togglebar Tags
This topic describes tags you can use to configure the togglebar.
For Each Toggle Tag
The toggleIterator tag iterates the number of toggle applets. It displays the contents of these toggle applets. It uses the following format:
<div od-iterator=toggleIterator>
This tag does not include any attributes.
Toggle Bar Tag
This topic describes tags that you can use to configure the toggle bar. It includes the following topics:
tag work. For more information, see Viewbar Tag.
It uses the following format:
<div od-type=togglebar type="value" property="value">
where:
type. If you set this attribute to:
Select. SWE displays the togglebar as an HTML Select control, which is supported in Siebel OpenUI. This control lists applet titles that the user can click to toggle applets.
property. If you set this attribute to FormattedHtml, then SWE displays the HTML Select control.
If you do not include this attribute, and if toggle applets are defined, then SWE uses the this tag in the body of this togglebar tag to display the select control. For more information, see This Tag.
You can use the property attribute only if you set the type attribute to Select.
If a toggle applet is not defined for the applet, then SWE ignores the togglebar tag.
Toggle Link Tag
The togglelink tag creates a toggle link. It uses the following format:
<div od-type=togglelink state="active or inactive" property="value">
where:
state. Optional. You can use one of the following values:
Active. Use this tag only if the current applet title identifies the currently active applet.
Inactive. Use this tag only if the current applet title does not identify the currently active applet.
If you do not include the state attribute, then SWE displays this tag in all applets.
property. Optional. If you set this attribute to FormattedHtml, then SWE creates the HTML that creates a link that the user can use to toggle the applet. If you do not include this attribute, then SWE does nothing.
Toggle Name Tag
The togglename tag displays the applet title. It uses the following format:
<div od-type=togglename/>
Examples of Using the Togglebar Tags
The following code displays toggle applets as a select control:
<div od-type=togglebar type="Select" >
<table>
<tr>
<td> <div od-type=control id="1" property="DisplayName"> </td>
<td> <div od-property="FormattedHtml"/> </td>
</tr>
</table>
<!--od section togglebar close–>
where:
SWE uses the control to create a label that is similar to the following. It places this control before the select control:
Show:
The following code displays the toggle applets as tabs or links:
<div od-type=togglebar>
<table>
<tr>
<td><div od-type=togglelink property="FormattedHtml"> <div od-type=togglename>
<!--od section togglelink close–>
</td>
</tr>
</table>
<!--od section togglebar close–>
Toolbar Tags
This topic describes toolbar tags. It includes the following topics:
A toolbar or toolbar item allows the user to start an action. Siebel CRM displays the toolbar in a separate frame. Siebel CRM maps a command object definition to:
A toolbar item or toolbar icon that resides in an application-level menu or menu item.
An applet method menu item that resides in an applet menu.
A toolbar icon or toolbar menu item can reference a method name, a method handler, or a service. This service can reside in one of the following locations:
On the Browser or the Siebel Server
In an applet class, business component class, SWE frame manager, or business component data in the Browser or Siebel Server.
Configuring an HTML or Java Toolbar
Siebel CRM supports the following types of toolbars:
HTML toolbar. Resides in the starting frame or first quadrant in the template. To add an HTML toolbar, you add the following code to the web template:
<div od-type=toolbar name=value> // any HTML here... <div od-type=toolbaritem> // any HTML here... <!--od section toolbar close–>
where:
value is the toolbar name that exists in the repository.
To configure a box item, you must configure the command so that it references a service.
Java toolbar. Resides in the frame after the starting frame in Siebel Call Center and other applications that use (CTI) computer telephony integration. If a Siebel Business Application does not use any Java toolbar, then Siebel CRM does not include this lower frame.
To add a Java toolbar, you add the following code to the web template:
<div od-type=toolbar name="name" javaapplet="true"/>
The Java applet calls the ShellUIInit method on the service that the command references when the Java applet attempts to start. This applet calls the ShellUIExit method when it exits. Siebel CRM uses a set of communication protocols that it defines for the communication between the Java applet and the service.
Siebel CRM implements the toolbar as a Java applet that includes all the toolbar controls and the threads that interact with the Siebel Server.
Toolbar Tag
The toolbar tag specifies a toolbar. It uses the following format:
<div od-type=toolbar name="name" javaapplet="Boolean" />
where:
name. Name of the toolbar object definition that resides in the repository.
javaapplet. You can use one of the following values:
TRUE. Use a Java toolbar.
FALSE or this attribute does not exist. Use an HTML toolbar.
Toolbaritem Tag
The toolbaritem tag resides between the toolbar start and end tags. It gets all of the toolbar items for this toolbar from the repository. It uses the following format:
<div od-type=toolbaritem>
This tag does not include any attributes.
Tree Tags
This topic describes tags that you can use to configure an explorer view that contains a tree applet and a list applet that allows the user to view tree details. This view style displays hierarchically structured information in an expandable tree control. It includes the following topics:
SWE does the following:
Displays the tree control in a vertical frame before the applet.
Displays detailed information for the item that the user chooses in the tree. It displays these details in a detail applet in a vertical frame after the applet.
These vertical frames allow the user to scroll the tree applet independently of the detail applet. This configuration allows the tree to grow in length and width.
SWE does the following to display a tree:
Iterates each item of the tree.
Displays each item start-last, depth-first.
Displays one item at time.
Indents each tree item so that the text displays at the correct indent level relative to the master, and to display the expand and collapse button, the text of the item, and the links.
It uses one of the following to display the indentation, the expand button, the collapse button, and the item:
A series of GIF images.
Text if in text-only mode.
Displays the list applet that is associated with the currently chosen tree node as part of the view.
Applet Tree List Tag
The applet-tree-list tag is a placeholder for the list applet that SWE displays if the user chooses or expands a tree item. This list applet depends on the type of the item that is currently chosen.
This tag uses the following format:
div od-type=applet-tree-list
This tag does not include any attributes.
For Each Indent Tag
The <div od-iterator=indentIterator> tag creates an indentation. It iterates each level of a tree item. It does not include any attributes.
This tag uses the following format:
div od-iterator=indentIterator>
For Each Node Tag
The <div od-iterator=nodeIterator> tag display tree nodes and field values. It iterates each visible item in the tree control start-last and depth-first. If you do not specify the count attribute, then this tag iterates all nodes in the tree. This tag uses the following format:
<div od-iterator=nodeIterator>
Indent Image Tag
The indent-img tag provides a placeholder for the GIF image that corresponds to the current indentation level of a tree item. SWE identifies the GIF file it uses in the img tag at each level. The GIF image in this file can be an empty space or a vertical bar.
This tag uses the following format:
<div od-type=indent-img>
This tag does not include any attributes.
Node Tag
The node tag provides a placeholder for a tree item. This item can be one of the following:
Tree node. SWE displays the display name.
Field value. SWE creates the field value.
This tag uses the following format:
<div od-type=node state="value" type="value"/>
where:
state. You can use one of the following values:
Active. A chosen node.
Inactive. A nonchosen node.
type. You can use one of the following values:
DisplayName. Display the Display Name property of the tree node.
FieldValue. Display the field value.
The expand and collapse button, the item icon, and the links are part of a tree item. Depending on settings in the configuration file, SWE displays the expand and collapse button as a GIF image or as text. It displays the expand and collapse button only if the tree item includes a child item.
The following links are associated with each item:
A link for the expand and collapse button that expands or collapses the item.
A link for the item image that allows the user to choose the item or to navigate to the next or previous workset.
This tag uses the this tag as a child tag. For more information, see This Tag.
View Tags
This topic describes tags that you can use to configure how SWE displays a view. It includes the following topics:
Overview of Using View Tags
SWE can display the following views on a single page:
Main view. The user uses the level 2 or level 3 view bar to choose the main view. A page can include only one main view.
Alternate views. Any other view. For example, the Search view that displays applets.
SWE can display views in the following ways:
Each view in a separate HTML frame.
All views in a single frame.
Multiple views in the main browser window or in a dialog box.
The examples in this book describe multiple view layouts that use SWE frames. The description for usage without frames is similar except you can use HTML tables to position the views instead of frames and framesets.
To support multiple views, you must modify frames, framesets, and the Content Container. The Content Container is the container page for the content area.
Modifications that Occurred Starting with Siebel CRM Version 8.x
Siebel CRM version 8.x includes an outer content frame. If you configured a view frame in the application container page, then you must replace this view frame with a content frame. In prior versions, the application container page template that includes the view frame without the outer content frame does not create any errors, but it does allow you to configure Siebel CRM to display multiple views.
if you configured a view frame in the application container page in a version prior to Siebel CRM version 8.x, then you must replace this view frame with a content frame. This content frame defines the area where Siebel CRM can load one or more views. This frame contains a frameset that includes a view frame. The structure of this container template must be similar to the following example:
<div od-type=frameset htmlAttr="rows='80,50,50,*' border='0'frameborder='No'"> <div od-type=frame type="Page" htmlAttr="marginheight='0' marginwidth='0' noresize scrolling='No'"> <div od-include="CCFrameBanner"/> <!--od section frame close–> <div od-type=frame type="Screenbar" htmlAttr="marginheight='0' marginwidth='0' noresize scrolling='No'"> <div od-include="CCFrameScreenbar"/> <!--od section frame close–> <div od-type=frame: type="Viewbar" htmlAttr="marginheight='0' marginwidth='0' noresize scrolling='No'"> <div od-include="CCFrameViewbar"/> <!--od section frame close–> <!--od section frameset close–>
Displaying More Views in the Content Area
To display more views in the content area, you can configure Siebel CRM to load a different content container page in the content frame. To do this, you can configure SWE to call the LoadContentContainer method from a control or page item. The User Property Container sends this content container.You set this to the Web Template Name of the content container page.
For example, to display the search view with the main view, you can configure SWE to create a content container page, such as CCSMainAndSearchView, and then use the LoadContentContainer method to load it. The following code from the CCSMainAndSearchView web template contains the tags that load the main view and search view into two frames:
<div od-type=frameset htmlAttr="cols='100%' border='0' frameborder='No'">
<div od-type=frame: type="View" htmlAttr="noresize scrolling='Yes'">
<div od-type=current-view/>
<!--od section frame close–>
<div od-type=frame type="AltView" name="Search" htmlAttr="noresize scrolling='Yes'">
<div od-type=view name="Search View" id="Search" />
<!--od section frame close–>
<!--od section frameset close–>
The current-view tag references the main view. The view tag references alternate views.
Current View Tag
The current-view tag identifies the location or zone that an alternate view occupies. It uses the following format:
<div od-type=current-view>
This tag allows the user to navigate to other views when multiple view zones exist. In the example in the Displaying More Views in the Content Area topic, SWE navigates to the Search view the first time it displays the search view zone. During any subsequent display of this zone, the specialized frame code in the Search view can call the BuildViewAsync method or it can display controls that the GotoView method references that allow the user to navigate to other views. For important caution information, see Using Specialized Classes.
The main view contains an empty view ID.
If you configure SWE to make a call from:
The BuildViewAsync method. You must set the pViewId parameter to the View ID of the view that SWE must display.
A frame. You must use the view ID of the frame that the m_cszViewId data member of the frame sets. This data member is part of the CSSSWEFrame class. It identifies the view where the frame resides. This configuration causes Siebel CRM to display another view in the same view zone.
To configure the main view to navigate to another view, you can configure SWE to call the BuildViewAsync method and set the pViewId parameter to NULL.
You can use the following code to get a view:
CSSSWEFrameMgr::GetView (const SSchar* pViewId = NULL);
where:
GetView is a method that resides in the CSSSWEFrameMgr class.
You can use the following code to get the main view:
m_pFrameMgr->GetView()
You can use the following code to get the search view:
m_pFrameMgr->GetView ("Search")
For Each View Tag
The <div od-iterator=viewIterator> tag iterates the views that SWE displays in the view bar. It uses the following format:
<div od-iterator=viewIterator>
This tag does not include any attributes.
View Tag
The view tag identifies alternate views in a frame set. It uses the following format:
<div od-type=view name="name" id="ID">
where:
name. Name of the alternate view.
id. An ID that identifies the location or zone that this view occupies. This ID replaces this view with another view.
Viewbar Tag
The viewbar tag implements a drop-down list or a detail view list. It uses the following format:
<div od-type=viewbar type="value" mode="context" property="value">
where:
type. You can use one of the following values:
Select. If the user chooses this control, then display the view that this control references.
A value other than Select. Display the view bar as an HTML select control that includes the set of context or noncontext views, depending on the value of the mode attribute.
mode. You can use one of the following values:
Context. Display only context views.
NonContext. Display only noncontext views.
If you do not specify the mode attribute, then SWE displays all views.
property. You can use this attribute only if you set the type attribute to Select. If:
You set this attribute to FormattedHtml, then SWE displays the HTML select control.
You do not specify this attribute, and if no views exist that SWE can display, then SWE displays the contents of this viewbar tag.
How the Viewbar Tag Implements Drop-Down Lists and Tabs
The viewbar tag implements the drop-down list that Siebel CRM uses for second-level navigation and the detail view list that Siebel CRM uses for third-level navigation. You can use it to implement one of the following items:
Drop-down list. SWE populates each item in the drop-down list with the display name of a context view. It displays the visibility drop-down list in the view bar frame. To implement this drop-down list as a viewbar tag, the following code in the PageContainer web template or the CCFrameViewbar web template sets the Type attribute to Select and the Mode attribute to Context:
<div od-type=form> <td nowrap> <div od-type=viewbar type="Select" mode="Context"> <div od-property="FormattedHtml"/> <!--od section viewbar close–> </td> <!--od section form close–>
Tabs. SWE creates a horizontal view bar that includes tabs. It sets each tab label to the display name of a noncontext view. To implement this view bar, the following code in the CCViewbar_Tabs web template does not include the Type attribute and it sets the Mode attribute to NonContext:
<div od-type=viewbar> ... HTML ... <div od-iterator=viewIterator> ... HTML ... <div od-type=viewlink state="Active"> ... HTML .... <div od-property="FormattedHtml"> ... HTML .... <div od-type=viewname/> ... HTML ... <!--od section this close–> ... HTML ... <!--od section viewlink close–> <div od-type=viewlink state="InActive"> ... HTML .... <div od-property="FormattedHtml"> ... HTML .... <div od-type=viewname/> ... HTML ... <!--od section this close–> ... HTML ... <!--od section viewlink close–> ... HTML .. <!--od section iterator close–> ... HTML ..<!--od section viewbar close–>
The detail view bar requires the following tags. The drop-down list does not require these tags:
child viewIterator
viewlink
viewname
View Link Tag
The viewlink tag displays a link that the user can click to display a view. It uses the following format:
<div od-type=viewlink state="value" property="value" htmlAttr="value"/>
where:
state. Optional. You can use one of the following values:
Active. Use this tag only if the current view name identifies the currently active view.
Inactive. Use this tag only if the current view name does not identify the currently active view.
If you do not include the state attribute, then SWE displays this tag in all views.
property. Optional. You can only use FormattedHtml as the value for this attribute. It creates the HTML that defines the link. If you do not include this attribute, then SWE creates no output.
htmlAttr. Optional. Add more HTML attributes to the HTML tag.
To display HTML for an active view that is different than the HTML for an inactive view, you can use the viewlink tag without specifying the property attribute but with a value for the state attribute. If you do not include the property attribute, then you can use the this tag to display the property in the body of the viewlink tag. For more information, see This Tag.
View Name Tag
The viewname tag displays the view name. It uses the following format:
<div od-type=viewname>
Predefined Query Tag
The pdqbar tag displays the list of predefined queries for a view, runs a predefined query, and sends the query result. It uses the following format:
<div od-type=pdqbar>...HTML code... <div od-type=pageitem id="##"/> ...HTML code... <div od-property="FormattedHtml" /> <!--od section pdqbar close–>
To display a label, you can use a pageitem tag in the view bar or a control tag in the view. You include these tags in the pdqbar tag. For more information, see Web Page Item Tag and Control Tag.
Tags That Support a Specific Feature
This topic describes tags that you can use to configure how SWE displays a particular feature. It includes the following topics:
Language Conversion Tag
The dir tag creates a template that can work with a bidirectional language. If SWE displays:
A language that the reader reads from right to left (rtl), then it converts the dir tag to dir="rtl".
A language that the reader reads from left to right, it does nothing.
This tag uses the following format:
<HTML dir="div od-tpe=dir">
You can use this tag only in an HTML tag that includes the dir attribute.
Training Tag
A training tag is an OD tag that SWE uses only with Siebel Training Test. The following table describes these tags.
Table Training Tags
| OD Tag | Description |
|---|---|
| <div od-type=answer> |
Display an answer. |
| <div od-type=answerList> |
Display the list of answers for the test. |
| <div od-type=questionList> |
Display all the questions that the test contains. |
| <div od-type=questionPoints> |
Display the maximum number of points for the test question. |
| <div od-type=questionPointsReceived> |
Display the points that the user earned. |
| <div od-type=questionSequence> |
Display the test question sequence. |
| <div od-type=questionText> |
Display the text of the test questions. |
| <div od-type=test> |
Display the name of the test. |
| <div od-type=userAnswer> |
Display the answers that the user provided. |
Wireless Tag
The screenoptionlink tag creates links that use a phone style so that the client displays phone numbers for list items. You can use it only with an application that uses Wireless Markup Language. It uses the following format:
<div od-type=screenoptionlink>
XSL Stylesheet Tag
The xsl-stylesheet tag specifies the name of the XSLT stylesheet (EXtensible Stylesheet Language) on the XML output document. It uses the following format:
<swe:xsl-stylesheet name= "table.xsl" mode= "process"/>
where:
name. Specifies the name of the stylesheet.
mode. You can use one of the following values:
Process. SWE processes XSLT on the XML output, and then sends the transformed document back to the client.
Embed. SWE inserts an XML processing instruction in the beginning of the XML document that Siebel CRM uses for external XSLT processing.
For more information, see the topic about manipulating Siebel XML with XSL stylesheets and XSLT in XML Reference: Siebel Enterprise Application Integration.
The style sheet must reside in the following directory:
\webtempl
Each view template contains only one xsl-stylesheet tag. If the view contains more than one xsl-stylesheet tag, then SWE uses the last tag that this view contains.
Tags That Are for Oracle Internal Use Only
This topic describes tags that only Oracle personnel can modify. It includes the following topics:
You must not modify these tags without assistance from Oracle. For more information, see Getting Help From Oracle.
All Applets, All Controls, and List Control Tags
SWE uses the following tags with the XML to SWE interface if SWE is in No Template mode. They are only for Oracle internal use:
<div od-type=all-applets>
<div od-type=all-controls>
<div od-type=list-control>
Calendar Tags
The OD calendar tags are specialized OD tags that SWE uses only with a calendar applet. They are only for Oracle internal use. They include the following tags:
<div od-type=calendar “>
<div od-type=calendarActivity>
<div od-type=calendarActivityLoop “>
<div od-type=CurrentDayHeader>
<div od-type=calendarInterval>
<div od-type=calendarIntervalLoop“>
<div od-type=calendarMultiDayActivity“>
<div od-type=calendarNotCurrentlyDayHeader>
<div od-type=printHr>
<div od-type=printTr>
Gantt Chart Tags
The Gantt chart tags are specialized OD tags that SWE uses only with a Gantt chart. They are only for Oracle internal use. The following tags are Gantt tags:
<div od-type=ganttChart>
<div od-type=ganttChartMajorAxisLegend>
<div od-type=ganttChartMinorAxisLegend>
<div od-type=ganttChartXObjectExtendedOT>
<div od-type=ganttChartXObjectLoop>
<div od-type=ganttChartXObjectMutiple>
<div od-type=ganttChartXObjectNone>
<div od-type=ganttChartXObjectOT>
<div od-type=ganttChartXObjectOff>
<div od-type=ganttChartXObjectOn>
<div od-type=ganttChartYObjectLoop>