Contents
1 What's New in This Release
- What’s New in Configuring Siebel Open UI, Siebel CRM 24.9 Update
- What’s New in Configuring Siebel Open UI, Siebel CRM 24.6 Update
- What’s New in Configuring Siebel Open UI, Siebel CRM 23.7 Update
- What’s New in Configuring Siebel Open UI, Siebel CRM 21.7 Update
2 Overview of Siebel Open UI
- Overview of Siebel Open UI
- About Siebel Open UI
- How Siebel CRM Renders Siebel Open UI Clients
- About Using This Book
3 Architecture of Siebel Open UI
- Architecture of Siebel Open UI
- About the Siebel Open UI Development Architecture
- Overview of the Siebel Open UI Development Architecture
- Example of How Siebel Open UI Renders a View or Applet
- Customizing the Presentation Model and Physical Renderer
- Customizing the Physical Renderer
- Customizing a Plug-in Wrapper
- Stack That Siebel Open UI Uses to Render Objects
- Items in the Development Architecture You Can Modify
- Example Client Customizations
- Differences in the Server Architecture Between High Interactivity and Siebel Open UI
- Differences in the Client Architecture Between High Interactivity and Siebel Open UI
- Life Cycle of User Interface Elements
4 Example of Customizing Siebel Open UI
- Example of Customizing Siebel Open UI
- Roadmap for Customizing Siebel Open UI
- Process of Customizing the Presentation Model
- Creating the Presentation Model
- Customizing the Setup Logic of the Presentation Model
- Customizing the Presentation Model to Identify the Records to Delete
- Customizing the Presentation Model to Delete Records
- Overriding Predefined Methods in Presentation Models
- Customizing the Presentation Model to Handle Notifications
- Attaching an Event Handler to a Presentation Model
- Customizing Methods in the Presentation Model to Store Field Values
- Customizing the Presentation Model to Call the Siebel Server and Delete a Record
- Process of Customizing the Physical Renderer
- Process of Customizing the Plug-in Wrapper
- Creating the Plug-in Wrapper
- Customizing the Plug-in Wrapper to Display the Control Differently
- Customizing the Plug-in Wrapper to Bind Custom Events to a Control
- Customizing the Plug-in Wrapper to Define Custom Events
- Customizing the Plug-in Wrapper to React to Value Changes of a Control
- Attaching the Plug-in Wrapper to a Control Conditionally
- Configuring the Manifest for the Recycle Bin Example
- Configuring the Manifest for the Color Box Example
- Testing Your Modifications
5 Customizing Siebel Open UI
- Customizing Siebel Open UI
- Guidelines for Customizing Siebel Open UI
- Doing General Customization Tasks
- Preparing Siebel Tools to Customize Siebel Open UI
- Modifying the Application Configuration File
- Deriving Presentation Models, Physical Renderers, and Plug-in Wrappers
- Adding Presentation Model Properties That Siebel Servers Send to Clients
- Configuring Siebel Open UI to Bind Methods
- Calling Methods for Applets and Business Services
- Using the Base Physical Renderer Class With Nonapplet Objects
- Creating Components
- Customizing How Siebel Open UI Displays Error Messages
- Customizing Navigation Options
- Example of Restricting Navigation Options
- Customizing Events
- Refreshing Custom Events
- Overriding Event Handlers
- Attaching an Event Handler to an Event
- Attaching More Than One Event Handler to an Event
- Stopping Siebel Open UI From Calling Event Handlers
- Attaching and Validating Event Handlers in Any Sequence
- Customizing the Sequence that Attaches and Validates Event Handlers
- Using AttachEventHandler Prior to Siebel CRM Release 8.1.1.13
- Overriding the OnControlEvent Method and Then Calling a Superclass
- Allowing Blocked Methods for HTTP GET Access
- Managing Files
- Configuring Manifests
- Configuring Multiple Tab Browsing
- Configuring Smartphone UX
- About Preferences
6 Customizing Styles, Applets, Fields, and Controls
- Customizing Styles, Applets, Fields, and Controls
- Customizing Logos, Themes, Backgrounds, Tabs, Styles, and Fonts
- Customizing the Logo
- Customizing Themes
- Customizing Themes for Other Objects
- Customizing the Synergy Theme
- Customizing the Aurora Theme
- Customizing Browser Tab Labels
- Using Cascading Style Sheets to Modify the Position, Dimension, and Text Attributes of an Object
- Adding Fonts to Siebel Open UI
- Specifying Font Families
- Customizing the Redwood Theme
- Customizing Applets
- Displaying and Hiding Fields
- Allowing Users to Drag and Drop Data into List Applets
- Expanding and Collapsing Applets
- Customizing List Applets to Display a Box List
- Customizing List Applets to Render as Carousels
- Customizing List Applets to Render as Maps
- Customizing List Applets with Class Names
- Configuring List and Form Applets to display a color based on the value selected
- Customizing Form Applets with Icon Map Images
- Disabling Oracle Maps
- Configuring the Focus in Siebel Applets
- Adding Static Drilldowns to Applets
- Adding Custom User Preferences to Applets
- Displaying Applets Differently According to the Applet Mode
- Allowing Users to Change the Applet Visualization
- Configuring Manifests for Predefined Visualizations
- Auto Tile Visualization Feature
- About Auto Tile Visualization of List Applets
- Criteria for Rendering Applets in Tile Mode
- Enabling Auto Tile Mode at the Application Level
- Enabling Auto Tile Mode at the List Applet level
- Predefined Manifest for Tiles Visualization
- Auto Tile Behavior
- Default Tile Content
- Customizing the Tile Content
- Customizing Tile Presentation for Qualifying List Applets
- Customizing Tile Presentation for a Specific List Applet
- Customizing the User Interface Layout of a List Applet
- Resolving Tile Presentation for a Specific List Applet
- Customizing Applets to Capture Signatures from Desktop Applications
- Customizing Applets to Capture Signatures for Siebel Mobile Applications
- Customizing Applets to Display Record Counts for Navigation Links
- Customizing Applets for Homepage Views in Redwood Theme
- Customizing Controls
- Creating and Managing Client-Side Controls
- Displaying Control Labels in Different Languages
- Customizing Presentation Models to Display Control Labels in Different Languages
- Customizing the Busy Cursor to Display While a Business Service Executes
- Creating Property Sets for Client-Side Controls
- Properties That You Can Specify for Client-Side Controls
- Text Copy of the Client Control Presentation Model File
7 Customizing Calendars and Schedulers
- Customizing Calendars and Schedulers
- Customizing Calendars
- Using Fields to Customize Event Styles for the Calendar
- Allowing Users to Copy Items from List Applets to Create Calendar Events
- Customizing Event Styles for the Calendar
- Customizing Calendar Work Days
- Customizing How Calendars Display Timestamps
- Replacing Standard Interactivity Calendars
- Customizing How Users View Calendar Availability
- Customizing the Calendar All Day Slot
- Customizing Resource Schedulers
- Overview of Customizing Resource Schedulers
- Customizing a Resource Scheduler
- Customizing the Filter Pane in Resource Schedulers
- Customizing the Resource Pane in Resource Schedulers
- Customizing the Timescale Pane in Resource Schedulers
- Customizing the Schedule Pane in Resource Schedulers
- Customizing Participant Availability in Resource Schedulers
- Customizing Tooltips in Resource Schedulers
8 Configuring Siebel UI to Interact with Other Applications
- Configuring Siebel Open UI to Interact with Other Applications
- Displaying Data from External Applications in Siebel Open UI
- Siebel Portal Framework
- Integrating External Content
- Displaying Data from External Applications in Siebel Views
- Displaying Data from External Applications in Siebel Applets
- Displaying Data from Siebel Open UI in External Applications
- Displaying Siebel Portlets in External Applications
- Configuring Multiple Siebel Portlets in Portal Applications
- Configuring Advanced Options
- Configuring Communications with Siebel Portlets When Hosted Inside iFrame
- Additional Considerations
- Limitations
- Preparing Standalone Applets
- Using iFrame Gadgets to Display Siebel CRM Applets in External Applications
- SWE API
- Web Engine HTTP TXN Business Service
9 Customizing Siebel Open UI for Siebel Mobile Disconnected
- Customizing Siebel Open UI for Siebel Mobile Disconnected
- Overview of Customizing Siebel Open UI for Siebel Mobile Disconnected
- Doing General Customization Tasks for Siebel Mobile Disconnected
- Modifying Manifest Files for Siebel Mobile Disconnected
- Registering Methods to Make Sure Siebel Open UI Runs Them in the Correct Sequence
- Using Siebel Business Services or JavaScript Services to Customize Siebel CRM Objects
- Using Custom JavaScript Methods
- Using Custom Siebel Business Services
- Configuring Data Filters
- Configuring Objects That Siebel Open UI Does Not Display in Clients
- Configuring Error Messages for Disconnected Clients
- About Siebel Mobile Application Logging
- Customizing Siebel Pharma for Siebel Mobile Disconnected Clients
- Customizing Siebel Service for Siebel Mobile Disconnected Clients
- Methods You Can Use to Customize Siebel Mobile Disconnected
- Methods You Can Use in the Applet Class
- Methods You Can Use in the Business Component Class
- ActivateField Method
- ActivateMultipleFields Method
- Associate Method
- ClearToQuery Method
- CountRecords Method
- DeactivateFields Method
- DeleteRecord Method
- ExecuteQuery Method
- FirstRecord Method
- GetAssocBusComp Method
- GetFieldValue Method
- GetLinkDef Method
- GetLastErrCode Method for Business Components
- GetLastErrText Method for Business Components
- GetMultipleFieldValues Method
- GetPicklistBusComp Method
- GetSearchExpr Method
- GetSearchSpec Method
- GetUserProperty Method
- GetViewMode Method
- InvokeMethod for Business Components
- Name Method for Business Components
- NextRecord Method
- ParentBusComp Method
- Pick Method
- RefreshBusComp Method
- RefreshRecord Method
- SetFieldValue Method
- SetMultipleFieldValues Method
- SetSearchSpec Method
- SetViewMode Method
- UndoRecord Method
- UpdateRecord Method
- WriteRecord Method
- Methods You Can Use in the Business Object Class
- Methods You Can Use in the Business Service Class
- Methods You Can Use in the Application Class
- ActiveBusObject Method
- ActiveViewName Method
- CurrencyCode Method
- FindApplet Method
- GetBusObject Method
- GetLastErrCode Method for Applications
- GetLastErrText Method for Applications
- GetService Method
- LoginId Method
- LoginName Method
- Name Method for Applications
- NewPropertySet Method
- PositionId Method
- PositionName Method
- Methods You Can Use in the Model Class
- Methods You Can Use in the Service Model Class
- Methods You Can Use in Offline Classes
- Other Methods You Can Use with Siebel Mobile Disconnected
10 Application Programming Interface
- Application Programming Interface
- Overview of the Siebel Open UI Client Application Programming Interface
- Methods of the Siebel Open UI Application Programming Interface
- Presentation Model Class
- AddComponentCommunication Method
- AddLocalString Method
- AddMethod Method
- AddProperty Method
- AddValidator Method
- AttachEventHandler Method
- AttachNotificationHandler Method
- AttachPMBinding Method
- AttachPostProxyExecuteBinding Method
- AttachPreProxyExecuteBinding Method
- ExecuteMethod Method
- Get Method
- GetCtrlTemplate Method
- Init Method
- OnControlEvent Method
- SetProperty Method
- Setup Method for Presentation Models
- Presentation Model Class for Applets
- Summary of Methods That You Can Use with the Presentation Model for Applets
- Properties of the Presentation Model That Siebel Open UI Uses for Applets
- Adding Code to the Physical Renderer
- CanInvokeMethod Method for Presentation Models
- CanNavigate Method
- CanUpdate Method
- ExecuteMethod_Method
- ExecuteUIUpdate_Method
- FieldChange Method for Presentation Models
- FocusFirstControl Method
- GetControl Method
- GetControlId Method
- GetFieldValue_Method
- GetFormattedFieldValue Method
- GetPhysicalControlValue Method
- InvokeMethod Method for Presentation Models
- InvokeStateChange Method
- IsPrivateField Method
- LeaveField Method
- NewFileAttachment Method
- PostExecute Method
- ProcessCancelQueryPopup Method
- RefreshData Method
- ResetAppletState Method
- SetActiveControl Method
- SetHighlightState Method
- SetFocusDefaultControl Method
- SetUpdateConditionals Method
- ShowPickPopup Method
- ShowPopup Method
- ShowSelection Method
- UpdateAppletMessage Method
- UpdateConditionals Method
- UpdateCurrencyCalcInfo Method
- UpdateQuickPickInfo Method
- UpdateStateChange Method
- Presentation Model Class for List Applets
- Properties of the Presentation Model That Siebel Open UI Uses for List
- Summary of Methods That You Can Use with the Presentation_Model That Siebel Open UI Uses for List Applets
- CellChange Method
- HandleRowSelect Method
- OnClickSort Method
- OnCtrlBlur Method
- OnCtrlFocus Method
- OnDrillDown Method
- OnVerticalScroll Method
- SetMultiSelectMode Method
- Presentation Model Class for Menus
- Physical Renderer Class
- Plug-in Wrapper Class
- Plugin Builder Class
- Template Manager Class
- Event Helper Class
- API Specification for Context Renderers
- Business Component Class
- Applet Class
- Applet Control Class
- GetCaseSensitive Method
- GetDisabledBmp Method
- GetDisplayName Method
- GetDispMode Method
- GetEDEnabled Method
- GetEnabledBmp Method
- GetFieldName Method
- GetHeight Method
- GetIndex Method
- GetInputName Method
- GetJustification Method
- GetMaxSize Method
- GetMethodName Method
- GetName Method for Applet Controls
- GetPMPropSet Method
- GetPopupHeight Method
- GetPopupType Method
- GetPopupWidth Method
- GetPrompt Method
- GetUIType Method
- GetWidth Method
- HandleDeleteNotification Method
- IsBoundedPick Method
- IsCalc Method
- IsDynamic Method
- IsEditEnabled Method
- IsSortable Method
- NewRecord Method
- NotifyNewData Method
- PreGetFormattedFieldValue Method
- PostLeaveField Method
- SetIndex Method
- JQ Grid Renderer Class for Applets
- OnControlBlur Method
- OnControlMvg Method
- OnControlPick Method
- OnPagination Method
- OnRowSelect Method
- Business Service Class
- Application Model Class
- CanInvokeMethod Method for Application Models
- ClearMainView Method
- GenerateSrvrReq Method
- GetActiveBusObj Method
- GetActiveView Method
- GetAppletControlInstance Method
- GetAppTitle Method
- GetDirection Method
- GetName Method for Application Models
- GetPageURL Method
- GetProfileAttr Method
- GetService_Method
- GotoView Method
- Work That Siebel Open UI Does When It Runs the GotoView Method
- InvokeMethod Method for Application Models
- IsExtendedKeyBoard Method
- IsMobileApplication Method
- LogOff Method
- LookupStringCache Method
- NewPropertySet Method
- RemoveService Method
- SetDiscardUserState Method
- Control Builder Class
- Locale Object Class
- FormattedToString Method
- GetCurrencyList Method
- GetDateFormat Method
- GetDayOfWeek Method
- GetDispCurrencyDecimal Method
- GetDispCurrencySeparator Method
- GetDispDateSeparator Method
- GetDispNumberDecimal Method
- GetDispNumberScale Method
- GetDispNumberSeparator Method
- GetDispTimeAM Method
- GetDispTimePM Method
- GetDispTimeSeparator Method
- GetExchangeRate Method
- GetFuncCurrCode Method
- GetLocalString Method
- GetMonth Method
- GetScale Method
- GetStringFromDateTime Method
- GetTimeFormat Method
- GetTimeZoneList Method
- GetTimeZoneName Method
- SetCurrencyCode Method
- SetExchDate Method
- SetScale Method
- StringToFormatted Method
- Component Class
- Component Manager Class
- Other Classes
- Presentation Model Class
- Methods for Pop-Up Objects and Property Sets
11 Reference Information for Siebel Open UI
- Reference Information for Siebel Open UI
- Life Cycle Flows of User Interface Elements
- Life Cycle Flows That Save Records
- Life Cycle Flows That Handle User Navigation
- Life Cycle Flows That Send Notifications
- Life Cycle Flows That Create New Records in List Applets
- Flow That Creates New Records in List Applets, Calling the Siebel Server
- Flow That Creates New Records in List Applets, Processing the Server Reply
- Flows That Create New Records in List Applets, Updating the User Interface
- Flow That Creates New Records in List Applets, Updating the Proxy and Presentation Model
- Life Cycle Flows That Handle User Actions in List Applets
- Flow That Handles Navigation to Another Row in List Applets
- Flow That Handles the Pagination Button in List Applets
- Flow That Handles a Column Sort in List Applets
- Flow That Handles a Cell Click in List Applets
- Flow That Handles a Cell Edit and Blur in List Applets
- Flow That Handles a Drilldown in List Applets
- Notifications That Siebel Open UI Supports
- Summary of Notifications That Siebel Open UI Supports
- Using Notifications with Operations That Call Methods
- NotifyGeneric Notification Type
- NotifyStateChanged Notification Type
- Example Usages of Notifications
- Example of the NotifyBeginNotifys Notification
- Example of the NotifyNewSelection Notification
- Example of the NotifyNewFieldData Notification
- Example of the NotifyNewDataWorkset Notification
- Example of the NotifyNewData, NotifyInsertWorkSet, and NotifyDeleteRecordSet Notifications
- Example of the NotifyBeginQuery, NotifyNewFieldQuerySpec, and NotifyEndQuery Notifications
- Example of the NotifyEndNotifys Notification
- Example of the SWEIRowSelection Notification
- Example of the BegRow Notification
- Example of the GetQuickPickInfo Notification
- Example of the ClosePopup Notification
- Example of the SWEAInvokeMethod Notification
- Example of the NotifyStateChanged Notification
- Property Sets That Siebel Open UI Supports
- Siebel CRM Events That You Can Use to Customize Siebel Open UI
- Languages That Siebel Open UI Supports
- Screens and Views That Siebel Mobile Uses
- Controls That Siebel Open UI Uses
- Browser Script Compatibility
12 Post-Upgrade Configuration Tasks
- Post-Upgrade Configuration Tasks
- Updating Physical Renderer Customizations for Controls
- Modifying Physical Renderer Code for Event Helper
- Overriding Plug-In Wrappers
13 Glossary
- access control
- account
- ActiveX
- ActiveX control
- activity
- activity (Siebel CRM)
- administrator
- applet metadata
- business component
- business object
- carouselrenderer.js file
- client
- client computer
- client file
- contact
- CRM (Customer Relationship Management)
- customization
- derive
- focus
- infinite scroll
- inheritance chain
- JQM Grid Renderer
- jqmlistrenderer and jqmgridrenderer
- Manifest File
- metadata
- metadata files
- native mode
- object definitions
- object manager
- opportunity
- parent business component
- physical renderer
- physical renderer methods
- predefined object
- predefined Siebel Open UI
- Presentation Model
- Presentation Model class
- private field
- proxy object
- responsibility
- shadow object
- Siebel Business Application
- Siebel CRM data
- Siebel Open UI
- Siebel Property Set
- Siebel Repository
- Siebel Server
- Siebel Web services
- SWE runtime applet object
- synchronous request
- user
- user interface