Configuring Siebel Open UI > Customizing Siebel Open UI > Doing General Customization Tasks >

Customizing How Siebel Open UI Displays Error Messages

Prior to Siebel CRM release 8.1.1.13, Siebel Open UI used the ErrorObject method to display the error dialog box. This method calls a browser alert method that displays the dialog box as a browser notification. Beginning with Siebel CRM release 8.1.1.13, you can modify this configuration so that Siebel Open UI displays the notification in a status bar or in a custom dialog box.

Siebel Open UI uses the following rendering files to display error messages:

• errorobjectrenderer.js. Displays an error alert or SWEAlert message.
• errorstatusbarrenderer.js. Displays an error message in a custom error status bar in the browser.
• errorpopuprenderer.js. Displays a custom dialog box that includes an error message.

Note the following:

• The errorobjectrenderer.js file is the only file that comes predefined with Siebel Open UI and does not require you to configure the manifest or to modify a method. You must not modify this file.
• The manifest does not come predefined to use the errorstatusbarrenderer.js file or the errorpopuprenderer.js file. If your customization requires one of these files, then you must add it to the manifest.
• Siebel Open UI renders only one of these files at a time. If you add errorstatusbarrenderer.js or errorpopuprenderer.js to the manifest, then Siebel Open UI uses one of these files instead of errorobjectrenderer.js.
• These files use the following constructor. You must not modify this constructor:

  SiebelApp.S_App.ErrorObjectRenderer

• These files reference the following method. For more information about this method, see ShowErrorMessage Method:

  ShowErrorMessage(message)

• Each file uses the typical sequence that a physical renderer uses. For example, each file calls the following methods in the following sequence. You must not modify this sequence. For more information, see Life Cycle of a Physical Renderer:
  1. ShowUI
  2. BindData
  3. BindEvents

For more information about configuring error messages in Siebel Open UI, see Configuring Error Messages for Disconnected Clients.

To customize how Siebel Open UI displays error messages

1. Optional. Modify the style that Siebel Open UI uses when it displays the error status bar.

   If your customization uses the errorstatusbarrenderer.js file, then you can style the status bar by adding style rules for the siebui-statusbar class in a custom cascading style sheet and place it in following folder:

   files\custom\my-style.css

   You must add the style sheet to the manifest by following the steps outlined in Configuring Manifests.

2. Configure the manifest. For more information about how to do this step, see Configuring Manifests:
   1. Log in to a Siebel client with administrative privileges.
   2. Navigate to the Administration - Application screen, and then the Manifest Files view.
   3. Add one of the following files, depending on your customization requirements:

   custom/errorstatusbarrenderer.js
   custom/errorpopuprenderer.js

   4. Navigate to the Manifest Administration view.
   5. In the UI Objects list, specify the following object.

      Field	Value
      Type	Application
      Usage Type	Theme
      Name	PLATFORM INDEPENDENT

   6. In the Object Expression list, add the following subexpression.

      Field	Value
      Group Name	Leave empty.
      Expression	Desktop
      Level	1 Siebel Open UI only uses the renderer whose level is set to 1.
      Operator	Leave empty.
      Web Template Name	Leave empty.

   7. In the Files list, click Add.
   8. In the Files dialog box, click Query.
   9. In the Name field, enter the path and file name that you added in Step c:

   files/custom/my-style.css

   10. Click Go.
3. Test your work:
   1. Log out of, and then log back into the client.
   2. Do something that results in an error.
   3. Verify that the client displays an error message according to your modifications.