Siebel Business Process Framework: Task UI Guide > Customizing Task UI > Other Options for Customizing a Task UI >

Creating an Applet Message


An applet message allows you to combine static text and dynamic data in a message that Siebel CRM displays in the Siebel client. You can place an applet message in an applet. For more information, see Applet Message.

To create an applet message

  1. If necessary, display the applet message and symbolic string object types, and their child object types.

    For more information, see Displaying Object Types You Use to Develop a Task UI.

  2. In Siebel Tools, define a symbolic string that includes the text of the applet message:
    1. In the Object Explorer, click Symbolic String.
    2. In the Symbolic Strings list, create a new symbolic string.

      In the Current String Value property, use %1, %2, and so on as placeholders for the dynamic data. Make sure you use an ascending number sequence to avoid a run-time error. For example, use %1, %2, %3, and so on.

  3. In the Object Explorer, click Applet.
  4. In the Applets list, query the Name property for the applet where you must define the applet message.
  5. In the Object Explorer, expand the Applet tree, and then click Applet Message.
  6. In the Applet Messages list, add an applet message object to the applet:
    1. In the Text Message property, choose the symbolic string you defined in Step 2.
    2. Define the other properties, as necessary.
  7. In the Object Explorer, expand the Applet Message tree, and then click Applet Message Variable.
  8. In the Applet Message Variables list, define one record for each value that Siebel CRM must substitute in the applet message:
    1. In the Value property, enter a substitution number.

      For example, enter the number 1 to represent the %1 substitution you defined in Step 2.

    2. In the Field property, choose the business component field whose value must display for the placeholder in the message.
    3. Define the other properties, as necessary.

      For example, the following configuration causes Siebel CRM to substitute the %1 placeholder in the applet message with the value of the Opportunity Name field:

      Property
      Value

      Value

      1

      Field

      Opportunity Name

  9. Define the layout of the applet message.

    For more information, see Defining the Layout of the Applet Message.

Defining the Layout of the Applet Message

This topic describes how to define the layout of the applet message.

To define the layout of the applet message

  1. In the Object Explorer, click Applet.
  2. In the Applets list, query the Name property for the applet where you must define the applet message.
  3. In the Object Explorer, expand the Applet tree, and then click Control.
  4. In the Controls list, add a new control for the applet message you created in Step 6 using values from the following table.
    Property
    Description

    Field

    Enter the name of the applet message.

    Field Type

    Choose Message.

  5. In the Applets list, right-click, and then choose Edit Web Layout.
  6. Drag and then drop a Label control from the Palette to the applet grid layout. Place this control where Siebel CRM must display the applet message.
  7. Optional. To modify the width of a control for text, do the following work:
    1. Position the mouse over the left edge or right edge of the control so that Siebel Tools changes the cursor to a line that includes arrows at each end of the line.
    2. Click and hold down the left mouse button.
    3. To modify the size of the control, drag the cursor.

      The text in the control wraps in the edit and preview modes. Siebel CRM wraps the applet message text in the Siebel client at run time. This message includes the dynamic text that replaces the placeholder text.

  8. In the Properties window, set the HTML Display Mode property to FormatData.

    Setting the HTML Display Mode property to FormatData allows line returns and spacing in the text string.

  9. Optional. If you did not enter text for the message when you defined the applet message, then you can enter it now:
    1. Double-click the control.
    2. In the text box in the layout editor, enter the text for the message.
Writing an Independent Message

An applet message uses a symbolic string, so you cannot predict with precision how Siebel CRM renders the message at run time. You must write the message so that it forms a sentence that is grammatically correct and that is less than 250 characters in length. Do not write a message that depends on the symbolic string to concatenate the message. For example, to instruct the user to make sure data is complete, you can write the following message:

Make sure the information you enter is complete.

Do not write the following:

Make sure the information

Siebel Business Process Framework: Task UI Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.