Contents

• Title and Copyright Information
• Preface

1 What's New in This Release

• What’s New in Siebel Object Interfaces Reference, Siebel CRM 20.3 Update
• What’s New in Siebel Object Interfaces Reference, Siebel CRM 20.1 Update
• What’s New in Siebel Object Interfaces Reference, Siebel CRM 19.1 Update

2 About Object Interfaces and the Programming Environment

• About Object Interfaces and the Programming Environment
• Object Interfaces You Can Use to Access Siebel Objects
  • Overview of Interfaces You Use to Access Siebel Objects
  • Objects You Can Access Through a Siebel Object Interface
    • Applets
    • Business Services
    • Property Sets
    • User Interface Controls
  • About the Siebel Java Data Bean Object Interface
  • About the Siebel COM Object Interface
    • How an External Application Communicates with a Siebel Application
    • Servers That the Siebel COM Interface Uses
      • Mobile Web Client Automation Server
      • How Siebel CRM Uses Memory and Resources with the Mobile Web Client Automation Server
      • COM Data Server
• About the Siebel Programming Environment
  • Programming Languages
  • Server Script
  • Browser Script
  • Siebel Script Editor
  • Siebel Debugger
  • Siebel Compiler and Run-Time Engine
    • Compilation Order
    • About Early and Late Binding
  • Siebel Script Profiler
• Siebel Object Interface Methods That You Can Use to Control Data and Objects
  • Methods That Locate Objects
  • Methods That Access Data from Business Components
    • Adding and Inserting Records
    • How Siebel CRM Saves a Record to the Siebel Database
    • Example of Accessing Data from an Existing Business Component Instance
    • Example of Accessing Data from a New Business Component Instance
    • Methods That Get Data From Business Components
  • Methods That Control Navigation Flow of Siebel Applications
  • Methods That Get and Display Information About the Current State
  • Methods That Control Debug Tracing

3 Customizing Siebel Object Interfaces

• Customizing Siebel Object Interfaces
• Process of Customizing a Siebel Object Interface
  • Determining the Type of Siebel Object Interface You Must Use
    • Use Caution If You Customize a Siebel Object Interface
  • Setting the Connect String
    • Format of the Connect String Parameter
    • Examples of Using the Connect String
    • Using Load Balancing with the Connect String
• Accessing a Siebel Object Interface
  • Accessing the Mobile Web Client Automation Server
    • Example of Accessing the Mobile Web Client Automation Server
  • Accessing the Siebel COM Interface
    • Example of an Object Browser
  • Accessing the COM Data Server
    • Example of Accessing the COM Data Server
  • Accessing the COM Data Server with Microsoft Visual Studio
  • Accessing COM Data Control
    • Example of Accessing COM Data Control
    • Example of Using Siebel Server ASP Script to Access COM Data Control
  • Accessing the Siebel Java Data Bean
    • Example of Accessing the Siebel Java Data Bean
    • Using Single Sign-on (SSO) with Siebel Java Data Bean
    • Customizing the Parameters a Third-Party Application Uses to Connect Through the Siebel Java Data Bean
      • Properties of the Siebel Properties File
      • Example of the Siebel Properties File
      • Determining the Total Number of Open Connections
    • Customizing Character Encoding for the Siebel Java Data Bean
    • Configuring TLS for the Siebel Java Data Bean Standalone Client
    • Encrypting Communication Between the Java Data Bean and the Siebel Server
    • Login Errors You Might Encounter When You Use the Siebel Java Data Bean
    • Using the Siebel Java Data Bean with Multiple Threads
• Customizing Object Interface Events and Extension Events
  • Overview of Object Interface Events and Extension Events
  • Format of the Object Interface Event
  • Customizing the Outcome of an Object Interface Event
  • Customizing How Siebel CRM Continues an Operation
    • Caution About Using the Cancel Operation Event Handler
    • Example of Using Siebel VB to Create a Validation
    • Example of Using Siebel eScript to Create a Validation
  • Using Tracing to Determine When an Event Occurs
• Configuring Error Handling
  • COM Error Handling
  • Examples of Configuring Error Handling
  • Error Message Tracking

4 Using Siebel Visual Basic and Siebel eScript

• Using Siebel Visual Basic and Siebel eScript
• Overview of Using Siebel Visual Basic and Siebel eScript
• Examples of Using Siebel Visual Basic and Siebel eScript
  • Validating Data
  • Modifying and Controlling Data
  • Customizing Behavior for User Interface Elements
• Guidelines for Using Siebel VB and Siebel eScript
  • Declare Your Variables
  • Use a Standardized Naming Convention
  • Use Constants to Standardize Code
  • Avoid Nested If Statements
  • Applying Multiple Object Interface Methods to a Single Object
  • Use a Self-Reference to Indicate the Current Object
  • Delete Objects You Have Created That You No Longer Require
  • Make Sure Function Names Are Unique
  • Manage the Script Buffer
  • Using Siebel VB and Siebel eScript Formats
  • Handling the Date Format in Siebel VB
  • Returning Run-Time Errors in Siebel VB
• Opening the Siebel Script Editor
• Declaring a Variable
  • Declaring a Local Variable
  • Declaring a Module Variable
  • Declaring a Global Variable
• Calling More Than One Object Interface Method In a Script
  • Example of Calling More Than One Object Interface Method in Siebel VB
  • Example of Calling More Than One Object Interface Method in Siebel eScript
• Using Script to Add Business Logic to a Business Component
• Using a MiniButton Control to Call a Custom Method
  • Using Script to Enable a MiniButton
• Tracing a Script

5 Siebel Object Interfaces Reference

• Siebel Object Interfaces Reference
• Format of the Object Interface Method
  • Formats for Siebel VB
  • Formats for Siebel eScript
  • Formats for the Component Object Model
• Technologies You Can Use to Access Object Interface Methods and Events
  • Technologies You Can Use to Access Object Interface Methods
    • Applet Methods
    • Application Methods
    • Business Component Methods
    • Business Object Methods
    • Business Service Methods
    • Control Methods
    • Property Set Methods
    • Miscellaneous Methods
  • Technologies You Can Use to Access Object Interface Events
    • Applet Events
    • Application Events
    • Business Component Events
    • Business Service Events
• Object Interfaces Reference
  • About Specialized and Custom Methods
  • Applet Methods
    • ActiveMode Method for an Applet
    • BusComp Method for an Applet
    • BusObject Method for an Applet
    • FindControl Method for an Applet
    • InvokeMethod Method for an Applet
    • Name Method for an Applet
  • Applet Events
    • Overview of Applet Events
    • Applet_ChangeFieldValue Event
    • Applet_ChangeRecord Event
    • Applet_InvokeMethod Event
    • Applet_Load Event
    • Applet_PreInvokeMethod Event
    • WebApplet_InvokeMethod Event
    • WebApplet_Load Event
    • WebApplet_PreCanInvokeMethod Event
    • WebApplet_PreInvokeMethod Event
  • Application Methods
    • Overview of Application Methods
    • ActiveApplet Method for an Application
    • ActiveBusComp Method for an Application
    • ActiveBusObject Method for an Application
    • ActiveViewName Method for an Application
    • Attach Method for an Application
    • CurrencyCode Method for an Application
    • Detach Method for an Application
    • EnableExceptions Method for an Application
    • FindApplet Method for an Application
    • GetBusObject Method for an Application
    • GetDataSource Method for an Application
    • GetLastErrCode Method for an Application
    • GetLastErrText Method for an Application
    • GetProfileAttr Method for an Application
    • GetService Method for an Application
    • GetSharedGlobal Method for an Application
    • GotoView Method for an Application
    • InvokeMethod Method for an Application
    • IsViewReadOnly Method for an Application
    • Language Method for an Application
    • LoadObjects Method for an Application
    • LoadUserAttributes Method for an Application
    • Login Method for an Application
    • LoginId Method for an Application
    • LoginName Method for an Application
    • Logoff Method for an Application
    • LookupMessage Method for an Application
    • LookupValue Method for an Application
    • Name Method for an Application
    • NewPropertySet Method for an Application
    • PositionId Method for an Application
    • PositionName Method for an Application
    • RaiseError Method for an Application
    • RaiseErrorText Method for an Application
    • SetPositionId Method for an Application
    • SetPositionName Method for an Application
    • SetProfileAttr Method for an Application
    • SetSharedGlobal Method for an Application
    • SWEAlert Method for an Application
    • Trace Method for an Application
    • TraceOff Method for an Application
    • TraceOn Method for an Application
  • Application Events
    • Application_Close Event
    • Application_InvokeMethod Event
    • Application_Navigate Event
    • Application_PreInvokeMethod Event
    • Application_PreNavigate Event
    • Application_Start Event
  • Business Component Methods
    • ActivateField Method for a Business Component
    • ActivateMultipleFields Method for a Business Component
    • Associate Method for a Business Component
    • BusObject Method for a Business Component
    • ClearToQuery Method for a Business Component
    • CountRecords Method for a Business Component
    • DeactivateFields Method for a Business Component
    • DeleteRecord Method for a Business Component
    • ExecuteQuery Method for a Business Component
    • ExecuteQuery2 Method for a Business Component
    • FirstRecord Method for a Business Component
    • FirstSelected Method for a Business Component
    • GetAssocBusComp Method for a Business Component
    • GetFieldValue Method for a Business Component
    • GetFormattedFieldValue Method for a Business Component
    • GetLastErrCode Method for a Business Component
    • GetLastErrText Method for a Business Component
    • GetMultipleFieldValues Method for a Business Component
    • GetMVGBusComp Method for a Business Component
    • GetNamedSearch Method for a Business Component
    • GetPicklistBusComp Method for a Business Component
    • GetSearchExpr Method for a Business Component
    • GetSearchSpec Method for a Business Component
    • GetSortSpec Method for a Business Component
    • GetUserProperty Method for a Business Component
    • GetViewMode Method for a Business Component
    • InvokeMethod Method for a Business Component
    • LastRecord Method for a Business Component
    • Name Method for a Business Component
    • NewRecord Method for a Business Component
    • NextRecord Method for a Business Component
    • NextSelected Method for a Business Component
    • ParentBusComp Method for a Business Component
    • Pick Method for a Business Component
    • PreviousRecord Method for a Business Component
    • RefineQuery Method for a Business Component
    • Release Method for a Business Component
    • SetFieldValue Method for a Business Component
    • SetFormattedFieldValue Method for a Business Component
    • SetMultipleFieldValues Method for a Business Component
    • SetNamedSearch Method for a Business Component
    • SetSearchExpr Method for a Business Component
    • SetSearchSpec Method for a Business Component
    • SetSortSpec Method for a Business Component
    • SetUserProperty Method for a Business Component
    • SetViewMode Method for a Business Component
    • UndoRecord Method for a Business Component
    • WriteRecord Method for a Business Component
  • Business Component Invoke Methods
    • Overview of Methods That Manipulate the File System
    • ClearLOVCache Method for a Business Component
    • CreateFile Method for a Business Component
    • GenerateProposal Method for a Business Component
    • GetFile Method for a Business Component
    • PutFile Method for a Business Component
    • RefreshBusComp Method for a Business Component
    • RefreshRecord Method for a Business Component
    • SetAdminMode Method for a Business Component
  • Business Component Events
    • Monitoring Modifications That the User Makes to a Multivalue Field
    • BusComp_Associate Event
    • BusComp_ChangeRecord Event
    • BusComp_CopyRecord Event
    • BusComp_DeleteRecord Event
    • BusComp_InvokeMethod Event
    • BusComp_NewRecord Event
    • BusComp_PreAssociate Event
    • BusComp_PreCopyRecord Event
    • BusComp_PreDeleteRecord Event
    • BusComp_PreGetFieldValue Event
    • BusComp_PreInvokeMethod Event
    • BusComp_PreNewRecord Event
    • BusComp_PreQuery Event
    • BusComp_PreSetFieldValue Event
    • BusComp_PreWriteRecord Event
    • BusComp_Query Event
    • BusComp_SetFieldValue Event
    • BusComp_WriteRecord Event
  • Business Object Methods
    • GetBusComp Method for a Business Object
    • GetLastErrCode Method for a Business Object
    • GetLastErrText Method for a Business Object
    • Name Method for a Business Object
    • Release Method for a Business Object
  • Business Service Methods
    • GetFirstProperty Method for a Business Service
    • GetNextProperty Method for a Business Service
    • GetProperty Method for a Business Service
    • InvokeMethod Method for a Business Service
    • Name Method for a Business Service
    • PropertyExists Method for a Business Service
    • Release Method for a Business Service
    • RemoveProperty Method for a Business Service
    • SetProperty Method for a Business Service
  • Business Service Events
    • Service_InvokeMethod Event
    • Service_PreCanInvokeMethod Event
    • Service_PreInvokeMethod Event
  • Control Methods
    • Applet Method for a Control
    • BusComp Method for a Control
    • GetProperty Method for a Control
    • GetValue Method for a Control
    • Name Method for a Control
    • SetLabelProperty Method for a Control
    • SetProperty Method for a Control
    • SetValue Method for a Control
  • Property Set Methods
    • AddChild Method for a Property Set
    • Copy Method for a Property Set
    • GetByteValue Method for a Property Set
    • GetChild Method for a Property Set
    • GetChildCount Method for a Property Set
    • GetFirstProperty Method for a Property Set
    • GetLastErrCode Method for a Property Set
    • GetLastErrText Method for a Property Set
    • GetNextProperty Method for a Property Set
    • GetProperty Method for a Property Set
    • GetPropertyCount Method for a Property Set
    • GetType Method for a Property Set
    • GetValue Method for a Property Set
    • InsertChildAt Method for a Property Set
    • PropertyExists Method for a Property Set
    • RemoveChild Method for a Property Set
    • RemoveProperty Method for a Property Set
    • Reset Method for a Property Set
    • SetByteValue Method for a Property Set
    • SetProperty Method for a Property Set
    • SetType Method for a Property Set
    • SetValue Method for a Property Set
  • Miscellaneous Methods
    • GetErrorCode Method
    • GetErrorMessage Method
    • TheApplication Method

6 Browser Script Quick Reference

• Browser Script Quick Reference
• Applet Methods for Browser Script
• Applet Events For Browser Script
• Application Methods for Browser Script
• Application Events for Browser Script
• Business Component Methods for Browser Script
• Business Component Events for Browser Script
• Business Object Methods for Browser Script
• Business Service Methods for Browser Script
• Business Service Events for Browser Script
• Property Set Methods for Browser Script
• Control Methods for Browser Script
• Document Object Model Events You Can Use
  • Document Object Model Events

7 Siebel VB Quick Reference

• Siebel VB Quick Reference
• Applet Methods for Siebel VB
• Web Applet Events for Siebel VB
• Application Methods for Siebel VB
• Application Events for Siebel VB
• Business Component Methods for Siebel VB
• Business Component Events for Siebel VB
• Business Object Methods for Siebel VB
• Business Service Methods for Siebel VB
• Business Service Events for Siebel VB
• Property Set Methods for Siebel VB
• Miscellaneous Methods for Siebel VB

8 Siebel eScript Quick Reference

• Siebel eScript Quick Reference
• Applet Methods for Siebel eScript
• Web Applet Events for Siebel eScript
• Application Methods for Siebel eScript
• Application Events for Siebel eScript
• Business Component Methods for Siebel eScript
• Business Component Events for Siebel eScript
• Business Object Methods for Siebel eScript
• Business Service Methods for Siebel eScript
• Business Service Events for Siebel eScript
• Property Set Methods for Siebel eScript
• Miscellaneous Methods for Siebel eScript

9 COM Data Server Quick Reference

• COM Data Server Quick Reference
• Application Methods for COM Data Server
• Business Component Methods for COM Data Server
• Business Object Methods for COM Data Server
• Business Service Methods for COM Data Server
• Property Set Methods for COM Data Server

10 COM Data Control Quick Reference

• COM Data Control Quick Reference
• Application Methods for COM Data Control
• Business Component Methods for COM Data Control
• Business Object Methods for COM Data Control
• Business Service Methods for COM Data Control
• Property Set Methods for COM Data Control

11 Mobile Web Client Automation Server Quick Reference

• Mobile Web Client Automation Server Quick Reference
• Application Methods for the Mobile Web Client Automation Server
• Business Component Methods for the Mobile Web Client Automation Server
• Business Object Methods for the Mobile Web Client Automation Server
• Business Service Methods for the Mobile Web Client Automation Server
• Property Set Methods for the Mobile Web Client Automation Server

12 Siebel Java Data Bean Quick Reference

• Siebel Java Data Bean Quick Reference
• Data Bean Methods for Siebel Java Data Bean
• Business Component Methods for Siebel Java Data Bean
• Business Object Methods for Siebel Java Data Bean
• Business Service Methods for Siebel Java Data Bean
• Property Set Methods for Siebel Java Data Bean
• Siebel Exception Methods for Siebel Java Data Bean