1. Object Types Reference
  2. Applet

Applet

An applet allows the user to view, enter, and modify data that the applet gets from a single business component. It includes the following qualities:

  • Occupies a section of a view

  • Composed of controls, such as buttons, fields, check boxes, and other types of controls, such as buttons that call a method or an ActiveX control

  • Allows the user to view, enter, modify, and navigate through records

  • Can display as a form, list of records, chart, business graphics, or navigation tree

  • Allows data entry for a single record or through a scrolling table that Siebel CRM displays multiple records

This object type occurs in the following location in the object hierarchy:

  • Siebel Objects > Applet

The following table describes properties that Siebel CRM uses with an applet.

Property Description

Associate Applet (O)

Specifies the name of an applet that relates data from two different entities. It uses a many-to-many relationship.

Siebel CRM can associate rows from entity B with rows from entity A, where entity B is an association applet that includes a many-to-many relationship and entity A is the main applet.

You can specify an association list applet.

Auto Query Mode (O)

You can use one of the following values:

  • New Query. Deletes the business component search specification, deletes the predefined query for the business object, and sets the business component to Query mode. Automatically displays the applet in Query mode.

  • Refine Query. Uses the existing search specifications and predefined queries.

Background Bitmap (O)(H)

The bitmap that Siebel CRM displays in the applet background. You can specify the object definition for any applet background bitmap.

Background Bitmap Style (O)(H)

Specifies how Siebel CRM arranges the background bitmap. You can use one of the following values:

  • Center. Display the image centered in the middle of the background.

  • Stretch. Stretch the image so that it covers the entire background.

  • Tile. Display multiple copies of the image so that it covers the entire background.

Business Component (O)

Specifies the name of the business component that includes the data that Siebel CRM displays.

A view that uses an applet references a business object. This business object must include a business object component that references the business component that includes the data that Siebel CRM must display.

Class (O)

Specifies the name of a C++ class that Siebel CRM uses to manage the applet. You can use one of the following values:

  • CSSFrame. Form applet.

  • CSSFrameChart. Chart applet.

  • CSSFrameList. List applet.

  • CSSFrameTree. Tree applet.

You can also use a specialized applet class. For example:

  • CSSFrameListAttachment

  • CSSFrameListActivity

Default Applet Method

Specifies the method that runs if the user presses the Enter key in the applet.

Height (R)(H)

Specifies the vertical size of the applet in sector units. You can use one of the following values:

  • 1

  • 2

  • 3

  • 4

Help Identifier (O)

Not used.

HTML Number of Rows (O)

Specifies the number of rows that Siebel CRM displays in a list applet. If the HTML Number of Rows Property property is empty, then Siebel CRM uses the value of the NumberOfListRows parameter in the application configuration file. This parameter sets the default number of rows for the list applets that this application displays. If the NumberOfListRows parameter is also not specified, then Siebel CRM sets the default value to 10. In some Siebel CRM versions, the default value for some applets might equal seven.

HTML Popup Dimension (O)(H)

Specifies the dimension in pixels of the pop-up dialog box. You use the following format:

numberxnumber

where:

  • x is lower case.

You cannot include empty spaces.

For example:

640x480

ICL Upgrade Path

For more information, see Common Object Properties.

Insert Applet (O)

Not used.

Insert Position (O)

Specifies the position where Siebel CRM creates a new record. You can use one of the following values:

  • BEFORE. Before the current record.

  • AFTER. After the current record.

  • FIRST. After first record.

  • LAST. After last record.

Mail Address Field (O)

Specifies the default email recipient that Siebel CRM displays in the Message Properties dialog box. It uses the list of recipients in the applet user properties. For example:

Email Address

Where:

  • Email Address is a business component field.

Mail Template (O)

Specifies the text file that Siebel CRM uses to fill in data in the default email message. It can include the following placeholder that uses a substitution value for a field:

%field%

The contents of the C:\Siebel\MSGTEMPL directory determines the list of mail templates that are available.

Name (R)

Specifies the name of the applet. The name can include spaces. It must be unique among applets. Any object that references an applet references the applet name. For example:

Account Form Applet

No Delete (O)

Specifies if Siebel CRM can delete a row in an applet. You can use one of the following values:

  • TRUE. No row deletion allowed.

  • FALSE. Row deletion allowed.

No Insert (O)

Specifies if Siebel CRM can insert a row in an applet. You can use one of the following values:

  • TRUE. No row insertion allowed.

  • FALSE. Row insertion allowed.

No Merge (O)

Specifies if Siebel CRM can merge a row in an applet. You can use one of the following values:

  • TRUE. No row merge allowed.

  • FALSE. Row merge allowed.

No Update (O)

Specifies if Siebel CRM can update a field in an applet. You can use one of the following values:

  • TRUE. No field update allowed.

  • FALSE. Field update merge allowed.

Popup Dimension (O)(H)

Specifies the size of the pop-up applet. This text property is valid only for association, pick, multivalue group, and detail applets. You can use the following format:

W X H

where:

  • W is the width in pixels.

  • H is the height in pixels.

  • X is upper-case.

  • A space must precede and follow the X.

For example:

512 X 220

Scripted (S)

Specifies if a Siebel VB or Siebel eScript script is attached to the applet. It can include of the following values:

  • TRUE. Script attached.

  • FALSE. No script attached.

Search Specification (O)

Specifies a conditional expression that Siebel CRM uses to restrict the records it gets from the business component that the applet references. For example:

[Service Flag] = ‘Y’

For more information, see How Siebel CRM Uses an Applet Search Specification.

Task

Specifies the name of the Task object for an applet that a task uses. For example:

Asset To Contract Task

Text Style (O)(H)

Specifies a text style for all controls that the applet includes. Siebel CRM uses this value by default only if the control does not specify a text style. If you do not specify a value for the Text Style property, then Siebel CRM uses the text style that the Browser specifies or that the .css files for the Siebel CRM application specifies.

Title (O)

Specifies the text that Siebel CRM uses for the applet title. For example:

Account

Type (O)

Specifies the type of the applet.

Upgrade Behavior

For more information, see Common Object Properties.

Width (R)(H)

Specifies the horizontal size of the applet in sectors. You can use one of the following values:

  • 1

  • 2