Configuring Siebel eBusiness Applications > Configuring Applets >

Guidelines for Configuring Applets


When configuring applets consider the following guidelines:

  • Keep the user interface consistent and intuitive to improve usability.
  • When possible, modify existing applets instead of creating new ones. This often requires less work and helps keep the number of objects you need to maintain in the repository to a minimum.
  • If you do require new applets, set the Upgrade Ancestor property on all custom applets that are cloned from other applets. For more information, see About Upgrade Inheritance.
  • Avoid unnecessary duplication by reusing applet definitions in multiple views and screens whenever possible.
  • Reduce complexity by keeping applet design simple and avoid inactive objects.
  • Give duplicate applets without drilldowns the same name as the original applet but with the words Without Navigation immediately preceding the word Applet (or Read-Only Applet)—for example, ABC Selective Account List Without Navigation Applet.
  • Applets that are used specifically for Administration purposes (which are almost always list applets) should be named <entity> Administration Applet—for example, Master Forecast Administration Applet.
  • Define the required applet modes. For example, will the applet be read-only or editable? Will it have New/Query options? If the applet will be read-only mode you will only need to define it in Base mode. If it will be editable then you will have to define it in Edit and Edit List modes. If the applet will have a New/Query option and if the applet should have a different layout for the New/Query modes (compared to Edit mode) then consider creating New/Query applet Web templates.
  • Do not expose unnecessary fields in list applets.

Naming Convention for Applets

The following are general naming recommendations for applets:

  • Name all new applets with a prefix that identifies your company. For example, ABC Incorporated could name a new applet ABC Opportunity List Applet.
  • Avoid using special characters in applet names. Use only alphanumeric characters.
  • Applet names should be meaningful. Avoid adding a number suffix (for example, ABC Opportunity List Applet 2) to an applet name. For example, if the applet differs because it does not allow drill down, then indicate this in your applet name (ABC Opportunity List Applet - Without Drill Down).
  • Initial-capitalize applet names, for example, Account List Applet rather than account list applet.

The type of applet should be included in the name just before the word applet, as shown in Table 38.

Table 38.  Naming Conventions for Applets
Type of Applet
Name Format
Example

Association applets

Xxx Assoc Applet

Opportunity Assoc Applet

Multi-value group applets

Xxx Mvg Applet

Fulfillment Position Mvg Applet

Pick applets

Xxx Pick Applet

Order Status Pick Applet

List applets

Xxx List Applet

Account List Applet

Form applets

Xxx Form Applet (if the applet does not contain buttons)

xxx Entry Applet (if the applet contains buttons)

Account Form Applet

Account Entry Applet

Chart applets

Xxx Chart Applet - yyy Analysis [By zzz]

Bug Chart Applet - Severity Analysis

Tree applets

Xxx Tree Applet

List of Values Tree Applet

Naming Conventions for Applet Titles

Follow these general guidelines when creating applet titles:

  • Always specify an applet title. Do not leave this property blank.
  • No two applets in the same view should have the same title. If a view contains multiple applets displaying data from the same business component, distinguish the titles by type. For example, in a list-form view displaying accounts, use distinct titles such as Account List and Account Form.

Table 39 offers standard conventions for the titles of certain applet types.

Table 39.  Title Conventions for Applets
Type of Applet
Title Format
Example

Association applets

Add buscomp_name(s)

Add Opportunities

Multi-value group applets

buscomp_name(s)

Contacts

Pick applets

Pick buscomp_name(s)

Pick Product

List applets

buscomp_name List

Account List

Form applets

buscomp_name Form

buscomp_name Entry

Account Form

Account Entry

Chart applets

Xxx Analysis

or

Xxx by Yyy

Open Defect Analysis

 

Lead Quality By Campaign

Tree applets

buscomp_name(s)

Opportunities

Configuring Siebel eBusiness Applications