Siebel Object Types Reference > Siebel Object Types >


Siebel Object Types > Applet

Defines a list or form applet (or a specialized applet type such as chart applet, Web applet, tree applet, or file attachment applet) to be included in views. The applet is responsible for displaying the data to the user and contains the control or list column layout information (through child object definitions).

You can add user properties to applets.

Valid Values/Examples

Associate Applet (O)

The name of an applet used to relate data from two separate entities (a many-to-many relationship).

Rows from entity B (association applet) can be associated (many-to-many relationship) with the selected row from entity A (base applet).

An applet of type "association list."

Auto Query Mode (O)

Allows for automatically showing the applet in query mode when New Query is entered as the value.

This property can have the following values:

New Query — When creating the applet, clears the business component's search specification, clears the business object's predefined query, and sets the business component to Query mode. Automatically shows the applet in Query mode.

Refine Query — Retains existing search specifications and predefined queries. Automatically shows the applet in Query mode.

Background Bitmap (O)(H)

The bitmap object definition to display in the background of the applet.

Any Applet Background bitmap definition.

Background Bitmap Style (O)(H)

Setting indicating how the background bitmap is arranged in the applet.

Center — Display once in the middle.

Stretch — Display once stretched to cover the applet area.

Tile — Display repeatedly, edge to edge, to cover the applet area.

Browser Class (O)(H)

Not used.

Not applicable.

Business Component (O)

The name of the business component whose data is to be displayed.

The business component must be defined in the business object specified for any view that uses this applet.


Class (O)

The name of a C++ class used to manage the applet.

Specialized applet classes are a subclass of one of the standard classes.

Standard classes:

  • CSSFrame (form applets).
  • CSSFrameChart (chart applets).
  • CSSFrameList (list applets).
  • CSSFrameTree (tree applets).
  • Examples of specialized classes:
  • CSSFrameListAttachment.
  • CSSFrameListActivity.

Height (R)(H)

The vertical size of the applet in sector units.

1, 2, 3, or 4.

Help Identifier (O)

Not used.

Not applicable.

HTML Number of Rows (O)

Denotes the number of rows to be displayed at a time when rendering a list applet.

Applies only to list applets, which show rows of data.

Used by the Siebel Web Engine.

Default is 7 rows.

Read HTML Number of Rows for details.

HTML Popup Dimension (O)(H)

Dimension, in pixels, of the pop-up window.

Used by the Siebel Web Engine.

An example is 640x480 (specified with a small x and without blank spaces).

Insert Applet (O)

The name of a pop-up applet to be displayed for creation of a new record.

Used with dynamic insert.

Any valid pop-up applet name.

Insert Position (O)

The position in which new records are created.

BEFORE — Before the current record.

AFTER — After the current record.

FIRST — The first record.

LAST — The last record.

Mail Address Field (O)

A default email recipient in the Message Properties dialog box.

The list of recipients is set up in user properties for the applet.

Example: Email Address (field in Business Component).

Mail Template (O)

A text file that is used to fill in the default email message.

Can contain placeholders in the form "%field%" to provide for value substitutions of fields.

The list of available mail templates is determined from the contents of the MSGTEMPL folder of the installation directory (C:\Siebel for most users).

Name (R)

The name of the applet. All references to the applet are made through its name.

The name can contain spaces and must be unique among applets. The name cannot contain parentheses.

Account Form Applet.

No Delete (O)

A TRUE or FALSE value that places additional security on top of the business component in a particular usage.

TRUE — No row deletion allowed.

FALSE — Row deletion allowed.

No Insert (O)

A TRUE or FALSE value that places additional security on top of the business component in a particular usage.

TRUE — No row insert allowed.

FALSE — Row insert allowed.

No Merge (O)

A TRUE or FALSE value that places additional security on top of the business component in a particular usage.

TRUE — No row merge allowed.

FALSE — Row merge allowed.

No Update (O)

A TRUE or FALSE value that places additional security on top of the business component in a particular usage.

TRUE — No field updates allowed.

FALSE — Field updates allowed.

Popup Dimension (O)(H)

The size of the pop-up applet. This text property is valid only for association, pick, MVG, and detail applets.

W X H where:

W — Width in pixels.

H — Height in pixels.

Example: 512 X 220.

Blank spaces and the capital X are part of the syntax.

Scripted (S)

A TRUE or FALSE value indicating whether the applet has a Siebel VB or Siebel eScript script attached to it.

TRUE — Siebel script attached.

FALSE — No Siebel script attached.

Search Specification (O)

A conditional expression used to restrict the records retrieved from the applet's business component.

For more information, read Search Specification.

Example: [Service Flag] = 'Y'.

Text Style (O)(H)

Defines the named text style to be used by default by all controls in the applet that do not specify their own text style. If not specified, the text style of the view is used.


Title (O)

The text used for the title of the applet.


Type (O)

The type of the applet.

Valid values are Association List, Detail, MVG, Pick List, and Standard.

Upgrade Behavior (R)

This property is set by Oracle and can not be modified.

Indicates if the object should be ignored if the repository merge is run with the Incorporate Custom Layout option.

Admin or Null

Admin indicates that the object should be ignored. Null indicates that the object is to be processed by the Incorporate Custom Layout option.

Width (R)(H)

The horizontal size of the applet in sector units.

Valid values are 1 and 2.

HTML Number of Rows

If this property is not specified for the applet, the application's CFG file is checked. In the CFG file, the default number of rows for list applets belonging to that application can be specified using the NumberOfListRows property. If this property is also not specified, the property defaults to ten.

However, in some areas of the application, the default specified for this property has been set to seven. So for those areas, you might see a default of seven rows instead of ten.

Search Specification

An applet search specification cannot be used to override the search specification of the underlying business component, if the business component has one. Rather than overriding the business component's search specification, the applet's search specification is appended to that of the business component.

Siebel applications do not requery, and therefore keep the existing search specification, if you navigate to an applet without an applet search specification. There are two exceptions. The first is for child applets. An empty applet search specification is applied when it is on a child applet. The second is when the visibility mode changes for the parent applet. In this case, the applet level search specification should always be applied regardless of whether it is empty.

If two applets are defined with the same business component and both have a search specification, then the search specification for the applet in lowest sector is used.

Do not specify different search specifications where several applets in one view are based on the same business component. All of these applets should have the same or an empty search specification.

The applet search specification was not applicable to MVG and association applets in versions prior to 5.0 but is applicable in subsequent versions.

The search specification can change the query context for users performing queries.

See Also

Applet Method Menu Item
Applet Locale
Applet Script (H)
Applet Toggle
Text Style (H)
Hidden Object Types and Properties

Siebel Object Types Reference Copyright © 2006, Oracle. All rights reserved.