Bookshelf v7.7: About Form Applet Templates (Non Grid-Based)

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

About Form Applet Templates (Non Grid-Based)

A Form Applet can appear in any of the four major modes—Base, Edit, New, and Query. The following is an example of a Form Applet template for use in Edit, New, and Query modes. Applets to be used in Base mode are similar except that they do not contain the <swe:form> tag.

<swe:control id="1100">

<swe:this property="FormattedHtml" hintText="Outside Applet Help Text"/>

</div>

</swe:control>

<swe:form>

<tr>

<swe:include file="CCTitle.swt"/>

</td>

</tr>

<tr>

<td>

<swe:error>

<swe:this property="FormattedHtml"/>

</swe:error>

</td>

</tr>

<swe:for-each startValue="1301" count="10" iteratorName="currentId">

<swe:control id="swe:currentId" hintMapType="FormItem">

<swe:this property="RequiredIndicator"
hintText="Required"/>

<swe:this property="DisplayName" hintText="Label"/>

</td>

<swe:this property="FormattedHtml" hintText="Field"/> 

</td>

</tr>

</swe:control>

</swe:for-each>

</swe:form>

</table>

The main tags that appear in this template are <swe:form>, <swe:control>, and <swe:error>.

<swe:form>
The <swe:form> tag is analogous to an HTML <form> tag and encloses a section of a page that accepts user input. The main attributes of this tag are htmlAttr and Name, both of which are optional.

The values of the htmlAttr should be valid attributes of the HTML <form> tag other than method, name, and action. These attributes will be used as is with the HTML <form> tag that is generated. The name attribute creates an HTML form with the specified name. If this attribute is not specified, an internally generated name is used.
<swe:control>
The <swe:control> tag specifies placeholders for controls. The main attributes of this tag are id, which maps the control to the placeholder, and the property, which specifies the property of the control to be rendered. The values for the property attribute that are germane to form applets include FormattedHTML, DisplayName, and RequiredIndicator.

The FormattedHTML property causes the data value of the control to be rendered, while the DisplayName corresponds to the Caption property. The RequiredIndicator results in specific HTML being rendered if the underlying Business Component Field is required.
<swe:error>
When a server side error occurs on submitting a form, the same page will be shown again with the error message displayed within the page. The <swe:error> tag denotes the location of this error message. The only attribute of the tag is a property whose value must be FormattedHtml. This results in the contents of the error message to be displayed. If when the form is rendered there are no errors, the contents of the <swe:error> tag are skipped.

NOTE: For errors that occur outside of a form submission, the application's Error Page will be used.

In many cases, you can forego read-only forms (Base mode) and use persistently editable forms because task activities are often data editing and input. This type of form improves usability because users can enter data without first having to click an edit button and then wait for the form to appear in edit mode.

If an applet is set to be in the Edit mode in a view (as specified by the mode property of the View Web Template Item), this applet is never shown in the Base mode. If you update the field values in this applet and commit the change, the applet continues to be shown in this mode after the changes are written to the database. You can, however, invoke a method like NewQuery or NewRecord on an applet that is shown in an Edit mode to show it in the Query or New modes. After executing the query or writing the new record, the applet is shown in the Edit mode.

Configuring Siebel eBusiness Applications