Siebel Business Process Framework: Task UI Guide > Configuring Task UI > Configuring UI Objects Used in Tasks >

Configuring Applet Messages

An applet message allows you to combine static text and dynamic data into a message to be displayed to the user. Applet messages can be used in task applets (based on a TBC), or in standard applets (based on standard BCs). The applet message configuration process is the same in both cases.

In Siebel Tools, the applet message is configured using the Applet Message and Applet Message Variable object types. You can place applet messages anywhere within an applet. Before you can position an applet message within an applet, you must create the definition of the applet message.

For more information about the Applet Message and other associated object types, see the Siebel Object Types Reference.

To create an applet message definition

1. In Siebel Tools, create a symbolic string reference containing the text of the applet message. Use %1, %2, and so on as placeholders for the dynamic data to be defined in the applet message variables.

   NOTE:  To avoid run-time errors, make sure you use a strictly ascending sequence of numbers.

2. In the Object Explorer, click the Applet object type.
3. In the OBLE, select the Applet you want to add the applet message to.
4. In the Objects Explorer, click the Applet Message object type.

   NOTE:  If the Applet Message object or its child objects are not visible in the Object Explorer, you can make them visible using the View > Options menu item.

5. Add an Applet Message object to the applet.

   NOTE:  For details about adding objects, see Using Siebel Tools.

   1. In the Text Message property, select the symbolic string reference you created in Step 1.
   2. Fill in the other properties as appropriate.
6. In the Object Explorer, click the Applet Message Variable object type.
7. In the Applet Message Variables OBLE, create one record for each value that needs to be substituted in the applet message:
   1. For the Value property, enter the appropriate substitution number (for example, 1 for %1 substitution).
   2. For the Field property, choose the appropriate business component field whose value should be displayed for the placeholder in the message.
   3. Fill in the other properties as appropriate.

      For example, the following properties cause the substitution of the string %1 in the applet message with the value of the field named Opportunity Name:

   Value = 1

   Field = Opportunity Name

To configure the layout of an applet message

You can use the Applet OBLE to refine the layout of the task applet in which you want to place an applet message.

1. In the Object Explorer (in Siebel Tools), click the Applet object type.
2. In the Applets OBLE, select the Applet you want to add the applet message to.
3. In the Object Explorer, click the Controls object type, and create a new control for the newly created applet message:
   1. Specify the name of the applet message as the Field property.

      The Field Type property is set to Message.

4. From the Dynamic Controls Palette, drag and drop the Static Dialog text control onto the applet grid layout in the position you want the applet message to appear.

   The applet message control is rendered on the grid.

5. (Optional) To specify the control width (for text wrapping), change the area size for this control.

   The associated text within the control wraps (in the edit and preview modes). At run time, the applet message includes the dynamic text where the placeholders sit, and the text wraps.

6. In the Properties window, set HTML Display Mode = FormatData.

   This allows you to put line returns and spacing within the string of text you are about to enter.

7. (Optional) If you have not entered text already for the message (when creating the referenced applet message), you can enter it now:
   1. Double-click on the control.
   2. In the text box within the layout editor, enter the message text.

      NOTE:  Because applet messages use symbolic strings, they must always be written as stand-alone sentences of less than 250 characters in length.