1. Configuring Siebel Open UI Guide
  2. Allowing Users to Change the Applet Visualization

Allowing Users to Change the Applet Visualization

This topic describes how you can modify an applet so that the user can change the applet visualization.The applet visualization is a type of configuration that specifies the layout that Siebel Open UI uses to display the applet. List, form, tile, map, grid, and carousel are each an example of an applet visualization.

Siebel Open UI allows the user to set some user preferences that determine how it displays an applet. The user can navigate to the User Preferences screen, and then use the Behavior view to set these preferences. For example, if the user chooses a value in the Visualization field of the Behavior view, such as Tile, and then navigates to a list applet that includes a tile configuration, such as the Opportunity List Applet, then Siebel Open UI displays this applet as a set of tiles. If the user clicks Grid in this applet, then Siebel Open UI displays the applet as a grid and sets Grid as the default layout only for the Opportunity List Applet. This local setting takes precedence over the global setting that the user sets in the Visualization field in the Behavior view. Siebel Open UI continues to use a tile layout for all other applets that include a tile configuration. In this situation, it displays the Opportunity List Applet as a grid even if the user logs out and then logs back in to the client.

The following figure shows the Contacts List (that you modified in this topic) where the user can change the applet visualization. The user can click one of the applet visualization buttons (such as Tile, Grid, or Map) to change the applet visualization.

Contacts List That Allows Users to Change the Applet Visualization: This image is described in the surrounding text.

This topic describes how to configure the manifest for a custom applet visualization. For information about configuring the manifest for a predefined configuration, see Configuring Manifests for Predefined Visualizations.

To allow users to change the applet visualization

  1. Modify the applet in Siebel Tools:

    1. Open Siebel Tools.

      For more information, see Using Siebel Tools.

    2. In the Object Explorer, click Applet.

    3. In the Applets list, query the Name property for the applet that you must modify.

      For example, query the Name property for Contact List Applet.

    4. In the Object Explorer, expand the Applet tree, and then click Applet Web Template.

      The Applet Web Templates list displays the applet modes that Siebel Tools defines for the applet. For example, Base, Edit, and Edit List. For more information about these modes, see Displaying Applets Differently According to the Applet Mode.

    5. In the Applet Web Templates list, add the following applet Web template.

      Property Description

      Name

      Enter text that describes the visualization behavior. For example, enter Edit Tile to describe a tile visualization that allows the user to modify field values.

      Sequence

      Enter a value of 1000 or greater. To help you quickly recognize how Siebel Open UI uses a Web template, it is recommended that you use a value of:

      • 1000 or greater for a Web template that Siebel Open UI uses to determine the applet visualization, such as a Tile.

      • 1, 2, or 3 for a Web template that Siebel Open UI uses to determine the applet mode, such as Edit List.

      Type

      Specify the applet mode, such as Edit or Edit List.

      Web Template

      Choose a Web template that defines the desired visualization. For example, choose Applet Tile.

    6. Make sure Siebel Tools defines an ODH for the Web template that you defined in Step e.

      For example, make sure the "Definition" column of Web Template in Siebel Tools includes ODH for the Applet Tile Web template. If your deployment requires a new Web template, then you must define it before you can define the applet Web template. For more information about configuring Web templates, see Configuring Siebel Business Applications.

    7. Repeat Step d and Step e for each Web template that your deployment requires.

      Your completed work in Siebel Tools must resemble the configuration shown in the following image. As shown in this image, the Applet Web Templates associated with the Contact List Applet are:

      • Base - Applet List (Base/EditList)

      • Edit - Applet List Edit (Edit/New/Query)

      • Edit List - Applet List (Base/EditList)

      • Edit Map - Applet Map

      • Edit Tile - Applet Tile


      Siebel Tools Configuration: This image is described in the surrounding text.

    8. Compile your modifications.

  2. Configure the manifest for the applet that you modified in Step 1:

    1. Log in to a Siebel client with administrative privileges.

      For more information about the screens that you use in this step, see Configuring Manifests.

    2. Navigate to the Administration - Application screen, and then the Manifest Files view.

    3. In the Files list, add the following predefined files.

      Field Value

      Name

      siebel/mappmodel.js

      siebel/Tilescrollcontainer.js

    4. Navigate to the Administration - Application screen, and then the Manifest Administration view.

    5. In the UI Objects list, specify the following applet.

      Field Value

      Type

      Applet

      Usage Type

      Web Template

      Name

      Contact List Applet

    6. In the Object Expression list, add the expressions that Siebel Open UI uses to render the applet for this Web template in the various visualizations and applet modes that you defined in step 1.

      Your completed work must resemble the following configuration. Use the Move Up, Move Down, Indent, and Outdent buttons to create the hierarchy. Note that you do not add files in the Files list for a Web template. You only add files for a presentation model or physical renderer. For more information about how to create these object expressions, see Configuring Manifests.


      Object list configuration

    7. Configure the manifest for the presentation model for each applet visualization that you defined in Step 1.

      You add the UI object, object expressions, and files until the Manifest Administration screen resembles the following configuration.


      Manifest Administration screen

    8. Repeat Step g for each applet visualization that you configured in Siebel Tools.

    9. Configure the physical renderer for each applet visualization that you defined in Step 1.

      You add the UI object, object expressions, and files until the Manifest Administration screen resembles the following configuration:


      Manifest Administration screen

      If you do not do this administration, then Siebel Open UI uses the jqgridrenderer.js file for the physical renderer for a list applet, by default.

  3. (Optional) Modify the strings that Siebel Open UI uses for the labels of the applet visualization buttons.

    Do the following:

    1. In Siebel Tools, choose the Screens application-level menu, click System Administration, and then click List of Values.

    2. In the List of Values list, query the Type property for OUI_MODE_VISUALIZATION.

    3. Make sure the Language-Independent Code property for each record that Siebel Tools displays in the List of Values list includes the same string that you modified in Step 2, Step g.

      For example, make sure the Language-Independent Code property includes the following values:

      Type Display Value Language-Independent Code

      OUI_MODE_VISUALIZATION

      Tile

      Tile

      Map

      Map

      Grid

      Grid

      Siebel Open UI uses the value that the Display Value property contains as the label for each applet visualization button. To view these buttons, see the first figure in this topic Allowing Users to Change the Applet Visualization.

    4. Compile your modifications.

    5. Log in to the client.

    6. Navigate to the Administration - Application screen, and then the Manifest Expressions view.

    7. In the Manifest Expressions view, modify the following strings, as necessary.

      Name Expression

      Tile

      GetObjectAttr("VisualMode") = 'Tile'

      Map

      GetObjectAttr("VisualMode") = 'Map'

      Grid

      GetObjectAttr("VisualMode") = 'Grid'

      For example, Siebel Open UI uses the Tile string in the Expression field for the Tile expression. You can modify these strings to meet your deployment requirements.

  4. Test your modifications:

    1. Log out of the client, and then log back in.

    2. Navigate to the Contacts screen, and then the Contacts List view.

    3. Verify that Siebel Open UI displays the Grid, Tile, and Map visualization buttons.

      The visualization buttons must resemble the buttons that the first figure in this topic Allowing Users to Change the Applet Visualization displays.

    4. Click each visualization button, and then verify that Siebel Open UI displays the visualization that is associated with the button that you click.