Configuring Siebel Business Applications > About Applets, Controls and List Columns > Guidelines for Creating an Applet >

Overview of Guidelines for Creating an Applet


If you create an applet, then use the following guidelines:

  • Keep the user interface consistent and intuitive.
  • If possible, modify a predefined applet instead of creating a new applet. This technique often requires less work and helps to minimize the objects in the Siebel repository that you must maintain.
  • If you do require a new applet, then set the Upgrade Ancestor property on each custom applet that you clone from another applet. For more information, see Guidelines for Using the Upgrade Ancestor Property.
  • To avoid unnecessary duplication, reuse an applet in multiple views and screens.
  • To reduce complexity, keep applet design simple.
  • Avoid inactive objects.
  • Give duplicate applets that do not contain drilldowns the same name as the original applet but add the phrase Without Navigation to the name immediately before the word Applet. For example, ABC Selective Account List Without Navigation Applet.
  • Add the phrase Administration Applet to the end of the name of each applet that specifically fulfils an administration function. For example, Master Forecast Administration Applet.
  • Define the required applet modes:
    • If the applet is in read-only mode, then you only define it in Base mode.
    • If the applet is editable, then you must define it in Edit and Edit List modes.
  • Do not display a field that no applet uses.

Guidelines for Naming an Applet

If you name an applet, then use the following guidelines:

  • Name each new applet with a prefix that identifies your company. For example, if your company name is ABC Incorporated, then name the new applet ABC Opportunity List Applet.
  • Include the type of applet in the name just before the word applet.
  • Capitalize the first letter of each word. For example, Account List Applet rather than account list applet.
  • Avoid using a special character in an applet name. Use only alphanumeric characters.
  • Make sure the applet name is meaningful. Avoid adding a number suffix to an applet name, such as ABC Opportunity List Applet 2. For example, if the applet differs because it does not allow drill down, then indicate this situation in your applet name. For example, ABC Opportunity List Applet - Without Drill Down.

Table 20 describes the naming formats for an applet. In Table 20, business component is the name of the business component that the applet references in the Business Component property.

Table 20. Naming Formats for an Applet
Type of Applet
Name Format
Example

Association applet

description Assoc Applet

Opportunity Assoc Applet

multi-value group applet

business component Applet

Fulfillment Position Mvg Applet

Pick applet

description Pick Applet

Order Status Pick Applet

List applet

business component name List Applet

Account List Applet

Form applet

If the applet does not contain buttons, then use business component name Form Applet.

If the applet contains buttons, then use business component name Entry Applet.

The following examples use this format:

  • Account Form Applet
  • Account Entry Applet

Chart applet

description Chart Applet - description Analysis

Bug Chart Applet - Severity Analysis

Tree applet

description Tree Applet

List of Values Tree Applet

For more information, see Guidelines for Naming an Object.

Guidelines for Creating an Applet Title

If you create an applet title, then use the following guidelines:

  • Always define the Title property of an applet. Do not leave this property empty.
  • Do not use the same title for more than one applet that Siebel CRM displays in the same view. If a view contains multiple applets that display data from the same business component, then distinguish the titles according to the type of applet. For example, use distinct titles in a view that displays accounts, such as Account List Applet or Account Form Applet.

Table 21 describes formats for an applet title.

Table 21. Formats for an Applet Title
Type of Applet
Title Format
Example

Association applet

Add business component name

Add Opportunities

multi-value group applet

business component name

Contacts

Pick applet

Pick business component name

Pick Product

List applet

business component name List

Account List

Form applet

Use one of the following formats:

  • business component name Form
  • business component name Entry

The following examples use this format:

  • Account Form
  • Account Entry

Chart applet

Use one of the following formats:

  • type of action Analysis
  • description by description

The following examples use this format:

  • Open Defect Analysis
  • Lead Quality By Campaign

Tree applet

business component name

Opportunities

For more information, see Guidelines for Naming an Object

Configuring Siebel Business Applications Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices.