Siebel Object Interfaces Reference - Oracle

Siebel Object Interfaces Reference

Siebel Innovation Pack 2013 Version 8.1/8.2 September 2013

Copyright ? 2005, 2013 Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be errorfree. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at .

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit or visit if you are hearing impaired.

Contents

Siebel Object Interfaces Reference 1

Chapter 1: What's New in This Release

Chapter 2: About Object Interfaces and the Programming Environment

Object Interfaces You Can Use to Access Siebel Objects 9

Overview of Interfaces You Use to Access Siebel Objects 9 Objects You Can Access Through a Siebel Object Interface 10 About the Siebel Java Data Bean Object Interface 12 About the Siebel COM Object Interface 12

About the Siebel Programming Environment 17

Siebel Object Interface Methods That You Can Use to Control Data and Objects 20

Methods That Locate Objects 20 Methods That Access Data from Business Components 21 Methods That Control Navigation Flow of Siebel Applications 26 Methods That Get and Display Information About the Current State 27 Methods That Control Debug Tracing 27

Chapter 3: Customizing Siebel Object Interfaces

Process of Customizing a Siebel Object Interface 29

Determining the Type of Siebel Object Interface You Must Use 29 Setting the Connect String 30

Accessing a Siebel Object Interface 34

Accessing the Web Client Automation Server 35 Accessing the Mobile Web Client Automation Server 36 Accessing the Siebel COM Interface 38 Accessing the COM Data Server 40 Accessing the COM Data Server with Microsoft Visual Studio 42 Accessing COM Data Control 46 Accessing the Siebel Java Data Bean 48

Customizing Object Interface Events and Extension Events 56

Overview of Object Interface Events and Extension Events 56 Format of the Object Interface Event 57 Customizing the Outcome of an Object Interface Event 57

Siebel Object Interfaces Reference Version 8.1/8.2

3

Contents

Customizing How Siebel CRM Continues an Operation 57 Using Tracing to Determine When an Event Occurs 59

Configuring Error Handling 60

Chapter 4: Using Siebel Visual Basic and Siebel eScript

Overview of Using Siebel Visual Basic and Siebel eScript 63 Examples of Using Siebel Visual Basic and Siebel eScript 63 Guidelines for Using Siebel VB and Siebel eScript 64 Opening the Siebel Script Editor 72 Declaring a Variable 73 Calling More Than One Object Interface Method In a Script 75 Using Script to Add Business Logic to a Business Component 76 Using a MiniButton Control to Call a Custom Method 76 Tracing a Script 79

Chapter 5: Siebel Object Interfaces Reference

Format of the Object Interface Method 83

Technologies You Can Use to Access Object Interface Methods and Events 85

Technologies You Can Use to Access Object Interface Methods 85 Technologies You Can Use to Access Object Interface Events 98

Object Interfaces Reference 100

Applet Methods 101 Applet Events 107 Application Methods 122 Application Events 177 Business Component Methods 183 Business Component Invoke Methods 250 Business Component Events 260 Business Object Methods 275 Business Service Methods 278 Business Service Events 287 Control Methods 294 Property Set Methods 304 Miscellaneous Methods 320

Chapter 6: Browser Script Quick Reference

Applet Methods for Browser Script 323 Applet Events For Browser Script 324 Application Methods for Browser Script 325 Application Events for Browser Script 326 Business Component Methods for Browser Script 326

4

Siebel Object Interfaces Reference Version 8.1/8.2

Contents

Business Component Events for Browser Script 328 Business Object Methods for Browser Script 328 Business Service Methods for Browser Script 328 Business Service Events for Browser Script 329 Property Set Methods for Browser Script 330 Control Methods for Browser Script 331 Document Object Model Events You Can Use 332

Chapter 7: Siebel VB Quick Reference

Applet Methods for Siebel VB 337 Web Applet Events for Siebel VB 338 Application Methods for Siebel VB 339 Application Events for Siebel VB 341 Business Component Methods for Siebel VB 342 Business Component Events for Siebel VB 346 Business Object Methods for Siebel VB 349 Business Service Methods for Siebel VB 349 Business Service Events for Siebel VB 350 Property Set Methods for Siebel VB 351 Miscellaneous Methods for Siebel VB 352

Chapter 8: Siebel eScript Quick Reference

Applet Methods for Siebel eScript 353 Web Applet Events for Siebel eScript 354 Application Methods for Siebel eScript 355 Application Events for Siebel eScript 357 Business Component Methods for Siebel eScript 357 Business Component Events for Siebel eScript 362 Business Object Methods for Siebel eScript 364 Business Service Methods for Siebel eScript 365 Business Service Events for Siebel eScript 366 Property Set Methods for Siebel eScript 366 Miscellaneous Methods for Siebel eScript 368

Chapter 9: COM Data Server Quick Reference

Application Methods for COM Data Server 369 Business Component Methods for COM Data Server 372 Business Object Methods for COM Data Server 376 Business Service Methods for COM Data Server 377 Property Set Methods for COM Data Server 378

Siebel Object Interfaces Reference Version 8.1/8.2

5

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download