For Oracle internal distribution only

Siebel Object Interfaces

Reference
Version 8.1
February 2008
 For Oracle internal distribution only

Copyright 2005, 2008, Oracle. All rights reserved.

The Programs (which include both the software and documentation) contain proprietary information;
they are provided under a license agreement containing restrictions on use and disclosure and are also
protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering,
disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability
with other independently created software or as specified by law, is prohibited.

The information contained in this document is subject to change without notice. If you find any problems
in the documentation, please report them to us in writing. This document is not warranted to be error-
free. Except as may be expressly permitted in your license agreement for these Programs, no part of
these Programs may be reproduced or transmitted in any form or by any means, electronic or
mechanical, for any purpose.

PRODUCT MODULES AND OPTIONS. This guide contains descriptions of modules that are optional and
for which you may not have purchased a license. Siebels Sample Database also includes data related to
these optional modules. As a result, your software implementation may differ from descriptions in this
guide. To find out more about the modules your organization has purchased, see your corporate
purchasing agent or your Oracle sales representative.

If the Programs are delivered to the United States Government or anyone licensing or using the Programs
on behalf of the United States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS. Programs, software, databases, and related documentation and technical
data delivered to U.S. Government customers are "commercial computer software" or "commercial
technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific
supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the
Programs, including documentation and technical data, shall be subject to the licensing restrictions set
forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set
forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA,
Inc., 500 Oracle Parkway, Redwood City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently
dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,
redundancy and other measures to ensure the safe use of such applications if the Programs are used for
such purposes, and we disclaim liability for any damages caused by such use of the Programs.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be
trademarks of their respective owners.

The Programs may provide links to Web sites and access to content, products, and services from third
parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites.
You bear all risks associated with the use of such content. If you choose to purchase any products or
services from a third party, the relationship is directly between you and the third party. Oracle is not
responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of
the agreement with the third party, including delivery of products or services and warranty obligations
related to purchased products or services. Oracle is not responsible for any loss or damage of any sort
that you may incur from dealing with any third party.
 For Oracle internal distribution only

Contents

Siebel Object Interfaces Reference 1

Chapter 1: Whats New in This Release

Chapter 2: Siebel Programming Tools

About the Siebel Programming Tools 15
Components of the Siebel Programming Environment 16
Supported Uses of Siebel Programming Languages 17
Business Logic Definition 17
Custom Behavior for User Interface Components 17
Adding New Business Logic to a Business Component 18
Tracing Scripts 18
About the Siebel Script Profiler 20
About the Siebel Compiler and Run-Time Engine 21
About Siebel VB 21
About Siebel eScript 24

Chapter 3: Programming
About Programming with Siebel Object Interfaces 27
About Siebel Object Interfaces 28
Siebel COM Interfaces 28
Siebel Java Interfaces 32
Built-In Scripting 32
Usage Evaluation Matrix 33
Installing Siebel Object Interfaces 33
Exposed Object Types 34
Application Object Type 34
Business Object Object Type 34
Business Component Object Type 35
Business Service Object Type 35
Applet Object Type 36
Property Set Object Type 36
User Interface Control Object Type 36

Siebel Object Interfaces Reference Version 8.1 3

 For Oracle internal distribution only
Contents

Summary of Exposed Object Types 37

Siebel Object Interface Method Syntax 37
Getting Started with the Siebel Object Interfaces 39
Accessing Siebel COM Interfaces 40
Accessing the Siebel Web Client Automation Server 40
Accessing the Siebel Mobile Web Client Automation Server 42
Instantiating the Siebel COM Data Server 44
Instantiating the Siebel COM Data Control 46
About Java Data Bean 48
Siebel Object Interface Methods 53
Locating Objects 54
Accessing Business Components 55
Navigation Methods 60
User Interaction Methods 60
Global State Properties and Functions 60
Variable Scoping for Siebel Script Variables 61
Local Variables 61
Module Variables 62
Global Variables 62
Inter-Application Variable Methods 63
Tracing 63
Siebel Object Interface Events and Siebel Extension Events 63
Event Method Syntax 64
How Your Script Affects Program Flow 64
Unique Names 68
Using Tracing to Find Out When Events Occur 68
Siebel Business Component Events 68
Applet Events 70
Application Events 71
Connect String 71
Error Handling 74

Chapter 4: Interfaces Reference

Object Interface Method Tables 77
Applet Methods 78
Application Methods 78
Business Component Methods 81
Business Object Methods 85
Business Service Methods 85
Control Methods 86

4 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Contents

Property Set Methods 87

Miscellaneous Methods 88
Object Interface Event Tables 89
Applet Events 89
Application Events 90
Business Component Events 90
Business Service Events 91
Siebel Constants 91
Applet Methods 92
ActiveMode Method 92
BusComp Method 93
BusObject Method 93
FindActiveXControl Method 94
FindControl Method 95
InvokeMethod Method 96
Name Method 98
Applet Events 99
Applet_ChangeFieldValue Event 99
Applet_ChangeRecord Event 101
Applet_InvokeMethod Event 101
Applet_Load Event 103
Applet_PreInvokeMethod Event 104
WebApplet_InvokeMethod Event 105
WebApplet_Load Event 106
WebApplet_PreCanInvokeMethod Event 108
WebApplet_PreInvokeMethod Event 109
WebApplet_ShowControl Event 110
WebApplet_ShowListColumn Event 112
Application Methods 115
ActiveApplet Method 116
ActiveBusComp Method 117
ActiveBusObject Method 118
ActiveViewName Method 120
Attach Method 121
CurrencyCode Method 123
Detach Method 124
EnableExceptions Method 125
FindApplet Method 127
GetBusObject Method 127
GetLastErrCode Method 129

Siebel Object Interfaces Reference Version 8.1 5

 For Oracle internal distribution only
Contents

GetLastErrText Method 130

GetProfileAttr Method 131
GetService Method 131
GetSharedGlobal Method 134
GotoView Method 135
InvokeMethod Method 138
LoadObjects Method 143
LoadUserAttributes Method 144
Login Method 145
LoginId Method 147
LoginName Method 147
Logoff Method 148
LookupMessage Method 149
Name Method 150
NewPropertySet Method 150
PositionId Method 152
PositionName Method 153
RaiseError Method 154
RaiseErrorText Method 155
SetPositionId Method 157
SetPositionName Method 158
SetProfileAttr Method 158
SetSharedGlobal Method 160
ShowModalDialog Method 162
SWEAlert Method 164
Trace Method 165
TraceOff Method 167
TraceOn Method 168
Application Events 171
Application_Close Event 172
Application_InvokeMethod Event 172
Application_Navigate Event 173
Application_PreInvokeMethod Event 173
Application_PreNavigate Event 175
Application_Start Event 176
Business Component Methods 178
ActivateField Method 179
ActivateMultipleFields Method 181
Associate Method 182
BusObject Method 184
ClearToQuery Method 185
CountRecords Method 186

6 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Contents

DeactivateFields Method 187

DeleteRecord Method 189
ExecuteQuery Method 190
ExecuteQuery2 Method 192
FirstRecord Method 192
FirstSelected Method 194
GetAssocBusComp Method 196
GetFieldValue Method 197
GetFormattedFieldValue Method 199
GetLastErrCode Method 201
GetLastErrText Method 202
GetMultipleFieldValues Method 203
GetMVGBusComp Method 203
GetNamedSearch Method 205
GetPicklistBusComp Method 205
GetSearchExpr Method 207
GetSearchSpec Method 208
GetSortSpec Method 209
GetUserProperty Method 209
GetViewMode Method 210
InvokeMethod Method 211
LastRecord Method 219
Name Method 220
NewRecord Method 221
NextRecord Method 222
NextSelected Method 223
ParentBusComp Method 224
Pick Method 224
PreviousRecord Method 226
RefineQuery Method 227
Release Method 228
SetFieldValue Method 230
SetFormattedFieldValue Method 232
SetMultipleFieldValues Method 233
SetNamedSearch Method 235
SetSearchExpr Method 237
SetSearchSpec Method 238
SetSortSpec Method 242
SetUserProperty Method 244
SetViewMode Method 245
UndoRecord Method 249
WriteRecord Method 249

Siebel Object Interfaces Reference Version 8.1 7

 For Oracle internal distribution only
Contents

Business Component Events 251

BusComp_Associate Event 251
BusComp_ChangeRecord Event 252
BusComp_CopyRecord Event 253
BusComp_DeleteRecord Event 254
BusComp_InvokeMethod Event 255
BusComp_NewRecord Event 255
BusComp_PreAssociate Event 256
BusComp_PreCopyRecord Event 256
BusComp_PreDeleteRecord Event 257
BusComp_PreGetFieldValue Event 258
BusComp_PreInvokeMethod Event 259
BusComp_PreNewRecord Event 260
BusComp_PreQuery Event 260
BusComp_PreSetFieldValue Event 261
BusComp_PreWriteRecord Event 263
BusComp_Query Event 264
BusComp_SetFieldValue Event 265
BusComp_WriteRecord Event 266
Business Object Methods 267
GetBusComp Method 267
GetLastErrCode Method 268
GetLastErrText Method 269
Name Method 270
Release Method 270
Business Service Methods 271
GetFirstProperty Method 271
GetNextProperty Method 273
GetProperty Method 275
InvokeMethod Method 275
Name Method 277
PropertyExists Method 277
Release Method 278
RemoveProperty Method 279
SetProperty Method 280
Business Service Events 281
Service_InvokeMethod Event 281
Service_PreCanInvokeMethod Event 283
Service_PreInvokeMethod Event 284
Control Methods 288
Applet Method 288

8 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Contents

BusComp Method 289

GetProperty Method 289
GetValue Method 290
Name Method 291
SetLabelProperty Method 291
SetProperty Method 293
SetValue Method 294
Property Set Methods 296
AddChild Method 297
Copy Method 298
GetByteValue Method 299
GetChild Method 300
GetChildCount Method 301
GetFirstProperty Method 302
GetLastErrCode Method 303
GetLastErrText Method 304
GetNextProperty Method 305
GetProperty Method 305
GetPropertyCount Method 306
GetType Method 307
GetValue Method 307
InsertChildAt Method 308
PropertyExists Method 309
RemoveChild Method 309
RemoveProperty Method 310
Reset Method 311
SetByteValue Method 311
SetProperty Method 312
SetType Method 313
SetValue Method 314
ToString Method 315
Miscellaneous Methods 315
GetErrorCode Method 315
GetErrorMessage Method 316
TheApplication Method 317

Chapter 5: Accessing Siebel COM Data Server with C++

Building the Siebel COM Client in C++ 319
Testing Your Program 325

Siebel Object Interfaces Reference Version 8.1 9

 For Oracle internal distribution only
Contents

Chapter 6: COM Data Control Quick Reference

Application Methods for COM Data Control 327
Business Component Methods for COM Data Control 330
Business Object Methods for COM Data Control 334
Business Service Methods for COM Data Control 334
Property Set Methods for COM Data Control 335

Chapter 7: COM Data Server Quick Reference

Application Methods for COM Data Server 339
Business Component Methods for COM Data Server 341
Business Object Methods for COM Data Server 346
Business Service Methods for COM Data Server 347
Property Set Methods for COM Data Server 348

Chapter 8: Mobile Web Client Automation Server Quick

Reference
Application Methods for Mobile Web Client Automation Server 351
Business Component Methods for Mobile Web Client Automation Server 354
Business Object Methods for Mobile Web Client Automation Server 358
Business Service Methods for Mobile Web Client Automation Server 359
Property Set Methods for Mobile Web Client Automation Server 360

Chapter 9: Java Data Bean Quick Reference

Data Bean Methods for Java Data Bean 363
Business Component Methods for Java Data Bean 365
Business Object Methods for Java Data Bean 369
Business Service Methods for Java Data Bean 369
Property Set Methods for Java Data Bean 370
SiebelException Methods for Java Data Bean 372

Chapter 10: Siebel Web Client Automation Server Quick

Reference
SiebelHTMLApplication Methods for Siebel Web Client Automation Server 373
SiebelService Methods for Siebel Web Client Automation Server 374

10 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Contents

Property Set Methods for Siebel Web Client Automation Server 375

Chapter 11: Siebel VB Quick Reference

Applet Methods for Siebel VB 377
WebApplet Events for Siebel VB 378
Application Methods for Siebel VB 379
Application Events for Siebel VB 382
Business Component Methods for Siebel VB 382
Business Component Events for Siebel VB 387
Business Object Methods for Siebel VB 389
Business Service Methods for Siebel VB 389
Business Service Events for Siebel VB 390
Property Set Methods for Siebel VB 391
Miscellaneous Methods for Siebel VB 393

Chapter 12: Browser Scripting

About Browser Script 395
Applet Methods for Browser Script 396
Applet Events for Browser Script 397
Application Methods for Browser Script 397
Application Events for Browser Script 398
Business Component Methods for Browser Script 399
Business Component Events for Browser Script 400
Business Object Methods for Browser Script 401
Business Service Methods for Browser Script 401
Business Service Events for Browser Script 402
Property Set Methods for Browser Script 403
Control Methods for Browser Script 404
Supported DOM Events for High Interactivity Mode 405
Supported DOM Events for Standard Interactivity Mode 407

Chapter 13: Siebel eScript Quick Reference

Applet Methods for eScript 409

Siebel Object Interfaces Reference Version 8.1 11

 For Oracle internal distribution only
Contents

WebApplet Events for eScript 410

Application Methods for eScript 411
Application Events for eScript 413
Business Component Methods for eScript 414
Business Component Events for eScript 418
Business Object Methods for eScript 420
Business Service Methods for eScript 420
Business Service Events for eScript 421
Property Set Methods for eScript 422
Miscellaneous Methods for eScript 423

Chapter 14: Invoking Custom Methods with MiniButton

Controls
Invoking Custom Methods with MiniButton Controls 425

Index

12 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

1 Whats New in This Release

Whats New in Siebel Object Interfaces Reference, Version 8.1

Table 1 lists changes in this version of the documentation to support release 8.1 of Oracles Siebel
software.

Table 1. Whats New in Siebel Object Interfaces Reference, Version 8.1

Topic Description

About the Siebel Script Profiler on The Siebel Script Profiler displays data for all the scripts
page 20 executed when an application is launched in Debug mode
from Siebel Tools, allowing developers to monitor and
improve script performance. For more information, see Using
Siebel Tools.

Accessing the Siebel Web Client You cannot invoke the Siebel Web Client Automation Server
Automation Server on page 40 directly from the active Siebel instance.

Instantiating the Java Data Bean Updated the connect string to include explicitly the port for
on page 48 the SCBroker component.

Java Data Bean and the The maximum possible value for both
siebel.properties File on page 49 siebel.conmgr.txtimeout and siebel.conmgr.sesstimeout in
the siebel.properties file is the largest positive integer,
2,147,483,647.

Connect String on page 71 Removed the http transport protocol, which is not valid for
connect strings.

Using Load Balancing with the When the COM Data Control operates in Server Mode in an
Connect String on page 73 environment that implements load balancing, the
VirtualServer parameter in the connect string must match the
VirtualServer parameter in the session manager rules in the
lbconfig.txt file.

Name Method on page 98 Changed the function name in the Browser Script example to
Applet_Load.

GetSharedGlobal Method on This method and the SetSharedGlobal method are not used
page 134 with the Java Data Bean. Use GetProfileAttr and SetProfileAttr
instead.

LoadUserAttributes Method on If the row ID argument is the row ID of the current user, the
page 144 user profile will be loaded into the Me profile.

SetProfileAttr Method on page 158 Added a note that system fields cannot be used with this
method.

Siebel Object Interfaces Reference Version 8.1 13

 For Oracle internal distribution only
Whats New in This Release

Table 1. Whats New in Siebel Object Interfaces Reference, Version 8.1

Topic Description

ExecuteQuery Method on Added a note that you must activate fields by using the
page 190 ActivateField method before executing a query for a business
component.

FirstRecord Method on page 192 Added a note that this method can cause extra SQL code to
be generated.

InvokeMethod Methods for the Added the ClearLOVCache method.

Business Component Object on
page 213

Service_PreInvokeMethod Event Added a note that Browser Script does not support output
on page 284 property sets with this event.

14 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

2 Siebel Programming Tools

This chapter describes the Siebel programming tools. It contains the following topics:

About the Siebel Programming Tools on page 15

Components of the Siebel Programming Environment on page 16

Supported Uses of Siebel Programming Languages on page 17

Adding New Business Logic to a Business Component on page 18

Tracing Scripts on page 18

About the Siebel Script Profiler on page 20

About the Siebel Compiler and Run-Time Engine on page 21

About Siebel VB on page 21

About Siebel eScript on page 24

About the Siebel Programming Tools

Oracles Siebel Business Applications include two programming languages. Siebel VB is a Visual
Basiclike programming environment that includes an editor, debugger, interpreter, and compiler.
Siebel VB runs on the Windows operating system only. Siebel eScript is, similarly, a JavaScript-like
programming environment, which uses the same tools that Siebel VB uses. Siebel eScript runs on
both Windows and UNIX operating systems. With these built-in languages, you can extend and
configure your Siebel application beyond the capabilities provided by declarative object property
definition.

The languages are integrated with other Siebel tools, such as the Applet Designer, Siebel CTI, and
Siebel SmartScript. Using this integration you can define object properties both with the designer
and by attaching scripts.

You should regard coding as a last resort. Siebel Tools provides many ways to configure your Siebel
application without coding, and these methods should be exhausted before you attempt to write your
own code, for three reasons:

Using Siebel Tools is easier than writing code.

More important, your code may not survive an upgrade. Customizations created directly in Siebel
Tools are upgraded automatically when you upgrade your Siebel application, but code is not
touched, and it may need to be reviewed following an upgrade.

Finally, declarative configuration through Siebel Tools results in better performance than
implementing the same functionality through code. For more information, see Siebel
Performance Tuning Guide.

Siebel Object Interfaces Reference Version 8.1 15

 For Oracle internal distribution only
Siebel Programming Tools Components of the Siebel Programming Environment

Components of the Siebel Programming

Environment
The individual components of the Siebel programming environment include:

Server Script:
Siebel VB language. A programming language that is syntactically and semantically
compatible with Microsoft Visual Basic. Because the language uses most of the same
commands and standards as Microsoft Visual Basic, you can extend your Siebel application
and reduce training costs.

Siebel eScript language. A programming language that is syntactically and semantically

compatible with Netscape JavaScript. In parallel with Siebel VB, the language uses most of
the same commands and standards as JavaScript, giving you the same advantages in an
alternative language. Moreover, you can use Siebel eScript on all Siebel-supported operating
systems. Siebel VB is supported on the Microsoft Windows operating system only.

Browser Script. A type of script (introduced in Siebel 7) that executes in and is interpreted by
the Browser. Browser Scripts are written in JavaScript and interact with the Document Object
Model (DOM) as well as with the Siebel Object Model available in the Browser through the
Browser Interaction Manager. A developer can script the behavior of Siebel events as well as the
Browser events that are exposed through the DOM. Be aware that the DOMs for Internet Explorer
and Netscape Navigator are different. Browser Script may only be used with applications which
run in high interactivity mode, except when scripting Control events supported by the Browser
Document Object Model.

Siebel Script Editor. An integrated editor used to create, view, edit, and save custom program
routines. The script editor has a code editing feature called Script Assist (introduced in version
7.8). Script Assist provides auto-complete, auto-indentation, method listing, and method
signature capabilities to help minimize errors as you develop script. For more information about
the Siebel Script Editor, including how to enable Script Assist, see Using Siebel Tools.

Siebel Debugger. Assists you in detecting errors contained within Siebel programming
language routines. It does not assist in detecting errors outside of the context of custom program
routines. The Siebel Debugger can be invoked automatically from Siebel applications when a run-
time error occurs if the Siebel application was invoked with the debug option, /H, on the
command startup line. The Debugger can also be invoked from the Debug toolbar and Debug
menu. The Debugger is described in more detail in Using Siebel Tools.

Compiler/Interpreter. A nonvisual component of the Siebel programming languages that

compiles and executes Siebel custom program routines. It is similar to Microsofts Visual Basic
Language Interpreter. Siebel language routines are compiled into p-code and stored with the
other object definitions in the SRF file.

Object Interfaces. A collection of selected objects that expose their data and functionality to
custom routines. The interface provides access to Siebel business objects with defined methods,
events, and associated data. The object interfaces are the subject of this book.

16 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel Programming Tools Supported Uses of Siebel Programming Languages

Supported Uses of Siebel Programming

Languages
The Siebel programming languages provide the ability to extend the behavior of the Siebel
application in specific ways. Supported extensions can be grouped into the following:

Business Logic Definition

Custom Behavior for User Interface Components on page 17

Business Logic Definition

The Siebel programming languages let you extend data validation beyond what is already provided
for in the standard Siebel application. The unique validation requirements of a business can be
satisfied by custom extension routines that implement the specific business rules prior to performing
record manipulation operations, such as record write or record delete.

Data validation routines can incorporate validations based on data from sources within or outside the
Siebel application. For example, a validation routine might verify that an opportunity revenue
amount is greater than zero if the probability of the opportunity is more than 20 percent using
internal Siebel data. Alternatively, an extension routine could verify the availability of a conference
room prior to inserting a new activity record by reading the information from another applications
database table.

The Siebel programming languages provide data manipulation capabilities that can be used to modify
data, such as updating, inserting, and deleting records. For example, a custom routine can be used
to set the value of one field based on the value of another before a new record is created. A custom
routine could thus be used to set the value of opportunity probability based on a stage in the sales
cycle, simplifying data entry.

The methods used to support data manipulation provide error notification. The Siebel programming
language is notified of the error and has access to information so you can handle the error and take
appropriate action.

Data manipulation methods in the Siebel programming languages conform to the same visibility rules
as the standard Siebel applications user interface. For example, if a business object is readable but
not editable because of visibility rules in the Siebel applications user interface, the same is true when
you are accessing the object through the Siebel languages. These languages cannot circumvent the
visibility rules or the security constraints enforced by the standard Siebel applications.

Custom Behavior for User Interface Components

With the Siebel Applet Layout Editor, you can add selected user interface objects to applets. With the
Siebel programming languages, you can associate behavior to the objects. An example of this feature
is placing a button on an applet which, when clicked, launches another program such as Microsoft
Excel.

Siebel Object Interfaces Reference Version 8.1 17

 For Oracle internal distribution only
Siebel Programming Tools Adding New Business Logic to a Business Component

With the Siebel programming languages, you can update a particular field based on the values of
other fields. An extension routine could enforce the business rule that states, If the sales cycle is
at or past the Quote Submitted stage, do not allow the Revenue field to be modified. The feature
can also be used to support the user-specific data maintenance rule by restricting updates to certain
fields based on the current users position.

Adding New Business Logic to a Business

Component
You use browser scripts and server scripts to add business logic to business components.

To add business logic to a business component

1 Start Siebel Tools.

2 Choose Repository > Check Out to lock the project from the server repository.

3 Select the business component using the Object Explorer and Object List Editor.

4 Right-click, and then choose Edit Browser Scripts or Edit Server Scripts.

The Script Editor appears.

5 Select the event from the Event List Tree applet, and then add your server scripts in the Script
Editor.

6 Validate the Siebel script syntax by choosing Debug > Check Syntax.

NOTE: The Check Syntax menu item is available for server scripts only.

7 Choose File > Save to save the changes.

8 Compile the modified business component by pressing F7.

9 Press F5 to run the modified application.

10 Choose Repository > Check In to check the modified project into the server repository.

Tracing Scripts
As part of debugging scripts you can run a trace on allocations, events, and SQL commands. The
tracing can be activated for specified user accounts, such as your development team. The Siebel
Server sends the tracing information to a log file.

For more information on configuring server components, see Siebel Applications Administration
Guide. For information on logging events, see Siebel System Monitoring and Diagnostics Guide.

To enable logging
1 Navigate to Server Configuration > Components.

2 Select a component to log. Not all components support logging, but the majority do.

18 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel Programming Tools Tracing Scripts

3 Click the Component Event Configuration tab.

4 Select the Object Manager Extension Language Log record. If this record does not exist, then the
selected component does not support logging.

5 Set the Log Level to 1. To disable logging when you are done, set the Log Level to 0 (zero).

6 Click the Component Parameters tab.

7 Optional. To display only the script tracing parameters, query for the following:

Parameter Alias = Trace*

Subsystem = Object Manager

Changes to the script tracing parameters can take effect immediately. If you want changes to
take effect now, then make changes to the values in the Current Value column. If you want the
changes to take effect only after a restart, then make changes to the values in the Value on
Restart column.

8 Set one or more tracing parameters from the following table.

Information to
Trace Parameter Alias Settings for Current Value and Value on Restart

Allocations TraceAlloc 0 (zero) to disable logging, 1 to enable logging

Events TraceEvents 0 (zero) to disable logging, 1 to enable logging

SQL Commands TraceSql 0 (zero) to disable logging, 1 to enable logging

Users TraceUser Comma-separated list of user names. Do not use

spaces (for example: sadmin,mmasters). The length
of this parameter is limited to 20 characters.

NOTE: Server-side tracing can have a significant

impact on performance. Use caution when making it
available for multiple users simultaneously.

The following is a sample trace:

2021 2003-04-09 15:37:20 2003-04-09 16:40:52 -0700 00000022 001 001f 0001 09 SCCObjMgr_enu 47126 1680 1584
C:\sea752\siebsrvr\log\SCCObjMgr_enu_47126.log 7.5.3 [16122] ENU

ObjMgrSessionInfoObjMgrLogin32003-04-09 15:37:20Login name : SADMIN

ObjMgrSessionInfoObjMgrAuth32003-04-09 15:37:20Authentication name : SADMIN

ObjMgrSessionInfoObjMgrLogin32003-04-09 15:37:20Session Type: Regular Session

GenericLogGenericError12003-04-09 15:37:20Invocation of Applet Menu New Service::NewExpense is not allowed.

GenericLogGenericError12003-04-09 15:37:20Invocation of Applet Menu New Service::NewTimeSheet is not

allowed.

ObjMgrExtLangLogObjMgrExtLangLog02003-04-09 15:38:27[User: SADMIN] EVENT, BEGIN, BusComp [Account],

BusComp_Query.

ObjMgrExtLangLogObjMgrExtLangLog02003-04-09 15:38:27[User: SADMIN] EVENT, END, BusComp [Account],

BusComp_Query.

Siebel Object Interfaces Reference Version 8.1 19

 For Oracle internal distribution only
Siebel Programming Tools About the Siebel Script Profiler

ObjMgrExtLangLogObjMgrExtLangLog02003-04-09 15:38:58[User: SADMIN] EVENT, BEGIN, BusComp [Account],

BusComp_NewRecord.

ObjMgrExtLangLogObjMgrExtLangLog02003-04-09 15:38:58[User: SADMIN] EVENT, END, BusComp [Account],

BusComp_NewRecord.

ObjMgrExtLangLogObjMgrExtLangLog02003-04-09 15:39:08[User: SADMIN] EVENT, BEGIN, BusComp [Account],

BusComp_PreSetFieldValue.

ObjMgrExtLangLogObjMgrExtLangLog02003-04-09 15:39:08[User: SADMIN] EVENT, END, BusComp [Account],

BusComp_PreSetFieldValue.

ObjMgrSessionInfoObjMgrLogin32003-04-09 16:40:52Username: SADMIN, Login Status: Attempt, Session Id:

!1.690.b816.3e94a0a0, IP Address: 172.20.94.66

Script tracing is not the same as file-based tracing. For more information on file-based tracing, read
Trace Method on page 165.

NOTE: You can also enable local object manager logging by setting the SIEBEL_LOG_EVENT
environment variable to a value from 2 to 5. For more information on setting environment variables,
see Siebel Applications Administration Guide.

About the Siebel Script Profiler

The Siebel Script Profiler gathers and displays data for all the scripts executed when an application
is launched in Debug mode from Siebel Tools.

The profiler data is displayed in a window in Siebel Tools (similar to the Watch window), and is
automatically updated whenever any script executes in the attached application.

The Script Profiler includes the following functionality:

Call tree view of script execution

Support for function profiling, as well as line profiling, of selected functions

Ability to use the Siebel Debugger and Script Profiler at the same time

Ability to see the compilation time caused by script execution alone

Using this data, developers can monitor the performance of their scripts, identify performance
bottlenecks, and compare profiling data with previous script executionsallowing them to improve
their scripts.

NOTE: The Script Profiler can only be used with the ST eScript Engine.

For more information on the Siebel Script Profiler, see Using Siebel Tools.

20 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel Programming Tools About the Siebel Compiler and Run-Time Engine

About the Siebel Compiler and Run-Time

Engine
To invoke the Siebel compiler and run-time engine, click the Compile button on the Debugger toolbar,
or press F7. You can also invoke it when compiling a project containing object definitions with
associated Siebel scripts. The Siebel compiler and run-time engine has no user interface of its own.
When the compiler is invoked, it compiles the custom routines and returns a message when
completed that indicates success or failure.

Compilation Order Considerations

The Siebel Compiler compiles Siebel VB functions and procedures in alphabetical order within an
object definition. If a function or procedure calls another function or procedure that has not been
defined, the compiler generates an error message in the form:

function_name Is An Unknown Function

To avoid this error, use the Declare statement to declare the function or procedure in the (general)
(declarations) section. For more information, read Siebel VB Language Reference.

Siebel eScript does not require forward declaration of functions.

ST eScript Engine
In version 7.8 and higher, the ST eScript engine is available. It is the default eScript scripting engine
in version 8.0. The new engine provides support for strongly typed objects (compliant with the
ECMAScript edition 4 specification). In addition, the new eScript engine provides other
enhancements, such as late and early binding. For information about the differences between the ST
eScript engine and the T engine, see Siebel eScript Language Reference. For information on using
the ST engine, see Using Siebel Tools.

About Siebel VB
If you have never programmed in Visual Basic before, you may want to start by reading Siebel VB
Language Reference. It includes information on the internal VB program constructs, statements, and
functions. You need to understand how these objects behave before you can program using the
Siebel object methods and events.

Declare your variables. As a general rule, using the Option Explicit statement is helpful as it forces
you to declare your variables (using the Dim statement) before you use them. Doing so makes it
easier for others to understand your code, and for you to debug the code. You can declare a variable
without giving it a data type, but if you do not specify a data type, Siebel VB assumes the type
Variant, which requires 16 bytestwice as much memory as the next smallest data type. If you can
avoid Variant variables, you reduce the amount of memory required by your code, which may make
execution faster. In Siebel VB, you place Option commands in the (general) (declarations) window.

Siebel Object Interfaces Reference Version 8.1 21

 For Oracle internal distribution only
Siebel Programming Tools About Siebel VB

Use standardized naming conventions. Another way to improve the readability of your code is
to follow a set of standardized naming conventions. It does not really matter what conventions you
follow as long as everyone in the programming group follows the same conventions. One very
common convention is to prefix each variable with a letter denoting its type, as shown in Table 2.

Table 2. Naming Conventions for Variables in Scripts

Data Type Symbol Example

String s sName

Integer i iReturn

Long integer l lBigCount

Single-precision number si siAllowance

Double-precision number d dBudget

Object o oBusComp

Currency c cAmtOwed

You can also use suffix characters on your variable names.

Use the Me object reference. The special object reference Me is a VB shorthand for the current
object. You should use it in place of references to active business objects. For example, in a business
component event handler, you should use Me in place of ActiveBusComp, as shown in the following
example:

Function BusComp_PreSetFieldValue(FieldName As String, FieldValue As String) As

Integer

If Val(Me.GetFieldValue("Rep %")) >75 Then

TheApplication.RaiseErrorText("You can set the Rep% to greater than 75")
End If
BusComp_PreSetFieldValue = ContinueOperation

End Function

You can see other examples of Me in ParentBusComp Method on page 224, SetViewMode Method
on page 245, BusComp_PreQuery Event on page 260, BusComp_PreWriteRecord Event on page 263,
and ActiveMode Method on page 92.

Trap run-time errors. The standard VB methods return numeric error codes, which are documented
in Siebel VB Language Reference. Siebel VB methods also may return error codes; however, they
must be handled differently from those returned by the standard VB methods. For standard methods,
you can use some combination of Err, ErrText, and Error. Siebel methods use numeric error codes in
the range from 4000 to 4999. When you access Siebel object interfaces through COM or ActiveX, use
a construct of this form to see the text of the error message.

If errCode <> 0 Then

ErrText = GetLastErrText
TheApplication.RaiseErrorText ErrText

22 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel Programming Tools About Siebel VB

Exit Sub
End If

NOTE: The GetLastErrText method is only available using interfaces external to Siebel Tools.
Therefore, you can use it in Microsoft VB, but not in Siebel VB.

If you are working within the Siebel applications, especially in a LAN environment, where you cannot
be sure that a record has not been changed or deleted by another user, create routines that keep
the program from failing when it meets an unexpected condition. For information about error-
handling routines, see the Language Overview topics in Siebel VB Language Reference.

Make effective use of the Select Case construct. The Select Case construct chooses among any
number of alternatives you require, based on the value of a single variable. This is greatly preferable
to a series of nested If statements, because it simplifies code maintenance and also improves
performance because the variable must be evaluated only once.

Use the With shortcut. Use the With statement to apply several methods to a single object. It
reduces typing and makes the code easier to read. Instead of a series of statements such as:

set oBusObject = TheApplication.GetBusObject("Opportunity");

set oBusComp = oBusObject.GetBusComp("Opportunity")
oBusComp.ActivateField "Account"
oBusComp.ClearToQuery
oBusComp.SetSearchSpec Name, varname
oBusComp.ExecuteQuery ForwardBackward
If (oBusComp.FirstRecord = 1) then
sAccount = oBusComp.GetFieldValue "Account"
End if
. . .

use the following:

set oBusObject = TheApplication.GetBusObject("Opportunity");

set oBusComp = oBusObject.GetBusComp("Opportunity")
With oBusComp
.ActivateField Account
.ClearToQuery
.SetSearchSpec Name, varname
.ExecuteQuery ForwardBackward
If (.FirstRecord = 1) then
sAccount = .GetFieldValue "Account"
End if
End With
. . .

Use extreme care when working with date variables. When working with date variables
extreme care has to be taken regarding the date format. GetFieldValue always returns the date in
dd/mm/yyyy format (eventually followed by the time). As a result, applying the CVDate() function,
which expects the regional setting, to the return value may cause an error. The
GetFormattedFieldValue method uses the regional settings of the users operating system. The
regional setting specifies the year with two digits in most cases, thereby creating the possibility of
Y2K noncompliance. For these reasons, you should use the following approach for performing date
arithmetic.

Siebel Object Interfaces Reference Version 8.1 23

 For Oracle internal distribution only
Siebel Programming Tools About Siebel eScript

To perform date arithmetic

1 Retrieve the value of date fields with the GetFieldValue method. For more information, read
GetFieldValue Method on page 197.

2 Convert it into a date variable using the DateSerial() function.

3 Perform the required date arithmetic.

The following example is in Siebel VB:

Dim strDate as String, varDate as Variant

strDate = oBC.GetFieldValue("Date Field")
varDate =DateSerial(Val(Mid(strDate,7,4)),Val(Left(strDate,2)),_
Val(Mid(strDate,4,2)))
[any date arithmetic]

Destroy any objects you have created when you no longer need them. While the interpreter
takes care of object cleanup, it is a best practice to write code that explicitly destroys objects when
they are no longer used. Explicit destruction of Siebel objects should occur in the procedure in which
they are created.

To destroy objects in Siebel VB, set each object to Nothing in the reverse order of creation. Destroy
child objects before parent objects. For example:

Set oBusObj = TheApplication.GetBusObject(contact)

Set oBusComp= oBusObj.GetBusComp(contact)

[ Your code here ]

Set oBusComp = Nothing

Set oBusObj = Nothing

About Siebel eScript

There are some important differences between Siebel eScript and Siebel VB:

Siebel eScript is case-sensitive; theApplication is different from TheApplication. Siebel VB is not

case-sensitive.

Siebel eScript does not distinguish between subroutines (which take no arguments) and
functions (which take arguments). In Siebel eScript, every method is a function, whether or not
it accepts arguments; therefore, it should be followed by a pair of parentheses.

Keep these differences in mind when you read the syntax diagrams. In many instances, the only
difference between the VB syntax and the eScript syntax is that the eScript syntax requires the pair
of parentheses at the end. In these instances, only the VB syntax is shown; you can derive the
eScript syntax by adding the parentheses.

There are also some important differences between Siebel eScript and standard ECMAscript. Most
important, Siebel eScript has no user interface functions. It cannot, therefore, be used to animate
or control Web pages. Second, it contains two objects that are not part of standard ECMAscript: SELib
and Clib. These objects implement a variety of C-like functions for interacting with the operating and
file systems, and for file I/O. For details on these and other eScript functions not covered here, see
Siebel eScript Language Reference.

24 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel Programming Tools About Siebel eScript

Declare your variables. Standard ECMAscript does not require that you declare variables. Variables
are declared implicitly as soon as they are used. As a general rule, you should declare the variables
used in a module before you use them. Doing so makes it easier for others to understand your code,
and for you to debug the code.

Use standardized naming conventions. Another way to improve the readability of your code is
to follow a set of standardized naming conventions. It does not really matter what conventions you
follow as long as everyone in the programming group follows the same conventions. One very
common convention is to prefix each variable with a letter denoting its type, as shown in Table 2 on
page 22.

Use the this object reference. The special object reference this is eScript shorthand for the
current object. You should use it in place of references to active business objects and components.
For example, in a business component event handler, you should use this in place of ActiveBusComp,
as shown in the following example:

if (condition)
{ ...
this.SetSearchSpec(...);
this.ExecuteQuery
return (CancelOperation)
}
else
return(ContinueOperation);

Use the with shortcut. The with shortcut applies several methods to a single object. It reduces
typing and makes the code easier to read. Instead of a series of statements such as:

var oBusObject = TheApplication().GetBusObject("Opportunity");

var oBusComp = oBusObject.GetBusComp("Opportunity");
oBusComp.ActivateField("Account");
oBusComp.ClearToQuery();
oBusComp.SetSearchSpec("Name", varname);
oBusComp.ExecuteQuery(ForwardBackward);
if oBusComp.FirstRecord();
{
var sAccount = oBusComp.GetFieldValue("Account");
}
. . .

use the following:

var oBusObject = TheApplication().GetBusObject("Opportunity");

var oBusComp = oBusObject.GetBusComp("Opportunity");
with (oBusComp)
{
ActivateField("Account");
ClearToQuery();
SetSearchSpec("Name", varname);
ExecuteQuery(ForwardBackward);
if (FirstRecord())
{

Siebel Object Interfaces Reference Version 8.1 25

 For Oracle internal distribution only
Siebel Programming Tools About Siebel eScript

var sAccount = GetFieldValue( "Account");

}
} //end with

Make effective use of the Switch construct. Use the Switch construct to choose among any
number of alternatives you require, based on the value of a single variable. This is greatly preferable
to a series of nested If statements because it simplifies code maintenance. It also improves
performance because the variable must be evaluated only once.

switch (FieldName)
{
case "Status":
{
var sysdate = new Date();
var sysdatestring = ((sysdate.getMonth() + 1) + "/" + sysdate.getDate() +
"/" + sysdate.getFullYear()+ " "+ sysdate.getHours() + ":" +
sysdate.getMinutes()+":" + sysdate.getSeconds());
this.SetFieldValue("Sales Stage Date",sysdatestring);
if ((FieldValue) == "Not Attempted")
{
if (this.GetFieldValue("Primary Revenue Amount") > 0)
this.SetFieldValue("Primary Revenue Amount",0);
}
break;
}
case "Revenue":
{
if (newrecSw =="Y")
{
newrecSw = "";
this.SetFieldValue("Account Revenue",(FieldValue));
}
break;
}
}

Destroy any objects you have created when you no longer need them. While the interpreter
takes care of object cleanup, it is a best practice to write code that explicitly destroys objects when
they are no longer used. Explicit destruction of Siebel objects should occur in the procedure in which
they are created.

To destroy objects in Siebel eScript, set each object to null in the reverse order of creation. Destroy
child objects before parent objects. For example:

var oBusObject = TheApplication().GetBusObject(Contact)

var oBusComp = oBusObject.GetBusComp(Contact)

[ Your code here ]

oBusComp = null;
oBusObject = null;

26 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

3 Programming

This chapter provides information about installing and using Siebel object interfaces:

About Programming with Siebel Object Interfaces on page 27

About Siebel Object Interfaces on page 28

Installing Siebel Object Interfaces on page 33

Exposed Object Types on page 34

Siebel Object Interface Method Syntax on page 37

Getting Started with the Siebel Object Interfaces on page 39

Siebel Object Interface Methods on page 53

Variable Scoping for Siebel Script Variables on page 61

Siebel Object Interface Events and Siebel Extension Events on page 63

About Programming with Siebel Object

Interfaces
Siebel object interfaces provide open interfaces into the Siebel applications, supporting integration
between Siebel applications and external applications.

Siebel object interface definitions are based on Siebel business objects and declarative object
definitions that can be configured and automatically upgraded to successive releases using Siebel
Tools.

Siebel object interfaces are available to developers through the following technologies:

Built-in scripting of Siebel objects using Siebel VB, Siebel eScript, and Browser Script

Component Object Model (COM) using the Siebel Web Client Automation Server, Siebel COM Data
Control, Siebel COM Data Server, and Siebel Mobile Web Client Automation Server

Java using Siebel Java Data Bean

Siebel developers can integrate client and server applications from a variety of vendors. Application
integration typically requires that cooperative software application programs interactively pass data
back and forth. In addition, application integration sometimes requires that one application
controls or automates another application.

Siebel Object Interfaces Reference Version 8.1 27

 For Oracle internal distribution only
Programming About Siebel Object Interfaces

The Siebel object interfaces are a collection of methods on Siebel objects that expose their data and
functions to custom routines written in Server Script, and also to other languages external to the
Siebel application. The interfaces provide access to Siebel business objects with defined methods,
events, and data.

CAUTION: Your Siebel application is a Web-based or client/server application designed to meet the
sales and marketing information requirements of large multinational corporations. Use caution when
extending the Siebel applications or accessing them through the interface described here, as this
should be done only by trained technical professionals. Improper application configuration or use of
these interfaces can cause your configured Siebel application to be less reliable, or to perform poorly.
Always test your configured application thoroughly before production rollout.

Oracle does not support the following:

Functions developed through custom programming

Custom-developed applications

Specific performance characteristics of other vendors software

In addition, Siebel business objects, the Siebel object interfaces, and their associated behavior and
properties are defined at the sole discretion of Oracle. Oracle reserves the right to change the
behavior, properties, and events at any time without notice.

This chapter describes the interface environments and object types. Chapter 4, Interfaces Reference
describes the supported methods of the Siebel object interfaces and provides examples of how you
can use them.

About Siebel Object Interfaces

Siebel object interfaces include:

Siebel COM Interfaces on page 28

Siebel Java Interfaces on page 32

Built-in scripting of Siebel objects using Siebel VB, Siebel eScript, and Browser Script. For more
information, read Built-In Scripting on page 32.

Related Topic
Usage Evaluation Matrix on page 33

Siebel COM Interfaces

Siebel COM object interfaces can be accessed in four ways: COM Data Control, COM Data Server,
Siebel Web Client Automation Server, and Siebel Mobile Web Client Automation Server.

28 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming About Siebel Object Interfaces

The supported languages for accessing Siebel COM interfaces are JavaScript, Visual Basic, and C++.
The Perl language is not supported with Siebel COM interfaces.

NOTE: The programming environment you use may impose limitations on the functionality of COM
servers. For example, code using the Data Server written in VB should not be implemented as a
Windows NT service.

COM Data Control

The Siebel COM Data Control interfaces allow external applications to access Siebel business objects
remotely.

To develop an application using the Siebel COM Data Control, you must have a Siebel Application
Object Manager set up and running on a Siebel Server. Refer to Siebel System Administration Guide
for information about installing and configuring the Siebel Object Manager.

Any external application or component that uses Siebel COM Data Control connects and
communicates with Siebel Application Object Manager using the SISNAPI protocol. The Siebel
Application Object Manager, which could be running on a remote Siebel Server, is a multithreaded,
multiprocess application server that hosts Siebel business objects and supports session-based
connections by clients. Figure 1 shows how external applications use Siebel COM Data Control to
communicate with the Siebel application.

Figure 1. Siebel COM Data Control

Siebel Object Interfaces Reference Version 8.1 29

 For Oracle internal distribution only
Programming About Siebel Object Interfaces

COM Data Server

Figure 2 shows how external applications use Siebel COM Data Server without having to access the
user interface objects. COM Data Server uses the same mechanism as the Mobile Web Client to
connect to the server database.

Figure 2. Siebel COM Data Server

You can expect differences in performance between Siebel COM Data Server and Siebel Mobile Web
Client Automation Server. This is due in part to the fact that COM Data Server is a DLL running in
the same address space as the calling program, while Automation Server is an executable that runs
in its own address space. DLLs that are accessed by a server task must be thread safe.

Siebel Web Client Automation Server

The Web Client Automation Server is implemented as a small COM object resident within the Web
browser (IE 5.0 or greater). The Web Client Automation Server is supported with the High Interactive
client only. When accessing the Web Client Automation Server, Siebel Web Client must be running.

To enable the Web Client Automation Server, make sure that the EnableWebClientAutomation
parameter is set to TRUE in the [SWE] section of the applications configuration file. With this
parameter set to TRUE, a small ActiveX Control downloads to the desktop and the
SiebelHTMLApplication process starts.

In the Windows Task Manager, this process is named one of the following:

siebelhtml.exe

siebelhtmlapplication.exe

SIEBEL~1.EXE

30 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming About Siebel Object Interfaces

This process terminates when the Siebel Web Client is gracefully terminated. You may need to modify
the ActiveX controls and plug-ins security settings in the Browser to use the Web Client Automation
Server.

Figure 3 shows how external applications can invoke business services and manipulate property sets
in the Siebel Web Client Automation Server.

Figure 3. Siebel Web Client Automation Server

Siebel Mobile Web Client Automation Server

When accessing the Mobile Web Client Automation Server, Siebel Mobile Web Client must be running.
Figure 4 shows how the Siebel Mobile Web Client Automation Server is used by external applications
to control the Siebel application.

Figure 4. Siebel Mobile Web Client Automation Server

Siebel Object Interfaces Reference Version 8.1 31

 For Oracle internal distribution only
Programming About Siebel Object Interfaces

Siebel Java Interfaces

The Siebel Java Data Bean allows external applications to access Siebel objects without having to
display the Siebel user interface. These objects are made available through the Siebel Java Data
Bean, which can be used by an external application, component, or Java applet. The Java Data Bean
provides functional access to the Siebel applications for both reading and writing data. The set of
interfaces exposed through this interface is similar to that exposed by the Siebel COM Data Control.

Any external application that uses the Siebel Java Data Bean connects and communicates with a
Siebel Application Object Manager using the SISNAPI protocol. The Siebel Application Object
Manager, which could be running on a remote Siebel Server, is a multithreaded, multiprocess
application server that hosts Siebel objects and supports session-based connections by clients. The
Siebel Application Object Manager specified in the connect string must be running on the specified
Siebel Server.

Using the Siebel Java Data Bean with Multiple Threads

Multiple threads of a single process should not access a common instance of the Java Data Bean. If
a process with multiple threads wants to use the Data Bean, each thread must create its own instance
of it.

For the same reasons, you should not reuse instances of any other objects exposed by the Java Data
Bean (SiebelBusObject, SiebelBusComp, SiebelService, and SiebelPropertySet) across multiple
threads of the same process.

CAUTION: You should create one instance of the Siebel Java Data Bean for each thread that wishes
to use it. Data Bean Objects obtained by one thread should not be shared among multiple threads.

Built-In Scripting
You can access Siebel methods and events from within the Siebel application through Siebel VB or
Siebel eScript. Both languages are procedural programming languages for writing custom extensions
that access and control Siebel objects through the Siebel object interfaces.

32 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Installing Siebel Object Interfaces

Usage Evaluation Matrix

Use Table 3 to determine which types of Siebel object interfaces to use.

NOTE: Throughout this guide, X in a table denotes that an object interface type can be used with a
specified method or object type, or for a specified purpose.

Table 3. Usage Evaluation

Mobile Web
Web Client Client Siebel Siebel
Automation Automation COM Data COM Data Siebel Java
Usage Server Server Control Server Data Bean

Control Siebel user X X

interface from your
external application

Access Siebel business X X X

objects without Siebel
user interface

Objects execute on a X X X
Siebel Server

Execute on the client X X

side in mobile
environments

Installing Siebel Object Interfaces

Table 4 lists the installation procedure for each object interface.

Table 4. Interface Installation

Interface Installation
Java Data Bean Installed by the Siebel Enterprise Server Installer under a
Typical installation, with the EAI Siebel Connectors option.
Also installed by default with Siebel Tools.

For more information on the EAI Siebel Connectors option,

see the Siebel Installation Guide for the operating system
you are using.

COM Data Control Installed by the Siebel Enterprise Server Installer under a
Typical installation, with the EAI Siebel Connectors option.

For more information on the EAI Siebel Connectors option,

see the Siebel Installation Guide for the operating system
you are using.

COM Data Server Installed by default with the Mobile Web Client.

Siebel Object Interfaces Reference Version 8.1 33

 For Oracle internal distribution only
Programming Exposed Object Types

Table 4. Interface Installation

Interface Installation

Siebel Mobile Web Client Installed by default with the Siebel Mobile Web Client.
Automation Server

Siebel Web Client Automation Installed by default with the Siebel Mobile Web Client. Also
Server installed by default with the Siebel Enterprise Server
Installer.

Exposed Object Types

Siebel object interfaces provide access to Siebel business objects. See the following sections for a
discussion of each exposed object type:

Application Object Type on page 34

Business Object Object Type on page 34

Business Component Object Type on page 35

Business Service Object Type on page 35

Applet Object Type on page 36

Property Set Object Type on page 36

User Interface Control Object Type on page 36

There are additional object types used in Siebel Business Applications, including specialized types
derived from the base object types. However, object types not specifically discussed here are not
exposed in the Siebel object interfaces and references to them may not be passed to external DLLs,
such as a Microsoft Visual Basic COM DLL.

NOTE: Interfaces may be subject to change.

Application Object Type

The application object represents the Siebel application that is currently active and is an instance of
the Application object type. An application object is created when a user session starts. This object
contains the properties and events that interact with Siebel software as a whole. An instance of a
Siebel application always has exactly one application object.

Business Object Object Type

Business objects are customizable, object-oriented building blocks of Siebel applications. Business
objects define the relationships between different business component objects (BusComps) and
contain semantic information about, for example, sales, marketing, and service-related entities.

34 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Exposed Object Types

A Siebel business object groups one or more business components into a logical unit of information.
Examples of Siebel business objects include Opportunity, Quote, Campaign, and Forecast. An
opportunity business object may consist of opportunity, contact, and product business components.
The opportunity business component dictates the information of the other business components in
a parent-child relationship.

Business Component Object Type

A business component defines the structure, the behavior, and the information displayed by a
particular subject such as a product, contact, or account. Siebel business components are logical
abstractions of one or more database tables. The information stored in a business component is
usually specific to a particular subject and is typically not dependent on other business components.
Business components can be used in one or more business objects.

Business component objects have associated data structured as records, they have properties, and
they contain data units called fields. In the object interfaces, fields are accessed through business
components. The business component object supports getting and setting field values, moving
backward and forward through data in a business component object, and filtering changes to data it
manages. This object type is available to every interface.

Business Service Object Type

Business service objects are objects that can be used to implement reusable business logic within
the Object Manager. They include:

Built-in business services, which are defined in Siebel Tools and stored in the repository.

Run-time business services, which are defined in the run-time client and stored in the application
database.

There are two types of built-in business services:

Standard, which are based on the class CSSService and can be scripted or modified.

Specialized, which are based on specialized C++ classes. Those specialized services whose
behavior has been documented can be scripted.

Using business services, you can configure stand-alone objects or modules with both properties
and scripts (written in VB or eScript). Business services may be used for generic code libraries that
can be called from any other scripts.

Built-in services cannot be modified at run time, and they cannot be overridden by run-time scripts.

User-created services can be created by adding a new record to the Business Service list applet in
Siebel Tools. They can also be defined by administrators at run time by using views in the Siebel
client. They can have whatever properties are needed to accomplish a particular task. They can be
called either from scripts or from object interfaces.

NOTE: To invoke a business service using the Web Client Automation Server and Browser Script, the
business service must first be registered in Siebel Tools as an application user property. This prevents
Service Not Found errors. For more information, see GetService Method on page 131.

Siebel Object Interfaces Reference Version 8.1 35

 For Oracle internal distribution only
Programming Exposed Object Types

Because they are reusable and can be set to persist throughout a session, business service objects
can be used to simulate global procedures.

Applet Object Type

Because applet objects are part of the user interface, they are not accessible when using the Siebel
object interfaces through the Siebel COM Data Server, Siebel COM Data Control, Siebel Web Client
Automation Server, Siebel Mobile Web Client Automation Server, or Siebel Java Data Bean.

An applet object represents an applet that is rendered by the Siebel Web Engine. It exists only as a
scriptable object, and is accessed by using the Edit Server Scripts or Edit Browser Scripts command
on the selected applet. Applet objects are accessible through Siebel VB and Siebel eScript in Server
Scripts, and through Browser JavaScript in Browser Scripts. Some Applet Events, such as
WebApplet_ShowControl and WebApplet_ShowListColumn, do not execute if the client is running in
high interactivity mode.

To add a Browser or Server script to an applet in Siebel Tools

1 In the Explorer window, choose the Applet object type.

2 In the right pane, locate the object to which you want to add a script.

3 Make sure that the project containing the applet is locked.

4 Right-click the item and select Edit Server Scripts or Edit Browser Scripts.

Property Set Object Type

Property set objects are collections of properties, which can be used for storing data. They may have
child property sets assigned to them to form a hierarchical data structure. Property sets are used
primarily for inputs and outputs to business services.

User Interface Control Object Type

A user interface control object, or a control, is a visual object with which the user can directly
interact, such as a button or text box. Control objects have properties that can be accessed by Siebel
Browser Script. Because control objects are part of the user interface, they are not accessible
through the Siebel COM Data Server, Siebel COM Data Control, Mobile Web Client Automation Server,
Web Client Automation Server, or Siebel Java Data Bean.

Controls are the visible building blocks of applets. Each control is unique and exists only in a single
applet. Only controls on the active (currently visible) applet are available to Siebel Browser Script.
Each control has a unique name within its containing applet, but control names need not be unique
across applets.

The control object supports getting and setting values and customized behavior when used in
conjunction with Siebel Browser Script.

36 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Method Syntax

Summary of Exposed Object Types

Table 5 summarizes the names and types of objects exposed.

Table 5. Exposed Object Types for Each Siebel Object Interface

Siebel
Siebel Web Mobile Web Siebel Siebel Siebel
Client Client COM COM Java
Object Server Browser Automation Automation Data Data Data
Type Script Script Server Server Control Server Bean

Applet X X

Application X X X X X X X

Business X X X X X X
Component

Business X X X X X X
Object

Business X X X X X X X
Service

Property Set X X X X X X X

Control X

Siebel Object Interface Method Syntax

The following conventions are used in this guide to describe methods, arguments, and return values:

Syntax
ObjectType.MethodName(arg1[, arg2, , argn])

Argument Description

arg1 Description of arg1

arg2 Description of arg2

. .

. .

argn Description of argn

Returns
Description of the value returned by the method, if any.

The following conventions are used in the syntax diagram:

Siebel Object Interfaces Reference Version 8.1 37

 For Oracle internal distribution only
Programming Siebel Object Interface Method Syntax

ObjectType is the object type, for example BusComp (business component), for which the
method is defined.

MethodName is the name of the method that is being invoked. A method can be a subroutine
that does not return a value, such as SetViewMode, or a function that returns a value, such as
GetFieldValue.

arg1, arg2 can be a string, constant, integer, or object. If a method returns a value, the
arguments must be enclosed in parentheses in Siebel VB. In Siebel eScript, enclose arguments
in parentheses, even if they do not return a value.

Brackets [ ] indicate an optional argument. In the description of the argument, the default value
for the optional argument is indicated.

If a method does not return a value or if you are using it in a manner that does not return a value,
then the arguments should not be enclosed in parentheses in Siebel VB.

When using COM Data Server, an additional argument, errCode, is always required as the last
argument.

Usage Syntax
The usage syntax for a method may differ between Server Script and COM, as described in the text
that follows. The description uses the following terms in addition to the ones defined previously:

ObjectReference is a variable name of type ObjectType that points to the object on which the
method is invoked.

NOTE: You do not need to explicitly specify an ObjectReference when you invoke a method on
an object inside its event handler.

returnValue is the value, if any, that is returned by the method. Some methods, such as
GetBusComp, return an object of the type business component. Other methods return strings or
integers.

Siebel VB
If there is a return value:

returnValue = ObjectReference.MethodName(arg1, arg2, ..., argn)

If there are no arguments:

returnValue = ObjectReference.MethodName

If there is no return value:

ObjectReference.MethodName arg1, arg2, ..., argn

Examples
acctName = acctBC.GetFieldValue("Name")

acctBC.SetViewMode AllView

38 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

Siebel eScript
If there is a return value:

returnValue = ObjectReference.MethodName(arg1, arg2, ..., argn);

If there are no arguments:

returnValue = ObjectReference.MethodName();

If there is no return value:

ObjectReference.MethodName(arg1, arg2, ..., argn);

Examples
acctName = acctBC.GetFieldValue("Name");

acctBC.SetViewMode(AllView);

Using parentheses ( ) when none are required, or failing to use them when they are required,
generates a Type Mismatch (error code 13) message. Another cause of this error code is using an
incorrect quantity of arguments.

COM
The usage depends on the language being used to call the COM Interfaces. For Microsoft Visual Basic
and equivalent languages, the usage is similar to that of Siebel VB, except that an error code is
passed as the final argument in the case of the COM Data Control.

Getting Started with the Siebel Object

Interfaces
The following sections contain directions for connecting to the COM Servers or COM Controls:

Accessing Siebel COM Interfaces on page 40

Accessing the Siebel Web Client Automation Server on page 40

Accessing the Siebel Mobile Web Client Automation Server on page 42

Instantiating the Siebel COM Data Server on page 44

Instantiating the Siebel COM Data Control on page 46

About Java Data Bean on page 48

Siebel Object Interfaces Reference Version 8.1 39

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

Accessing Siebel COM Interfaces

To use the Siebel COM interfaces, you must set the EnableOLEAutomation flag in the CFG file to
TRUE. For Siebel Interface methods through COM, use the object browser of your COM programming
tool to determine the correct method syntax. Figure 5 displays an example of an object browser in
Microsoft Visual Basic 5.0.

Syntax window

Figure 5. Determining Correct COM Syntax in Microsoft Visual Basic

Accessing the Siebel Web Client Automation Server

The Web Client Automation Server allows external applications to invoke business services and
manipulate property sets. The Web Client Automation Server is implemented as a small COM object
resident within the Web browser (IE 5.0 or greater). The Web Client Automation Server can be used
with the Web client and the Mobile Web Client. The Web Client Automation Server is supported with
the high interactivity mode only.

NOTE: You cannot invoke the Siebel Web Client Automation Server directly from the active Siebel
instance. Trying to do so will cause an error.

To set up Microsoft Visual Basic to access the Siebel Web Client Automation Server
1 Start Microsoft Visual Basic.

2 Select Standard EXE.

40 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

3 Choose Project > References.

4 In the list box, highlight and check the SiebelHTML 1.0 Type Library.

The following example shows how to use Microsoft Visual Basic 6.0 with the Siebel Web Client
Automation Server:

Private Sub Command1_Click()

'Siebel Application Object
Dim siebApp As SiebelHTMLApplication
Dim siebSvcs As SiebelService
Dim siebPropSet As SiebelPropertySet
Dim bool As Boolean
Dim errCode As Integer
Dim errText As String
Dim connStr As String
Dim lng As String
'Create The SiebelHTML Object
Set siebApp = CreateObject("Siebel.Desktop_Integration_Application.1")

If Not siebApp Is Nothing Then

'Create A New Property Set

Set siebPropSet = siebApp.NewPropertySet
If Not siebPropSet Is Nothing Then
Set siebPropSet = Nothing
Else
errCode = siebApp.GetLastErrCode
errText = siebApp.GetLastErrText
TheApplication().RaiseErrorText("Property Set Creation failed: " & errCode &
"::" & errText)
End If

'Get A Siebel Service

Set siebSvcs = siebApp.GetService("Workflow Process Manager")
If Not siebSvcs Is Nothing Then
Set siebSvcs = Nothing
Else
errCode = siebApp.GetLastErrCode
errText = siebApp.GetLastErrText
TheApplication().RaiseErrorText("Could not Get Siebel Service: " & errCode &
"::" & errText)
End If

Set siebApp = Nothing

End If
End Sub

Siebel Object Interfaces Reference Version 8.1 41

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

Accessing the Siebel Mobile Web Client Automation

Server
The Siebel Mobile Web Client Automation Server accesses the server object instantiated by the Siebel
Business Application. When you have this object, you can obtain other Siebel objects and execute
Siebel object interface methods through those objects. Calls made to the Siebel Mobile Web Client
Automation Server are out of process. If you create a DLL that is run in process with the Siebel
application, the calls made from the DLL to the Siebel Mobile Web Client Automation Server are still
out of process.

The mechanism for instantiating COM servers depends on the programming tool or language being
used.

If you use Microsoft Visual Basic 5.0 or later, the required support file must be in the same directory
as the CFG file you are using for your Siebel application, or the Mobile Web Client Automation Server
does not work. Take the following steps to make sure that you are referring to the correct library.

To set up Microsoft Visual Basic to access the Siebel Mobile Web Client Automation
Server
1 Start Microsoft Visual Basic.

2 Select Standard EXE.

3 Choose Project > References.

4 In the list box, highlight (check) Siebel Mobile Web Client Automation Server. Near the bottom
of the dialog box, note the directory in which the file Siebel.exe resides.

The following examples show how to use Microsoft Visual Basic 6.0 to interface with Siebel Mobile
Web Client Automation Server.

The following is sample code for the Siebel Mobile Web Client Automation Server:

Private Sub Command1_Click()

'Siebel Application Object
Dim siebApp As SiebelWebApplication
Dim siebBusObj As SiebelBusObject
Dim siebBusComp As SiebelBusComp
Dim siebSvcs As SiebelService
Dim siebPropSet As SiebelPropertySet
Dim bool As Boolean
Dim errCode As Integer
Dim errText As String
Dim connStr As String
Dim lng As String
'Create The Siebel WebApplication Object
Set siebWebApp = CreateObject("TWSiebel.SiebelWebApplication.1")

If Not siebWebApp Is Nothing Then

'Create A Business Object

Set siebBusObj = siebWebApp.GetBusObject("Contact")

42 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

If Not siebBusObj Is Nothing Then

'Create a Business Component
Set siebBusComp = siebBusObj.GetBusComp("Contact")

Else
errCode = siebWebApp.GetLastErrCode
errText = siebWebApp.GetLastErrText
TheApplication().RaiseErrorText("Business Object Creation failed: " & errCode &
"::" & errText);

End If

'Create A New Property Set

Set siebPropSet = siebWebApp.NewPropertySet
If Not siebPropSet Is Nothing Then
Set siebPropSet = Nothing

Else

errCode = siebWebApp.GetLastErrCode
errText = siebWebApp.GetLastErrText
TheApplication().RaiseErrorText("Property Set Creation failed: " & errCode &
"::" & errText);
End If

'Get A Siebel Service

Set siebSvcs = siebWebApp.GetService("Workflow Process Manager")
If Not siebSvcs Is Nothing Then
Set siebSvcs = Nothing
Else
errCode = siebWebApp.GetLastErrCode
errText = siebWebApp.GetLastErrText
TheApplication().RaiseErrorText("Could not Get Siebel Service: " & errCode & "::"
& errText);
End If

If Not siebBusComp Is Nothing Then

Set siebBusComp = Nothing
End If

If Not siebBusObj Is Nothing Then

Set siebBusObj = Nothing
End If

Set siebWebApp = Nothing

End If

End Sub

Siebel Object Interfaces Reference Version 8.1 43

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

Instantiating the Siebel COM Data Server

Because the Siebel COM Data Server acts without the regular Siebel Business Application User
Interface, you must use the Login method to set up your Data Server object. You cannot use methods
that retrieve active Siebel objects, because there are no current active Siebel objects. You must
instantiate your own Siebel objects. Calls made to the Siebel COM Data Server are in process.

If you use Microsoft Visual Basic 5.0 or later, the required support file, sobjsrv.tlb, must be in the
same directory as the CFG file you are using for your Siebel application, or the COM Data Server does
not work. Take the following steps to make sure you are referring to the correct library.

NOTE: Do not run in the Microsoft VB Debug environment when communicating with the Siebel COM
Data Server.

When using COM Data Server, the COM client cannot create multiple connections to the COM Server.
The COM client must be restarted before another connection attempt can be successful. Use COM
Data Control instead.

To set up Microsoft Visual Basic to access the Siebel COM Data Server
1 Start Microsoft Visual Basic.

2 Select Standard EXE.

3 Choose Project > References.

4 In the dialog box that appears, click on Siebel Data BusObject Interfaces, but do not check its
checkbox. Near the bottom of the dialog box, note the directory in which the file sobjsrv.tlb
resides, as shown in the following illustration.

5 Select the Siebel Data BusObject Interfaces checkbox, and then click OK.

The following is sample code for the Siebel COM Data Server. Make sure that the DataSource
parameter in the CFG file is set to the database to which you want to connect.

NOTE: This code must be written and executed outside of Siebel Tools, for example in Microsoft
Visual Basic.

44 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

Private Sub Command1_Click()

'Siebel Application Object
Dim siebApp As SiebelApplication
Dim siebBusObj As SiebelBusObject
Dim siebBusComp As SiebelBusComp
Dim siebSvcs As SiebelService
Dim siebPropSet As SiebelPropertySet
Dim bool As Boolean
Dim errCode As Integer
Dim errText As String
Dim connStr As String
Dim lng As String
Dim cfgLoc As String

ChDrive "D"
ChDir "D:\Server\siebsrvr\bin"

'Create The COM Data Server Object

Set siebApp = CreateObject("SiebelDataServer.ApplicationObject")

If Not siebApp Is Nothing Then

'''COM Data Server

cfgLoc = " D:\Server\siebsrvr\bin \ENU\siebel.cfg,ServerDataSrc"
siebApp.LoadObjects cfgLoc, errCode
If errCode = 0 Then
'Log Into the Siebel Server
siebApp.Login "username", "password", errCode
If errCode = 0 Then
'Creat A Business Object
Set siebBusObj = siebApp.GetBusObject("Contact", errCode)
If errCode = 0 Then
'Create a Business Component
Set siebBusComp = siebBusObj.GetBusComp("Contact")
Else
errText = siebApp.GetLastErrText
siebApp.RaiseErrorText("Business Object Creation failed: " & errCode & "::" &
errText);
End If

'Create A New Property Set

Set siebPropSet = siebApp.NewPropertySet(errCode)
If errCode = 0 Then
Set siebPropSet = Nothing
Else
errText = siebApp.GetLastErrText
siebApp.RaiseErrorText("Property Set Creation failed: " & errCode & "::" &
errText);
End If

'Get A Siebel Service

Set siebSvcs = siebApp.GetService("Workflow Process Manager", errCode)
If Not siebSvcs Is Nothing Then
Set siebSvcs = Nothing
Else

Siebel Object Interfaces Reference Version 8.1 45

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

errText = siebApp.GetLastErrText
siebApp.RaiseErrorText("Could not Get Siebel Service: " & errCode & "::" &
errText);
End If

If Not siebBusComp Is Nothing Then

Set siebBusComp = Nothing
End If
If Not siebBusObj Is Nothing Then
Set siebBusObj = Nothing
End If
Else
errText = siebApp.GetLastErrText
siebApp.RaiseErrorText("Login Failed: " & errCode & "::" & errText);
End If
Else
errText = siebApp.GetLastErrText
siebApp.RaiseErrorText("Load Objects Failed: " & errCode & "::" & errText);
End If

Set siebApp = Nothing

End If

End Sub

Instantiating the Siebel COM Data Control

To use Siebel Interface methods with the Siebel COM Data Control, use the object browser of your
Siebel COM Data Control programming tool to determine the correct method syntax.

To set up Microsoft Visual Basic to access the Siebel COM Data Control Interface
1 Be sure you have installed the Siebel COM Data Control. Read Installing Siebel Object Interfaces
on page 33.

2 Start Microsoft Visual Basic.

3 Select Standard EXE.

4 Choose Project > References.

46 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

5 In the dialog box that appears, select the Siebel BusObject Interfaces Type Library checkbox.

6 Click OK to open the Object Browser, and then verify that you can see the Siebel objects.

To instantiate and use the Siebel COM Data Control, you must use the CreateObject and Login
methods. You cannot use methods that retrieve active Siebel objects, because there are no currently
active Siebel objects. You must instantiate your own Siebel objects. Calls made to the Siebel COM
Data Control are also in-process.

The following is sample code for the Siebel COM Data Control:

Sub CreateDataControl()
Dim errCode As Integer
Set SiebelApplication = CreateObject("SiebelDataControl.SiebelDataControl.1")
SiebelApplication.Login "host=""siebel://hostname/EnterpriseServer/AppObjMgr""",
"CCONWAY", "CCONWAY"
errCode = SiebelApplication.GetLastErrCode()
If errCode <> 0 Then
ErrText = SiebelApplication.GetLastErrText
TheApplication().RaiseErrorText(ErrText);
Exit Sub
End If
set OpptyB0 = SiebelApplication.GetBusObject("Opportunity",errCode)
set OpptyBC = OpptyBO.GetBusComp("Opportunity", errCode)
End Sub

See Table 19 on page 72 for values to substitute for the placeholders in the login string.

The following sample code instantiates the COM Data Control from a server-side ASP script.

NOTE: The symbols <% and %> are used within HTML script to set off an ASP script.

<%

Dim SiebelApplication, BO, BC, ConnStr, logstat

Dim strLastName, strFirstName, errCode, errText

Set SiebelApplication = CreateObject("SiebelDataControl.SiebelDataControl.1")

Siebel Object Interfaces Reference Version 8.1 47

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

' Test to see if object is created

If IsObject(SiebelApplication) = False then
Response.Write "Unable to initiate Siebel Session.
Else
connStr = "host=" & Chr(34) & "siebel.tcpip.none.none://<hostname>:2321/
EntServer/ObjMgr" & Chr(34) & " lang=" & Chr(34) & "<lang>" & Chr(34)
logstat = SiebelApplication.Login ConnStr, "SADMIN", "SADMIN"

response.write(Login Status: & logstat)

Set BO = SiebelApplication.GetBusObject("Employee")
Set BC = BO.GetBusComp("Employee")
End If

%>

For more information on instantiating the Siebel COM Data Control, read Connect String on page 71.

About Java Data Bean

Siebel Java Data Bean provides users with a native Java interface to access Siebel Object Manager.
It provides functional access to the Siebel applications for both reading and writing data. Siebel Data
Bean is a set of Java libraries built using J2SE Development Kit (JDK). Users can incorporate these
libraries to build Java Applications, Applets, Servlets, JSPs, or Enterprise Java Beans into their Java-
based applications. For more information on Java, refer to http://java.sun.com.

A Java client that uses the Java Data Bean interface to connect to the Siebel server needs several
JAR files that provide the objects and methods of the Siebel Object Interface to the Java language.
The JAR files of the Java Data Bean interface are specific to the Siebel application version with which
they were delivered. Do not use these JAR files with other versions of the Siebel server.

NOTE: Prior to compilation or execution, add the Siebel JAR files (Siebel.jar and
SiebelJI_<lang>.jar) to the CLASSPATH.

Supported Platforms and JDKs

Refer to Siebel System Requirements and Supported Platforms on Oracle Technology Network.

Instantiating the Java Data Bean

To instantiate and use the Siebel Java Data Bean, you must instantiate a new SiebelDataBean Java
object and call its login method. You cannot use methods that retrieve active Siebel objects, because
there are no current active Siebel objects. You must instantiate your own Siebel objects.

The following is sample code for the Siebel Java Data Bean:

import com.siebel.data.*;
import com.siebel.data.SiebelException;

48 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

public class DataBeanDemo

{
private SiebelDataBean m_dataBean = null;
private SiebelBusObject m_busObject = null;
private SiebelBusComp m_busComp = null;

public static void main(String[] args)

{
DataBeanDemo demo = new DataBeanDemo();
}

public DataBeanDemo()
{
try
{
// instantiate the Siebel Data Bean
m_dataBean = new SiebelDataBean();

// log in to the server

// SiebelServerhost = the name or IP address of your Siebel Server
// SCBPort = listening port number for the SCBroker component (default 2321)
m_dataBean.login("Siebel://SiebelServerhost:SCBPort/enterpriseServer/
AppObjMgr_enu", CCONWAY, CCONWAY, enu);

// get the business object

m_busObject = m_dataBean.getBusObject("Opportunity");

// get the business component

m_busComp = m_busObject.getBusComp("Opportunity");

// log off
m_dataBean.logoff();
}

catch (SiebelException e)
{
System.out.println(e.getErrorMessage());
}
}
}

NOTE: If you are using a single sign-on (SSO) with Java Data Bean, you must use the login ID of an
employee as the username and the value of the trust token (the TrustToken parameter in the
applications CFG file) in the connect string to log into the server. For more information, see Connect
String on page 71.

Java Data Bean and the siebel.properties File

The siebel.properties file, which is located in your classpath, can be used to provide default
parameters for client applications connecting to Siebel applications using the Java Data Bean.

Siebel Object Interfaces Reference Version 8.1 49

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

Table 6 shows the properties in the siebel.properties file.

Table 6. Properties in the siebel.properties File

Property Type Property Description

Siebel Connection siebel.conmgr.txtimeout Indicates the transaction timeout (in

Manager Connection milliseconds). Defaults to 600000 = 10
properties minutes. The maximum value is
2,147,483,647 ms (approximately 25
days).

siebel.conmgr.poolsize Indicates the connection pool size.

Connection pool maintains a set of
connections to a specific server process.
Defaults to 2. Max connection pool size is
500.

siebel.conmgr.sesstimeout Indicates the transaction timeout (in

seconds) on the client side. Defaults to
2700 = 45 minutes. The maximum value
is 2,147,483,647 s (approximately 68
years).

siebel.conmgr.retry Indicates the number of open session

retries. Defaults to 3.

siebel.conmgr.jce Indicates the usage of Java

Cryptography Extension. 1 for jce usage
and 0 for no usage.

Siebel Generated code siebel.connection.string Specifies the Siebel connection string.

for JCA/JDB properties
siebel.user.name Specifies the user name to be used for
logging in to Object Manager.

siebel.user.password Specifies the password to be used for

logging in to Object Manager.

siebel.user.language Specifies the user's preferred language.

siebel.user.encrypted Specifies whether the username and

password is encrypted.

siebel.jdb.classname Specifies the default JDB classname

Java System Properties file.encoding Indicates the codepage on the client

side. For example, cp1252, utf8,
unicodeBig, cp942.

NOTE: Java System Properties are System Properties, not Siebel Properties.

The following is a sample siebel.properties file:

50 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

siebel.connection.string = siebel.tcpip.rsa.none://test.siebel.com/siebel/
sseobjmgr_enu/test

siebel.user.name = User1

siebel.user.password = password

siebel.user.language = enu

siebel.user.encrypted = false

siebel.conmgr.txtimeout = 3600

siebel.conmgr.poolsize = 5

siebel.conmgr.sesstimeout = 300000

siebel.conmgr.retry = 5

siebel.conmgr.jce = 1

Java Data Bean and Codepage Support

For the client and server to communicate correctly, the codepage of the Siebel server and client must
be the same. If the client and server default codepages cannot be the same, you can alter the client
codepage by setting the system property file.encoding to the proper codepage. You can set the
system property for the entire JVM (for example, java -Dfile.encoding=ascii <java_application> on
the command line or with the use of the environment variable; reference your particular JVM for
details) or for the given Java component by adding the following line to your Java component.
System.setProperty("file.encoding", CodePageValue);.

Table 7 lists codepage mappings for JDB.

Table 7. Codepage Mappings for Java Data Bean

Java Value Siebel Value

ascii 1

cp1252 1252

iso8859_1 1252

iso8859-1 1252

unicodebig 1201

unicodelittle 1200

utf8 65001
big5 950

cp942 932

cp942c 932

Siebel Object Interfaces Reference Version 8.1 51

 For Oracle internal distribution only
Programming Getting Started with the Siebel Object Interfaces

Table 7. Codepage Mappings for Java Data Bean

Java Value Siebel Value

cp943 932

cp943c 932

cp949 949

cp949c 949

cp950 950

cp1250 1250

cp1251 1251

cp1253 1253

cp1254 1254

cp1255 1255

cp1256 1256

cp1257 1257

cp1258 1258

gbk 936

ms874 874

ms932 932

ms936 936

ms949 949

ms950 950
sjis 932

tis620 874

Encrypting Communication Between JDB and Siebel Server

Siebel Business Applications supports the encryption of communication between the Java Data Bean
(JDB) and the Siebel Server. Preconfigured, it is possible to encrypt communication between the JDB
and the Siebel Server using RSA's encryption libraries. For more information on supported platforms,
see Siebel System Requirements and Supported Platforms on Oracle Technology Network.

To enable encryption support between the Siebel Server and a component built
using the Java Data Bean
1 Enable encryption in the corresponding Object Manager Server Component. Please refer to Siebel
System Administration Guide for details on how to enable encryption within an Object Manager
Server Component.

52 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Methods

2 Set the encryption parameter of the connect string in the Java Data Bean to rsa, which enables
encryption support. For example, siebel.tcpip.rsa.none://<gateway>/<enterprise>/
<ObjMgr>

After completing the two previous steps, communications between the Java Data Bean and the
Siebel Server is encrypted.

To support encryption on platforms not supported by the RSA libraries, Oracle supports the Java
Cryptography Extension (JCE) v1.2.1 specification. JCE is designed so that other qualified
cryptography libraries can be used as service providers.

To enable JCE support

1 Download and install the JCE v1.2.1 software, policy files and documentation. Please refer to
http://java.sun.com/products/jce/index-121.html for additional information on obtaining,
installing and configuring your JVM for use with JCE. Please note that the Java Data Bean only
supports static specification of JCE providers.

2 Modify the java.security file to specify your provider of choice and make sure that the
necessary provider JAR files are included in the CLASSPATH.

3 Set the siebel.conmgr.jce property in the siebel.properties file to 1.

After completing the three previous steps, communications between the Java Data Bean and the
Siebel Server is encrypted.

Login Errors
The Siebel Data Bean may return a login error including the following text:

Siebel Exception thrown invoking login Method. Code--1. Message-Logon request 75 was
abandoned after 2ms connection

The root cause of this error can be one of the following:

OM or OM process down

Hardware reset (OM hardware, router, switch, and so on)

OS settings or OS networking issue

Network failure

NAT timeout

Siebel Object Interface Methods

Several groups of methods are available to Siebel object interface programmers. They are organized
according to functional capabilities:

Locating objects. These are methods that allow the user to locate instances of objects so that
they can be manipulated by other methods.

Siebel Object Interfaces Reference Version 8.1 53

 For Oracle internal distribution only
Programming Siebel Object Interface Methods

Accessing business components. These are methods that provide the ability to access and
modify data within Siebel applications.

Navigation. These are methods that provide a way to control the flow of the application as it is
presented to the user by explicitly setting the focus of the application to the desired view, applet,
or control. These methods are useful only when accessing the Siebel object interfaces from Siebel
VB and when accessing Siebel as a Mobile Web Client Automation Server. When Siebel is accessed
through the COM Data Control, COM Data Server, or Java Data Bean, no Siebel user interface is
present.

Manipulating controls. These are the methods that get or set the value of a control. These
methods are useful only when accessing controls from Browser Script.

Global state properties and functions. These are methods that get information on the current
state.

User interaction. These are methods that provide user interface elements similar to those in
standard Windows programs.

Related Topics
Locating Objects
Accessing Business Components on page 55
Navigation Methods on page 60
User Interaction Methods on page 60
Global State Properties and Functions on page 60

Locating Objects
This set of methods allows the user to locate instances of objects within Siebel applications so they
can be used by other methods. Active objects are instances of objects that currently have focus. The
active control is the control that currently has the user interface focus. The active applet is the applet
that contains the active control. The active business component is the business component
associated with the active applet. When located, an object can be used or manipulated by Siebel
object interfaces.

For locating objects, use the following methods:

ActiveBusObject Method on page 118

ActiveMode Method on page 92

ActiveViewName Method on page 120

BusComp Method on page 289

BusObject Method on page 93

GetBusObject Method on page 127

GetValue Method on page 307

Name Method on page 291

54 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Methods

TheApplication Method on page 317

Accessing Business Components

The Siebel business component object (BusComp) presents a two-dimensional grid of data values
much like a table in a relational database. The named fields are analogous to columns in the database
table, and the records are analogous to rows. Developers use business components to read data,
manipulate it, and write it back into the Siebel database. Business components manage the
complexities of multiple-table access to the database and access different types of databases.

Many methods are available to use on business components for getting and setting the values of their
fields. Record operations can be performed programmatically by using business component access
methods.

These operations invoke Siebel VB or Siebel eScript extension routines. For example, if you have
created a Siebel VB or Siebel eScript script that is tied to the NewRecord event on a business
component, the script is processed whenever NewRecord in that business component is processed,
even if the NewRecord method was called by another Siebel VB or Siebel eScript script or was called
from the Siebel object interfaces. Note that events are available only with Siebel VB or Siebel eScript.

Adding and Inserting Records

In the context of a many-to-many relationship, you can use Siebel VB or Siebel eScript to mimic
either the Add New Record command, which associates a new child record, or the Insert Record
command, which creates a new record in the child business component. To associate a new child
record, use GetAssocBusComp and the Associate method. To create a new record in the child, use
the NewRecord method in a child business component, or use GetMVGBusComp and the NewRecord
method.

Committing Records to the Database

A commit is performed under the following circumstances:

Explicitly by issuing BusComp.WriteRecord

Navigating away from the current record by any of the following methods:

BusComp.Associate

BusComp.DeleteRecord (DeleteRecord commits automatically, because it moves the cursor

to another record.)

BusComp.FirstRecord

BusComp.LastRecord

BusComp.NextRecord

BusComp.PreviousRecord

Closing a BusComp (Set BusComp = Nothing)

Siebel Object Interfaces Reference Version 8.1 55

 For Oracle internal distribution only
Programming Siebel Object Interface Methods

Scenarios for Business Components

The two scenarios that follow involve the use of Siebel scripts to work with business components.

The first example shows how to invoke methods on an existing business component when an event
is triggered. In this example, the VB script is in the SetFieldValue event of a business component:

Sub BusComp_SetFieldValue (FieldName As String)

Dim desc As String
Dim newDesc As String

TheApplication.TraceOn "c:\temp\trace.txt", "Allocation", "All"

If FieldName = "Type" Then

newDesc = "Any valid string which contains the

new description."
desc = Me.GetFieldValue("Description")
TheApplication.Trace "The previous description is " & desc
Me.SetFieldValue "Description", newDesc
TheApplication.Trace "The new description is " & newDesc

End If
TheApplication.TraceOff

End Sub

The next example shows how to instantiate your own BusObject and BusComp. This example uses
the PreSetFieldValue event of the Opportunity BusComp. If the Sales Stage is updated to 07 - Verbal
Agreement, a decision maker must be associated with the opportunity. Otherwise, it is reset to the
previous value. The Contacts for the selected opportunity are searched to see if any vice president
or president is associated with the opportunity.

The logical flow of instantiating your own BusComp object is as follows:

1 GetBusComp

2 SetViewMode (optional, because if you are using Me or the current object, then the BusComp
may already be in the correct mode)

3 ActivateField
4 ClearToQuery

5 SetSearchSpec or SetSearchExpr

NOTE: It is not necessary to activate fields on which search specs and search expressions are
set.

6 ExecuteQuery

The following example shows how to instantiate objects in eScript:

function BusComp_PreSetFieldValue (FieldName, FieldValue)

{
var RetValue = ContinueOperation;
switch (FieldName)
{
case "Sales Stage":

56 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Methods

if (FieldValue == "08 - Negotiation")

{
//Do not allow the sales cycle to be changed to this value
//if the decision-maker is not a contact for the Oppty.
//Decision-maker defined as anyone with rank VP and above
var oBusObj;
var sRowId;
var iViewMode;
sRowId = this.GetFieldValue("Id");
iViewMode = this.GetViewMode();
oBusObj = TheApplication().ActiveBusObject();
//Because parent-child relationship is established when
//BusComps are instantiated from the same BusObject.
//The ContactBC has all contact records for the
//current Oppty record.
ContactBC = oBusObj.GetBusComp("Contact");
with (ContactBC)
{
ClearToQuery();
SetSearchSpec("Job Title", "*VP*");
ExecuteQuery(ForwardOnly);
if (FirstRecord())
{
TheApplication().RaiseErrorText("Found a decision maker");
}
else
{
RetVal = ContinueOperation;
}
}
}
break;
}
return(RetVal);
}

The following example shows how to instantiate objects in Siebel VB:

Function BusComp_PreSetFieldValue (FieldName As String, FieldValue As String) As

Integer

Dim RetValue As Integer

RetValue = ContinueOperation
Select Case FieldName
Case "Sales Stage"
If FieldValue = "08 - Negotiation" Then
' Do not allow the sales cycle to be changed to this value
' if the decision-maker is not a contact for the Oppty.
' Decision-maker defined as anyone with rank VP and above
Dim oBusObj As BusObject
Dim sRowId As String
Dim iViewMode As Integer

Siebel Object Interfaces Reference Version 8.1 57

 For Oracle internal distribution only
Programming Siebel Object Interface Methods

sRowId = GetFieldValue("Id")
iViewMode = GetViewMode
Set oBusObj = TheApplication.ActiveBusObject

' Because parent-child relationship is established when

' BusComps are instantiated from the same BusObject.
' The ContactBC has all contact records for the
' current Oppty record.
Set ContactBC = oBusObj.GetBusComp("Contact")
With ContactBC
.ClearToQuery
.SetSearchSpec "Job Title", "*VP*"
.ExecuteQuery ForwardOnly
If (.FirstRecord = 1) Then
TheApplication.RaiseErrorText "Found a decision maker"
Else
RetVal = ContinueOperation
End If
End With
End If
End Select
BusComp_PreSetFieldValue = RetValue
End Function

Methods for Accessing Business Components

To access business components, use the following methods:

ActivateField Method on page 179

ActivateMultipleFields Method on page 181

Associate Method on page 182

ClearToQuery Method on page 185

CountRecords Method on page 186

DeactivateFields Method on page 187

DeleteRecord Method on page 189

ExecuteQuery Method on page 190

ExecuteQuery2 Method on page 192

FirstRecord Method on page 192

FirstSelected Method on page 194

GetAssocBusComp Method on page 196

GetFieldValue Method on page 197

GetFormattedFieldValue Method on page 199

GetMultipleFieldValues Method on page 203

GetMVGBusComp Method on page 203

58 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Methods

GetNamedSearch Method on page 205

GetPicklistBusComp Method on page 205

GetSearchExpr Method on page 207

GetSearchSpec Method on page 208

GetSortSpec Method on page 209

GetUserProperty Method on page 209

GetViewMode Method on page 210

InvokeMethod Method on page 211

LastRecord Method on page 219

NewRecord Method on page 221

NextRecord Method on page 222

ParentBusComp Method on page 224

Pick Method on page 224

PreviousRecord Method on page 226

RefineQuery Method on page 227

SetFieldValue Method on page 230

SetFormattedFieldValue Method on page 232

SetMultipleFieldValues Method on page 233

SetNamedSearch Method on page 235

SetSearchExpr Method on page 237

SetSearchSpec Method on page 238

SetSortSpec Method on page 242

SetViewMode Method on page 245

UndoRecord Method on page 249

WriteRecord Method on page 249

Siebel Object Interfaces Reference Version 8.1 59

 For Oracle internal distribution only
Programming Siebel Object Interface Methods

Navigation Methods
The navigation methods set the focus for user interaction to the named view. Table 8 identifies the
navigation methods. Cannot be invoked from Browser Script.

NOTE: Properties for Siebel objects such as business component applets and business components
are stored in the repository and cannot be changed at run time using Siebel VB methods.

Table 8. Navigation Methods

Method

InvokeMethod Method on page 96

GotoView Method on page 135

User Interaction Methods

The following methods allow the Siebel extension routines to interact directly with the user through
traditional user interface techniques. These methods are similar to the standard procedures available
to Windows programs. User interaction methods are listed in Table 9.

Table 9. User Interaction Methods

Method

RaiseError Method on page 154

RaiseErrorText Method on page 155

Global State Properties and Functions

The application object provides a set of properties and functions that return information about the
current state. This information is useful when you are processing rows of data or generating query
criteria. Global state methods are listed in Table 10.

Table 10. Global State Methods

Method

CurrencyCode Method on page 123

EnableExceptions Method on page 125

GetLastErrCode Method on page 129

GetLastErrText Method on page 130

LoginId Method on page 147

60 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Variable Scoping for Siebel Script Variables

Table 10. Global State Methods

Method

LoginName Method on page 147

LookupMessage Method on page 149

PositionName Method on page 153

SetPositionId Method on page 157

SetPositionName Method on page 158

Variable Scoping for Siebel Script

Variables
Three levels of scope exist for Siebel variables:

Local Variables on page 61

Module Variables on page 62

Global Variables on page 62

Related Topics
Inter-Application Variable Methods on page 63
Tracing on page 63

Local Variables
Local variables defined within a Siebel script are the lowest level of variable scoping. These variables
are declared using the Dim statement in Siebel VB or the var statement in Siebel eScript, and their
values are accessible only within the script in which they were defined.

The following example is in Siebel eScript:

function WebApplet_Load ()
{
var localStr;
}

The following example is in Siebel VB:

Sub WebApplet_Load
Dim localStr As String
End Sub

Siebel Object Interfaces Reference Version 8.1 61

 For Oracle internal distribution only
Programming Variable Scoping for Siebel Script Variables

Module Variables
Module variables defined in the (general) (declarations) section of a Siebel object (such as an applet
or business component) are the next level of variable scoping. These variables are available as long
as the object is instantiated and the values are accessible to scripts in the same object or module.
Use Dim statements (for VB) or var statements (for eScript) in the (general) (declarations) section
to declare module variables.

The following example is in Siebel VB:

(general) (declarations)
Dim ContactId as String

Code in the VB Editor in the (general) (declarations) section is illustrated in Figure 6.

Figure 6. Declarations in the (general) (declarations) Section

Global Variables
The global variables exist at the highest level. You must declare these variables in every module that
needs to access their values. Use the Global statement to declare these variables. Avoid using global
variables to store Siebel objects such as BusComp and BusObject. If you need to store Siebel objects
such as BusComp and BusObject, always set these variables to Nothing whenever the objects are no
longer required, or at least in the Application_Close event. Failure to do so may cause memory
problems because the objects being referenced cannot be freed from memory while they are still
being referenced. If you must create a global variable for a business component, make sure there is
a global variable for the business object. Otherwise, the business component is out of scope.

The following example is in Siebel eScript:

62 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

TheApplication().gVar = "some value";

Inter-Application Variable Methods

Siebel provides two sets of methods to send values for variables back and forth between the Siebel
application and external applications. Table 11 lists inter-application communication methods.

Table 11. Inter-Application Communication Methods

Method

GetUserProperty Method on page 209

SetUserProperty Method on page 244

GetLastErrCode Method on page 129

SetSharedGlobal Method on page 160

GetProfileAttr Method on page 131

SetProfileAttr Method on page 158

Tracing
Table 12 lists Application event methods for controlling debug tracing.

Table 12. Debug Tracing Methods

Method

Trace Method on page 165

TraceOff Method on page 167

TraceOn Method on page 168

Siebel Object Interface Events and

Siebel Extension Events
Selected events within the Siebel applications allow the association of extension routines that extend
the base behavior of the application. These routines are available in Browser and Server Script. When
the Siebel application fires or activates the event, the user-specified procedures are invoked along
with the standard Siebel procedures. The event names listed under Siebel Business Component
Events on page 68 refer to the tag or entry point used to tie the extension routine to a particular
action or event.

The following topics cover the object interface events and extension events:

Siebel Object Interfaces Reference Version 8.1 63

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

Event Method Syntax on page 64

How Your Script Affects Program Flow on page 64

Using Tracing to Find Out When Events Occur on page 68

Siebel Business Component Events on page 68

Applet Events on page 70

Application Events on page 71

Connect String on page 71

Error Handling on page 74

Each topic provides the following information:

The syntax for using the event.

A brief description of the event.

A checklist that indicates which interface environments support the event.

Event Method Syntax

The methods syntax uses the following form:

ObjectReference_EventName (arguments) As RetValue.

ObjectReference is the variable name of the object on which the event is invoked.

EventName is the event that is being invoked.

The events exposed can be classified into preoperation events or postoperation events. The
preoperation events occur before the standard Siebel operation. An example of a preoperation event
is PreDeleteRecord. This event occurs before a DeleteRecord event occurs.

The corresponding postoperation event is DeleteRecord. This event is fired after the PreDeleteRecord
operation has been executed.

You can use preoperation events to alter standard Siebel behavior. For example, the PreDeleteRecord
event can be used to perform additional, customer-specific validation on the record about to be
deleted, and if the validations fail, the DeleteRecord operation can be canceled.

Postoperation events are useful when the event relies on data that may have been updated in the
course of executing the standard Siebel event.

How Your Script Affects Program Flow

For every Siebel operation event handler, there is also a preoperation event handler. Generally,
scripts are placed in the preoperation event. You can alter the effect of an event by attaching a script
to the preoperation event handler. The events with the most important effects are the
PreInvokeMethod events. In a PreInvokeMethod event, you can call a method that substitutes for the
internal Siebel code.

64 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

As Figure 7 illustrates, you can change the outcome of an event by specifying the return value on the
preoperation events. The standard return value for preoperation events is ContinueOperation, which
tells the calling Siebel object to continue processing the remaining operations associated with the
event, as shown in Step 2 in Figure 7.

Figure 7. The Effects of CancelOperation and ContinueOperation

If you wish to create an alternative to an existing routine, change the return value in your custom
event handler to CancelOperation. This tells the Siebel application to cancel the remaining operations
associated with the event. If, for example, the validation in the PreDeleteRecord event fails, set the
return value for the event to CancelOperation. If you want to preprocess before the default event
method executes, use the return value ContinueOperation.

The post-event handler is rarely scripted, but you may use it for such post-operation events as
posting a notice to a log when the event completes successfully.

The following eScript example sets up a validation routine in which a specific field is queried to
determine whether the event should fire:

Siebel Object Interfaces Reference Version 8.1 65

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

function BusComp_PreSetFieldValue (FieldName, FieldValue)

{
var iReturn = ContinueOperation;
//Routine to check if a quote discount > 20%
//if it is, notify user and cancel the operation
var varvalue;
var msgtext;
if (FieldName == "Discount")
{
varvalue = ToNumber(FieldValue);
if (varvalue > 20)
{
msgtext = "Discounts greater than 20% must be approved";
TheApplication().RaiseErrorText(msgtext);
}
else
{
iReturn = ContinueOperation;
}
}
}

The following Siebel VB example sets up a validation routine in which a specific field is queried to
determine whether the event should fire:

Function BusComp_PreSetFieldValue (FieldName As String,

FieldValue As String) As Integer
' Routine to check if a quote discount > 20%
' if it is, notify user and cancel the operation
Dim value as Integer
Dim msgtext as String
If FieldName = "Discount" then
value = Val(FieldValue)
If value > 20 then
msgtext = "Discounts greater than 20% must be approved"
TheApplication.RaiseErrorText msgtext
Else
BusComp_PreSetFieldValue = ContinueOperation
End if
End If
End Function

Note the logical structure of this routine:

If (condition is true)
[perform custom routine]
[cancel operation by raising error text]
Else
returnValue = ContinueOperation
End If

Within this structure, the custom routine is executed only if the condition is true. If the condition is
true, the custom routine substitutes for the built-in routine. If it is not true, the built-in routine is
executed because the event handler returns ContinueOperation.

66 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

The following alternative structure is also acceptable:

returnValue = ContinueOperation
If (condition is true)
[perform custom routine]
End If

Note that in PreInvokeMethod events, the condition should always be a test for the method name;
for example:

if (methodName = "PushOpportunity")

If more than one method may be invoked, you may find it more efficient to use a Select structure
(in VB) or a switch structure (in eScript). The following example is in Siebel VB:

Dim iReturn As Integer

iReturn = ContinueOperation
Select Case methodName
Case "PushOpportunity"
[custom routine]
iReturn = CancelOperation
Case "Stage3"
[custom routine]
iReturn = CancelOperation
End Select
object_PreInvokeMethod = iReturn

The following example is in Siebel eScript:

var iReturn;
switch (methodName)
{
case "PushOpportunity":
//[custom routine]
iReturn = CancelOperation;
break;
case "Stage3":
//[custom routine]
iReturn = CancelOperation;
break;

default:
iReturn = ContinueOperation;
}
return (iReturn);

To make your code easier to read and maintain, you can create the custom routines as subprograms
or functions in the (general) (declarations) section.

Siebel Object Interfaces Reference Version 8.1 67

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

Unique Names
Make sure that every function you create has a unique name. If two functions on the same view have
the same name, results are unpredictable. Good coding practice is to make sure all such names are
unique. Consider using a naming convention, such as using the view name as a function name prefix.

Using Tracing to Find Out When Events Occur

There is no simple way to determine when various events occur, as many different events can occur
when a view becomes current or when an object is invoked. To find out the exact order of events,
enable tracing when the application starts (Application_Start event). For Siebel eScript the syntax
resembles the following:

TheApplication().TraceOn("filename, type, selection");

TheApplication().TraceOn(" Event_Name has fired.");

For Siebel VB the syntax resembles the following:

TheApplication.TraceOn "filename, type, selection"

TheApplication.Trace "Event_Name has fired."

When the preceding code has been placed on the Application_Start event, place a line of code of the
following form in each event handler (including the Pre-event handlers) for the object, including
insert, delete, write, business component, and any others that may apply.

TheApplication.Trace "Event_Name fired."

Then perform some simple inserts, updates, and deletes, and make a note of each message as it
appears. You then have a list of the order in which events fire on that view or for that object.

Siebel Business Component Events

Events can be invoked from data operations on business components. These are defined on a per-
business component basis. Events can be invoked before or after the specified standard behavior.

The only means of trapping modifications to a multi-value field is through the underlying MVG
business component. If the multi-value field is modified without popping up the MVG applet, then
the PreSetFieldValue and SetFieldValue events for those fields are not triggered. The only way in
which the PreSetFieldValue and SetFieldValue events are fired for a multi-value field is if the field is
updated within the MVG applet. If the user makes a change to the multi-value field through the MVG
applet, then only the events on the MVG business component are called. No events on the parent
business component are called.

68 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

Table 13 and Table 14 list BusComp events.

Table 13. Server Side BusComp Events

Method

BusComp_Associate Event on page 251

BusComp_ChangeRecord Event on page 252

BusComp_PreCopyRecord Event on page 256

BusComp_CopyRecord Event on page 253

BusComp_InvokeMethod Event on page 255

BusComp_NewRecord Event on page 255

BusComp_PreAssociate Event on page 256

BusComp_PreDeleteRecord Event on page 257

BusComp_PreGetFieldValue Event on page 258

BusComp_PreInvokeMethod Event on page 259

BusComp_PreNewRecord Event on page 260

BusComp_PreQuery Event on page 260

BusComp_PreSetFieldValue Event on page 261

BusComp_PreWriteRecord Event on page 263

BusComp_Query Event on page 264

BusComp_SetFieldValue Event on page 265

BusComp_WriteRecord Event on page 266

Table 14. Browser Side BusComp Events

Method

BusComp_PreSetFieldValue Event on page 261

Siebel Object Interfaces Reference Version 8.1 69

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

Applet Events
Events are invoked in response to user interactions. These can be managed on a per-applet basis.
Applet events are only supported in high interactivity mode. Table 15 and Table 16 list the User
interface events.

Table 15. Server-side Applet Events

Method

WebApplet_InvokeMethod Event on page 105

WebApplet_Load Event on page 106

WebApplet_PreCanInvokeMethod Event on page 108

WebApplet_PreInvokeMethod Event on page 109

Table 16. Browser-side Applet Events

Method

Applet_ChangeFieldValue Event on page 99

Applet_ChangeRecord Event on page 101

Applet_InvokeMethod Event on page 101

Applet_PreInvokeMethod Event on page 104

70 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

Application Events
Application events are listed in Table 17 and Table 18.

Table 17. Server-side Application Events

Method

Application_InvokeMethod Event on page 172

Application_Navigate Event on page 173

Application_PreInvokeMethod Event on page 173

Application_PreNavigate Event on page 175

Application_Start Event on page 176

Table 18. Browser-side Application Events

Method

Application_InvokeMethod Event on page 172

Application_PreInvokeMethod Event on page 173

Connect String
The connect string is a URL containing the information needed to connect to any Siebel Server
component. It specifies both the protocol and the details of the Client Application Manager service
in the Siebel Servers to which the client connects. The generic form of the syntax for the connect
string follows:

host="siebel[.transport][.encryption][.compression]://host[:port]/
EnterpriseServer/AppObjMgr_lang" lang=lang_code

The following is an example of a connect string. SiebelApplication is an application instance:

SiebelApplication.Login "host=""siebel://host/EnterpriseServer/SCCObjMgr_enu""
lang=ENU, "CCONWAY", "CCONWAY"

Note that the entire protocol string is optional. You can specify the transport protocol alone and
separate it from siebel with a single period:

siebel.tcpip://host/siebel/AppObjMgr_lang

However, if you specify any of the other protocols, you must use a period as a placeholder for each
protocol not specified. The following is an example:

siebel...zlib://hhost/siebel/SCCObjMgr_enu

Protocols that are not specified receive their default values, as shown in Table 19 on page 72.

Siebel Object Interfaces Reference Version 8.1 71

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

Make the following substitutions for the placeholders in the example:

Table 19. Placeholder Substitutions When Logging into a Siebel Server

In Place Of Insert

transport The default value, tcpip, or leave blank

encryption One of the following values:

none (default)

mscrypto (not supported by Java Data Bean)

rsa (supported by Java Data Bean)

compression One of the following values:

none

zlib (the default)

host The name of the computer on which the Siebel Server is installed

port The SCBroker port; by default 2321. This changes only if the Siebel
administrator changes the default during installation.

For information about load-balancing with SCBroker, see Siebel

Deployment Planning Guide, Siebel Applications Administration Guide,
and Siebel Installation Guide for the operating system you are using.

EnterpriseServer The name of the Siebel Enterprise Server

AppObjMgr The name of the defined Application Object Manager that you want the
Web client to access; this can be a user-defined component or one of
these predefined components:

ISSObjMgr_<lang>

SCCObjMgr_<lang>

SSEObjMgr_<lang>

SSVObjMgr_<lang>

For more information, see Siebel System Administration Guide.

For more information about the Login method, see Login Method on page 145.

The following is a sample connect string for the COM Data Control operating in Server Mode:

'COM Data Control : SERVER Mode

lstr = "host=" + """siebel://frashid/Siebel/SSEObjMgr_enu"""
'Format of the connect string is
'"host=" + """siebel://<host>/<Enterprise>/<App. Object Mgr_lang>"""
lng = "lang=" + """ENU"""
retval = siebDataCtl.Login(lng + lstr, "username", "password")

72 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

The following is a sample connect string for the COM Data Control operating in Local Mode. When
running in Local Mode, the COM Data Control must reside on the same machine as the Mobile Web
Client.

'COM Data Control : LOCAL Mode

lstr = "cfg=" + """D:\Client\mwebc\BIN\ENU\siebel.cfg,ServerDataSrc"""

'Format of the connect string is

'"cfg=" + """Absolute path of the CFG file, DataSource"""
'Datasource = ServerDataSrc or Local or Sample
lng = "lang=" + """ENU"""
retval = siebDataCtl.Login(lng + lstr, "username", "password")

The following is a sample connect string for the COM Data Control for PowerBuilder. Char(34) denotes
a double quote:

ConnStr = "host =" + char(34) + "siebel://HOST/ENTERPRISE_SERVER/SCCObjMgr_enu/

SIEBEL_SERVER" + char(34) + " Lang = " + char(34) + "LANG" + char(34)

If you are using a single sign-on (SSO) with Java Data Bean, you must use the login ID of an
employee as the username and the value of the trust token (the TrustToken parameter in the
applications CFG file) in the connect string to log into the server.

For example, the connect string would be:

m_dataBean.login("Siebel://gatewayserver:2321/enterpriseServer/SCCObjMgr_enu",
SADMIN, HELLO,"enu");

where SADMIN is an employee and TrustToken = HELLO in the [LDAPSecAdpt] section of uagent.cfg.

Using Load Balancing with the Connect String

Siebel COM Data Control operating in server mode and Java Data Bean support Siebel native load
balancing across Siebel Servers. The standard connect string is modified to direct requests to an
appropriate virtual host that includes specific Siebel Servers with the desired object manager, and
to provide the path to the file that defines the virtual host.

Connect strings that use Siebel native load balancing have the following structures:

COM Data Control:

host="siebel://VirtualHost/EnterpriseServer/AppObjMgr_lang"vhosts="<path to
lbconfig.txt>"

where lbconfig.txt is the file that defines virtual hosts.

For information on lbconfig.txt definition of virtual hosts, see Siebel System Administration
Guide.

Java Data Bean:

Siebel Object Interfaces Reference Version 8.1 73

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

host="siebel://VirtualHost/EnterpriseServer/AppObjMgr_lang"

When using generated code, by default, virtual host definitions are read from the
siebel.conmgr.virtualhosts property in the siebel.properties file. The siebel.properties file must
be in the classpath of the Java Virtual Machine.

For information on definition of virtual hosts in siebel.properties, see Transports and Interfaces:
Siebel Enterprise Application Integration.

The following is a sample connect string for the COM Data Control operating in Server Mode in an
environment that implements Siebel round-robin load balancing across Siebel Servers:

'COM Data Control : Load Balancing

lstr = "host=" + """siebel://VirtualServer1/Siebel/SSEObjMgr_enu""" + "vhosts=" +
"""m:\siebel\admin\lbconfig.txt"""
lng = "lang=" + """ENU"""
retval = siebDataCtl.Login(lng + lstr, "username", "password")

where VirtualServer1 matches the VirtualServer parameter in the session manager rules in
lbconfig.txt, for example:

VirtualServer1=1:SiebServA:2321;2:SiebServB:2321;

For information on the structure of the lbconfig.txt file, see Siebel System Administration Guide.

Error Handling
This section explains the Siebel COM Interfaces error handling differences.

COM Error Handling

The errCode parameter is the standard last parameter for every COM Data Server interface method.
It is not available in the COM Data Control, Mobile Web Client Automation Server, Web Client
Automation Server, or Java Data Bean. The following examples illustrate the difference between
calling a COM Data Server interface method and calling the version of the method that is compatible
with COM Data Control and Mobile Web Client Automation Server.

Error Handling ExampleCOMData Server only

GetBusObject (BusObjectName as string, errcode as integer) -> businessObject

Error Handling ExampleCOM Data Control and Mobile Web Client Automation Server
GetBusObject (BusObjectName as string) -> businessObject

Java Error Handling

The Siebel Java interfaces error-handling differences are explained in this section.

74 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

Errors in the Siebel Java Data Bean are handled by the SiebelException object. It supports the
getErrorCode() and getErrorMessage() methods. The SiebelException object is defined in
com.siebel.data.SiebelException. It is used as follows:

...

import com.siebel.data.SiebelException;
import com.siebel.data.SiebelDataBean;
...
SiebelDataBean mySiebelBean=null;
try

{
mySiebelBean = new SiebelDataBean();
mySiebelBean.login("Siebel://SOMSERVER/somsiebel/AppObjMgr/, "CCONWAY",
"CCONWAY","enu");
}
catch (SiebelException e){
// Exception handling code
System.out.println (e.getErrorMessage ());
mySiebelBean = null; //avoid using mySiebelBean if login is unsuccessful
}

...

For additional methods on the SiebelException object, refer to the Siebel Java Data Bean JavaDoc
installed with Siebel Tools. Note that the JavaDoc is installed only if the Siebel Java Integration
option is installed. If so, then a zipped file containing the JavaDoc is in the <tools install>\CLASSES
folder.

Error Message Tracking

For error message tracking in ActiveX, you can use either exceptions or methods. The following
methods are available:

EnableExceptions

GetLastErrCode

GetLastErrText

EnableExceptions Method
EnableExceptions(enable as integer)

The EnableExceptions method allows applications to use the native COM error-handling technique.
If the method is about to fail due to error, then a COM exception is generated and the method does
not return. The COM host receives the control instead. However, it may display the error message
(this is default for Microsoft Internet Explorer or VB), but it can be changed by scripting.

Siebel Object Interfaces Reference Version 8.1 75

 For Oracle internal distribution only
Programming Siebel Object Interface Events and Siebel Extension Events

GetLastErrCode, GetLastErrText Method

After execution of a method, the GetLastErrCode can be invoked to check if any error was returned
from the previous operation. The GetLastErrText method can be invoked to retrieve the text of the
error message, for example:

GetLastErrCode() ' retrieves errCode As Integer

GetLastErrText() ' retrieves text As String

76 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

4 Interfaces Reference

This chapter lists the methods and events available to Siebel object interfaces:

Object Interface Method Tables on page 77

Object Interface Event Tables on page 89

Siebel Constants on page 91

Applet Methods on page 92

Applet Events on page 99

Application Methods on page 115

Application Events on page 171

Business Component Methods on page 178

Business Component Events on page 251

Business Object Methods on page 267

Business Service Methods on page 271

Business Service Events on page 281

Control Methods on page 288

Property Set Methods on page 296

Miscellaneous Methods on page 315

Object Interface Method Tables

This section lists the Siebel interface methods, grouped by object interface type:

Applet Methods on page 78

Application Methods on page 78

Business Component Methods on page 81

Business Object Methods on page 85

Business Service Methods on page 85

Control Methods on page 86

Property Set Methods on page 87

Miscellaneous Methods on page 88

Siebel Object Interfaces Reference Version 8.1 77

 For Oracle internal distribution only
Interfaces Reference Object Interface Method Tables

Applet Methods
Table 20 lists the applet methods.

Table 20. Applet Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

ActiveMode X
Method

BusComp Method X X

BusObject X X
Method

FindActiveXContr X
ol Method

FindControl X
Method

InvokeMethod X X
Method

Name Method X X

Application Methods
Table 21 lists the application methods.

Table 21. Application Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

ActiveApplet X
Method

ActiveBusComp X
Method

ActiveBusObject X X X
Method

ActiveViewName X X X
Method

78 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Object Interface Method Tables

Table 21. Application Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

Attach Method X X

CurrencyCode X X X X X X
Method

Detach Method X X

EnableExceptions X X
Method

FindApplet X
Method

GetBusObject X X X X X
Method

GetDataSource X X X X
Method
Called only with
InvokeMethod

GetLastErrCode X X X
Method

GetLastErrText X X X X
Method

GetProfileAttr X X X X X X
Method

GetService X X X X X X X
Method

GetSharedGlobal X X X X X
Method

GotoView Method X

InvokeMethod X X X X X X
Method

IsViewReadOnly X X X X X X
Method
Called only with
InvokeMethod

Language Method X
Called only with
InvokeMethod

Siebel Object Interfaces Reference Version 8.1 79

 For Oracle internal distribution only
Interfaces Reference Object Interface Method Tables

Table 21. Application Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

LoadObjects X
Method

LoadUserAttribut X
es Method

Login Method X X X X

LoginId Method X X X X X

LoginName X X X X X
Method

Logoff Method X X X

LookupMessage X
Method

LookupValue X X X X
Method
Called only with
InvokeMethod

Name Method X X

NewPropertySet X X X X X X X
Method

PositionId Method X X X X X

PositionName X X X X X
Method

RaiseError X
Method

RaiseErrorText X
Method

SetPositionId X X X X X
Method

SetPositionName X X X X X
Method

SetProfileAttr X X X X X X
Method

SetSharedGlobal X X X X X
Method

80 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Object Interface Method Tables

Table 21. Application Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

ShowModalDialo X
g Method

SWEAlert Method X

Trace Method X X X X X

TraceOff Method X X X X X

TraceOn Method X X X X X

Business Component Methods

Table 22 lists the business component methods.

Table 22. Business Component Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

ActivateField X X X X X
Method

ActivateMultipleFie X X X X X
lds Method

Associate Method X X X X X

BusObject Method X X X X X X
ClearLOVCache X X X X X X
Method
Called only with
InvokeMethod

ClearToQuery X X X X X
Method

CreateFile Method X X X X X
Called only with
InvokeMethod

DeactivateFields X X X X X
Method

Siebel Object Interfaces Reference Version 8.1 81

 For Oracle internal distribution only
Interfaces Reference Object Interface Method Tables

Table 22. Business Component Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

DeleteRecord X X X X X
Method

ExecuteQuery X X X X X
Method

ExecuteQuery2 X X X X X
Method

FirstRecord Method X X X X X

FirstSelected X
Method

GenerateProposal X X X X X
Method
Called only with
InvokeMethod

GetAssocBusComp X X X X X
Method

GetFieldValue X X X X X X
Method

GetFile Method X X X X X
Called only with
InvokeMethod

GetFormattedField X X X X X X
Value Method

GetLastErrCode X X
Method

GetLastErrText X X
Method

GetMultipleFieldVal X X X X X
ues Method

GetMVGBusComp X X X X X
Method

GetNamedSearch X X X X X
Method

GetPicklistBusCom X X X X X
p Method

82 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Object Interface Method Tables

Table 22. Business Component Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

GetSearchExpr X X X X X X
Method

GetSearchSpec X X X X X X
Method

GetSortSpec X X X X X
Method

GetUserProperty X X X X X
Method

GetViewMode X X X X X
Method

InvokeMethod X X X X X
Method

LastRecord Method X X X X X

Name Method X X X X X X

NewRecord Method X X X X X

NextRecord X X X X X
Method

NextSelected X
Method

ParentBusComp X X X X X
Method

Pick Method X X X X X

PreviousRecord X X X X X
Method

PutFile Method X X X X X
Called only with
InvokeMethod

RefineQuery X X X X X
Method

RefreshBusComp X X X X X X
Method
Called only with
InvokeMethod

Siebel Object Interfaces Reference Version 8.1 83

 For Oracle internal distribution only
Interfaces Reference Object Interface Method Tables

Table 22. Business Component Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

RefreshRecord X X X X X
Method
Called only with
InvokeMethod

Release Method X

SetAdminMode X X X X X
Method
Called only with
InvokeMethod

SetFieldValue X X X X X X
Method

SetFormattedField X X X X X X
Value Method

SetMultipleFieldVal X X X X X
ues Method

SetNamedSearch X X X X X
Method

SetSearchExpr X X X X X
Method

SetSearchSpec X X X X X
Method

SetSortSpec X X X X X
Method

SetUserProperty X X X X X
Method

SetViewMode X X X X X
Method

UndoRecord X X X X X
Method

WriteRecord X X X X X X
Method

84 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Object Interface Method Tables

Business Object Methods

Table 23 lists the business object methods.

Table 23. Business Object Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

GetBusComp X X X X X X
Method

GetLastErrCode X X
Method

GetLastErrText X X
Method

Name Method X X X X X X

Release Method X

Business Service Methods

Table 24 lists the business service methods.

Table 24. Business Service Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

GetFirstProperty X X X X X X
Method

GetNextProperty X X X X X X
Method

GetProperty X X X X X X
Method

InvokeMethod X X X X X X X
Method

Name Method X X X X X X X

PropertyExists X X X X X X
Method

Release Method X

Siebel Object Interfaces Reference Version 8.1 85

 For Oracle internal distribution only
Interfaces Reference Object Interface Method Tables

Table 24. Business Service Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

RemoveProperty X X X X X X
Method

SetProperty X X X X X X
Method

Control Methods
Table 25 lists the control methods.

Table 25. Control Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

Applet Method X

BusComp Method X

GetProperty X
Method

GetValue Method X

Name Method X
SetLabelProperty X
Method

SetProperty X
Method

SetValue Method X

86 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Object Interface Method Tables

Property Set Methods

Table 26 lists the property set methods.

Table 26. Property Set Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

AddChild Method X X X X X X X

Copy Method X X X X X X X

GetByteValue X
Method

GetChild Method X X X X X X X

GetChildCount X X X X X X X
Method

GetFirstProperty X X X X X X X
Method

GetLastErrCode X
Method

GetLastErrText X
Method

GetNextProperty X X X X X X X
Method

GetProperty X X X X X X X
Method

GetPropertyCount X X X X X X X
Method

GetType Method X X X X X X X

GetValue Method X X X X X X X

Siebel Object Interfaces Reference Version 8.1 87

 For Oracle internal distribution only
Interfaces Reference Object Interface Method Tables

Table 26. Property Set Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

InsertChildAt X X X X X X X
Method

PropertyExists X X X X X X X
Method

RemoveChild X X X X X X X
Method

RemoveProperty X X X X X X X
Method

Reset Method X X X X X X X

SetByteValue X
Method

SetProperty X X X X X X X
Method

SetType Method X X X X X X X

SetValue Method X X X X X X X

ToString Method X

Miscellaneous Methods
Table 27 lists miscellaneous methods.

Table 27. Miscellaneous Methods

Mobile Web Siebel

Web Client Client COM COM Java
Server Browser Automation Automation Data Data Data
Method Script Script Server Server Control Server Bean

GetErrorCode X
Method

GetErrorMessage X
Method

TheApplication X X
Method

88 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Object Interface Event Tables

Object Interface Event Tables

The object interface events are available in Server Script or Browser Script within Siebel Tools. This
section lists the Siebel interface events, grouped by object interface type:

Applet Events

Application Events on page 90

Business Component Events on page 90

Business Service Events on page 91

Applet Events
Table 28 lists the applet events.

Table 28. Applet Events

Server Browser
Event Script Script Comments

Applet_ChangeFieldValue Event X

Applet_ChangeRecord Event X

Applet_InvokeMethod Event X

Applet_Load Event X

Applet_PreInvokeMethod Event X

WebApplet_InvokeMethod Event X

WebApplet_Load Event X
WebApplet_PreCanInvokeMethod Event X

WebApplet_PreInvokeMethod Event X

WebApplet_ShowControl Event X Not available in high

interactivity mode

WebApplet_ShowListColumn Event X Not available in high

interactivity mode

Siebel Object Interfaces Reference Version 8.1 89

 For Oracle internal distribution only
Interfaces Reference Object Interface Event Tables

Application Events
Table 29 lists the application events.

Table 29. Application Events

Event Server Script Browser Script Comments

Application_Close Event X

Application_InvokeMethod Event X X

Application_Navigate Event X

Application_PreInvokeMethod Event X X

Application_PreNavigate Event X

Application_Start Event X

Business Component Events

Table 30 lists the application events.

Table 30. Business Component Events

Server Browser
Event Script Script Comments

BusComp_Associate Event X

BusComp_ChangeRecord Event X
BusComp_CopyRecord Event X

BusComp_DeleteRecord Event X

BusComp_InvokeMethod Event X

BusComp_NewRecord Event X

BusComp_PreAssociate Event X

BusComp_PreCopyRecord Event X

BusComp_PreDeleteRecord Event X

BusComp_PreGetFieldValue Event X

BusComp_PreInvokeMethod Event X

BusComp_PreNewRecord Event X

BusComp_PreQuery Event X

90 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Siebel Constants

Table 30. Business Component Events

Server Browser
Event Script Script Comments

BusComp_PreSetFieldValue Event X X Available only in high

interactivity mode.
Requires a field property to
be set for the event to be
immediately executed on
the server.

BusComp_PreWriteRecord Event X

BusComp_Query Event X

BusComp_SetFieldValue Event X

BusComp_WriteRecord Event X

Business Service Events

Table 31 lists the business service events.

Table 31. Business Service Events

Server Browser
Event Script Script Comments

Service_InvokeMethod Event X X

Service_PreCanInvokeMethod Event X X

Service_PreInvokeMethod Event X X

Siebel Constants
The Siebel programming languages provide constants for the convenience of programmers. These
constants are listed in Table 32. Use the constant names, rather than their integer values in your
code. Use of these constant names makes your code more readable by others, because it clarifies
your intentions. The integer values are included only to aid in debugging. A constants integer value
appears in the Debugger when the constant is stored in a local variable and the value of the local
variable is exposed.

Table 32. Siebel Constants

Used With Constant Name Integer Value

Pre Event Handler Methods ContinueOperation 1

CancelOperation 2

Siebel Object Interfaces Reference Version 8.1 91

 For Oracle internal distribution only
Interfaces Reference Applet Methods

Table 32. Siebel Constants

Used With Constant Name Integer Value

Search Methods ForwardBackward 256

ForwardOnly 257

NewRecord Method NewBefore 0

NewAfter 1

NewBeforeCopy 2
(Not available with Java Data Bean)

NewAfterCopy 3
(Not available with Java Data Bean)

Siebel ViewMode Methods SalesRepView 0

ManagerView 1

PersonalView 2

AllView 3

OrganizationView 5

GroupView 7

CatalogView 8

SubOrganizationView 9

Applet Methods
In the following methods, the placeholder Applet in the syntax represents an applet instance:

ActiveMode Method

BusComp Method on page 93

BusObject Method on page 93

FindActiveXControl Method on page 94

FindControl Method on page 95

InvokeMethod Method on page 96

Name Method on page 98

ActiveMode Method
ActiveMode returns a string containing the name of the current Web Template mode.

92 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Applet Methods

Syntax
Applet.ActiveMode

Argument Description

Not applicable

Returns
A string containing the name of the current Web Template mode.

Used With
Browser Script

Example
The following example is in Browser Script:

function Applet_Load ()
{
var currMode = this.ActiveMode();
alert("The active mode for the selected applet is: " + currMode);
}

BusComp Method
BusComp returns the business component that is associated with the applet.

Syntax
Applet.BusComp();

Argument Description

Not applicable

Returns
The business component associated with the applet.

Used With
Browser Script, Server Script

BusObject Method
BusObject returns the business object for the business component of the applet.

Siebel Object Interfaces Reference Version 8.1 93

 For Oracle internal distribution only
Interfaces Reference Applet Methods

Syntax
Applet.BusObject()

Argument Description

Not applicable

Returns
The business object for the applets business component.

Used With
Browser Script, Server Script

Example
The following example is in Browser Script:

function Applet_Load ()
{
var appletname = this.Name();
var currBO = this.BusObject();
var currBOName = currBO.Name();
alert("The active Business Object for the " + appletname + " is: " + currBOName);
}

The following example is in Siebel eScript:

function WebApplet_Load ()
{
var busObj = this.BusObject();
}

The following example is in Siebel VB:

Sub WebApplet_Load
Dim oBusObject As BusObject
Set oBusObject = Me.BusObject

End Sub

FindActiveXControl Method
FindActiveXControl returns a reference to a DOM element based upon the name specified in the name
argument.

94 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Applet Methods

Syntax
Applet.FindActiveXControl(controlName)

Argument Description

controlName Literal string or string variable containing the name of the desired control

Returns
The control object identified in controlName.

Usage
FindActiveXControl is used for finding controls on form applets. It does not locate list columns on list
applets.

Used With
Browser Script

Example
The following Browser Script example interacts with a Microsoft slide ActiveX control that has been
placed on a Siebel applet:

// Get a reference to the control

var SlideCtrl = FindActiveXControl("SliderControl");

// Display some of the ActiveX Control's properties

theApplication().SWEAlert ("element id = " + SlideCtrl.id);
theApplication().SWEAlert ("Max ticks = " + SlideCtrl.Max);

SlideCtrl.SelStart = 2; // Set a control property

SlideCtrl.Refresh(); // Call the control's Refresh method

var myCustomCtrl = FindActiveXControl("TestControl");

myCustomCtrl.TestProperty01 = "abc";
myCustomCtrl.Style.visible = "hidden"; // Use a Style sheet property

FindControl Method
FindControl returns the control whose name is specified in the argument. This applet must be part
of the displayed view.

Siebel Object Interfaces Reference Version 8.1 95

 For Oracle internal distribution only
Interfaces Reference Applet Methods

Syntax
Applet.FindControl(controlName)

Argument Description

controlName Literal string or string variable containing the name of the desired control

Returns
The control object identified in controlName.

Usage
FindControl does not find controls for MVG applets, Pick applets, Associate applets, or detail applets
that are not on the views applet list. It also does not locate list columns on list applets.

Used With
Browser Script

Example
To use this Browser Script example, read the notes for the SetLabelProperty Method on page 291.

function Applet_PreInvokeMethod (name, inputPropSet)

{
// Code to change the Font Size of the "Location" label
if (name == "fontsize")
{
// Use FindControl() to get a reference to the control
var ctl = this.FindControl("Location");

ctl.SetLabelProperty("FontSize", "22"); // Set the font size

return ("CancelOperation");
}
}

InvokeMethod Method
The InvokeMethod method invokes the specialized or custom method specified by its argument.

Browser Script Syntax

Applet.InvokeMethod(methodName, methodArgs_PropSet);

Argument Description

methodName The name of the method

methodArgs_PropSet Property set containing the method arguments

96 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Applet Methods

Server Script Syntax

Applet.InvokeMethod(methodName, methodArgs);

Argument Description

methodName The name of the method

methArg1, methArg2, , One or more strings containing arguments to methodName

methArgN

Returns
In Server Script, returns a string containing the result of the method.

In Browser Script, returns a property set.

Usage
Available to Browser and Server scripting. If the method to be invoked exists in the Browser, it
executes in the browser. Otherwise, the request is sent to the server for execution.

NOTE: The InvokeMethod method should only be used with documented methods. Oracle does not
support calling methods with InvokeMethod, unless they are listed in this book. Calling InvokeMethod
with an undocumented method is not supported. Undocumented methods may be modified or
obsoleted without notice. Use of undocumented methods is entirely at your own risk.

Used With
Browser Script, Server Script

Example
The following example is in Siebel eScript:

function WebApplet_PreInvokeMethod (MethodName)

{
//Invoke a Siebel SmartScript from a custom button
//using the applet.InvokeMethod method
//Note the InvokeSScriptFromButton is from a custom
//method added to a button
if (MethodName == "InvokeSScriptFromButton")
{
var iReturn = ContinueOperation;
var sArgs = new Array(3);
sArgs[0] = "Demo Opportunity Profile";
sArgs[1] = "";
sArgs[2] = "";
this.InvokeMethod("RunCallScript", sArgs);
iReturn = CancelOperation;
}
else
{
iReturn = ContinueOperation;

Siebel Object Interfaces Reference Version 8.1 97

 For Oracle internal distribution only
Interfaces Reference Applet Methods

}
return(iReturn);
}

Name Method
The Name method returns the name of the applet.

Syntax
Applet.Name()

Argument Description

Not applicable

Returns
A string containing the applet object name.

Used With
Browser Script, Server Script

Example
The following example is in Browser Script:

function Applet_Load ()
{
//Display the name of the applet when the applet loads using the
//applet.Name() method to obtain the name of the applet
var appletName;
appletName = this.Name();
alert("The name of the applet is: " + appletName);
}

The following example is in Siebel eScript:

function WebApplet_Load ()
{
//Display the name of the applet when the applet loads using the
//applet.Name() method to obtain the name of the applet
var appletName;
appletName = this.Name();
TheApplication().RaiseErrorText("The name of the applet is: " + appletName);
}

The following example is in Siebel VB:

98 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Applet Events

Sub WebApplet_Load
' Display the name of the applet when the applet loads using the
' applet.Name() method to obtain the name of the applet
Dim appletName As String
appletName = Me.Name
TheApplication.RaiseErrorText "The name of the applet is: " & appletName
End Sub

Applet Events
The following topics describe applet events:

Applet_ChangeFieldValue Event on page 99

Applet_ChangeRecord Event on page 101

Applet_InvokeMethod Event on page 101

Applet_Load Event on page 103

Applet_PreInvokeMethod Event on page 104

WebApplet_InvokeMethod Event on page 105

WebApplet_Load Event on page 106

WebApplet_PreCanInvokeMethod Event on page 108

WebApplet_PreInvokeMethod Event on page 109

WebApplet_ShowControl Event on page 110

WebApplet_ShowListColumn Event on page 112

Applet_ChangeFieldValue Event
The ChangeFieldValue event fires after the data in a field changes through the applet in the user
interface.

Syntax
Applet_ChangefieldValue(fieldname, fieldValue)

Argument Description

FieldName A string representing the name of the field whose value changed

FieldValue A string representing the new value assigned to FieldName

Returns
Not applicable

Siebel Object Interfaces Reference Version 8.1 99

 For Oracle internal distribution only
Interfaces Reference Applet Events

Usage
ChangeFieldValue fires after the data in a field changes, but not when a user moves to a different
record without changing a value in the previous record. If a user changes the value in a field, and
other dependent fields, such as calculated fields, change as a result, the event fires once for each
field whose value changed.

NOTE: This event does not trigger for changes made in pick applets or popup applets.

Used With
Browser Script

Example
The following example is in Browser Script:

function Applet_ChangeFieldValue (field, value)

{
try
{
switch (field)
{
case "Primary Revenue Committed Flag":
if (value == "Y")
{
var thisBC = this.BusComp();
var sRev = thisBC.GetFieldValue("Primary Revenue Amount");
var sUpside = thisBC.GetFieldValue("Primary Revenue Upside Amount");
var total = sRev + sUpside;
if (total < 500000)
{
thisBC.SetFieldValue("Primary Revenue Committed Flag", "N");
alert("Changing the Committed Flag to NO as $500,000 in Revenue +
Upside amount is required");
}
}
break;
}
}
catch(e)
{
alert("Error in ChangeFieldValue and error is " + e.toString() + " " +
e.errText());
}
}

Related Topic
Applet_ChangeRecord Event

100 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Applet Events

Applet_ChangeRecord Event
The ChangeRecord event is called when the user moves to a different row or view.

Syntax
Applet_ChangeRecord()

Argument Description

Not applicable

Returns
Not applicable

Used With
Browser Script

Example
The following example is in Browser Script:

function Applet_ChangeRecord ()
{
try
{
var thisBC = this.BusComp();
var sFlag = thisBC.GetFieldValue("Primary Revenue Committed Flag");
if (sFlag == "Y")
{
alert("This record cannot be update as its been Committed");
}
}
catch(e)
{
alert("Error in ChangeFieldValue and error is " + e.toString() + " " +
e.errText());
}
}

Related Topic
Applet_ChangeFieldValue Event on page 99

Applet_InvokeMethod Event
The InvokeMethod event is triggered by a call to applet.InvokeMethod or a specialized method, or
by a user-defined menu.

Siebel Object Interfaces Reference Version 8.1 10 1

 For Oracle internal distribution only
Interfaces Reference Applet Events

Syntax
Applet_InvokeMethod(name, inputPropSet)

Argument Description

Name The name of the method that is triggered.

inputPropSet A property set containing arguments to be passed to the InvokeMethod

event.

Returns
Not applicable

Usage
Typical uses include showing or hiding controls, or setting a search specification. When accessing a
business component from this event handler, use this.BusComp(), rather than
TheApplication.ActiveBusComp.

Used With
Browser Script

Example
Some special methods create, modify, or delete records. In some cases, events at the applet or
business component level are triggered by these actions. If there is a requirement to perform a
specific action before and after the method has been executed, these events can be used. In this
example, code has been added to the PreInvokeMethod and InvokeMethod applet events to set and
reset the flag and to the NewRecord server event to set the fields.

function Applet_PreInvokeMethod (name, inputPropSet)

{
if (name == "Quote")
{
// Add code that needs to be executed BEFORE the special method
// Set flag to "1"
TheApplication().SetProfileAttr("flag","1");
}

return ("ContinueOperation");
}

function Applet_InvokeMethod (name, inputPropSet)

{
if (name == "Quote")
{
// Add code that needs to be executed AFTER the special method

102 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Applet Events

// Reset the flag to "0"

TheApplication().SetProfileAttr("flag","0");
}

function BusComp_NewRecord ()
{
if (TheApplication().GetProfileAttr("flag")== "1" )
{
this.SetFieldValue ("Field1", "Value1");
this.SetFieldValue ("Field2", "Value2");
. . . . .
}

Related Topics
Applet_PreInvokeMethod Event on page 104
Application_InvokeMethod Event on page 172

Applet_Load Event
The Applet_Load event is triggered after an applet has loaded and after data is displayed.

Syntax
Applet_Load()

Argument Description

Not applicable

Returns
Not applicable

Usage
You can use this event with form applets to dynamically hide or manipulate controls or set properties
on an ActiveX Control. The following controls can be dynamically modified: CheckBox, ComboBox,
TextBox, TextArea, Label.

NOTE: Do not use the SWEAlert or RaiseErrorText methods in this event to display a popup. This can
cause the browser to crash if the application has not yet been fully rendered in the browser.

Siebel Object Interfaces Reference Version 8.1 10 3

 For Oracle internal distribution only
Interfaces Reference Applet Events

Used With
Browser Script

Example
Use this event to dynamically hide or manipulate controls or set properties on a control. The following
controls can be dynamically modified: CheckBox, ComboBox, Label, TextArea, and TextBox.

NOTE: This example is only applicable to code on form applets.

function Applet_Load ()
{
// Get the control instance.
var ctrl = this.FindControl("FirstName");

// Hide the control

ctrl.SetProperty("Visible","false");

// Hide the label

ctrl.SetLabelProperty("Visible", "hidden");
}

Applet_PreInvokeMethod Event
The PreInvokeMethod event is called before a specialized method is invoked, by a user-defined applet
menu, or by calling InvokeMethod on an applet.

Syntax
Applet_PreInvokeMethod(Name, inputPropSet)

Argument Description
inputPropSet A property set containing arguments to be passed to the PreInvokeMethod
event

Returns
ContinueOperation or CancelOperation

Usage
The PreInvokeMethod event is called just before a specialized method is invoked on the applet. If
implementing a new method (not defined by the built-in functions), the Basic script should return
CancelOperation to avoid invoking an Unknown Method Name error. Specialized methods are
methods based on applet or business component classes other than CSSFrame and CSSBusComp,
respectivelythat is, specialized classes.

104 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Applet Events

CancelOperation does not stop the execution of the code following it, but it does prevent the
execution of any built-in code associated with this event. Applet_PreInvokeMethod should return
CancelOperation when you are handling the event entirely through scripting and do not want the
built-in code to execute. However, if there is code in the same script following CancelOperation, that
code runs regardless of the CancelOperation.

Used With
Browser Script

Example
function Applet_PreInvokeMethod (name, inputPropSet)
{
if(name == 'NewRecord')
{
if(confirm("Are you sure you want to create a new record?"))
return ("ContinueOperation");
else
return ("CancelOperation");
return ("ContinueOperation");
}
}

Related Topic
How Your Script Affects Program Flow on page 64

WebApplet_InvokeMethod Event
The InvokeMethod event is called after a specialized method on the Web applet has been executed.
WebApplet_InvokeMethod triggers for Siebel-defined methods only, it does not trigger for user-
defined methods.

Syntax
WebApplet_InvokeMethod(methodName)

Argument Description

methodName String variable or literal containing the name of the method invoked.

Returns
Not applicable

Used With
Server Script

Siebel Object Interfaces Reference Version 8.1 10 5

 For Oracle internal distribution only
Interfaces Reference Applet Events

Example
The following example is in Siebel eScript:

switch (MethodName)
{
case "NewQuery":
TheApplication().SetSharedGlobal("EnableButton", "N"); break;
case "ExecuteQuery":
TheApplication().SetSharedGlobal("EnableButton", ""); break;
case "UndoQuery":
TheApplication().SetSharedGlobal("EnableButton", "");
break;
}

The following example is in Siebel VB:

Select Case MethodName

Case "NewQuery"
TheApplication.SetSharedGlobal "EnableButton", "N"
break
Case "ExecuteQuery"
TheApplication.SetSharedGlobal "EnableButton", ""
break
Case "UndoQuery"
TheApplication.SetSharedGlobal "EnableButton", ""
break
End Select

Related Topics
Applet_InvokeMethod Event on page 101
Application_InvokeMethod Event on page 172
WebApplet_PreCanInvokeMethod Event on page 108

WebApplet_Load Event
The Load event is triggered just after an applet is loaded.

Syntax
WebApplet_Load()

Argument Description

Not applicable

Returns
Not applicable

106 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Applet Events

Usage
Do not call TheApplication().ActiveBusObject from WebApplet_Load because it returns a null. Instead
use this.BusObject() to obtain a reference to the current business object.

Used With
Server Script

Example
The following example is in Siebel eScript:

function WebApplet_Load ()
{
try
{
var currBC = this.BusComp();
with (currBC)
{
SetViewMode(OrganizationView);
ClearToQuery();
SetSearchSpec("Last Name", "A*");
ExecuteQuery(ForwardBackward);
}
}
catch (e)
{
TheApplication().RaiseErrorText(e.errText);
}
}

The following example is in Siebel VB:

Sub WebApplet_Load
Dim iReturn As Integer
Dim currBC As BusComp
Set currBC = Me.BusComp
With currBC
.SetViewMode OrganizationView
.ClearToQuery
.SetSearchSpec "Last Name", "A*"
.ExecuteQuery
End With
End Sub

Related Topics
Applet_InvokeMethod Event on page 101
Application_InvokeMethod Event on page 172
WebApplet_PreCanInvokeMethod Event on page 108

Siebel Object Interfaces Reference Version 8.1 10 7

 For Oracle internal distribution only
Interfaces Reference Applet Events

WebApplet_PreCanInvokeMethod Event
The PreCanInvokeMethod event is called under the following conditions, allowing the script to
determine whether or not the user has the authority to invoke the applet method:

Before the PreInvokeMethod event is called

When the user steps to a different record

When an applet is loaded

When a different method, such as GetProfileAttr() or SetProfileAttr(), is called from Browser

Script

NOTE: It is often easier to enable and disable methods at the applet level declaratively, using the
CanInvokeMethod applet user property. For an example of this, see Invoking Custom Methods with
MiniButton Controls on page 425. For more information on the CanInvokeMethod user property, see
Siebel Developers Reference.

Syntax
WebApplet_PreCanInvokeMethod(MethodName, &CanInvoke)

Argument Description

MethodName A string representing the name of the method to be executed.

&CanInvoke A string representing whether or not the Applet method can be invoked. Valid
values are TRUE or FALSE.

NOTE: Using the FirstSelected business component method with the PreCanInvokeMethod event can
cause unexpected behavior in pick applets invoked from the applet where this event is called.

Returns
CancelOperation or ContinueOperation

Used With
Server Script

Example
The following example is in Siebel eScript:

function WebApplet_PreCanInvokeMethod (MethodName, &CanInvoke)

{
if ( MethodName == "CustomMethod" )
{
CanInvoke = "TRUE";
return( CancelOperation );

108 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Applet Events

}
return (ContinueOperation);
}

The following example is in Siebel VB:

Function WebApplet_PreCanInvokeMethod (MethodName As String, CanInvoke As String)

As Integer
Dim iReturn As Integer
iReturn = ContinueOperation
If MethodName = "Test" Then
CanInvoke = "TRUE"
iReturn = CancelOperation
End If
WebApplet_PreCanInvokeMethod = iReturn
End Function

WebApplet_PreInvokeMethod Event
The PreInvokeMethod event is called before a specialized method for the Web applet is invoked or a
user-defined method is invoked through oWebApplet.InvokeMethod.

Syntax
WebApplet_PreInvokeMethod(methodName)

Argument Description

methodName String variable or literal containing the name of the method invoked

Returns
ContinueOperation or CancelOperation

Usage
The PreInvokeMethod event is called just before a specialized method is invoked on the Web applet.
If implementing a new method (not defined by the built-in functions), the script should return
CancelOperation to avoid invoking an Unknown Method Name error.

CancelOperation does not stop the execution of the code following it, but it does prevent the
execution of any built-in code associated with this event. WebApplet_PreInvokeMethod should return
CancelOperation when you are handling the event entirely through scripting and you do not want the
built-in code to execute. However, if there is code in the same script following CancelOperation, that
code runs regardless of the CancelOperation.

Used With
Server Script

Siebel Object Interfaces Reference Version 8.1 10 9

 For Oracle internal distribution only
Interfaces Reference Applet Events

Example
The following example is in Siebel eScript:

function WebApplet_PreInvokeMethod (MethodName)

{
switch (MethodName)
{
case "CustomMethod":
var applet = this;
var BC = applet.BusComp();
var ConId = BC.GetFieldValue("Contact Id");
var WshShell = COMCreateObject("WScript.Shell");
WshShell.Popup("My Custom Method was called. Here is the ID " + ConId);
return(CancelOperation);
break;
}
return (ContinueOperation);
}

The following example is in Siebel VB:

Function WebApplet_PreInvokeMethod (MethodName As String) As Integer

Dim iReturn As Integer
iReturn = ContinueOperation
Select Case MethodName
Case "CustomMethod"
Dim oBusComp As BusComp
Set oBusComp = Me.BusComp
Dim WshShell As Object
ConId = oBusComp.GetFieldValue("Contact Id")
Set WshShell = CreateObject("WScript.Shell")
WshShell.Popup("My Custom Method was called. Here is the ID " & ConId)
iReturn = CancelOperation
End Select
WebApplet_PreInvokeMethod = iReturn
End Function

WebApplet_ShowControl Event
This event allows scripts to modify the HTML generated by the Siebel Web Engine to render a control
on a Web page in an application running in standard interactivity mode.

110 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Applet Events

Syntax
WebApplet_ShowControl (controlName, property, mode, HTML)

Argument Description

controlName A string indicating the name of the control to be rendered.

property A string indicating the value of the property attribute of the swe:control or
swe:this tag that triggers this event; it can also be an empty string if this
attribute is not specified for the tag.

mode The mode of the applet that is being shown; possible modes are:

Base

Edit

New
Query

Sort
HTML The HTML generated by the Siebel Web Engine for the swe:control or
swe:this tag that triggers this event.

Returns
Not applicable

Usage
The generated HTML depends on the control, the property being shown, and the mode of the applet.
The script can modify the value of the HTML argument, and the Siebel Web Engine sends the modified
value back to the Web browser.

Customer applications render the layout of applets using template files (.swt files). These are HTML
files that contain special placeholder tags that indicate where a control is to be rendered. These
control placeholder tags (<swe:control>) can be included in the following two ways:

The <swe:control> tag by itself is used to show a control:

<swe:control id="1" property="DisplayName"/>

The <swe:control> tag and <swe:this> tag are used to show a control:

<swe:control id="1">
.
.
.
<swe:this property="DisplayName"/>
.
.
.
</swe:control>

Siebel Object Interfaces Reference Version 8.1 11 1

 For Oracle internal distribution only
Interfaces Reference Applet Events

In the first instance, if the control ID is mapped to an actual control in the applet using Siebel Tools,
Siebel Web Engine renders the DisplayName property of the control at the point where this tag is
placed in the template file.

In the second instance, the Siebel Web Engine renders the DisplayName property of the control at
the point where the <swe:this> tag is placed in the template file. The outer <swe:control> tag in
this case is used only to check if the control ID is mapped to an actual control in the applet.

The Siebel Web Engine converts these tags into HTML to render the controls on the Web page. The
WebApplet_ShowControl event is triggered for each of these tags after the Siebel Web Engine has
generated the HTML for rendering the control, but before the generated HTML is sent back to the
browser. This gives the scripts a chance to modify the generated HTML before it is shown.

In the first example, the event fires only once, after the Siebel Web Engine generates the HTML for
the <swe:control> tag. In the second example, this event gets fired twice. The event is first fired
when the Siebel Web Engine has generated the HTML for the <swe:this> tag. The event is fired
again when the Siebel Web Engine has generated the HTML for the outer <swe:control> tag; that
is, after everything between the <swe:control> and </swe:control> tags, including the <swe:this>
tag, is converted into HTML. The script can distinguish between these two event calls by the value
of the property attribute of the tag that is passed as an argument to the event.

The WebApplet_ShowControl event is supported in Standard Activity applications only.

Used With
Server Script

Example
This Siebel eScript script displays negative amounts in red in a read-only form:

function WebApplet_ShowControl (ControlName, Property, Mode, &HTML)

{
var BC = this.BusComp();
if( ControlName == "Amount" && Mode == "Base" && Property == "FormattedHTML")
{
var amount = ToNumber(BC.GetFieldValue ("Transaction Amount"));
if (amount < 0)
HTML = "<FONT Color=Red> " + HTML + " </FONT>";
}
}

WebApplet_ShowListColumn Event
This event allows scripts to modify the HTML generated by the Siebel Web Engine to render a list
column on a Web page in an application running in standard interactivity mode.

112 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Applet Events

Syntax
WebApplet_ShowListColumn (columnName, property, mode, HTML)

Argument Description

columnName A string indicating the name of the list column to be rendered

property A string indicating the value of the property attribute of the swe:control or
swe:this tag that triggers this event; it can also be a empty string if this
attribute is not specified for the tag.

mode The mode of the applet that is being shown; possible modes are:

Base

Edit

New
Query

Sort
HTML The HTML generated by the Siebel Web Engine for the swe:control or swe:this
tag that triggers this event

Returns
Not applicable

Usage
The generated HTML depends on the list column, the property being shown, and the mode of the
applet. The script can modify the value of the HTML argument, and the Siebel Web Engine sends the
modified value back to the Web browser.

Customer applications render the layout of applets using template files (.swt files). These are HTML
files that contain special placeholder tags that indicate where a control is to be rendered. These
control placeholder tags (<swe:control>) can be included in the following two ways:

The <swe:control> tag by itself is used to show a list column:

<swe:control id="1" property="DisplayName"/>

The <swe:control> tag and <swe:this> tag are used to show a list column:

<swe:control id="1">
.
.
.
<swe:this property="DisplayName"/>
.
.
.
</swe:control>

Siebel Object Interfaces Reference Version 8.1 11 3

 For Oracle internal distribution only
Interfaces Reference Applet Events

In the first instance, if the list column ID is mapped to a list column in the applet using Siebel Tools,
Siebel Web Engine renders the DisplayName property of the list column at the point where this tag
is placed in the template file.

In the second instance, the Siebel Web Engine renders the DisplayName property of the list column
at the point where the <swe:this> tag is placed in the template file. The outer <swe:control> tag
in this case is used only to check if the list column ID is mapped to an actual list column in the applet.

The Siebel Web Engine converts these tags into HTML to render the list columns on the Web page.
The WebApplet_ShowListColumn event is triggered for each of these tags after the Siebel Web Engine
has generated the HTML for rendering the list column, but before the generated HTML is sent back
to the browser. This gives the scripts a chance to modify the generated HTML before it is shown.

In the first example, the event fires only once, after the HTML for the <swe:control> tag is generated
by the Siebel Web Engine. In the second example, this event is triggered twice. The event is first
triggered when the Siebel Web Engine has generated the HTML for the <swe:this> tag. The event
is fired again when the Siebel Web Engine has generated the HTML for the outer <swe:control> tag;
that is, after everything between the <swe:control> and </swe:control> tags, including the
<swe:this> tag, is converted into HTML. The script can distinguish between these two event calls by
the value of the property attribute of the tag that is passed as an argument to the event.

The WebApplet_ShowListColumn event is supported in Standard Activity applications only.

Used With
Server Script

Example
This Siebel VB script displays negative amounts in a list in red:

Sub WebApplet_ShowListColumn (ColumnName As String, Property As String, Mode As

String, HTML As String)

Dim amount as Double

If ColumnName = "Amount" and Mode = "Base" and Property = "FormattedHTML" Then

If HTML < 0 Then
HTML = "<FONT Color=Red> " + HTML + " </FONT>"
End If
End If
End Sub

The following example is in Siebel eScript:

function WebApplet_ShowListColumn (ColumnName, Property, Mode, &HTML)

{
if ((ColumnName == 'Amount') && (Mode == "Base") && (Property == "FormattedHTML"))
{
var val - HTML.valueOf();
if (val < 0)
HTML = "<FONT Color=Red> " + HTML + " </FONT>";
}
}

114 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Application Methods
The following methods are built-in methods that return the current Siebel Application object
instance:

TheApplication when called from Siebel VB within Siebel Tools,

TheApplication() (case-sensitive) when called from Siebel eScript within Siebel Tools

theApplication() (case-sensitive) when called from Browser Script within Siebel Tools

If an Application method applies to one scripting language, then the Syntax definition in the methods
section includes TheApplication, TheApplication(), or theApplication() specifically.

If a method applies to external interfaces or to more than one scripting language, and thus to more
than one syntax, then the Syntax definition includes Application, which denotes that:

The applicable construct should be substituted for Application in Siebel VB, Siebel eScript, or
Browser Script

The name of an Application instance should be substituted for Application when you use external
interfaces.

Examples of Application methods used by external interfaces frequently include SiebelApplication

as the Application instance. You should understand that the examples assume that
SiebelApplication is instantiated in the script, whether the instantiation statement is included in
the example or not.

This section includes documentation for the following Application methods:

ActiveApplet Method on page 116

ActiveBusComp Method on page 117

ActiveBusObject Method on page 118

ActiveViewName Method on page 120

Attach Method on page 121

CurrencyCode Method on page 123

Detach Method on page 124

EnableExceptions Method on page 125

FindApplet Method on page 127

GetBusObject Method on page 127

GetDataSource Method on page 139

GetLastErrCode Method on page 129

GetLastErrCode Method on page 129

GetLastErrText Method on page 130

GetProfileAttr Method on page 131

GetService Method on page 131

Siebel Object Interfaces Reference Version 8.1 11 5

 For Oracle internal distribution only
Interfaces Reference Application Methods

GetSharedGlobal Method on page 134

GotoView Method on page 135

InvokeMethod Method on page 138

IsViewReadOnly Method on page 140

LoadObjects Method on page 143

Login Method on page 145

LoginId Method on page 147

LoginName Method on page 147

Logoff Method on page 148

LookupMessage Method on page 149

LookupValue Method on page 141

Name Method on page 150

NewPropertySet Method on page 150

PositionId Method on page 152

PositionName Method on page 153

RaiseError Method on page 154

RaiseErrorText Method on page 155

SetPositionId Method on page 157

SetPositionName Method on page 158

SetProfileAttr Method on page 158

SetSharedGlobal Method on page 160

ShowModalDialog Method on page 162

SWEAlert Method on page 164

Trace Method on page 165

TraceOff Method on page 167

TraceOn Method on page 168

ActiveApplet Method
ActiveApplet returns a reference to the applet that currently has focus.

116 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Syntax
theApplication().ActiveApplet();

Argument Description

Not applicable

Returns
The name of the applet instance that has focus

Usage
Use this method to determine which applet currently has focus. The applet typically has a blue border
to show that it is active.

Used With
Browser Script

Example
function Applet_PreInvokeMethod (name, inputPropSet)
{
switch (name)
{
case "Drilldown":
var activeapplet = theApplication().ActiveApplet();
var activeappletname = activeapplet.Name();
alert("Here is the applet we are drilling down from " + activeappletname);
break;
}
return ("ContinueOperation");
}

ActiveBusComp Method
ActiveBusComp returns the business component associated with the active applet.

Syntax
theApplication().ActiveBusComp();

Argument Description
Not applicable

Siebel Object Interfaces Reference Version 8.1 11 7

 For Oracle internal distribution only
Interfaces Reference Application Methods

Returns
The business component associated with the active applet

Used With
Browser Script

Example
function Applet_Load ()
{
var activeBC = theApplication().ActiveBusComp();
activeBC = activeBC.Name();
alert(activeBC);
}

ActiveBusObject Method
ActiveBusObject returns the business object of the active view.

Syntax
Application.ActiveBusObject

Argument Description

Not applicable

Returns
The business object of the active view

Usage
Do not use ActiveBusObject in any event handler that may be initiated by the COM Data Server, COM
Data Control, or Java Data Bean. If you use ActiveBusObj() you get the business object that exists
already (if there is one). If you use GetBusObject() instead, any child Business components are
ALWAYS new ones, even if you have some already.

Used With
Browser Script, Mobile Web Client Automation Server, Server Script

Example
The following example is in Browser Script:

function Applet_Load ()
{
var oBusObj;

118 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

oBusObj = theApplication().ActiveBusObject();
theApplication().SWEAlert("The active business object is " + oBusObj.Name() +
".")
}

The following samples show an example of server side script that could be invoked from a custom
button on a child applet within a view. The script first checks to see if the Contact business object is
active, and if so, retrieves the email address of the currently active parent Contact record. The
custom 'SendEmail()' function is then invoked using the Contact's email address. Note that the
objects are not destroyed at the end of the script, as they are the ones that are currently active in
the user interface.

The following example is in Siebel eScript:

function WebApplet_PreInvokeMethod (MethodName)

{
if (MethodName == "Send Email")
{
var oBO = TheApplication().ActiveBusObject();

if (oBO.Name() == "Contact")
{
var oBC = oBO.GetBusComp("Contact");
var sEmail = oBC.GetFieldValue("Email Address");

SendMail(sEmail);

sEmail ="";
}
return (CancelOperation);
}
return (ContinueOperation);
}

The following example is in Siebel VB:

Function WebApplet_PreInvokeMethod (MethodName As String) As Integer

Dim iRtn As Integer

iRtn = ContinueOperation

If MethodName = "Send Email" Then

Dim oBO As BusObject

Set oBO = TheApplication.ActiveBusObject()

If oBO.Name() = "Contact" Then

Dim oBC As BusComp

Dim sEmail As String

Set oBC = oBO.GetBusComp("Contact")

sEmail = oBC.GetFieldValue("Email Address")

SendEmail(sEmail)

Siebel Object Interfaces Reference Version 8.1 11 9

 For Oracle internal distribution only
Interfaces Reference Application Methods

sEmail =""

End If

iRtn = CancelOperation

End If

WebApplet_PreInvokeMethod = iRtn
End Function

ActiveViewName Method
ActiveViewName returns the name of the active view.

Syntax
Application.ActiveViewName

Argument Description

Not applicable

Returns
A string containing the active view name

Usage
Do not use the ActiveViewName method in any event handler that may be initiated by the COM Data
Server, COM Data Control, or Java Data Bean.

Used With
Browser Script, Mobile Web Client Automation Server, Server Script

Example
The following example is in Siebel eScript:

function BusComp_PreSetFieldValue (FieldName, FieldValue)

{
switch(FieldName)
{
case "Name":
case "Location":
case "Account Status":
case "Alias":
case "City":
case "Country":
case "Currency Code":

120 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

case "Current Volume":

case "DUNS Number":
case "Expertise":
case "Freight Terms":
case "Freight Terms Info":
case "Home Page":
case "Industry":
case "Location":
case "Main Phone Number":
case "Main Fax Number":
case "Sales Rep":
var sActiveViewName = TheApplication().ActiveViewName();
if (sActiveViewName == "All Accounts across Organizations")
{
TheApplication().RaiseErrorText("You cannot update the " + FieldName +
" on the " + sActiveViewName + " View");
}
break;
}
return (ContinueOperation);
}

Attach Method
The Attach method allows an external application to reconnect to an existing Siebel session.

Syntax
Application.Attach(sessionString)

Argument Description

sessionString A string containing the Siebel Session Id. The sessionString is typically the
output of the Detach method.

Returns
Boolean indicating whether or not the method was successfully executed

Used With
COM Data Control, Java Data Bean

Examples
Each of these examples instantiates the first COM Data Control instance, logs in to a Siebel Server,
detaches this instance, and then gains the session string. It then instantiates the second COM Data
Control instance. It does not need to log in again, as it attaches to the existing session by using the
session string. This reuses the connection created by the first instance.

Siebel Object Interfaces Reference Version 8.1 12 1

 For Oracle internal distribution only
Interfaces Reference Application Methods

The following example is for COM Data Control and is written in native Visual Basic:

Dim SiebelApplication_first As SiebelDataControl

Dim SiebelApplication_second As SiebelDataControl
Dim errCode As Integer
Dim sessionString As String
Dim attachResult As Boolean
Dim errText As String

' Instantiate the first instance

Set SiebelApplication_first = CreateObject("SiebelDataControl.SiebelDataControl.1")

' Login to Siebel

SiebelApplication_first.Login "host=""Siebel.tcpip.none.none://<virtual
ip>:<port>/<enterprise>/<object manager>""", "<user id>", "<password>"

errCode = SiebelApplication_first.GetLastErrCode
If errCode <> 0 Then
errText = SiebelApplication_first.GetLastErrText
MsgBox errText
Exit Sub
End If

' Detach this instance from Siebel and get session id

sessionString = SiebelApplication_first.Detach
MsgBox "The session string is: " & sessionString

' Instantiate the second instance

Set SiebelApplication_second =
CreateObject("SiebelDataControl.SiebelDataControl.1")

' Attach the existing session to this instance

attachResult = SiebelApplication_second.Attach(sessionString)
If (attachResult = True) Then
MsgBox "Session attached!"
Else
MsgBox "Session attach failed"
End If

SiebelApplication_second.LogOff
Set SiebelApplication_second = Nothing
Set SiebelApplication_first = Nothing

The following example is for Java Data Bean:

import com.siebel.data.*;
import com.siebel.data.SiebelException;

public class JDBAttachDetachDemo

{
private SiebelDataBean m_dataBean_first = null;
private SiebelDataBean m_dataBean_second = null;

122 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

public static void main(String[] args)

{
JDBAttachDetachDemo demo = new JDBAttachDetachDemo();
}

public JDBAttachDetachDemo()
{
try
{
// Instantiate the Siebel Data Bean
m_dataBean_first = new SiebelDataBean();

// Login to the servers

m_dataBean_first.login("siebel.tcpip.none.none://<virtualip>:2320/
<enterprise>/<object manager name>","<user id>","<password>");

System.out.println("Logged in to the Siebel server ");

//Get the Detach Handle

String detachHandle = m_dataBean_first.detach();
System.out.println("The session id is: " + detachHandle);

// Instantiate another Java Data Bean

SiebelDataBean m_dataBean_second = new SiebelDataBean();

// Do Attach
System.out.println("Attaching in to the Siebel server ");
m_dataBean_second.attach(detachHandle);
System.out.println("Attach Done ");

// Logoff
m_dataBean_second.logoff();
}

catch (SiebelException e)
{
System.out.println(e.getErrorMessage());
}
}
}

CurrencyCode Method
CurrencyCode returns the operating currency code associated with the division to which the users
position has been assigned.

Siebel Object Interfaces Reference Version 8.1 12 3

 For Oracle internal distribution only
Interfaces Reference Application Methods

Syntax
Application.CurrencyCode

Argument Description

Not applicable

Returns
A string containing the currency code; for example, USD for U.S. dollars, EUR for the euro, JPY for
the Japanese yen.

Used With
Browser Script, COM Data Control, COM Data Server, Web Client Automation Server, Server Script

Example
The following example is in Siebel eScript:

function WebApplet_Load ()
{
var currencycode;
currencycode = TheApplication().CurrencyCode();
var WshShell = COMCreateObject("WScript.Shell");
WshShell.Popup(currencycode);
}

Detach Method
The Detach method returns a string containing the Siebel session Id.

Syntax
Application.Detach

Argument Description

Not applicable

Returns
String containing the Siebel session Id.

Usage
The string returned by the Detach method should only be used with the Attach method.

124 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Used With
COM Data Control, Java Data Bean

Examples
For a Java Data Bean sample and a native VB sample using COM Data Control, read Attach Method
on page 121.

EnableExceptions Method
The EnableExceptions method enables or disables native COM error handling.

Syntax
Application.EnableExceptions(bEnable)

Argument Description

bEnable A Boolean: TRUE or FALSE

Returns
Not applicable

Usage
Setting the argument to TRUE enables native error handling. This allows applications to intercept and
display the exception ID and description. Native COM error handling is disabled by default.

Used With
COM Data Control, Mobile Web Client Automation Server

Examples
This native Visual Basic script uses the Siebel ActiveX Data Control to connect to the Siebel
Application and instantiate a business object. The script prompts the user to select whether the
native error handling is to be enabled or not. If yes, the script throws the error immediately when it
gets an error. If not, the script suppresses Siebel errors and errors are only detected by using
GetLastErrCode method.

Dim SiebelApplication As SiebelDataControl

Dim errCode As Integer
Dim wrongBO As SiebelBusObject

Dim nativeHandle As String

Set SiebelApplication = CreateObject("SiebelDataControl.SiebelDataControl.1")

' Login to Siebel

Siebel Object Interfaces Reference Version 8.1 12 5

 For Oracle internal distribution only
Interfaces Reference Application Methods

SiebelApplication_first.Login "host=""Siebel.tcpip.none.none://<virtual
ip>:<port>/<enterprise>/<object manager>""", "<user id>", "<password>"

nativeHandle = InputBox("Use native error handling?", "", "Yes")

If nativeHandle = "Yes" Then

SiebelApplication.EnableExceptions (True)
Else
SiebelApplication.EnableExceptions (False)
End If

Set wrongBO = SiebelApplication.GetBusObject("No Such One") 'intended to create an

error at this line by instantiating a non-existing Business Object

errCode = SiebelApplication.GetLastErrCode()
If errCode <> 0 Then 'if native error handle is disabled, this block detects it
ErrText = SiebelApplication.GetLastErrText
MsgBox ErrText
Exit Sub
End If

This Visual Basic sample code uses the Siebel Mobile Automation Server to connect to the Siebel
Application and instantiate a business object. The program prompts the user to select whether the
native error handling is to be enabled or not. If yes, the script throws the error immediately when it
gets an error. If not, the script suppresses Siebel errors and errors are only detected by using
GetLastErrCode method.

Dim SiebelApp As SiebelWebApplication

Dim errCode As Integer
Dim wrongBO As SiebelBusObject

Set SiebelApp = CreateObject("TWSiebel.SiebelWebApplication.1")

Dim nativeHandle As String

nativeHandle = InputBox("Use native error handle?", "", "Yes")

If nativeHandle = "Yes" Then

SiebelApp.EnableExceptions (True)
Else
SiebelApp.EnableExceptions (False)
End If

Set wrongBO = SiebelApp.GetBusObject("No Such One") 'intended to create an error at

this line by instantiating a non-existing Business Object

errCode = SiebelApp.GetLastErrCode()
If errCode <> 0 Then 'if native error handle is disabled, this block detects it
ErrText = SiebelApp.GetLastErrText
MsgBox ErrText
Exit Sub
End If

126 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

FindApplet Method
FindApplet returns the applet that is identified by the appletName argument.

Syntax
theApplication().FindApplet(appletName)

Argument Description

appletName String variable or literal containing the name of the desired applet.

Returns
The applet identified in appletName

Usage
The only applets available are applets visible in the active view.

Used With
Browser Script

Example
The following example is in Browser Script:

function Applet_ChangeFieldValue (field, value)

{
if (theApplication().ActiveViewName() == "Account List View")
{
var newapplet = theApplication().FindApplet("Account Entry Applet");
var entryappletcontrol = newapplet.FindControl("Name");
var entryappletvalue = entryappletcontrol.GetValue();
alert(entryappletvalue);
}
}

GetBusObject Method
The GetBusObject method instantiates and returns a new instance of the business object specified
in its argument.

Siebel Object Interfaces Reference Version 8.1 12 7

 For Oracle internal distribution only
Interfaces Reference Application Methods

Syntax
Application.GetBusObject(busObjectName)

Argument Description

busObjectName String variable or literal containing the name of the business object to
instantiate.

Returns
The business object instance specified in the argument

Usage
Set the business object to Nothing to destroy the instantiated business object after it is no longer
needed. If you use ActiveBusObj() you get the business object that exists already (if there is one).
If you use GetBusObject() instead, any child business components are ALWAYS new ones, even if
you have some already.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Examples
The following examples always instantiate and return a new instance of the business object specified
in the argument, which is the Account business object.

The following example is in Siebel eScript:

var oBusObject = TheApplication().GetBusObject("Account");

var oBusComp = oBusObject.GetBusComp("Account");

[ Your code here ]

oBusComp = null;
oBusObject = null;

The following example is in Siebel VB:

Dim AccntBO as BusObject

Dim AccntBC as BusComp
Dim AddrBC as BusComp
Set AccntBO = TheApplication.GetBusObject("Account")
Set AccntBC = AccntBO.GetBusComp("Account")

[ your code here]

Set AccntBO = Nothing

Set AccntBC = Nothing

128 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

The following examples instantiate and return a new instance of the business object as did the
previous example. However, the difference is that the business object returned could vary depending
on the location from which the code is invoked, such as a Web applet event. This is useful when you
want to refer to the currently active business object.

The following example is for Java Data Bean:

private SiebelDataBean m_dataBean = null;

private SiebelBusObject m_busObject = null;
m_busObject = m_dataBean.getBusObject("Opportunity");

The following example is in Siebel eScript:

var oBO = TheApplication().GetBusObject(this.BusObject.Name);

The following example is in Siebel VB:

Dim oBO as BusObject

Dim oBC as BusComp
Set oBO = TheApplication.GetBusObject(Me.BusObject.Name)

GetLastErrCode Method
The GetLastErrCode method returns the last error execution status.

Syntax
Application.GetLastErrCode

Argument Description

Not applicable

Returns
A short integer containing the last error execution status: 0 indicates no error.

Usage
After execution of a method, the GetLastErrCode can be invoked to check if any error was returned
from the previous operation. GetLastErrText method can be invoked to retrieve the text of the error
message. Each method invocation resets the execution status.

Used With
COM Data Control, COM Data Server, Mobile Web Client Automation Server, Web Client Automation
Server

Example
The following example is for COM Data Control. SiebelApplication is an Application instance.

Siebel Object Interfaces Reference Version 8.1 12 9

 For Oracle internal distribution only
Interfaces Reference Application Methods

errcode = SiebelApplication.GetLastErrCode
If errcode <> 0 Then
ErrText = SiebelApplication.GetLastErrText
MsgBox ErrText
Exit Sub
End If

Related Topic
GetLastErrText Method on page 130

GetLastErrText Method
The GetLastErrText method returns the last error text message.

Syntax
Application.GetLastErrText

Argument Description

Not applicable

Returns
The last error text message as a string

Used With
COM Data Control, COM Data Server, Mobile Web Client Automation Server, Web Client Automation
Server

Example
The following example is for COM Data Control. SiebelApplication is an Application instance.

errcode = SiebelApplication.GetLastErrCode
If errcode <> 0 Then
ErrText = SiebelApplication.GetLastErrText
MsgBox ErrText
Exit Sub
End If

Related Topic
GetLastErrCode Method on page 129

130 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

GetProfileAttr Method
GetProfileAttr returns the value of an attribute in a user profile.

Syntax
Application.GetProfileAttr(name)

Argument Description

name A string indicating the name of the attribute

Returns
The value of the attribute name

Usage
GetProfileAttr is used in personalization to retrieve values of attributes in a user profile. It cannot be
used with system fields, except Id, because they are not explicitly defined in the Personalization
Profile business component. For more information on profile attributes, see Siebel Personalization
Administration Guide.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Examples
The following example is in Browser Script:

var myprofile = theApplication().GetProfileAttr("Hobby");

The following example is in Siebel eScript:

var myprofile = TheApplication().GetProfileAttr("Hobby");

The following example is in Siebel VB:

Dim myprofile As String

myprofile = TheApplication.GetProfileAttr("Hobby")

Related Topic
SetProfileAttr Method on page 158

GetService Method
The GetService method returns a specified business service. If the business service is not already
running, it is constructed.

Siebel Object Interfaces Reference Version 8.1 13 1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Syntax
Application.GetService(serviceName)

Argument Description

serviceName The name of the service to start

Returns
A reference to the requested business service

Usage
This method finds the business service indicated by serviceName; it constructs the service if it is not
already running. It first searches through the built-in services that are stored in the repository. If
the business service is not found, GetService searches through services defined in the run-time
Business Services table.

A business service is normally deleted from memory as soon as every reference to it, such as local
or global variables, is cleared by setting it to another value. However, if the Cache flag on the
business service is set, the service remains in memory as long as the Siebel application is running.

To invoke a business service using the Web Client Automation Server and Browser Script, the
business service must first be registered in Siebel Tools as an application user property. This prevents
Service Not Found errors.

To register a business service

1 In Siebel Tools, select the Application object in the Object Explorer.

2 Select the desired application, for example Siebel Universal Agent, in the Object List Editor.

3 In the Object Explorer, expand the Application object, and then choose Application User Prop.
4 In the Object List Editor, create new application user property records as needed:

Name Value

ClientBusinessService0 XML Converter

ClientBusinessService1 My Business Service

NOTE: ClientBusinessServicen entries must be sequential, starting at 0 and incrementing by 1.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Examples
The following examples instantiate a business service named Workflow Process Manager.

132 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

The following example is in Browser Script:

function Applet_PreInvokeMethod (name, inputPropSet)

{
if (name == "MyCustomMethod")
{
var oBS;
var inpPS;
var outPS;
inpPS = theApplication().NewPropertySet();
outPS = theApplication().NewPropertySet();
oBS = theApplication().GetService("Workflow Process Manager");
outPS = oBS.InvokeMethod("RunProcess", inpPS);
inpPS = null;
outPS = null;
return ("CancelOperation");
}
else
{
return ("ContinueOperation");
}
}

The following example is in Siebel eScript:

function WebApplet_PreInvokeMethod (MethodName)

{
if (MethodName == "MyCustomMethod")
{
var oBS;
var inpPS;
var outPS;
inpPS = TheApplication().NewPropertySet();
outPS = TheApplication().NewPropertySet();
oBS = TheApplication().GetService("Workflow Process Manager");
oBS.InvokeMethod("RunProcess", inpPS, outPS);
inpPS = null;
outPS = null;
oBS = null;
return (CancelOperation);
}
else
{
return (ContinueOperation);
}
}

The following example is in Siebel VB:

Function WebApplet_PreInvokeMethod (MethodName As String) As Integer

If MethodName = "MyCustomMethod" Then
Dim oBS As Service
Dim inpPS As PropertySet
Dim outPS As PropertySet
Set inpPS = TheApplication.NewPropertySet

Siebel Object Interfaces Reference Version 8.1 13 3

 For Oracle internal distribution only
Interfaces Reference Application Methods

Set outPS = TheApplication.NewPropertySet

Set oBS = TheApplication.GetService("Workflow Process Manager")
oBS.InvokeMethod "RunProcess", inpPS, outPS
Set inpPS = Nothing
Set outPS = Nothing
Set oBS = Nothing
WebApplet_PreInvokeMethod = CancelOperation
Else
WebApplet_PreInvokeMethod = ContinueOperation
End If
End Function

GetSharedGlobal Method
Shared global variables are unique to the user and the users associated session. One user's global
variables are not visible to other users. The variables are global to the current user and session only.
The GetSharedGlobal method gets the shared user-defined global variables.

Syntax
Application.GetSharedGlobal(varName)

Argument Description

varName String literal or variable containing the name of the global variable

Returns
A string containing the user-defined global variables.

Usage
GetSharedGlobal("varName")

retrieves the string set by:

SetSharedGlobal "varName", "stringValue".

Used With
COM Data Control, COM Data Server, Mobile Web Client Automation Server, Server Script

Examples
In the following examples, the GetSharedGlobal method is called to get a global variable called
myGlobalVar. The global variable was originally set using the SetSharedGlobal method in the
Application_Start event. The global variable can be accessed from any event. For these examples, in
the BusComp_WriteRecord event, the GetSharedGlobal method is called to retrieve myGlobalVar.

The following example is for COM. SiebelApplication is an Application instance.

134 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Dim sReturn as String

oleVar = SiebelApplication.GetSharedGlobal("myGlobalVar", errCode)
SiebelApplication.SetSharedGlobal "myGlobalVar", " helloworld", errCode

The following example is in Siebel eScript:

function Application_Start (CommandLine)

{
TheApplication().SetSharedGlobal("myGlobalVar", "helloworld");
}

function BusComp_WriteRecord ()
{
var myVar;
myVar = TheApplication().GetSharedGlobal("myGlobalVar");
}

The following example is in Siebel VB:

Sub Application_Start (CommandLine As String)

TheApplication.SetSharedGlobal "myGlobalVar", "helloworld"
End Sub

Sub BusComp_WriteRecord
Dim myVar as String
myVar = TheApplication.GetSharedGlobal("myGlobalVar")
End Sub

Related Topic
SetSharedGlobal Method on page 160

GotoView Method
GotoView activates the named view and its BusObject. As a side effect, this method activates the
views primary applet and its BusComp and activates the primary applets first tab sequence control.
Further, this method deactivates any BusObject, BusComp, applet, or control objects that were active
prior to this method call.

Syntax
Application.GotoView(ViewName[, BusinessObjectName])

Argument Description

ViewName The name of the view for the Siebel application to display

BusinessObjectName An optional argument to specify the business object to use for displaying
the view. You cannot specify the current active business object as an
argument to GotoView. If this argument is not supplied, or is specified as
Nothing, a new business object is loaded in the normal fashion.

Siebel Object Interfaces Reference Version 8.1 13 5

 For Oracle internal distribution only
Interfaces Reference Application Methods

Returns
Not applicable

Usage
If a business object has not been instantiated, BusinessObjectName should have the value Nothing.

NOTE: The GotoView method is not supported in the following events: Application_Navigate,
Application_PreNavigate, Application_Start, Navigate, PreNavigate, and WebApplet_Load.

The following Siebel VB script uses GotoView to programmatically navigate to the Opportunity List
view.

TheApplication.GotoView "Opportunity List View", Nothing

Alternatively, if your application has already instantiated an Opportunity object with the object
reference of objOppty, the appropriate usage in Siebel VB is:

TheApplication.GotoView "Opportunity List View", objOppty

NOTE: When this method is used in a Siebel VB or eScript script, regardless of where it appears in
the script, it is executed last.

The Control property Show Popup should not be set to TRUE on a button if there is underlying script
that uses GotoView. If Show Popup is set to TRUE and GotoView is used, the view is opened in a new
browser window. The Siebel client UI does not support a Multiple Document Interface (MDI)
architecture, so this combined configuration and scripted call to GotoView is not supported.

Used With
Server Script

Example
The following examples show how to use GoToView with and without the optional business object
parameter.

The following example is in Siebel eScript:

function BusComp_WriteRecord ()
{
var leadQuality;
var actName;
var actBO;
var actBC;

//Get the lead quality for this opportunity

leadQuality = this.GetFieldValue("Quality");
if(leadQuality == "1-Excellent")
{

136 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

//If it is a excellent lead,

//go to the account for this opportunity
actName = this.GetFieldValue("Account");
actBO = TheApplication().GetBusObject("Account");
actBC = actBO.GetBusComp("Account");

with (actBC)
{
SetViewMode(AllView);
ClearToQuery();
SetSearchSpec("Name", actName);
ExecuteQuery();
}

TheApplication().GotoView("All Account List View",actBO);

}
else
{
TheApplication().GotoView("Opportunity Detail - Activities View");
}

actBC = null;
actBO = null;

The following example is in Siebel VB:

Sub BusComp_WriteRecord

Dim leadQuality As String

Dim actName As String
Dim actBO As BusObject
Dim actBC As BusComp

'Get the lead quality For this opportunity

leadQuality = Me.GetFieldValue("Quality")
If (leadQuality = "1-Excellent") Then

'If it is an excellent lead

'go to the account For this opportunity
actName = Me.GetFieldValue("Account")
Set actBO = TheApplication.GetBusObject("Account")
Set actBC = actBO.GetBusComp("Account")

With actBC
.SetViewMode AllView
.ClearToQuery
.SetSearchSpec "Name", actName
.ExecuteQuery
End With

TheApplication.GotoView "All Account List View",actBO

Siebel Object Interfaces Reference Version 8.1 13 7

 For Oracle internal distribution only
Interfaces Reference Application Methods

Else
TheApplication.GotoView "Opportunity Detail - Activities View"
End If

Set actBC = Nothing

Set actBO = Nothing

End Sub

InvokeMethod Method
InvokeMethod calls a specialized method or user-defined method specified by its argument.

Browser Script Syntax

theApplication().InvokeMethod(methodName, methodArgs_PropSet);

Argument Description

methodName The name of the method.

methodArgs_PropSet One or more strings containing arguments to methodName.

Server Script Syntax

Application.InvokeMethod(methodName, methodArgs);

Argument Description

methodName The name of the method.

methArg1, methArg2, , One or more strings containing arguments to methodName.

methArgN

Returns
In Server Script, returns a string containing the result of the method

In Browser Script, returns a Boolean

Usage
InvokeMethod allows you to call methods on an Application object that is exposed directly through
the Application interface.

NOTE: The InvokeMethod method should be used only with documented specialized methods. Oracle
does not support calling specialized methods with InvokeMethod unless they are listed in this book.

138 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Example
For an example, read InvokeMethod Method on page 96.

InvokeMethod Methods for the Application Object

The following methods are supported for use with InvokeMethod:

GetDataSource Method on page 139

IsViewReadOnly Method on page 140

Language Method on page 141

LookupValue Method on page 141

GetDataSource Method
Returns the name of the data source, as defined in the CFG file, that is being used for the session.

Syntax
dataSrc = Application.InvokeMethod(GetDataSource)

Argument Description

Not applicable

Returns
A string containing the value of the data source currently used by the application.

Used With
This method is supported by Application.InvokeMethod() calls in COM Data Control, Java Data Bean,
Mobile Web Client Automation Server, and Server Script.

Example
The following eScript example detects the data source and displays its name in a dialog box.

var dataSrc = TheApplication().InvokeMethod("GetDataSource");

TheApplication().RaiseErrorText(dataSrc);

The following is the same example in Siebel VB.

Dim dataSrc As String

dataSrc = TheApplication.InvokeMethod("GetDataSource")
TheApplication.RaiseErrorText(dataSrc)

Siebel Object Interfaces Reference Version 8.1 13 9

 For Oracle internal distribution only
Interfaces Reference Application Methods

IsViewReadOnly Method
You can use the IsViewReadOnly method to test whether a view is read-only.

Syntax
Application.InvokeMethod(IsViewReadOnly,viewName)

Argument Description

viewName The name of a view, as defined in Siebel Tools, in double quotes or a

variable containing the name of a view.

Returns
Returns TRUE if the view is read-only, else it returns FALSE. If neither of these values is returned,
then an error has occurred. Your script should provide a handler if neither TRUE nor FALSE is
returned.

Usage
You can set a view as read-only for particular responsibilities in the Responsibility Administration
view. One use of the IsViewReadOnly method is to determine whether such a view is read-only for
the current responsibility before attempting to edit a field.

Buttons are not automatically set to read-only on views that are read-only due to the view-
responsibility association, so another application is to set buttons to read-only in views for which
IsViewReadOnly returns TRUE.

Used With
This method is supported by Application.InvokeMethod() calls in Browser Script, COM Data Control,
COM Data Server, Java Data Bean, Mobile Web Client Automation Server, and Server Script.

Example
The following example is for Siebel eScript:

function BusComp_PreSetFieldValue(FieldName,FieldValue)

if (TheApplication().InvokeMethod("IsViewReadOnly","Account List View") == "TRUE")

TheApplication().RaiseErrorText("Return value is TRUE.");

else if

(TheApplication().InvokeMethod("IsViewReadOnly","Account List View") == "FALSE")

TheApplication().RaiseErrorText("Return value is FALSE.");

140 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

else

TheApplication().RaiseErrorText("Return value is Unknown.");

Language Method
Retrieves the language code of the language in which the active application is running.

Syntax
Application.InvokeMethod(Language);

Argument Description

Not applicable

Returns
The language code of the active application, for example ENU

Used With
This method is supported by Application.InvokeMethod() calls in Server Script.

Example
Siebel VB:

Dim curLang As String

curLang = TheApplication.InvokeMethod("Language")

Siebel eScript:

var curLang;

curLang = TheApplication().InvokeMethod("Language");

LookupValue Method
Finds a row in S_LST_OF_VAL where the TYPE column matches the type argument, the CODE column
matches the lang_ind_code argument, and the LANG_ID column matches the language code of the
currently active language. This function is used to obtain the translation of the specified untranslated
value in the specified LOV into the currently active language.

Siebel Object Interfaces Reference Version 8.1 14 1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Syntax
val = Application.InvokeMethod(LookupValue, type, lang_ind_cd)

Argument Description

type Type as specified in the List of Values administration view.

lang_ind_cd Language independent code value as specified in the List of Values

administration view.

Returns
Returns a string containing the display value (the VAL column) for the row. LookupValue tries to find
the display value for a given language independent code. If the display value is not found,
LookupValue returns the language independent code itself as the value.

Used With
This method is supported by Application.InvokeMethod() calls in COM Data Control, Java Data Bean,
Mobile Web Client Automation Server, and Server Script.

Example
The following eScript example finds a row in S_LST_OF_VAL where the TYPE column matches the
type argument, the CODE column matches the lang_ind_code argument, and the LANG_ID column
matches the language code of the currently active language. This function is used to obtain the
translation of the specified untranslated value in the specified LOV into the currently active language.

var LOVText=TheApplication().InvokeMethod("LookupValue","SR_AREA","Network");

142 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

LoadObjects Method
The LoadObjects method is used to start the COM Data Server object, and returns a reference to the
Application object. This method must be the first call to the COM Data Server.

Syntax
Application.LoadObjects(absoluteCFGfileName)

Argument Description

absoluteCFGfileName The complete path and name of the CFG file to open. For example:
C:\siebel\bin\uagent.cfg

You can optionally identify the data source in the argument to the
LoadObjects method by appending to the CFG file string, separated by
a comma. For example:
"D:\Server\siebsrvr\bin\ENU\siebel.cfg,ServerDataSrc"

When the data source is not specified, the LoadObjects method

assumes Local as the data source.

Returns
The Application object opened on start-up

Usage
Prior to calling LoadObjects, you must change the current directory to the Siebel\bin directory.

When using COM Data Server, the COM client cannot create multiple connections to the COM Server.
For example, a second attempt at calling LoadObjects() causes the error message: The object
definition manager has already been initialized. The COM client must be restarted before another
connection attempt can be successful. Use COM Data Control instead.

Used With
COM Data Server

Example
The following example is for COM Data Server. SiebelApplication is an Application instance.

Private Sub LoadConfig_Click()

Dim errCode As Integer
LoadConfig.Enabled = False
SiebelApplication.LoadObjects "C:\siebel\bin\uagent.cfg", _
errCode

If errCode = 0 Then
ConfigOK = 1
End If

Siebel Object Interfaces Reference Version 8.1 14 3

 For Oracle internal distribution only
Interfaces Reference Application Methods

Status.Text = SiebelApplication.GetLastErrText
End Sub

LoadUserAttributes Method
The LoadUserAttributes method loads a user profile into the session.

Syntax
LoadUserAttributes(row_id)

Argument Description

row_id The row ID of the user whose profile needs to be loaded

Returns
Not applicable

Usage
This function has only one argument: the row ID of the user whose profile needs to be loaded. This
loaded profile can be accessed as the You profile from personalization rules, with one exception: if
the row ID is that of the current user, the profile will be loaded into the Me profile.

If this function is called with no argument, it unloads the loaded user profile.

For more information on user profiles, see Siebel Personalization Administration Guide.

Used With
Server Script

Example
The following Siebel VB example shows a method that loads a user profile into the session. The
function is exposed on the Siebel Application Object.

Function LoadUserProfile As Integer

TheApplication.InvokeMethod ("LoadUserAttributes",0-10N07)
End Function

The following Siebel VB example unloads the loaded user profile:

Function LoadUserProfile As Integer

TheApplication.InvokeMethod ("LoadUserAttributes", )
End Function

144 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Login Method
The Login method allows external applications to log in to the COM Data Server, COM Data Control,
or Java Data Bean, and to access the Siebel objects. The Login method allows the end user to invoke
the Siebel application without being prompted for a login and password. The Login method
determines the privileges granted, and the role and responsibility of the end user for that session.

Syntax
Application.Login([connectString,] userName, password)

Argument Description

connectString Token-based connect string

userName Username for login

password User password for login

Returns
A string containing the error code

Usage
Verify that the Siebel\bin directory is the current directory. To access the Data Control, make sure
the default Data Source points to the database that you wish to access and set EnableOLEAutomation
to TRUE in your CFG file (this is the default value for the argument).

For information on formatting the connect string, read Connect String on page 71.

Used With
COM Data Control, COM Data Server, Mobile Web Client Automation Server, Java Data Bean

Example
The connect string for the COM Data Control is token-based; for example:

host = "Siebel://my_computer/SIEBEL/objsrvr/my_computer" lang = "ENU"

Because most languages use quotes to enclose text strings, you must use quotes inside parentheses;
for example:

To use the COM Data Control in Visual Basic:

m_dataBean.login("siebel.tcpip.none.none://gateway:gatewayport/enterpriseserver/
SCCObjMgr", "username", "password");

To use the COM Data Control in C++:

Login("host=\"siebel://my_computer/SIEBEL/objsvr/my_computer\" lang =
\"ENU\"","user","password");

Siebel Object Interfaces Reference Version 8.1 14 5

 For Oracle internal distribution only
Interfaces Reference Application Methods

The following code sample illustrates how to log in to the server and check for errors:

Call SiebelAppControl.Login("host=""siebel://gtwy/enterprise/ObjMgr""",
"SADMIN", "SADMIN")

//Check for errors

If SiebelAppControl.GetLastErrCode <> 0 Then
frmMain.txtStatus.Text = SiebelAppControl.GetLasErrText
Else
frmMain.txtStatus.Text = "Connected successfully..."
End If

The following is a Java Data Bean example that logs into a Siebel Server and then logs off:

import com.siebel.data.*;
import com.siebel.data.SiebelException;

public class JDBLoginLogoffDemo

{
private SiebelDataBean m_dataBean = null;
public static void main(String[] args)
{
JDBLoginLogoffDemo demo = new JDBLoginLogoffDemo();
}

public JDBLoginLogoffDemo()
{
try
{

// instantiate the Siebel Data Bean

m_dataBean = new SiebelDataBean();

// login to the servers

m_dataBean.login("siebel.tcpip.none.none://<gateway>:<port>/<enterprise>/
<object manager>","<userid>","<password>");
System.out.println("Logged in to the Siebel server ");

//perform function code

//release the business object

// logoff
m_dataBean.logoff();
System.out.println("Logged off the Siebel server ");
}

catch (SiebelException e)
{
System.out.println(e.getErrorMessage());
}
}
}

146 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

LoginId Method
The LoginId method returns the login ID of the user who started the Siebel application.

Syntax
Application.LoginId

Argument Description

Not applicable

Returns
A string containing the login ID

Usage
The login ID is the row ID of the users login in the Employee table. When obtained, the login ID can
be conveniently used as a search specification.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
In this Siebel VB example of the BusComp_PreSetFieldValue event, the LoginId method is used to
determine whether the user has the right to modify a record.

Function BusComp_PreSetFieldValue (FieldName As String,

FieldValue As String) As Integer
Select Case FieldName
Case "Account Status"
if Me.GetFieldValue("Created By") <> _
TheApplication.LoginId then
TheApplication.RaiseErrorText("*** You cannot change Account Status _
because you did not create the record***")
end if
End Select
BusComp_PreSetFieldValue = ContinueOperation
End Function

LoginName Method
The LoginName method returns the login name of the user who started the Siebel application (the
name typed in the login dialog box).

Siebel Object Interfaces Reference Version 8.1 14 7

 For Oracle internal distribution only
Interfaces Reference Application Methods

Syntax
Application.LoginName

Argument Description

Not applicable

Returns
A string containing the users login name

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
For examples, read ExecuteQuery Method on page 190 and TheApplication Method on page 317.

Related Topic
Login Method on page 145

Logoff Method
The Logoff method disconnects the client from the server.

Syntax
Application.Logoff

Argument Description

Not applicable

Returns
Not applicable

Usage
For clients with user interfaces, Logoff destroys every window except for the topmost window. Logoff
also deletes every object, except for the topmost object, on both client and server.

Logoff is called automatically if you destroy the main object.

148 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Used With
COM Data Control, Java Data Bean, Mobile Web Client Automation Server

LookupMessage Method
The LookupMessage method returns the translated string for the specified key, in the current
language, from the specified category. The optional arguments are used to format the string if it
contains any substitution arguments (%1,%2).

Syntax
Application.LookupMessage (category, key, [arg1], [arg2],...., [argN])

Argument Description

category Name of the Message Category object, as defined in Siebel Tools, that
is the parent of Key value.

key Name of the Message object, as defined in Siebel Tools, whose text
contains the value to be investigated.

arg1, arg2, , argN Optional arguments used to format the error message if it contains any
substitution arguments (%1, %2).

Returns
A string containing the localized message text.

Usage
Useful for retrieving locale specific custom error messages.

Used With
Server Script

Example
The following eScript example returns the text Account Title should be entered before Stepping off.
To test this under the User Defined Errors message category, create a new record with the following
text: %1 should be entered before Stepping Off. The parameter that is substituted in place of %1
is Account Title, which is present in the message test.

var sVal = TheApplication().LookupMessage("User Defined Errors", "Test", "Account

Title");

Siebel Object Interfaces Reference Version 8.1 14 9

 For Oracle internal distribution only
Interfaces Reference Application Methods

Name Method
The Name method returns name of the application.

Syntax
Application.Name

Argument Description

Not applicable

Returns
A string containing the name of the application

Used With
Browser Script, Web Client Automation Server

NewPropertySet Method
The NewPropertySet method constructs a new property set object.

Syntax
Application.NewPropertySet

Argument Description
Not applicable

Returns
A property set

Usage
NewPropertySet is used primarily to construct input and output arguments for business services.

NOTE: When using NewPropertySet on an existing PropertySet object, old references to this
PropertySet are lost. When reusing a PropertySet, use the Reset method on the PropertySet itself.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

150 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Example
This method constructs a new property set object.

The following example is in Browser Script:

function Applet_PreInvokeMethod (name, inputPropSet)

{
if (name == "MyCustomMethod")
{
var oBS;
var inpPS;
var outPS;
inpPS = theApplication().NewPropertySet();
outPS = theApplication().NewPropertySet();
oBS = theApplication().GetService("New Value Business Service");
outPS = oBS.InvokeMethod("New Value Method", inpPS);
inpPS = null;
outPS = null;
oBS = null;
return ("CancelOperation");
}

else
{
return ("ContinueOperation");
}
}

The following example is for COM. SiebelApplication is an Application instance.

Dim oBS As SiebelService

Dim inpPS As SiebelPropertySet
Dim outPS As SiebelPropertySet
Dim errCode as integer

Set inpPS = SiebelApplication.NewPropertySet errCode

Set outPS = SiebelApplication.NewPropertySet errCode
Set oBS = SiebelApplication.GetService("New Value Business Service", errCode)
oBS.InvokeMethod "New Value Method", inpPS, outPS, errCode
Set inpPS = Nothing
Set outPS = Nothing
Set oBS = Nothing

The following example is in Siebel eScript:

function WebApplet_PreInvokeMethod (MethodName)

{
if (MethodName == "MyCustomMethod")
{
var oBS;
var inpPS;
var outPS;
inpPS = TheApplication().NewPropertySet();
outPS = TheApplication().NewPropertySet();
oBS = TheApplication().GetService("New Value Business Service");

Siebel Object Interfaces Reference Version 8.1 15 1

 For Oracle internal distribution only
Interfaces Reference Application Methods

oBS.InvokeMethod("New Value Method", inpPS, outPS);

inpPS = null;
outPS = null;
oBS = null;
return (CancelOperation);
}

else
{
return (ContinueOperation);
}

The following example is in Siebel VB:

Function WebApplet_PreInvokeMethod (MethodName As String) As Integer

If MethodName = "MyCustomMethod" Then
Dim oBS As Service
Dim inpPS As PropertySet
Dim outPS As PropertySet
Set inpPS = TheApplication.NewPropertySet
Set outPS = TheApplication.NewPropertySet
Set oBS = TheApplication.GetService("New Value Business Service")
oBS.InvokeMethod "New Value Method", inpPS, outPS
Set inpPS = Nothing
Set outPS = Nothing
Set oBS = Nothing
WebApplet_PreInvokeMethod = CancelOperation
Else
WebApplet_PreInvokeMethod = ContinueOperation
End If

End Function

PositionId Method
The PositionId property returns the position ID (ROW_ID from S_POSTN) of the users current
position. This is set by default when the Siebel application is started and may be changed (through
Edit > Change Position) if the user belongs to more than one position.

Syntax
Application.PositionId

Argument Description

Not applicable

Returns
A string row ID

152 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

PositionName Method
The PositionName property returns the position name of the users current position. This is set by
default when the Siebel application is started.

Syntax
Application.PositionName

Argument Description

Not applicable

Returns
A string containing the users position

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
This Siebel VB example checks for the position of a user changing the sales stage, and prevents
changes if the user is not of the appropriate position.

Function BusComp_PreSetFieldValue (FieldName As String, FieldValue As String) As

Integer

Dim sPosName As String sMsgText As String

Select Case FieldName
Case "Sales Stage"
If FieldValue = "Approved" Then
' Do not allow the sales cycle to be changed to
' this value if the User is not a manager or VP.
sPosName = TheApplication.PositionName
If NOT ((sPosName="Manager") OR (sPosName="VP"))Then
TheApplication.RaiseErrorText("Only a Manager or Vice President can
approve a Pipeline Item. Please notify your Manager that you _
want to have this Pipeline Item approved.")
End If
BusComp_PreSetFieldValue = ContinueOperation
End Select

End Function

Siebel Object Interfaces Reference Version 8.1 15 3

 For Oracle internal distribution only
Interfaces Reference Application Methods

RaiseError Method
The RaiseError method raises a scripting error message to the browser. The error code is a canonical
number. The error text is based on the specified key, looked up for the current language from the
User-Defined Errors category. You can define these errors in Tools using the Message Category
object. The optional arguments are used to format the string if it contains any substitution
arguments (%1, %2).

Syntax
Application.RaiseError(key, [arg1], [arg2],...., [argN])

Argument Description

key Name of the Message object, as defined in Siebel Tools, whose text
contains the value to be used.

arg1, arg2, , argN Optional arguments used to format the error message if it contains any
substitution arguments (%1, %2).

Returns
Not applicable

Usage
When invoked, the RaiseError method causes execution of the script to terminate, and sends a
notification to the browser. Therefore, CancelOperation is not required after RaiseError.

Internally, the RaiseError/RaiseErrorText methods raise a Server Script exception. Therefore, if you
have implemented error handling in your scripts, please note that the error handling can suppress
RaiseError/RaiseErrorText functionality.

If you have implemented error handling in Siebel VB, remember that when using On Error Goto ,
the RaiseError and RaiseErrorText methods result in the script transferring execution to the error
handler. On Error Resume Next suppresses the RaiseError and RaiseErrorText methods.

CAUTION: Do not use RaiseError in the BusComp_PreWriteRecord or BusCompWriteRecord event.

Termination of the event will cause the application to stop responding, for example preventing users
from stepping off records.

Used With
Server Script

Example
In the following eScript example, the RaiseError results in a scripting exception being raised,
transferring control to the catch statement. To display the error message, the error must be thrown
using the throw statement.

154 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

function BusComp_PreDeleteRecord ()
{
try {
var status = this.GetFieldValue("Account Status");

if (status == "Gold") {
TheApplication().RaiseError(<user defined error name>);
}
else {
return (ContinueOperation);
}
}
catch (e) {
throw e;
}

The following eScript example raises the error message This user-defined test error is used in
PreDelete, as an example for RaiseError Method when deleting an opportunity with the Pipeline
revenue class. Note that the key "user-defined test error1" is predefined as "This user-defined test
error is used in %1, as an example for %2". When the script runs, 'PreDelete' is substituted for %1
and 'Raise Error Method' is substituted for %2.

function BusComp_PreDeleteRecord ()
{
try
{
var revClass = this.GetFieldValue("Primary Revenue Class");
if (revClass == "1-Pipeline")
{
TheApplication().RaiseError("user-defined test error1", "PreDelete",
"RaiseError Method" );
}

else
{
return (ContinueOperation);
}

}
catch (e)
{
throw e;
}

RaiseErrorText Method
The RaiseErrorText method raises a scripting error message to the browser. The error text is the
specified literal string. The optional arguments are used to format the string if it contains any
substitution arguments (%1, %2).

Siebel Object Interfaces Reference Version 8.1 15 5

 For Oracle internal distribution only
Interfaces Reference Application Methods

Syntax
Application.RaiseErrorText(value, [arg1], [arg2],...., [argN])

Argument Description

value The error text message.

arg1, arg2, , argN Optional arguments used to format the error message if it contains any
substitution arguments (%1, %2).

Returns
Not applicable

Usage
When invoked, the RaiseErrorText method stops execution of the script. Therefore, CancelOperation
is not required after RaiseErrorText.

Internally, the RaiseError and RaiseErrorText methods raise a Server Script exception. Therefore, if
you have implemented error handling in your scripts, the error handling can suppress RaiseError and
RaiseErrorText functionality.

If you have implemented error handling in Siebel VB and are using On Error Goto , the RaiseError
and RaiseErrorText methods result in the script transferring execution to the error handler. On Error
Resume Next suppresses the RaiseError and RaiseErrorText methods.

NOTE: Do not use the %s and %n formatting literals with the RaiseErrorText method. This causes
unpredictable results.

CAUTION: Do not use RaiseErrorText in the BusComp_PreWriteRecord or BusCompWriteRecord

event. Termination of the event will cause the application to stop responding, for example preventing
users from stepping off records.

Used With
Server Script

Example
In the following eScript example, the RaiseErrorText results in a scripting exception being raised,
transferring control to the catch statement. For the error message to be displayed, the error must
be thrown, using the throw statement.

function BusComp_PreDeleteRecord ()
{
try {
var status = this.GetFieldValue("Account Status");

if (status == "Gold") {
TheApplication().RaiseErrorText("Unable to delete Gold Account");
}
else {

156 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

return (ContinueOperation);
}
}
catch (e) {
throw e;
}

The following eScript example raises an error when deleting an opportunity with the Pipeline
revenue class.

function BusComp_PreDeleteRecord ()
{
try
{
var revClass = this.GetFieldValue("Primary Revenue Class");
if (revClass == "1-Pipeline")
{
TheApplication().RaiseErrorText("Exception occurred in %1. Unable to
delete Opportunity with %2 revenue class.", "PreDeleteRecord", revClass);
}
else
{
return (ContinueOperation);
}

}
catch (e)
{
throw e;
}
}

SetPositionId Method
SetPositionID sets the active position to the Position Id specified in the argument.

Syntax
Application.SetPositionId(positionId)

Argument Description

positionId A string containing the Position Id you would like to change to

Returns
A Boolean denoting whether or not the operation was successfully completed

Siebel Object Interfaces Reference Version 8.1 15 7

 For Oracle internal distribution only
Interfaces Reference Application Methods

Usage
When invoking the SetPositionId method, the positionId argument must contain a Position Id that
has already been associated with the current, logged-in user.

Used With
COM Data Server, COM Data Control, Java Data Bean, Mobile Web Client Automation Server, Server
Script

SetPositionName Method
SetPositionName sets the active position to the position name specified in the argument. Returns a
Boolean indicating whether or not method succeeded.

Syntax
Application.SetPositionName(positionName)

Argument Description

positionName A string containing the name of the position.

Returns
A Boolean denoting whether or not the operation was successfully completed

Usage
When invoking the SetPositionName method, the positionName argument must contain a Position
name that has already been associated with the current, logged-in user.

Used With
COM Data Server, COM Data Control, Java Data Bean, Mobile Web Client Automation Server, Server
Script

SetProfileAttr Method
SetProfileAttr is used in personalization to assign values to attributes in a user profile.

158 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Syntax
Application.SetProfileAttr(name, value)

Argument Description

name A string indicating the name of the attribute

value The value of name

Returns
Not applicable

Usage
SetProfileAttr assigns the value value to the attribute in a user profile indicated by name. If the
profile attribute specified in the argument string already exists, the corresponding persistent profile
attribute in the application, defined in the Personalization Profile business component, is updated
with the new value. If the profile attribute specified in the argument string does not exist in the list
of persistent profile attributes, it is created as a dynamic profile attribute, without quotation marks
encompassing the name.

In Browser Script, using SetProfileAttr() triggers a round trip to the server and back, creating a
performance overhead each time it is used.

NOTE: SetProfileAttr() cannot be used with system fields, which are not explicitly defined in the
Personalization Profile business component. While GetProfileAttr() can be used with the Id field,
SetProfileAttr() cannot be used with it, because attempting to change the ROW_ID column of a table
will generate an error. For more information on system fields, see Configuring Siebel Business
Applications.

Used With
Browser Script, COM Data Control, COM Data Server, Server Script, Java Data Bean, Mobile Web
Client Automation Server

Example
The following example is in Browser Script:

function Applet_PreInvokeMethod (name, inputPropSet)

{
if (name == "hobbyReq") {
var hobby = theApplication().GetProfileAttr("Hobby");

if (hobby == "") {
hobby = prompt("Please enter your favorite hobby");
theApplication().SetProfileAttr("Hobby", hobby);
}
return ("CancelOperation");
}

Siebel Object Interfaces Reference Version 8.1 15 9

 For Oracle internal distribution only
Interfaces Reference Application Methods

else
return ("ContinueOperation");
}

This following examples show how to exchange information between applet server scripts and applet
browser scripts. In an applet server script, a customer profile attribute called MyProAttr is set to
Hello World using the SetProfileAttr method. In applet browser scripts, you can retrieve the profile
attribute using GetProfileAttr method.

The following example is in Siebel eScript:

function WebApplet_PreInvokeMethod (MethodName)

{

if (MethodName == "MyCustomMethod") {

TheApplication().SetProfileAttr("MyProAttr", "Hello World eScript");

return (CancelOperation);

}
return (ContinueOperation);

The following example is in Siebel VB:

Function WebApplet_PreInvokeMethod (MethodName As String) As Integer

If MethodName = "MyCustomMethod" Then

TheApplication.SetProfileAttr "MyProAttr", "Hello World VB"

WebApplet_PreInvokeMethod = CancelOperation
Else
WebApplet_PreInvokeMethod = ContinueOperation
End If

End Function

Related Topics
Name Method on page 150

For more information on user profile attributes, read Siebel Applications Administration Guide.

SetSharedGlobal Method
Shared global variables are unique to the user and the users associated session. One user's global
variables are not visible to other users. The variables are global to the current user and session only.
The SetSharedGlobal property sets a shared user-defined global variable, which can be accessed
using GetSharedGlobal.

160 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Syntax
Application.SetSharedGlobal(varName, value)

Argument Description

varName String variable or literal containing the name of the shared global variable to set

value String variable or literal containing the value to set the variable to set

Returns
Not applicable

Used With
COM Data Control, COM Data Server, Mobile Web Client Automation Server, Server Script

Example
The following example is for COM. SiebelApplication is an Application instance.

comVar = SiebelApplication.GetSharedGlobal("myVar", errCode)

SiebelApplication.SetSharedGlobal "myVar", "BLAH", errCode

The following example is in Siebel VB:

TheApplication.SetSharedGlobal "myVar", "FOO"

myVar = TheApplication.GetSharedGlobal("myVar")

In this example, the SetSharedGlobal method is called to set a global variable called myGlobalVar in
Application_Start event. The global variable can be accessed from any event. For this example, in
the BusComp_WriteRecord event, the GetSharedGlobal method is called to retrieve the global
variable.

The following example is for COM. SiebelApplication is an Application instance.

Dim sReturn as String

oleVar = SiebelApplication.GetSharedGlobal("myGlobalVar", errCode)
SiebelApplication.SetSharedGlobal "myGlobalVar", " helloworld", errCode

The following example is in Siebel eScript:

function Application_Start (CommandLine)

{
TheApplication().SetSharedGlobal("myGlobalVar", "helloworld");
}

function BusComp_WriteRecord ()
{
var myVar;
myVar = TheApplication().GetSharedGlobal("myGlobalVar");
}

The following example is in Siebel VB:

Siebel Object Interfaces Reference Version 8.1 16 1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Sub Application_Start (CommandLine As String)

TheApplication.SetSharedGlobal "myGlobalVar", "helloworld"
End Sub

Sub BusComp_WriteRecord
Dim myVar as String
myVar = TheApplication.GetSharedGlobal("myGlobalVar")
End Sub

Related Topic
GetLastErrCode Method on page 129

ShowModalDialog Method
ShowModalDialog allows you to show a modal dialog box with the cursor maintained in its default
state. This Application object method invokes Microsofts equivalent Window object method.

Syntax
theApplication().ShowModalDialog (url[, argin][, options])

Argument Description

url The URL of the document to load and display.

162 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Argument Description

argin This parameter is used to pass arguments to use when displaying the document.
This argument can be a value of any type, including an array of values.

options String that specifies the attributes of the window that displays the dialog box.

This parameter may include one or more of the following semicolon-delimited

values:

dialogHeight:sHeight sets the height of the dialog window, where sHeight can
be an integer or floating-point number, followed by an absolute units
designator (cm, mm, in, pt, pc, or px) or a relative units designator (em or
ex). For consistent results, specify the dialogHeight and dialogWidth in pixels
when designing modal dialog boxes. Default unit of measure is em. Minimum
height is 100 pixels.

dialogLeft:sXPos sets the left position of the dialog window relative to the
upper-left corner of the desktop.

dialogTop:sYPos sets the top position of the dialog window relative to the
upper-left corner of the desktop.

dialogWidth:sWidth sets the width of the dialog window.

center:{ yes | no | 1 | 0 | on | off } specifies whether to center the dialog

window within the desktop. The default is yes.

dialogHide:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window

is hidden when printing or using print preview. This feature is only available
when a dialog box is opened from a trusted application. The default is no.

edge:{ sunken | raised } specifies the edge style of the dialog window. The
default is raised.

help:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window displays

the context-sensitive Help icon. The default is yes.

resizable:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window

has fixed dimensions. The default is no.

scroll:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window

displays scrollbars. The default is yes.

status:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window

displays a status bar. The default is yes for untrusted dialog windows and no
for trusted dialog windows.

unadorned:{ yes | no | 1 | 0 | on | off } specifies whether the dialog window

displays the border window chrome. This feature is only available when a
dialog box is opened from a trusted application. The default is no.

Returns
The value of the returnValue property, as set by the window of the document specified by the url
parameter

Siebel Object Interfaces Reference Version 8.1 16 3

 For Oracle internal distribution only
Interfaces Reference Application Methods

Used With
Browser Script

Example
This example shows how this method can be used in browser script to bring up a modal dialog box
with a specified URL.

function Applet_Load ()
{
var sOptions="dialogHeight: 1000px;edge:sunken;resizable;yes";
theApplication().ShowModalDialog("http://www.yahoo.com", "", sOptions)
}

SWEAlert Method
SWEAlert displays a modal dialog box containing a message to the user.

Syntax
theApplication().SWEAlert(message)

Returns
Undefined (similar to returning nothing)

Usage
Use SWEAlert instead of Alert. With Alert, popup applets such as Mvg and Pick applets are hidden
(sent to the background) when a JavaScript Alert() is raised by a Browser side event. With SWEAlert,
the dialog's parent applet is not sent to the foreground.

Used With
Browser Script

Example
The following browser script example displays a status message to the user.

function BusComp_PreSetFieldValue (fieldName, value) {

if (fieldName == "Account Status") {

var cVolume = this.GetFieldValue("Current Volume");
if ((value == "Inactive") && (cVolume > 0)) {
theApplication().SWEAlert("Unable to inactivate an account that has a
current volume greater than 0");

return ("CancelOperation");
}
else

164 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

return ("ContinueOperation");
}
else
return ("ContinueOperation");
}

Trace Method
The Trace method appends a message to the trace file. Trace is useful for debugging SQL query
execution and the allocation of the objects. This tracing is not the same as the tracing that can be
activated in the applications CFG file. For more information, read Tracing Scripts on page 18.

NOTE: This method and the TraceOn Method on page 168 are meant for debugging purposes and are
not recommended for use in production environments.

Syntax
Application.Trace(message)

Argument Description

message String variable or literal containing message text to append to the trace file

Returns
Not applicable

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is for COM Data Server. SiebelApplication is an Application instance.

Private Sub TraceOn_Click()

Dim ErrCode As Integer
SiebelApplication.TraceOn "c:\temp\trace.txt", "allocation", _
"all", ErrCode
If (ErrCode = 0) Then SiebelApplication.TraceOn
"c:\temp\trace.txt", "SQL", "",ErrCode
If (ErrCode = 0) Then SiebelApplication.Trace
"Start of Tracing!",
ErrCode
End Sub

The following example is in Siebel VB:

Siebel Object Interfaces Reference Version 8.1 16 5

 For Oracle internal distribution only
Interfaces Reference Application Methods

Sub Button2_Click
TheApplication.TraceOn "C:\temp\trace.txt", "allocation", "all"
TheApplication.TraceOn "C:\temp\trace.txt", "sql", ""
TheApplication.Trace "start of tracing!"
End Sub

The following is sample output of an Allocation trace section:

03/05/98,17:27:47,START,4.0.4 [1425_P3] ENU

03/05/98,17:27:47,ALLOC,1,BusObject,Account,Basic
03/05/98,17:27:48,ALLOC,2,BusComp,Account,Basic
03/05/98,17:27:48,RELEASE,1
03/05/98,17:27:48,RELEASE,2

The following is sample output of an SQL trace section:

01/22/98,21:03:49,START,4.0.2 [1416] ENU

01/22/98,21:04:02,COMMENT,Start of Tracing!
01/22/98,21:04:10,SQLSTMT,1,SELECT,"SELECT
T1.ROW_ID,
T1.MODIFICATION_NUM,
T1.CREATED_BY,
T1.LAST_UPD_BY,
T1.CREATED,
T1.LAST_UPD,
T1.CONFLICT_ID,
T1.NAME,
T1.DESC_TEXT,
T1.PRIV_FLG,
T1.QUERY_STRING
FROM
DEV32.S_APP_QUERY T1
WHERE
(T1.CREATED_BY = :1 OR T1.PRIV_FLG = :2) AND
((T1.NAME LIKE :3 OR T1.NAME LIKE :4 OR T1.NAME LIKE :5 OR
T1.NAME LIKE :6) AND UPPER(T1.NAME) = UPPER(:7))
ORDER BY
T1.NAME, T1.DESC_TEXT"
01/22/98,21:04:10,SQLBIND,1,1,1-6NF
01/22/98,21:04:10,SQLBIND,1,2,N
01/22/98,21:04:10,SQLBIND,1,3,ac%
01/22/98,21:04:10,SQLBIND,1,4,Ac%
01/22/98,21:04:10,SQLBIND,1,5,aC%
01/22/98,21:04:10,SQLBIND,1,6,AC%
01/22/98,21:04:10,SQLBIND,1,7,Account

Related Topics
TraceOff Method
TraceOn Method on page 168

166 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

TraceOff Method
TraceOff turns off the tracing started by the TraceOn method.

Syntax
Application.TraceOff

Argument Description

Not applicable

Returns
Not applicable

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
This Siebel VB example sets the value in the Sales Stage field to the default, that is, to the first value
in the fields picklist, and uses tracing to track the result:

Sub BusComp_NewRecord
TheApplication.TraceOn "C:\lvpick.doc", "SQL", ""
Dim oBC as BusComp
set oBC = me.GetPickListBusComp("Sales Stage")

With oBC
.SetViewMode AllView
.ActivateField "Sales Stage Order"
.ClearToQuery
.SetSortSpec "Sales Stage Order"
.ExecuteQuery ForwardOnly
if .FirstRecord then
.Pick
end if
End With

set oBC = Nothing

TheApplication.TraceOff

End Sub

Siebel Object Interfaces Reference Version 8.1 16 7

 For Oracle internal distribution only
Interfaces Reference Application Methods

TraceOn Method
TraceOn turns on the tracking of allocations and deallocations of Siebel objects and SQL statements
generated by the Siebel application.

Syntax
Application.TraceOn(filename, type, selection)

Argument Description

filename Output filename for the trace messages. If this argument is not specified, tracing
information is logged to the Object Manager log file for that user session.

The filename argument can take two additional inline arguments: $p and $t. The $p
argument substitutes the process id to the filename, and $t substitutes the thread
id to the file name. For example:

TheApplication().TraceOn("d:\\temp\\trace_$p_$t.txt", "Allocation",
"All");

would log trace files to d:\temp\trace\trace_1496_1412.txt. Place a separator between

the $p and $t arguments to make sure that the filename argument is unique. For
example, if user A had a process id of 1 and a thread of 12 without using a separator,
the tracing file would be

d:\temp\trace_112.txt

If user B had a process id of 11, and a thread id of 2, their tracing file would be

d:\temp\trace_112.txt

As a result, both users would attempt to log to the same file. Adding a separator
between the process and thread id keeps the filenames unique.

d:\temp\trace_1_12.txt

d:\temp\trace_11_2.txt
type Specifies the type of tracing to start. This can have the following values:

Allocation. Traces allocations and deallocations of Siebel objects. This option is

useful if you suspect memory leaks in your code.

SQL. Traces SQL statements generated by the Siebel application.

selection Indicates which Siebel objects should be traced for the Allocation trace type. This
argument should be "" if the trace type is SQL.

Script. Traces VB and eScript objects.

OLE. Traces allocations for data server or automation server programs.

All. Traces all objects. The All value does not trace the Siebel objects managed
implicitly by Siebel's declarative configuration use. All traces the Siebel objects
constructed by scripting.

168 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Methods

Returns
Not applicable

Usage
Always issue TraceOff to turn off tracing. If you attempt to call TraceOn with a different filename
without calling TraceOff first, trace information is written to the new trace filename. You can issue
multiple TraceOn statements to the same trace file.

NOTE: This method and the Trace Method on page 165 are meant for debugging purposes and are
not recommended for use in production environments.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is for COM Data Server. SiebelApplication is an Application instance:

Private Sub TraceOn_Click()

Dim ErrCode As Integer
SiebelApplication.TraceOn "c:\temp\trace.txt", "allocation",
"all", ErrCode
If (ErrCode = 0) Then SiebelApplication.TraceOn
"c:\temp\trace.txt", "SQL", "",ErrCode
If (ErrCode = 0) Then SiebelApplication.Trace
"Start of Tracing!",
ErrCode
End Sub

The following example is in Siebel eScript:

function BusComp_PreSetFieldValue (FieldName, FieldValue)

{
TheApplication().TraceOn("d:\\temp\\trace.txt", "Allocation", "All");
TheApplication().TraceOn("d:\\temp\\trace.txt", "SQL", "");
TheApplication().Trace("start tracing!");

return (ContinueOperation);
}

The following example is in Siebel VB:

Sub Button2_Click
TheApplication.TraceOn "C:\temp\trace.txt", "allocation",
"all"
TheApplication.TraceOn "C:\temp\trace.txt", "sql", ""
TheApplication.Trace "start of tracing!"
End Sub

The following is sample output of an Allocation trace section:

Siebel Object Interfaces Reference Version 8.1 16 9

 For Oracle internal distribution only
Interfaces Reference Application Methods

03/05/98,17:27:47,START,4.0.4 [1425_P3] ENU

03/05/98,17:27:47,ALLOC,1,BusObject,Account,Basic
03/05/98,17:27:48,ALLOC,2,BusComp,Account,Basic
03/05/98,17:27:48,RELEASE,1
03/05/98,17:27:48,RELEASE,2

The following is sample output of an SQL trace section:

01/22/98,21:03:49,START,4.0.2 [1416] ENU

01/22/98,21:04:02,COMMENT,Start of Tracing!
01/22/98,21:04:10,SQLSTMT,1,SELECT,"SELECT
T1.ROW_ID,
T1.MODIFICATION_NUM,
T1.CREATED_BY,
T1.LAST_UPD_BY,
T1.CREATED,
T1.LAST_UPD,
T1.CONFLICT_ID,
T1.NAME,
T1.DESC_TEXT,
T1.PRIV_FLG,
T1.QUERY_STRING
FROM
DEV32.S_APP_QUERY T1
WHERE
(T1.CREATED_BY = :1 OR T1.PRIV_FLG = :2) AND
((T1.NAME LIKE :3 OR T1.NAME LIKE :4 OR T1.NAME LIKE :5 OR
T1.NAME LIKE :6) AND UPPER(T1.NAME) = UPPER(:7))
ORDER BY T1.NAME, T1.DESC_TEXT"
01/22/98,21:04:10,SQLBIND,1,1,1-6NF
01/22/98,21:04:10,SQLBIND,1,2,N
01/22/98,21:04:10,SQLBIND,1,3,ac%
01/22/98,21:04:10,SQLBIND,1,4,Ac%
01/22/98,21:04:10,SQLBIND,1,5,aC%
01/22/98,21:04:10,SQLBIND,1,6,AC%
01/22/98,21:04:10,SQLBIND,1,7,Account

The following examples show the use of Trace, Traceoff, and TraceOn methods to generate a trace
file with SQL statements issues by the scripting query.

The following example is in Siebel eScript:

function BusComp_NewRecord ()
{
TheApplication().TraceOn("C:\\trace_output.txt", "SQL", "");
TheApplication().Trace("Start of tracing!");
var oBC = this.GetPickListBusComp("Sales Stage");

with (oBC)
{
SetViewMode(AllView);
ActivateField("Sales Stage Order");
ClearToQuery();
SetSortSpec("Sales Stage Order(ASCENDING)");
ExecuteQuery(ForwardOnly);

170 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Events

if (FirstRecord())
{
Pick();
}
}

oBC = null;
TheApplication().Trace("End of tracing!");
TheApplication().TraceOff();
}

The following example is in Siebel VB:

Sub BusComp_NewRecord

TheApplication.TraceOn "C:\trace_output.txt", "SQL", ""

TheApplication.Trace "Start of tracing!"
Dim oBC as BusComp
Set oBC = Me.GetPickListBusComp("Sales Stage(ASCENDING)")

With oBC
.SetViewMode AllView
.ActivateField "Sales Stage Order"
.ClearToQuery
.SetSortSpec "Sales Stage Order"
.ExecuteQuery ForwardOnly
If .FirstRecord Then
.Pick
End If
End With

Set oBC = Nothing

TheApplication.Trace "End of tracing!"
TheApplication.TraceOff
End Sub

Related Topics
Trace Method on page 165
TraceOff Method on page 167

Application Events
The following topics describe application events:

Application_Close Event

Application_InvokeMethod Event on page 172

Application_Navigate Event on page 173

Application_PreInvokeMethod Event on page 173

Application_PreNavigate Event on page 175

Siebel Object Interfaces Reference Version 8.1 17 1

 For Oracle internal distribution only
Interfaces Reference Application Events

Application_Start Event on page 176

Application_Close Event
The Close event is called before the application exits. This allows scripts to perform last-minute
cleanup (such as cleaning up a connection to a COM server). It is called when Windows notifies the
application that it should close, but not if the process is terminated directly.

Syntax
Application_Close

Argument Description

Not applicable

Returns
Not applicable

Used With
Server Script

NOTE: Siebel Business Processes invokes this event. For more information, read Siebel Business
Process Framework: Workflow Guide.

Application_InvokeMethod Event
The Application_InvokeMethod event is called after a specialized method is invoked.

Server Script Syntax

Application_InvokeMethod(methodName)

Argument Description

methodName Name of the method invoked

Browser Script Syntax

Application_InvokeMethod(name, inputPropSet)

Argument Description

inputPropSet A property set containing arguments to be passed to the InvokeMethod event.

172 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Events

Returns
Returns TRUE if the call succeeds or FALSE if it does not succeed.

Usage
The InvokeMethod event is called just after a specialized or user-defined method is invoked on the
application.

The Browser script implementation does not return a property set.

Used With
Browser Script, Server Script

Related Topics
How Your Script Affects Program Flow on page 64
Application_PreInvokeMethod Event

Application_Navigate Event
The Application_Navigate event is called after the client has navigated to a view.

Syntax
Application_Navigate

Argument Description

Not applicable

Returns
Not applicable

Used With
Server Script

Application_PreInvokeMethod Event
The PreInvokeMethod event is called before a specialized method is invoked by a user-defined applet
menu or by calling InvokeMethod on the application.

Siebel Object Interfaces Reference Version 8.1 17 3

 For Oracle internal distribution only
Interfaces Reference Application Events

Server Script Syntax

Application_PreInvokeMethod(methodName)

Argument Description

methodName String variable or literal containing the name of the method invoked

Browser Script Syntax

Application_PreInvokeMethod (methodName, inputPropSet)

Argument Description

methodName String variable or literal containing the name of the method invoked.

inputPropSet A property set containing arguments to be passed to the event.

Returns
ContinueOperation or CancelOperation

Usage
The PreInvokeMethod event is called just before a specialized method is invoked on the application.
If implementing a user-defined method, the script should return CancelOperation if you wish to
handle the event entirely through your own scripting.

Specialized methods are methods based on applet or business component classes other than
CSSFrame and CSSBusComp, respectively, that is, specialized classes.

When the method to be invoked is part of an If statement, this functions return value must be
assigned before the End If statement, as in the following code fragment.

If MethodName = ResetQuery then

Application_PreInvokeMethod = CancelOperation
End If

CancelOperation stops the execution of the underlying Siebel code associated with the event.
However, if there is code in the same script following CancelOperation, that code runs regardless of
the CancelOperation.

Used With
Browser Script, Server Script

Example
The following example is in Siebel VB and shows an implementation of the PreInvokeMethod:

Function Application_PreInvokeMethod (MethodName _

As String) As Integer

174 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Events

Dim i As Integer
Dim iReturn As Integer
iReturn = ContinueOperation

Select Case MethodName

Case "LaunchWord"
i = Shell("C:\Program Files\Microsoft Office _
\Office\WINWORD.EXE",1)
iReturn = CancelOperation

Case "LaunchExcel"
i = Shell("C:\Program Files\Microsoft Office _
\Office\EXCEL.EXE",1)
iReturn = CancelOperation
End Select

Application_PreInvokeMethod = iReturn

End Function

The following is the equivalent sample in Siebel eScript. Note that for this script to run, the entire
Clib.system statement must appear on a single line in the Editor:

function Application_PreInvokeMethod (MethodName)

var iReturn = ContinueOperation;

switch (MethodName)
{
case "LaunchWord":
Clib.system("\"C:\\Program Files\\Microsoft Office
\\Office\\WINWORD.EXE"",1);
iReturn = CancelOperation;
break;

case "LaunchExcel":
Clib.system("\"C:\\Program Files\\Microsoft Office
\\Office\\EXCEL.EXE"",1);
iReturn = CancelOperation;
}

return (iReturn)
}

Related Topic
How Your Script Affects Program Flow on page 64

Application_PreNavigate Event
The Application_PreNavigate event is called before the client navigates to a view.

Siebel Object Interfaces Reference Version 8.1 17 5

 For Oracle internal distribution only
Interfaces Reference Application Events

Syntax
Application_PreNavigate(DestViewName, DestBusObjName As String) As Integer

Argument Description

DestViewName Name of the view to which the user is navigating

DestBusObjName Business object of the destination view

Returns
CancelOperation or ContinueOperation

Used With
Server Script

Example
In the following eScript code sample the script checks for the current business object (contact) and
sets the current contact id as global variable (can be used for keeping context):

function Application_PreNavigate (DestViewName, DestBusObjName)

{
try
{
var currentView = this.ActiveViewName();
var BO = this.ActiveBusObject();
if(BO.Name() == "Contact")
{
var BC = BO.GetBusComp("Contact");
var id = BC.GetFieldValue("Id");
TheApplication().SetSharedGlobal("ContactId", id);
}
}
catch (e)
{
this.Trace("Exception caught: "+e.toString());
}
return (ContinueOperation);
}

Application_Start Event
The Start event is called when the client starts and again when the user interface is first displayed.

176 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Application Events

Syntax
Application_Start(commandline)

Argument Description

commandline Text of the command line with which the Siebel application was started.

NOTE: Siebel Business Processes invoke this event. For more information, read Siebel Business
Process Framework: Workflow Guide.

Returns
Not applicable

Used With
Server Script

Example
This Siebel VB code should be placed in the Application_Start procedure for the application of your
choice. This example retrieves the first and last name of the user logging into the Siebel application:

Sub Application_Start(CommandLine As String)

Dim oEmpBusObj as BusObject
Dim oEmpBusComp as BusComp
Dim oEmpBusComp as BusComp Dim sLoginName as String
Dim sUserName as String

sLoginName = TheApplication.LoginName
Set oEmpBusObj = TheApplication.GetBusObject("Employee")
Set oEmpBusComp = oEmpBusObj.GetBusComp("Employee")
With oEmpBusComp
.ActivateField "First Name"
.ActivateField "Last Name"
.ClearToQuery
.SetSearchSpec "Login Name", sLoginName
.ExecuteQuery
If (.FirstRecord = 1) Then
sUserName = .GetFieldValue("First Name")
sUserName = sUserName + " " + .GetFieldValue("Last Name")
End If
End With

Set oEmpBusComp = Nothing

Set oEmpBusObj = Nothing
End Sub

Siebel Object Interfaces Reference Version 8.1 17 7

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Business Component Methods

In the methods described in this section, the placeholders oBusComp and BusComp refer to a
business component instance:

ActivateField Method on page 179

ActivateMultipleFields Method on page 181

Associate Method on page 182

BusObject Method on page 184

ClearToQuery Method on page 185

DeactivateFields Method on page 187

DeleteRecord Method on page 189

ExecuteQuery Method on page 190

ExecuteQuery2 Method on page 192

FirstRecord Method on page 192

FirstSelected Method on page 194

GetAssocBusComp Method on page 196

GetFieldValue Method on page 197

GetFormattedFieldValue Method on page 199

GetLastErrCode Method on page 201

GetLastErrText Method on page 202

GetMultipleFieldValues Method on page 203

GetMVGBusComp Method on page 203

GetNamedSearch Method on page 205

GetPicklistBusComp Method on page 205

GetSearchExpr Method on page 207

GetSearchSpec Method on page 208

GetSortSpec Method on page 209

GetUserProperty Method on page 209

GetViewMode Method on page 210

InvokeMethod Method on page 211

LastRecord Method on page 219

Name Method on page 220

NewRecord Method on page 221

NextRecord Method on page 222

178 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

NextSelected Method on page 223

ParentBusComp Method on page 224

Pick Method on page 224

PreviousRecord Method on page 226

RefineQuery Method on page 227

Release Method on page 228

SetFieldValue Method on page 230

SetFormattedFieldValue Method on page 232

SetMultipleFieldValues Method on page 233

SetNamedSearch Method on page 235

SetSearchExpr Method on page 237

SetSearchSpec Method on page 238

SetSortSpec Method on page 242

SetUserProperty Method on page 244

SetViewMode Method on page 245

UndoRecord Method on page 249

WriteRecord Method on page 249

ActivateField Method
ActivateField allows queries to retrieve data for the argument-specified field.

Syntax
BusComp.ActivateField(FieldName)

Argument Description

FieldName String variable or literal containing the name of the field to activate

Returns
Not applicable

Siebel Object Interfaces Reference Version 8.1 17 9

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Usage
FieldName must be enclosed in double quotes and must be spelled exactly as the field name appears
in Siebel Tools, using the same case. You must activate fields using ActivateField before executing a
query for the business component.

NOTE: If you are writing an event handler on a business component, you must make sure that the
field has already been activated by specifying the ForceActive user property on the control.

By default, fields are inactive except when:

They are displayed on the applet and the business component is the instance on which the applet
is based.

They are System fields (which include Id, Created, Created By, Updated, and Updated By).

Their ForceActive property is set to TRUE.

The method ActivateField has been invoked with the FieldName.

They have the Link Specification property set to TRUE.

After a business component has been executed, if additional fields are activated, the business
component must be requeried before field values can be accessed. Failure to requery the business
component results in a value of 0 being returned. The ActivateField method destroys the context of
a query when it is used after the ExecuteQuery method.

The ActivateField method forces the specified field to be included in the SQL statement that is
initiated by an ExecuteQuery method that follows. ActivateField should always be followed by
ExecuteQuery. If a field is activated and then referenced by a GetFieldValue or SetFieldValue
statement prior to an ExecuteQuery statement, the activation has no effect. The activated field is not
retrieved through a query, so it contains an empty value.

If a field is not activated prior to a WriteRecord, the data is written to the database, but corruption
issues may arise when mobile users synchronize. An ActivateField call prior to an ExecuteQuery call,
followed by a WriteRecord, makes sure that the field is written correctly to the transaction log so that
changes made by mobile users are saved back to the server database correctly at synchronization
time.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is in Siebel VB. For an equivalent Siebel eScript example, read ClearToQuery
Method on page 185.

Dim oEmpBusObj As BusObject

Dim oEmpBusComp As BusComp
Dim sLoginName As String

Set oEmpBusObj = TheApplication.ActiveBusObject

Set oEmpBusComp = oEmpBusObj.GetBusComp("Employee")
oEmpBusComp.SetViewMode AllView

180 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

oEmpBusComp.ClearToQuery
oEmpBusComp.SetSearchSpec "Login Name", sLoginName
oEmpBusComp.ExecuteQuery
Set oEmpBusComp = Nothing

Related Topic
DeactivateFields Method on page 187

ActivateMultipleFields Method
Use ActivateMultipleFields to activate data for the fields specified in the property set.

Syntax
BusComp.ActivateMultipleFields(SiebelPropertySet sps)

Argument Description

SiebelPropertySet Property set containing a collection of properties representing the fields

that are to be activated

Returns
TRUE if success; FALSE if failure

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is for Java Data Bean:

import com.siebel.data.*;
...
//Create Siebel Data Bean.
//login into Siebel Data Bean
...
//Create Siebel Bus Object.
//Get the Bus Object from SiebelDataBean
...
//Create Siebel Bus Comp siebBusComp
//Get the business component using SiebelBusObject

SiebelPropertySet ps = new mdata_bean.NewPropertySet();

ps.setProperty("Account Products","");
ps.setProperty("Agreement Name","");
ps.setProperty("Project Name","");

Siebel Object Interfaces Reference Version 8.1 18 1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

ps.setProperty("Description","");
ps.setProperty("Name","");
siebBusComp.ActivateMultipleFields(ps);
...

The following Siebel eScript example queries the Contact business component and retrieves the First
Name and Last Name of the first contact found:

var ContactBO = TheApplication().GetBusObject("Contact");

var ContactBC = ContactBO.GetBusComp("Contact");
with (ContactBC)
{
SetViewMode(AllView);
var fieldsPS = TheApplication().NewPropertySet();
var valuesPS = TheApplication().NewPropertySet();
fieldsPS. SetProperty("Last Name", "");
fieldsPS.SetProperty("First Name", "");
ActivateMultipleFields(fieldsPS);
ClearToQuery();
ExecuteQuery();
if (FirstRecord())
{
GetMultipleFieldValues(fieldsPS, valuesPS);
var slName = valuesPS.GetProperty("Last Name");
var sfName = valuesPS.GetProperty("First Name");
}
}

Related Topics
SetMultipleFieldValues Method on page 233
GetMultipleFieldValues Method on page 203

Associate Method
The Associate method creates a new many-to-many relationship for the parent object through an
association business component (see GetAssocBusComp).

Syntax
BusComp.Associate(whereIndicator)

Argument Description

whereIndicator This argument should be one of the following predefined constants or the
corresponding integer: NewBefore (0) or NewAfter (1), as in NewRecord.

Returns
Not applicable

182 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Usage
To set field values on a child record that has been associated to a parent record, use the context of
the MVGBusComp.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following VB example updates the Opportunity Assignment Type field. The parent business
component can be any business component that includes the Sales Rep multi-value group.

Dim oParentBC as BusComp

Dim oMvgBC as BusComp
Dim oAssocBC as BusComp

Set oParentBC = me.BusComp

Set oMvgBC = OpBC.GetMVGBusComp("Sales Rep")
Set oAssocBC = oMvgBC.GetAssocBusComp
With oAssocBC
.SetSearchSpec "Id", newPosId
.ExecuteQuery
.Associate NewAfter
End With

oMvgBC.SetFieldValue "Opportunity Assignment Type", "NewType"

oMvgBC.WriteRecord
Set oAssocBC = Nothing
Set oMvgBC = Nothing
Set oParentBC = Nothing

The following Siebel eScript example finds a contact with the Last Name = Abanilla, and adds a new
organization named CKS Software to its Organization MVG.

var ok = 0;
var ContactBO= TheApplication().GetBusObject("Contact");
var ContactBC = ContactBO.GetBusComp("Contact");
with (ContactBC)
{
ClearToQuery();
SetViewMode(AllView);

// Searches by Last Name

SetSearchSpec ("Last Name", "Abanilla");
ExecuteQuery();
if (FirstRecord())
{

// Instantiates Organization MVG

var oMvgBC = GetMVGBusComp("Organization");
var oAssocBC = oMvgBC.GetAssocBusComp();

Siebel Object Interfaces Reference Version 8.1 18 3

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

oAssocBC.ClearToQuery();
oAssocBC.SetSearchSpec("Name", "CKS Software");
oAssocBC.ExecuteQuery ();

// Checks if the Organization was found

if (oAssocBC.FirstRecord())
{

// Organization was found

try
{
oAssocBC.Associate(NewAfter);
ok = 1;
}

catch (e)
{
ok = 0;
TheApplication().RaiseErrorText("Error Associating new Organization");
}

} // if oAssocBC.FirstRecord

} // if FirstRecord

} // With ContactBC

Related Topics
NewRecord Method on page 221
FirstSelected Method on page 194
GetMVGBusComp Method on page 203

BusObject Method
The BusObject method returns the business object that contains the business component.

Syntax
BusComp.BusObject

Argument Description

Not applicable

Returns
The business object that contains the business component

184 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Example
For an example, read SetViewMode Method on page 245.

Related Topic
ActiveBusObject Method on page 118

ClearToQuery Method
The ClearToQuery method clears the current query but does not clear sort specifications on the
BusComp.

Syntax
BusComp.ClearToQuery

Argument Description

Not applicable

Returns
Not applicable

Usage
Any fields to be queried must be activated before ClearToQuery. For more information, read
ActivateField Method on page 179.

Search and sort specifications sent to the business component are cumulative; the business
component retains and logically performs an AND operation on query qualifications since the last
ClearToQuery, except for new search specifications on a field for which a search specification has
previously been set. In that circumstance, the new specification replaces the old.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is in Siebel eScript. For Siebel VB examples, read Applet_PreInvokeMethod
Event on page 104, ActivateField Method on page 179, and ExecuteQuery Method on page 190. For
another eScript example, read GotoView Method on page 135.

Siebel Object Interfaces Reference Version 8.1 18 5

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

var oEmpBusObj = TheApplication().ActiveBusObject();

var oEmpBusComp = oEmpBusObj ().GetBusComp("Employee");
var sLoginName;

oEmpBusComp.ClearToQuery();
oEmpBusComp.SetSearchSpec("Login Name", sLoginName);
oEmpBusComp.ExecuteQuery();

oEmpBusComp = null;
oEmpBusObj = null;

Related Topic
RefineQuery Method on page 227

CountRecords Method
CountRecords uses database aggregation to count the records returned by the last ExecuteQuery()
call.

Syntax
BusComp.CountRecords()

Argument Description

Not applicable

Returns
An integer indicating the number of records returned by the last ExecuteQuery() call.

Used With
Server Script

Examples
The following example is in Siebel eScript:

function Service_PreInvokeMethod (MethodName, Inputs, Outputs)

{
if (MethodName == "Call_eScript")
{
var bo = TheApplication().GetBusObject("Opportunity");
var bc = bo.GetBusComp("Opportunity");
with (bc)
{
ClearToQuery();
SetSearchSpec ("Name", "A*");

186 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

ExecuteQuery();
var count = CountRecords();
}

// other code..

return (CancelOperation);
}

return (ContinueOperation);
}

DeactivateFields Method
DeactivateFields deactivates the fields that are currently active from a business component SQL
query statement, except those that are not ForceActive, required for a link, or required by the
BusComp class.

Syntax
BusComp.DeactivateFields

Argument Description

Not applicable

Returns
Not applicable

Usage
You must activate fields using ActivateField prior to executing a query for the business component.

By default, fields are inactive except when:

They are displayed on the applet and the business component is the instance on which the applet
is based.

They are System fields (which include Id, Created, Created By, Updated, and Updated By).

Their ForceActive property is set to TRUE.

The method ActivateField has been invoked with the FieldName.

They have the Link Specification property set to TRUE.

After fields have been deactivated, the business component must be reexecuted or the application
crashes.

Siebel Object Interfaces Reference Version 8.1 18 7

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Examples
The following example is for COM. SiebelApplication is an Application instance.

Dim oBO As BusObject

Dim OBC As BusComp
Dim errCode

Set oBO = SiebelApplication.GetBusObject("Account", errCode)

Set oBC = oBO.GetBusComp("Account", errCode)
oBC.DeactivateFields errCode
oBC.ActivateField "Name", errCode
oBC.ActivateField "Location", errCode
oBC.ClearToQuery errCode
oBC.ExecuteQuery ForwardOnly, errCode
Set oBC = Nothing
Set oBO = Nothing

The following example is in Siebel eScript:

var oBC;
var oBO;

oBO = TheApplication().GetBusObject("Account");
oBC = oBO.GetBusComp("Account");
oBC.DeactivateFields();
oBC.ActivateField("Name");
oBC.ActivateField("Location");
oBC.ClearToQuery();
oBC.ExecuteQuery(ForwardOnly);
oBC = null;
oBO = null;

The following example is in Siebel VB:

Dim oBO As BusObject

Dim oBC As BusComp

Set oBO = TheApplication.GetBusObject("Account")

Set oBC = oBO.GetBusComp("Account")
oBC.DeactivateFields
oBC.ActivateField "Name"
oBC.ActivateField "Location"
oBC.ClearToQuery
oBC.ExecuteQuery ForwardOnly
Set oBC = Nothing
Set oBO = Nothing

Related Topic
ActivateField Method on page 179

188 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

DeleteRecord Method
DeleteRecord removes the current record from the business component.

Syntax
BusComp.DeleteRecord

Argument Description

Not applicable

Returns
Not applicable

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
This Siebel VB example illustrates how to delete accounts with a status of Inactive:

Sub DeleteInactiveAccounts()
Dim objBO as BusObject
Dim objBC as BusComp

Set objBO = TheApplication.GetBusObject("Account")

Set objBC = objBO.GetBusComp("Account")
With objBC
.ClearToQuery
.SetSearchSpec "Status", "Inactive"
.ExecuteQuery ForwardBackward
Do While .FirstRecord
.DeleteRecord
Loop
End With
Set objBC = Nothing
Set objBO = Nothing
End Sub

NOTE: The cursor is moved to the next record after DeleteRecord is executed. Therefore, it is not
necessary to execute NextRecord after DeleteRecord. Do not use NextRecord after DeleteRecord in
a loop because this causes the deletion of the last record in the loop to be skipped. If you use
DeleteRecord on the last record, the cursor points to nothing.

Siebel Object Interfaces Reference Version 8.1 18 9

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

ExecuteQuery Method
ExecuteQuery returns a set of business component records using the criteria established with
methods such as SetSearchSpec.

Syntax
BusComp.ExecuteQuery ([cursorMode])

Argument Description

cursorMode An integer. An optional argument that must be one of the following constants
(provided in Siebel VB as well as COM Servers):

ForwardBackward. Selected records can be processed from first to last or

from last to first. This is the default if no value is specified.

ForwardOnly. Selected records can be processed only from the first record
to the last record. Focus cannot return to a record.

Returns
Not applicable

Usage
Use a cursorMode of ForwardOnly wherever possible to achieve maximum performance. If you use
ForwardOnly, make sure that your application code does not attempt to navigate backward using
PreviousRecord or FirstRecord without a requery. Do not use ForwardOnly when operating on UI
business components unless the application code requeries using a cursorMode of ForwardBackward.

When using the ForwardBackward cursor mode, and the query matches over 10,000 records, the
object manager returns this error message: There were more rows than could be returned. Please
refine your query to bring back fewer rows.

To reduce the number of queries needed, you can use the parent-child relationships for business
components that are set up in business objects. For example, an Opportunity business object sets
up a parent-child relationship between the Opportunity business component and the Contact
business component. If you query on the Opportunity business component you can read values from
the corresponding records in the Contact business component without any additional queries. Before
querying a child business component, you must query its parent, otherwise the query returns no
records.

NOTE: You must activate fields by using the ActivateField method before executing a query for a
business component. If you are writing an event handler on a business component, you must make
sure that the field has already been activated by specifying the ForceActive user property on the
control.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

190 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Example
This Siebel VB example sets up and executes a query to find the primary on the account team. Only
the primary can change the primary address. For other examples, read Applet_PreInvokeMethod
Event on page 104, GotoView Method on page 135, and ClearToQuery Method on page 185.

(general) (declarations)
Option Explicit
Function BusComp_PreSetFieldValue (FieldName As String,
FieldValue As String) As Integer
Dim i As Integer
Dim iFoundP As Integer ' 1 = found (TRUE), 0 = not found (FALSE)
Dim oMVGBC as BusComp

iFoundP = FALSE
Select Case FieldName
Case "SSA Primary Field"
set oMVGBC = me.ParentBusComp.GetMVGBusComp("Sales Rep")
With oMVGBC ' this is the position BC
.ActivateField "Active Login Name"
.ActivateField "SSA Primary Field"
.ClearToQuery
.ExecuteQuery ForwardBackward
i = .FirstRecord
Do While i <> 0
if .GetFieldValue("SSA Primary Field") = "Y" then
iFoundP = TRUE 'mark that found a primary
if.GetFieldValue("Active Login Name") <> TheApplication.LoginName then
TheApplication.RaiseErrorText"You cannot change the Primary address
because you are not the Primary on the Account Team")
end if
Exit Do
else
i = .NextRecord
end if
Loop
if iFoundP = FALSE then
.FirstRecord
TheApplication.RaiseErrorText("No Primary Found - Contact an Administrator")
end if
End With
End Select

set oMVGBC = Nothing

BusComp_PreSetFieldValue = ContinueOperation

End Function

Related Topics
ActivateField Method on page 179
ClearToQuery Method on page 185
SetSearchSpec Method on page 238

Siebel Object Interfaces Reference Version 8.1 19 1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

ExecuteQuery2 Method
ExecuteQuery2 returns a set of business component records using the criteria established with
methods such as SetSearchSpec.

Syntax
BusComp.ExecuteQuery2 ([cursorMode], ignoreMaxCursorSize)

Argument Description

cursorMode An integer. An optional argument that can be one of the following two
constants (provided in Siebel VB as well as COM Servers):

ForwardBackward. Selected records may be processed from first

to last or from last to first. This is the default if no value is specified.

ForwardOnly. Selected records can be processed only from the

first record to the last record. Focus cannot return to a record.

ignoreMaxCursorSize TRUE. Retrieves every row from a business component. This option
may result in lower performance.

FALSE. Retrieves the number of rows specified by the

MaxCursorSize argument in the CFG file.

Returns
Not applicable

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

FirstRecord Method
FirstRecord moves the record pointer to the first record in a business component, making that record
current and invoking any associated script events.

NOTE: When executing a query on a business component, SQL is generated for any active child
business component. Calling the FirstRecord method triggers the BusComp_ChangeRecord event and
causes the same SQL for the child business component to execute again.

Syntax
BusComp.FirstRecord

Argument Description

Not applicable

192 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Returns
An integer in Siebel VB: 1 or nonzero if there was a first record (the query returned results) and 0
if there are no records; a Boolean in Siebel eScript, COM, and ActiveX.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Examples
The following examples show how the FirstRecord method could be used to check whether an Account
displayed in a child applet (for example, the Account List Applet - child applet in the Contact Detail
- Accounts View) has any service requests associated to it. The outcome of this could then determine
whether other code should be run against the Account record.

The following example is in Siebel eScript:

function BusComp_PreInvokeMethod (MethodName)

{
// 'CheckSR' method invoked from a custom button on 'Account List Applet - child'
applet.
if (MethodName == "CheckSR")
{
var oBO = TheApplication().ActiveBusObject();
var oBC = oBO.GetBusComp("Service Request");
var strAccntId = this.GetFieldValue("Id");

with (oBC)
{
SetViewMode(AllView);
ClearToQuery();
SetSearchSpec("Account Id", strAccntId);
ExecuteQuery(ForwardOnly);
if (FirstRecord())
{

// [additional code placed here]

}

else
{
TheApplication().RaiseErrorText("No Service Requests Associated To This
Account.")
}

return (CancelOperation);
}

return (ContinueOperation);
}

Siebel Object Interfaces Reference Version 8.1 19 3

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

The following example is in Siebel VB:

Function BusComp_PreInvokeMethod (MethodName As String) As Integer

Dim iRtn As Integer

iRtn = ContinueOperation

''CheckSR' method invoked from a custom button On 'Account List Applet - child'
Applet.
If MethodName = "CheckSR" Then
Dim oBO As BusObject
Dim oBC As BusComp
Dim strAccntId As String

Set oBO = TheApplication.ActiveBusObject

Set oBC = oBO.GetBusComp("Service Request")
strAccntId = me.GetFieldValue("Id")

With oBC
.SetViewMode AllView
.ClearToQuery
.SetSearchSpec "Account Id", strAccntId
.ExecuteQuery ForwardOnly
If .FirstRecord Then
'[additional code placed here]
Else
TheApplication.RaiseErrorText("No Service Requests Associated To This
Account.")
End If

End With

iRtn = CancelOperation
End If

BusComp_PreInvokeMethod = iRtn
End Function

Related Topic
NextRecord Method on page 222

FirstSelected Method
FirstSelected moves the focus to the first record of the multiple selection in the business component,
invoking any associated Basic events.

194 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
BusComp.FirstSelected

Argument Description

Not applicable

Returns
An integer in Siebel VB: 1 or nonzero if there was a first record (the query returned results) and 0
if there are no records; a Boolean in ActiveX, COM, and Siebel eScript.

Used With
COM Data Server, Server Script

Examples
The following examples show how the FirstSelected method could be used in conjunction with the
NextSelected method to provide custom multirecord deletion functionality. This code could be
triggered in respect to the user invoking the Delete Selected custom method, when pressing a
custom button on an applet.

The following example is in Siebel eScript:

function BusComp_PreInvokeMethod (MethodName)

{
if (MethodName == "Delete Selected")
{
with (this)
{
var iRecord = FirstSelected();

while (iRecord)
{
DeleteRecord();
iRecord = NextSelected();
}

return (CancelOperation);
}

return (ContinueOperation);
}

The following example is in Siebel VB:

Function BusComp_PreInvokeMethod (MethodName As String) As Integer

Dim iRtn As Integer

Siebel Object Interfaces Reference Version 8.1 19 5

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

iRtn = ContinueOperation
If MethodName = "Delete Selected" Then

With me
Dim iRecord As Integer

iRecord = .FirstSelected

While iRecord
.DeleteRecord
iRecord = .NextSelected
Wend

End With

iRtn = CancelOperation

End If

BusComp_PreInvokeMethod = iRtn
End Function

GetAssocBusComp Method
GetAssocBusComp returns the association business component. The association business component
can be used to operate on the association using the normal business component mechanisms.

Syntax
BusComp.GetAssocBusComp

Argument Description
Not applicable

Returns
The association business component for a business component

Usage
This method and the Associate method make sense only for many-to-many relationships, which are
based on intersection tables, for example Account and Industry. In the context of a many-to-many
relationship, you can use Siebel VB to either add a new record (that is, associate a new child record),
or insert a record (that is, create a new record) in the child business component. To add a record,
use GetAssocBusComp and the Associate method. To insert a record, use GetMVGBusComp and the
NewRecord method. The GetAssocBusComp should be set to Nothing after use.

GetAssocBusComp can also be applied to the Child Business Component of a Master Detail View
(rather than upon the MVG BusComp) when a N:M Link is used and the Child Applet has an
Association Applet defined.

196 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is in Siebel VB and uses GetAssocBusComp to add a new industry to an
account record:

Dim oAssocBC As BusComp

Set oAssocBC = oMainBc.GetMVGBusComp("Industry").GetAssocBusComp

With oAssocBC
.ClearToQuery
.SetSearchExpr "[SIC Code] = ""5734"" "
.ExecuteQuery ForwardOnly

If .FirstRecord Then .Associate NewBefore

End With
Set oAssocBC = Nothing

The following is the equivalent Siebel eScript code:

//get the business Object and the business component

var oAssocBC = oMainBc.GetMVGBusComp("Industry").GetAssocBusComp();
with (oAssocBC)
{
ClearToQuery;
SetSearchExpr("[SIC Code] = ""5734"" ");
ExecuteQuery(ForwardOnly)
If (FirstRecord())
Associate(NewBefore);
}
oAssocBC = null;

Related Topics
GetMVGBusComp Method on page 203
GetPicklistBusComp Method on page 205

GetFieldValue Method
GetFieldValue returns the value for the field specified in its argument for the current record of the
business component. Use this method to access a field value.

Siebel Object Interfaces Reference Version 8.1 19 7

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
BusComp.GetFieldValue(FieldName)

Argument Description

FieldName String variable or literal containing the name of the field

Returns
A string containing the field value of the field identified in FieldName, an error message if the field
is inactive, or an empty string if the field is empty.

NOTE: Date fields retrieved by GetFieldValue() are always returned using the format MM/DD/YYYY,
no matter what your local date format is set to. Use GetFormattedFieldValue() to get the same date
format you use in the client interface.

Usage
Only fields that were active at the time of the BusComp query contain values. For more information,
read ActivateField Method on page 179. If this method is used on fields that are not active, an error
message is returned. If this method is used on fields that are empty, an empty string is returned.

CAUTION: If a value from a business component that is a child of the current business component
is desired, the Link Specification property for that field must be set to TRUE in Siebel Tools.
Otherwise, the parent business component cannot access the value in the child business component.
For more information, read Siebel Object Types Reference.

The FieldName must be enclosed in double quotes and must be spelled exactly as the field name
appears in Siebel Tools, with the correct case; for example,

GetFieldValue("ActivityCreatedByName")

The name "Person who created the activity", as shown in the status bar, does not work; nor does
the column head "Created By".

NOTE: In Browser Script, GetFieldValue can be used only for the fields exposed in the applet and for
the system Id field.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Example
The following example is in Siebel VB. It shows an implementation of the PreSetFieldValue event to
illustrate the use of GetFieldValue:

Function BusComp_PreSetFieldValue (FieldName As String, FieldValue As String) As

Integer

198 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Dim bcOppty As BusComp

Dim boBusObj As BusObject
Dim srowid As String

srowid = GetFieldValue("Id")
Set boBusObj = TheApplication.GetBusObject("Opportunity")
Set bcOppty = boBusObj.GetBusComp("Opportunity")
With bcOppty
.SetViewMode SalesRepView
.ActivateField "Sales Stage"
.SetSearchSpec "Id", srowid
.ExecuteQuery ForwardOnly
End With

Set bcOppty = Nothing

Set boBusObj = Nothing

End Function

The following is the equivalent example in Siebel eScript.

function BusComp_PreSetFieldValue (FieldName, FieldValue)

var boBusObj = TheApplication().GetBusObject("Opportunity");

var bcOppty = boBusObj.GetBusComp("Opportunity");
var srowid = GetFieldValue("Id");

with (bcOppty)
{
SetViewMode(SalesRepView);
ActivateField("Sales Stage");
SetSearchSpec("Id", srowid);
ExecuteQuery(ForwardOnly);
}

bcOppty = null;
boBusObj = null;
}

Related Topics
ActivateField Method on page 179
GetFormattedFieldValue Method

GetFormattedFieldValue Method
GetFormattedFieldValue returns the field value in the current local format; it returns values in the
same format as the Siebel UI.

Siebel Object Interfaces Reference Version 8.1 19 9

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
BusComp.GetFormattedFieldValue(FieldName)

Argument Description

FieldName String variable or literal containing the name of the field to obtain the value
from

Returns
A string containing the value of the requested field, in the same format as displayed in the user
interface, or an empty string ("") if the field is inactive or empty.

Usage
GetFormattedFieldValue is useful for code that is used in multiple countries with different formats for
currency, date, and number. This method can be used only on fields that have been activated using
ActivateField.

Some special behavior is associated with particular data types.

DTYPE_PHONE. When used on fields of DTYPE_PHONE, these methods return formatted phone
numbers.

Example 1:

phone = bc.GetFieldValue("Main Phone Number")

TheApplication.Trace "The number is " & phone

Result:

The number is 8869629123

Example 2:

phone = bc.GetFormattedFieldValue("Main Phone Number")

TheApplication.Trace "The number is " & phone

Result:

The number is (886) 962-9123

DTYPE_DATE. When used on fields of DTYPE_DATE, these methods are the same as GetFieldValue
and SetFieldValue, except that the result is in the format of the Regional Setting.

Table 33 shows the standard formats used by GetFieldValue and SetFieldValue to return data.

Table 33. Date and Time Formats

Type of Data Format

Dates mm/dd/yyyy

200 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Table 33. Date and Time Formats

Type of Data Format

Times hh:nn:ss

Date-times mm/dd/yyyy hh:nn:ss

If you attempt to use SetFieldValue and your Regional Setting format is different, you receive an
error like this:

Error: The value '31-Dec-99' can not be converted to a date time value.

This error can be avoided by using the GetFormattedFieldValue and SetFormattedFieldValue

methods.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Example
The following Siebel VB example demonstrates how to use the GetFormattedFieldValue function and
how to calculate the number of days between two dates.

Sub Button_Click
Dim DateDiff as Integer
Dim oBC as BusComp
Set oBC= me.BusComp
x = oBC.GetFormattedFieldValue("Start Date")
y = oBC.GetFormattedFieldValue("Done")
dx = DateValue(x)
dy = DateValue(y)
DateDiff = dy - dx
End Sub

Related Topics
ActivateField Method on page 179
GetFieldValue Method on page 197
SetFieldValue Method on page 230
SetFormattedFieldValue Method on page 232

GetLastErrCode Method
The GetLastErrCode method returns the most recent error code on the business component level.

Siebel Object Interfaces Reference Version 8.1 20 1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
BusComp.GetLastErrCode

Argument Description

Not applicable

Returns
The last error code as a short integer. 0 indicates no error.

Usage
After execution of a method, the GetLastErrCode can be invoked to check if any error was returned
from the previous operation. The GetLastErrText method can be invoked to retrieve the text of the
error message. The text retrieved using GetLastErrText also includes a Siebel error number that can
be used to search Oracle MetaLink 3 for additional information about the error.

Used With
COM Data Control, Mobile Web Client Automation Server

GetLastErrText Method
The GetLastErrText method returns the last error text message on the business component level.

Syntax
BusComp.GetLastErrText

Argument Description
Not applicable

Returns
The most recent error text message as a String

Usage
After execution of a method, the GetLastErrCode can be invoked to check if any error was returned
from the previous operation. The GetLastErrText method can be invoked to retrieve the text of the
error message.

Used With
COM Data Control, Mobile Web Client Automation Server

202 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Related Topic
GetLastErrCode Method

GetMultipleFieldValues Method
GetMultipleFieldValues returns values for the fields specified in the property set.

Syntax
BusComp.GetMultipleFieldValues(SiebelPropertySet fieldNames, SiebelPropertySet fieldValues)

Argument Description

fieldNames A property set containing a collection of properties representing the fields

fieldValues A property set containing a collection of properties representing the values for
the fields specified in the fieldNames argument

Returns
TRUE if success; FALSE if failure

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Related Topic
SetMultipleFieldValues Method on page 233

GetMVGBusComp Method
The GetMVGBusComp method returns the MVG business component associated with the business
component field specified by FieldName. This business component can be used to operate on the
multi-value group using the normal business component mechanisms.

Syntax
BusComp.GetMVGBusComp(FieldName)

Argument Description

FieldName Name of the field with a multi-value group attached, used to obtain the multi-
value group business component

Siebel Object Interfaces Reference Version 8.1 20 3

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Returns
The multi-value group business component of the current business component and identified field

Usage
A multi-value group is a set of detail records attached to the current record in the business
component that holds the corresponding multi-value field.

The GetMVGBusComp should be set to Nothing after use.

NOTE: In the context of a many-to-many relationship, you can use Siebel VB to either add a new
record, that is, associate a new child record, or insert a record, that is, create a new record in the
child business component. To add a record, use GetAssocBusComp and the Associate method. To
insert a record, use GetMVGBusComp and the NewRecord method.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following sample Siebel VB code using GetMVGBusComp inserts a new address to the Hong
Kong Flower Shop account record. For other examples, read ExecuteQuery Method on page 190 and
FirstSelected Method on page 194.

Dim AccntBO as BusObject

Dim AccntBC as BusComp
Dim AddrBC as BusComp
Set AccntBO = TheApplication.GetBusObject "Account"
Set AccntBC = AccntBO.GetBusComp "Account"

With AccntBC
.SetViewMode SalesRepView
.ClearToQuery
.SetSearchSpec "Name", "Hong Kong Flower Shop"
.ExecuteQuery
Set AddrBC = .GetMVGBusComp "Street Address"
End With

With AddrBC
.NewRecord NewAfter
.SetFieldValue "City", "Denver"
.WriteRecord
End With

Set AccntBO = Nothing

Set AccntBC = Nothing
Set AddrBC = Nothing

204 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Related Topics
FirstSelected Method on page 194
GetPicklistBusComp Method

GetNamedSearch Method
GetNamedSearch returns the named search specification specified by searchName.

Syntax
BusComp.GetNamedSearch(searchName)

Argument Description

searchName Name of the search specification that references the search string.

Returns
A string containing the value specified in the search specification identified in searchName

Usage
The search specification uses the same syntax as used in predefined queries.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Related Topics
GetSearchExpr Method on page 207
GetSearchSpec Method on page 208
SetNamedSearch Method on page 235

GetPicklistBusComp Method
GetPicklistBusComp returns the pick business component associated with the specified field in the
current business component.

Siebel Object Interfaces Reference Version 8.1 20 5

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
BusComp.GetPicklistBusComp(FieldName)

Argument Description

FieldName Name of the field with a picklist specified; used to obtain the pick business
component

Returns
The pick business component of the current business component and identified field. If there is no
picklist associated with that field, the function returns an error.

Usage
The returned pick business component can be used to operate on the picklist. The
GetPickListBusComp should be destroyed after use by using the Nothing function.

NOTE: When a record is picked on a constrained picklist using the GetPickListBusComp and Pick
methods, the constraint is active. Therefore, the retrieved picklist business component contains only
those records that fulfill the constraint.

To pick a value from a picklist in Siebel VB

1 Use GetPicklistBusComp to create an instance of the pick list business component.

2 Navigate in the picklist business component to the record you want to pick.

3 Use Pick to pick the value.

4 Use Set objBCPickList = Nothing to explicitly destroy the picklist business component
instance.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is in Siebel eScript:

if (this.GetFieldValue("City") == "San Mateo")

{
var oBCPick = this.GetPicklistBusComp("State");
with (oBCPick)
{
ClearToQuery();
SetSearchSpec("Value", "CA");
ExecuteQuery(ForwardOnly);
if(FirstRecord())
Pick();

206 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

}
oBCPick = null;
}

The following example is for Java Data Bean. It selects a product from a picklist.

Sieb_busObject = Sieb_dataBean.getBusObject("Service Request");

Sieb_busComp = Sieb_busObject.getBusComp("Service Request");
Sieb_busComp.newRecord(false);

. . .

SiebelBusComp productBusComp = Sieb_busComp.getPicklistBusComp("Product");

productBusComp.ClearToQuery();
productBusComp.setSearchSpec("Name", "ATM Card");
productBusComp.executeQuery(false);
isRecord =productBusComp.firstRecord();
try
{
if (isRecord)
productBusComp.pick();
Sieb_busComp.writeRecord();
}

catch (SiebelException e)
{
System.out.println("Error in Pick " + e.getErrorMessage());
}

The following example is in Siebel VB:

If Me.GetFieldValue("City") = "San Mateo" Then

Set oBCPick = Me.GetPicklistBusComp("State")
With oBCPick
.ClearToQuery
.SetSearchSpec "Value", "CA"
.ExecuteQuery ForwardOnly
If .FirstRecord Then .Pick
End With
Set oBCPick = Nothing
End If

Related Topics
FirstSelected Method on page 194
GetMVGBusComp Method on page 203

GetSearchExpr Method
GetSearchExpr returns the current search expression for the business component.

Siebel Object Interfaces Reference Version 8.1 20 7

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
BusComp.GetSearchExpr

Argument Description

Not applicable

Returns
A string containing the current search expression. An example of a returned search expression string
is "Revenue > 10000 AND Probability > .5".

Usage
GetSearchSpec retrieves the business component state, not the values. The business component
state does not change until the query is executed. Note that it may never change to the original value
if the user input is invalid.

When using GetSearchExpr in a browser script and the Applet_PreInvokeMethod, GetSearchExpr

returns a null value even if a query filter has been added.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Related Topics
GetNamedSearch Method on page 205
GetSearchSpec Method
SetSearchExpr Method on page 237

GetSearchSpec Method
GetSearchSpec returns the search specification for the field specified by the FieldName argument.

Syntax
BusComp.GetSearchSpec(FieldName)

Argument Description

FieldName Contains the name of the field from which to obtain the associated search
specification.

Returns
A string containing the search specification for the field identified in FieldName. An example of a
returned search specification string is "> 10000".

208 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Related Topics
GetNamedSearch Method on page 205
GetSearchExpr Method on page 207
GetSortSpec Method on page 209
SetSearchSpec Method on page 238

GetSortSpec Method
GetSortSpec returns the active sort specification of the object that has context.

Syntax
this.GetSortSpec();

Argument Description

Not applicable

Returns
Active sort specification of the object that has context

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Related Topics
GetSearchSpec Method on page 208
SetSortSpec Method on page 242

GetUserProperty Method
GetUserProperty returns the value of a named user property.

Siebel Object Interfaces Reference Version 8.1 20 9

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
BusComp.GetUserProperty(propertyName)

Argument Description

propertyName Contains the name of the user property to obtain.

Returns
The user property

Usage
The value of a user property is set using SetUserProperty. The user properties act like instance
variables of a business component. The advantage of user properties is that they can be accessed
from anywhere in the code (even from other applications through COM) using GetUserProperty. An
instance variable, on the other hand, can be accessed only from within Siebel VB from the same
object on which the variable is declared.

The value of the property is reset every time you instantiate a new business component.

NOTE: GetUserProperty does not interact directly with user properties defined in Siebel Tools.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Related Topic
SetUserProperty Method on page 244

GetViewMode Method
GetViewMode returns the current visibility mode for the business component. This effects which
records are returned by queries according to the visibility rules. For more information, read
SetViewMode Method on page 245.

Syntax
BusComp.GetViewMode

Argument Description

Not applicable

210 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Returns
An integer constant that identifies a visibility mode

Returns Description

mode Where mode is a Siebel ViewMode constant or its corresponding integer value. The
constants shown are defined in three environments. For details on each Siebel
ViewMode constant, read SetViewMode Method on page 245.

SalesRepView (0)

ManagerView (1)

PersonalView (2)

AllView (3)

OrganizationView (5)

GroupView (7)

CatalogView (8)

SubOrganizationView (9)

Usage
GetViewMode() returns NoneSetView mode until a business component is executed or has its view
mode set through SetViewMode(). The NoneSetViewMode value indicates that the business
component has not yet had any visibility rules applied to it. A business component that has just been
created through a call to GetBusComp() is in this state, so if a specific view mode is desired, it must
be explicitly set through SetViewMode(). Otherwise, the first time the business component is
executed, its view mode is set according to some internal rules.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Related Topic
SetViewMode Method on page 245

InvokeMethod Method
InvokeMethod calls the specialized method or user-created method named in the argument.

Siebel Object Interfaces Reference Version 8.1 21 1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

VB Syntax
BusComp.InvokeMethod methodName, methodArgs

Argument Description

methodName The name of the method. For more information on the available methods, read
InvokeMethod Methods for the Business Component Object on page 213.

methodArgs A single string or a string array (object interfaces) containing arguments to

methodName.

eScript Syntax
BusComp.InvokeMethod(methodName, methArg1, methArg2, , methArgn);

Argument Description

methodName The name of the method

methArg1, methArg2, , One or more strings containing arguments to methodName

methArgn

Returns
A string containing the result of the method

Usage
Use InvokeMethod to call methods on a business component object that are not exposed directly
through the object interface.

Specialized methods are typically methods implemented in applet or business component classes
other than CSSFrame and CSSBusComp, respectively, that is, specialized classes.

NOTE: The InvokeMethod method should be used only with documented specialized methods. Oracle
does not support calling specialized methods with InvokeMethod, unless they are listed in this book.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is in Siebel VB:

(general) (declarations)
Option Explicit

Sub Button1_Click
Me.BusComp.InvokeMethod "Select All"
End Sub

212 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Function BusComp_PreInvokeMethod (MethodName As String) As Integer

BusComp_PreInvokeMethod = ContinueOperation
On Error GoTo Leave
If MethodName = "Select All" Then
Dim oCurBC as BusComp
Set oCurBC = Me
If oCurBC is not nothing Then
oCurBC.ClearToQuery
oCurBC.ExecuteQuery
BusComp_PreInvokeMethod = CancelOperation
End If
End If

Leave:
End Function

The following is the equivalent example in Siebel eScript.

function BusComp_PreInvokeMethod (MethodName)

{
var iReturn = ContinueOperation;
If (Clib.errno() != 0)
return(CancelOperation);
if (MethodName = "Select All")
{
var oCurBC = this;
if (oCurBC != null)
{
oCurBC.ClearToQuery();
oCurBC.ExecuteQuery();
return(CancelOperation);
}
}
return (iReturn);
}

InvokeMethod Methods for the Business Component Object

Siebel applications provide multiple methods for manipulating files stored in the Siebel File System.
These methods may be invoked using server script (Siebel VB, eScript) or using one of the
programmatic interfaces (Mobile Web Client Automation Server connected mode only, COM Data
Control, Java Data Bean). The methods available for manipulating the file system always store or
retrieve the file to and from the local file system. For example, if you construct a Java client using
the Java Data Bean to manipulate the file system, all files must be accessible from the Siebel Server.
You can use UNC naming conventions (for example: \\server\dir\file.txt) or standard DOS directories
(for example: D:\dir\file.txt) for file access, but the UNC path or mounted file system must be
accessible to the Siebel Server. These methods do not serialize the files from a remote client and
place them in the Siebel file system.

Methods that manipulate files are available for business components whose Class is CSSBCFile. The
methods can be accessed using COM Data Control, Java Data Bean, Mobile Web Client Automation
Server, and Server Script.

Siebel Object Interfaces Reference Version 8.1 21 3

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

The following methods are available for use with InvokeMethod:

ClearLOVCache Method on page 214

CreateFile Method on page 215

GenerateProposal Method on page 216

GetFile Method on page 216

PutFile Method on page 217

RefreshBusComp Method on page 218

RefreshRecord Method on page 218

SetAdminMode Method on page 219

ClearLOVCache Method
This method clears the object manager list of values (LOV) cache, functioning similarly to the Clear
Cache button in the Administration - Data > List of Values view.

NOTE: ClearLOVCache clears only the object manager cache, not the session cache in the High
Interactivity client.

Syntax
BusComp.InvokeMethod(ClearLOVCache)

Argument Description

none

Returns
Not Applicable

Used With
This method is supported by BusComp.InvokeMethod() calls in Browser Script, COM Data Control,
COM Data Server, Java Data Bean, Mobile Web Client Automation Server, and Server Script.

Example
The following Siebel eScript example is for Server Script:

function WebApplet_PreInvokeMethod (MethodName)

if (MethodName == "TestMethod") {

var lov_bo = TheApplication().GetBusObject("List Of Values");

var lov_bc = lov_bo.GetBusComp("List Of Values");

214 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

lov_bc.NewRecord(0);

lov_bc.SetFieldValue("Type", "ACCOUNT_STATUS");

lov_bc.SetFieldValue("Name", "Hello");

lov_bc.SetFieldValue("Value", "Hello");

lov_bc.SetFieldValue("Order By", "12");

lov_bc.SetFieldValue("Translate", "Y");

lov_bc.WriteRecord();

lov_bc.InvokeMethod("ClearLOVCache");

lov_bc = null;

lov_bo = null;

return (CancelOperation);

return(ContinueOperation);

CreateFile Method
To create a file in the Siebel file system from an external source, use the business component
CreateFile method. Before calling CreateFile, make sure that a new business component record has
been created using the NewRecord method for the business component.

Syntax
BusComp.InvokeMethod("CreateFile", SrcFilePath, KeyField, KeepLink)

Argument Description

SrcFilePath The fully qualified path of the file on the Siebel Server or Mobile Web Client.

KeyFieldName The name of the field in the business component that contains the File Name.
For example: AccntFileName field in the Account Attachment business
component.

KeepLink Applies to URLs. Either Y or N depending on whether a link to the file is stored
as an attachment instead of the actual file.

Returns
A string containing the values of Success or Error depending on whether or not the operation
succeeded.

Siebel Object Interfaces Reference Version 8.1 21 5

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Used With
This method is supported by BusComp.InvokeMethod() calls in COM Data Control, COM Data Server,
Java Data Bean, Mobile Web Client Automation Server, and Server Script.

GenerateProposal Method
GenerateProposal creates a new proposal record. The DocServer handles the work of generating the
actual proposal.

Syntax
To specify a template:
BusComp.InvokeMethod("GenerateProposal", RecordExists, Replace, TemplateFile);

To use the default proposal template:

BusComp.InvokeMethod("GenerateProposal", RecordExists, Replace)

Argument Description

RecordExists If FALSE, then a new record is created and used to create a new proposal.

If TRUE, the current selected proposal is used.

Replace If TRUE, the template file is copied from the template into the proposal (as a
draft file). You should typically call this method with this argument set to FALSE.

TemplateFile (Optional)
The default value of this argument is NULL.
A string that specifies the name of the template to use. When a string is passed
into this argument, the proposal searches for the first template record whose
name contains the string passed rather than using the default template.

Used With
This method is supported by BusComp.InvokeMethod() calls in Browser Script, COM Data Control,
COM Data Server, Java Data Bean, Mobile Web Client Automation Server, and Server Script.

GetFile Method
Obtains a file from the Siebel file system and places that file on the local file system of the Siebel
Server or Mobile Client. Note that you must be properly positioned on the desired file attachment
record to get the file and have it placed on the local file systems temporary directory.

216 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
BusComp.InvokeMethod(GetFile, KeyFieldName)

Argument Description

KeyFieldName The name of the field in the business component that contains the File Name.
For example: AccntFileName field in the Account Attachment business
component.

Returns
A string containing Success, <OutFilePath> if the operation succeeded. OutFilePath is the fully
qualified path of the file on the Client/Server machine in the users temp directory. The return value
is Error if the operation failed.

Used With
This method is supported by BusComp.InvokeMethod() calls in COM Data Control, COM Data Server,
Java Data Bean, Mobile Web Client Automation Server, and Server Script.

PutFile Method
Updates a file in the Siebel file system with a newer file. Note that you must be properly positioned
on the desired file attachment record to update the file in the file system.

Syntax
BusComp.InvokeMethod(PutFile, SrcFilePath, KeyFieldName)

Argument Description
SrcFilePath This is the fully qualified path of the file on the Siebel Server or Mobile Web
Client.

KeyFieldName This is the name of the field in the business component that contains the File
Name. For example: AccntFileName field in the Account Attachment business
component.

Returns
A string containing the values of Success or Error depending on whether or not the operation
succeeded.

Usage
After using PutFile to save a file attachment the updated attachment is not visible in the user
interface until you call the WriteRecord method. For more information about WriteRecord, read
WriteRecord Method on page 249.

Siebel Object Interfaces Reference Version 8.1 21 7

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Used With
This method is supported by BusComp.InvokeMethod() calls in COM Data Control, COM Data Server,
Java Data Bean, Mobile Web Client Automation Server, and Server Script.

RefreshBusComp Method
This method re-executes the current query for the business component and places the focus back
onto the record that was previously highlighted. The user sees that the data is refreshed but the
same record is still highlighted in the same position in the list applet as before the RefreshBusComp
method was invoked.

Syntax
BusComp.InvokeMethod(RefreshBusComp)

Argument Description

none

Returns
Not Applicable

Used With
This method is supported by BusComp.InvokeMethod() calls in Browser Script, COM Data Control,
COM Data Server, Java Data Bean, Mobile Web Client Automation Server, and Server Script.

NOTE: This method only works with business components that are derived from CSSBCBase.

RefreshRecord Method
This method refreshes the currently highlighted record, which triggers an update of the business
component fields in the client display and positions the cursor on the context record.

Syntax
retVal = BusComp.InvokeMethod(RefreshRecord)

Argument Description

none

Returns
Not Applicable

218 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Used With
This method is supported by BusComp.InvokeMethod() calls in Browser Script, COM Data Control,
Java Data Bean, Mobile Web Client Automation Server, and Server Script.

NOTE: This method only works with business components that are derived from CSSBCBase.

SetAdminMode Method
This method is particularly useful if you need to replicate the behavior enforced by the Admin
property of the View object by disabling all visibility rules for the business component.

Syntax
BusComp.InvokeMethod(SetAdminMode, flag)

Argument Description

flag TRUE or FALSE. Flag to specify whether the business component should be
executed in Admin mode.

Returns
Not Applicable

Used With
This method is supported by BusComp.InvokeMethod() calls in COM Data Control, COM Data Server,
Java Data Bean, Mobile Web Client Automation Server, and Server Script.

LastRecord Method
LastRecord moves the record pointer to the last record in the business component.

Syntax
BusComp.LastRecord

Argument Description

Not applicable

Returns
An integer in Siebel VB; a Boolean in ActiveX, COM, Java Data Bean, Siebel eScript.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Siebel Object Interfaces Reference Version 8.1 21 9

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Example
The following example is for Mobile Web Client Automation Server. SiebelApplication is an
Application instance:

Private Sub LastRecord_Click()

Dim errCode As Integer

Dim oBusComp as SiebelBusComp
FieldValue.Text = ""
HourGlassStart
oBusComp.LastRecord errCode
If errCode = 0 Then
FieldValue.Text = oBusComp.GetFieldValue(FieldName.Text, _
errCode)
End If

HourGlassStop

Status.Text = SiebelApplication.GetLastErrText
End Sub

Related Topics
FirstRecord Method on page 192
NextRecord Method on page 222

Name Method
The Name property contains the name of the business component.

Syntax
BusComp.Name()

Argument Description
Not applicable

Returns
A string containing the business component name

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Example
The following example is in Browser Script:

220 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

function BusComp_PreSetFieldValue (fieldName, value)

{
theApplication().SWEAlert(this.Name());
}

NewRecord Method
NewRecord adds a new record (row) to the business component.

Syntax
BusComp.NewRecord(whereIndicator)

Argument Description

whereIndicator Predefined constant or corresponding integer indicating where the new row
is added. This value should be one of the following:

0 (or NewBefore)

1 (or NewAfter)

2 (or NewBeforeCopy)

3 (or NewAfterCopy)

With Java Data Bean the values are:

FALSE (equivalent to NewBefore)

TRUE (equivalent to NewAfter)

Returns
Not applicable

Usage
This new row becomes the current row, either before or after the previously current record,
depending on the value you selected for WhereIndicator.

You can use NewRecord to copy a record. To place the copy before the original record use the
following command.

Object.NewRecord NewBeforeCopy

To place the copy after the original record, use the following command.

Object.NewRecord NewAfterCopy

In certain cases, using the NewRecord method in a server script results in slow performance for this
method. There is no error message shown and the new record is created, but the response time is
not optimal. This is due to the expected behavior of the application when creating new records.

Siebel Object Interfaces Reference Version 8.1 22 1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Before an application inserts a new record into the database, it must obtain the cursor for the record
set to position the new record in the record set. This requires the record set to be populated before
creating the new record. In the context of a script, a query must be run on the business component
before the NewRecord method is called. If the query is not explicitly run in the script, the application
will force a query to run to bring back the cursor. The application will normally run a full table query,
which results in the performance issue.

For more information on performance issues with the NewRecord method, see FAQ 2079 on Oracle
MetaLink 3.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is in Siebel VB:

Dim oBusObj as BusObject

Dim oBC as BusComp

Set oBusObj = TheApplication.ActiveBusObject

Set oBC = oBusObj.GetBusComp("Action")
oBC.NewRecord NewAfter
oBC.SetFieldValue "Type", "To Do"
oBC.SetFieldValue "Description", "Find Decision Makers")
oBC.WriteRecord

set oBC = Nothing

set oBusObj = Nothing

NextRecord Method
NextRecord moves the record pointer to the next record in the business component, making that the
current record and invoking any associated script events.

Syntax
BusComp.NextRecord

Argument Description

Not applicable

Returns
An integer in Siebel VB; a Boolean in Siebel eScript and COM: 1 if the record pointer was moved to
the next record, 0 if the current record was already the last record.

222 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is in Siebel eScript. For the equivalent Siebel VB example, read FirstRecord
Method on page 192.

var i = 0;
var isRecord;

with (this)
{
ClearToQuery();
SetSearchSpec("Name", "*");
ExecuteQuery(ForwardBackward);
isRecord = FirstRecord();
}
while (isRecord)
{
i++;
isRecord = BusComp.NextRecord();
}

Related Topic
FirstRecord Method on page 192

NextSelected Method
NextSelected moves the focus to the next record of the current multiple selection.

Syntax
BusComp.NextSelected

Argument Description

Not applicable

Returns
An integer: 1 if there is another record in the multiple selection, 0 otherwise.

Used With
Server Script

Siebel Object Interfaces Reference Version 8.1 22 3

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Example
For examples, read FirstSelected Method on page 194.

ParentBusComp Method
ParentBusComp returns the parent (master) business component when given the child (detail)
business component of a Link.

Syntax
BusComp.ParentBusComp

Argument Description

Not applicable

Returns
The parent business component of the Link

Usage
ParentBusComp allows you to write code in the child business component that accesses field values
and performs actions on the parent business component using the normal business component
mechanisms.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is in Siebel VB. For another example, read ExecuteQuery Method on
page 190.

Dim strParentName as String

...
strParentName = Me.ParentBusComp.GetFieldValue("Name")

Pick Method
The Pick method places the currently selected record in a picklist business component into the
appropriate fields of the parent business component.

NOTE: In Siebel Business Applications v.7.5.3 and later releases, Pick cannot be used to change the
record in a read-only picklist field.

224 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
BusComp.Pick

Argument Description

Not applicable

Returns
Not applicable

Usage
Pick must be invoked on the picklists business component. When a record is picked on a constrained
picklist using the GetPickListBusComp and Pick methods, the constraint is active. Therefore, only
records that fulfill the constraint can be retrieved.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
This Siebel VB example sorts the values in the Sales Stage field:

Sub BusComp_NewRecord
Dim oBC as BusComp
set oBC = me.GetPickListBusComp("Sales Stage")

With oBC
.ActivateField "Sales Stage Order"
.ClearToQuery
.SetSortSpec "Sales Stage Order"
.ExecuteQuery ForwardOnly
if .FirstRecord then .Pick
End With

set oBC = Nothing

End Sub

The following is the equivalent example in Siebel eScript:

function BusComp_NewRecord ()
{
var oBC = this.GetPickListBusComp("Sales Stage");
with (oBC)
{
ActivateField("Sales Stage Order");
ClearToQuery();
SetSortSpec("Sales Stage Order");
ExecuteQuery(ForwardOnly);
if (FirstRecord())

Siebel Object Interfaces Reference Version 8.1 22 5

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Pick();
}
oBC = null;
}

Related Topic
GetPicklistBusComp Method on page 205

PreviousRecord Method
PreviousRecord moves to the previous record in the business component, invoking any associated
Basic events.

Syntax
BusComp.PreviousRecord

Argument Description

Not applicable

Returns
An integer in Siebel VB; a Boolean in Siebel eScript, COM, and ActiveX.

Usage
PreviousRecord may be used only on a business component that has been queried using the
FowardBackward CursorMode.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following example is for Mobile Web Client Automation Server. SiebelApplication is an
Application instance:

(general) (declarations)
Option Explicit

Private Sub PreviousRecord_Click()

Dim errCode As Integer
Dim oBusComp as BusComp
FieldValue.Text = ""
HourClassStart
oBusComp.PreviousRecord errCode

226 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

If errCode = 0 Then
FieldValue.Text = oBusComp.GetFieldValue(FieldName.Text, _
errCode)
End If

HourClassStop
Status.Text = SiebelApplication.GetLastErrText

End Sub

Related Topic
ExecuteQuery Method on page 190

RefineQuery Method
This method refines a query after the query has been executed.

Syntax
BusComp.RefineQuery

Argument Description

Not applicable

Returns
Not applicable

Usage
Unlike ClearToQuery, RefineQuery retains the existing query specification and allows you to add
search conditions based only on those fields that have not been set by previous search expressions.
RefineQuery may be most useful when used in conjunction with GetNamedSearch.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
The following Siebel VB code fragment shows how RefineQuery might be used:

me.SetSearchSpec "Status", "Open"

me.ClearToQuery
me.ExecuteQuery

Siebel Object Interfaces Reference Version 8.1 22 7

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

me.RefineQuery
me.SetSearchSpec "Substatus", "Assigned"
me.ExecuteQuery

Related Topics
ClearToQuery Method on page 185
GetNamedSearch Method on page 205

Release Method
The Release() method enables the release of the business component and its resources on the Siebel
Server.

Syntax
BusComp.release()

Argument Description

Not applicable

Returns
Not applicable

Used With
Java Data Bean

Example
The following example is for Java Data Bean:

import com.siebel.data.*;
{

// create Siebel Data Bean
// login into Siebel Data Bean

// Create Siebel Bus Object.
// get the Bus Object from SiebelDataBean

// Create Siebel Bus Comp siebBusComp
// Get the business component using SiebelBusObject

// Use the bus. Component

// Be sure to release the business component and its resources on the server
side siebBusComp.release();

228 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

// release the resources occupied by Siebel Bus Object and Siebel Data Bean after
their use.
}

The following example logs in to a Siebel Server. It then instantiates a business object, a business
component, and a business service. Then, it releases them in reverse order.

import com.siebel.data.*;
import com.siebel.data.SiebelException;

public class JDBReleaseDemo

{
private SiebelDataBean m_dataBean = null;
private SiebelBusObject m_busObject = null;
private SiebelBusComp m_busComp = null;
private SiebelService m_busServ = null;

public static void main(String[] args)

{
JDBReleaseDemo demo = new JDBReleaseDemo();
}

public JDBReleaseDemo()
{
try
{

// instantiate the Siebel Data Bean

m_dataBean = new SiebelDataBean();

// login to the servers

m_dataBean.login("siebel.tcpip.none.none://<gateway>:<port>/<enterprise>/
<object manager>","<user id>","<password>");
System.out.println("Logged in to the Siebel server ");

// get the business object

m_busObject = m_dataBean.getBusObject("Account");

// get the business component

m_busComp = m_busObject.getBusComp("Account");

// get the business service

m_busServ = m_dataBean.getService("Workflow Process Manager");

//release the business service

m_busServ.release();
System.out.println("BS released ");

//release the business component

m_busComp.release();

System.out.println("BC released ");

//release the business object

m_busObject.release();
System.out.println("BO released ");

Siebel Object Interfaces Reference Version 8.1 22 9

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

// logoff
m_dataBean.logoff();
System.out.println("Logged off the Siebel server ");
}

catch (SiebelException e)
{
System.out.println(e.getErrorMessage());
}

Related Topic
Logoff Method on page 148

SetFieldValue Method
SetFieldValue assigns the new value to the named field for the current row of the business
component.

Syntax
BusComp.SetFieldValue FieldName, FieldValue

Argument Description

FieldName String containing the name of the field to assign the value to

FieldValue String containing the value to assign

Returns
Not applicable

Usage
This method can be used only on fields that are active. For details, read ActivateField Method on
page 179. For applications in standard interactivity mode, write the record immediately after using
SetFieldValue by calling WriteRecord.

FieldName must be enclosed in double quotes, and must be spelled exactly as the field name appears
in Siebel Tools (not in the status line of the application or the column head), with the correct case;
for example,

SetFieldValue "Name", "Acme"

230 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

FieldValue must not have a length that exceeds the defined length of the field. For example, passing
a 20 character string into a field that is defined as being 16 characters long results in the runtime
error Value too long for field 'xxxxx' (maximum size nnn). A good practice is to check the length of
the string against the length of the destination field before using SetFieldValue.

To set a field to null, follow this example:

SetFieldValue "Name", ""

Do not use the SetFieldValue method on a field that has a pick list. Instead, use the following
procedure.

1 Use GetPicklistBusComp(...) to get a reference to the picklist business component for the Last
Name field.

2 Set the required SearchSpec on the pick list business component so that a single unique record
is returned.

3 Execute the query on the pick list business component.

4 Call picklistbuscomp.Pick to emulate the user picking the record.

NOTE: SetFieldValue cannot be used with calculated fields and cannot be used recursively.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Example
The following example is in Siebel VB:

Dim CurrOppty as BusComp

Set CurrOppty = Me
If Val(CurrOppty.GetFieldValue("Rep %")) < 75 Then
CurrOppty.SetFieldValue "Rep %", "75"
End If

The following is the equivalent example in Siebel eScript:

var CurrOppty = this;

if (ToInteger(CurrOppty.GetFieldValue("Rep %")) < 75)
CurrOppty.SetFieldValue("Rep %", "75");

Related Topics
ActivateField Method on page 179
SetFormattedFieldValue Method
Pick Method on page 224
GetPicklistBusComp Method on page 205

Siebel Object Interfaces Reference Version 8.1 23 1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

SetFormattedFieldValue Method
SetFormattedFieldValue assigns the new value to the named field for the current row of the business
component. SetFormattedFieldValue accepts the field value in the current local format.

Syntax
BusComp.SetFormattedFieldValue FieldName, FieldValue

Argument Description

FieldName String containing the name of the field to assign the value to.

FieldValue String containing the value to assign.

Returns
Not applicable

Usage
This method is useful when you write code for a Siebel configuration that is used in multiple countries
with different currency, date, and number formats. This method can be used only on fields that have
been activated using ActivateField.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Example
This Siebel VB example is a fragment from a program designed to track the velocity of an opportunity
through its sales stages:

(general) (declarations)
Option Explicit

Dim OpportunityBO as BusObject, StageBC as BusComp

Dim OppStageId as String, SalesRep as String, Stage as String
Dim StagePrev As String, StageDate as String, StageDatePrev as String
Dim Dx as Double, Dy as Double, Diff as Double, DiffStr as String
Dim OppID As String, OppStageId as String, StageID As String
Dim SalesStageBO as BusObject, SalesStageBC as BusComp

Set SalesStageBO = TheApplication.GetBusObject ("Sales Cycle Def")

Set SalesStageBC = SalesStageBO.GetBusComp("Sales Cycle Def")

With SalesStageBC
.SetViewMode AllView
.ClearToQuery
.SetSearchSpec "Sales Cycle Stage", StagePrev
.ExecuteQuery ForwardOnly

232 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

.FirstRecord
StageId = .GetFieldValue("Id")
End With

'Instantiate stage BC
Set StageBC = OpportunityBO.GetBusComp("Opportunity Stage")

'Check that we do not already have a record for the stage

With StageBC
.SetViewMode AllView
.ClearToQuery
.SetSearchSpec "Sales Stage Id", StageId
.ExecuteQuery ForwardOnly

'Proceed further only if we do not already have record

'opportunity sales stage

If (.FirstRecord = 0) Then
'Create a new stage record and write it out
.NewRecord 1
'Record Id for future use
OppStageId = .GetFieldValue("Id")
.SetFieldValue "Opportunity Id", OppId
.SetFieldValue "Sales Stage Id", StageId
.SetFieldValue "Sales Rep", SalesRep
.SetFormattedFieldValue "Entered Date", StageDatePrev
.SetFormattedFieldValue "Left Date", StageDate
Dx = DateValue (StageDatePrev)
Dy = DateValue (StageDate)
Diff = Dy - Dx
DiffStr = Str(Diff)
.SetFieldValue "Days In Stage", DiffStr
.WriteRecord
End If
End With

Related Topics
ActivateField Method on page 179
SetFieldValue Method on page 230

SetMultipleFieldValues Method
SetMultipleFieldValues assigns a new value to the fields specified in the property set for the current
row of the business component.

Siebel Object Interfaces Reference Version 8.1 23 3

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
BusComp.SetMultipleFieldValues oPropertySet

Argument Description

oPropertySet Property set containing a collection of properties representing the fields to be

set, and their values

Returns
Not applicable

Usage
This method can be used only on fields that are active. The FieldName argument in the property must
be set exactly as the field name appears in Siebel Tools, with the correct case. For example, in

oPropertySet.SetProperty "Name","Acme"

the FieldName is Name and the FieldValue is Acme.

NOTE: Do not use the SetMultipleFieldValues method on a field that has a pick list.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Examples
The following example is in Siebel eScript:

var bo = TheApplication().GetBusObject("Opportunity");
var bc = bo.GetBusComp("Opportunity");
var ps = TheApplication().NewPropertySet ;

with (ps)
{
SetProperty ("Name", "Call Center Opportunity");
SetProperty ("Account", "Marriott International");
SetProperty ("Sales Stage", "2-Qualified");
}

bc.ActivateMultipleFields(ps);
bc.NewRecord(NewBefore);
bc.SetMultipleFieldValues(ps) ;
bc.WriteRecord;

The following Java example sets multiple fields using SetMultipleFieldValues:

SiebelDataBean Sieb_dataBean = null;

SiebelBusObject Sieb_busObject = null;
SiebelBusComp Sieb_busComp = null;
SiebelPropertySet ps = null;

234 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

try
{
Sieb_dataBean = new SiebelDataBean();
...
Sieb_busObject = Sieb_dataBean.getBusObject("Account");
Sieb_busComp = Sieb_busObject.getBusComp("Account");
ps = Sieb_dataBean.newPropertySet();

with(ps)
{
setProperty("Name", "Frank Williams Inc");
setProperty("Location", "10 Main St");
setProperty("Account Status", "Active");
setProperty("Type", "Customer");
}

Sieb_busComp.activateField ("Name");
Sieb_busComp.activateField ("Location");
Sieb_busComp.activateField ("Account Status");
Sieb_busComp.activateField ("Type");

Sieb_busComp.newRecord(true);
Sieb_busComp.setMultipleFieldValues(ps);
Sieb_busComp.writeRecord();
}

catch (SiebelException e)
{
system.out.println("Error : " + e.getErrorMessage());
}

Related Topics
ActivateMultipleFields Method on page 181
GetMultipleFieldValues Method on page 203

SetNamedSearch Method
SetNamedSearch sets a named search specification on the business component. A named search
specification is identified by the searchName argument.

Syntax
BusComp.SetNamedSearch searchName, searchSpec

Argument Description

searchName String containing the name of the named search specification

searchSpec String containing the search specification string corresponding to the name

Siebel Object Interfaces Reference Version 8.1 23 5

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Returns
Not applicable

Usage
A named search specification is a search criterion that is not cleared by the ClearToQuery; for
example, a predefined query or business component search specification.

A named search specification can be modified only programmatically; it cannot be modified through
the UI. This specification is applied in conjunction with the existing search specification. When set,
the named search specification is applied every time ExecuteQuery is called. ClearToQuery does not
clear the named search specification. To clear it, explicitly set the searchSpec argument to "". Note
that when a new instance of the BusComp is created, the named search specification is cleared.

The searchSpec argument assigned to SetNamedSearch is the same argument that is used after the
equal sign in a predefined query. The maximum length of a predefined query is 2000 characters. For
details on how to set up the search specification, read SetSearchExpr Method and SetSearchSpec
Method on page 238.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Examples
This example shows how to set a named search to a business component depending on the position
of the current user.

The following example is in Siebel eScript:

function BusComp_PreQuery ()
{
if (TheApplication().GetProfileAttr("Position") == "Siebel Administrator");
{
this.SetNamedSearch ("Candidates", "[Status] LIKE 'Candidate'")
}

return (ContinueOperation);
}

The following example is in Siebel VB:

Function BusComp_PreQuery () As Integer

If TheApplication.GetProfileAttr("Position") = "Siebel Administrator" Then
Me.SetNamedSearch "Candidates", "[Status] LIKE 'Candidate'"
End If

BusComp_PreQuery = ContinueOperation
End Function

Note that defining searches using the SetNamedSearch method does not create a PDQ entry, this is
a search specified in script only. To retrieve this search specification, use GetNamedSearch method.
GetProfileAttr is used in personalization to retrieve values of an attribute in a user profile.

236 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Related Topics
GetNamedSearch Method on page 205
SetSearchSpec Method on page 238

SetSearchExpr Method
SetSearchExpr sets an entire search expression on the business component, rather than setting one
search specification for each field. Syntax is similar to that on the Predefined Queries screen.

Syntax
BusComp.SetSearchExpr searchSpec

Argument Description

searchSpec Search specification string field

Returns
Not applicable

Usage
Call this method after ClearToQuery and before ExecuteQuery. It is not necessary to use ActivateField
on a field that is used in SetSearchExpr.

The maximum length of a predefined query is 2000 characters. The argument assigned to
SetSearchExpr is the same as that used after the equal sign in a predefined query. For example, the
first line following is a search specification in a predefined query; the second is the equivalent search
specification used with the various interface methods. Note that Name is a field on the business
component and therefore must be enclosed in brackets, [ ].

'Account'.Search = "[Name] ~ LIKE ""A. C. Parker"" "

BC.SetSearchExpr "[Name] ~ LIKE ""A. C. Parker"" "

If field values have search keywords such as NOT, AND, and OR, use two pairs of double quotes
around the field value. For example, if a field Sub-Status can have the string Not an Issue as a field
value, you would use the following VB syntax to avoid an SQL error:

substatus = GetFieldValue("Sub-Status")
searchst = "[Value] = """ & substatus & """""
BC.SetSearchExpr searchst

The following VB syntax generates an SQL error:

substatus = GetFieldValue("Sub-Status")
searchst = "[Value] = " & substatus
BC.SetSearchExpr searchst

Siebel Object Interfaces Reference Version 8.1 23 7

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Use both SetSearchExpr and SetSortSpec to build a query that includes both a search specification
and a sort specification. You cannot set a sort specification with SetSearchExpr by itself. Do not use
SetSearchExpr and SetSearchSpec together; they are mutually exclusive.

Any dates used with SetSearchExpr must use the format MM/DD/YYYY, regardless of the Regional
control panel settings of the server or client computer.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Example
The following example is in Siebel eScript:

var Ob = TheApplication().ActiveBusObject();
var BC = Ob.GetBusComp("Opportunity");
var Account = "Turston Steel";
var Oppty = "CAD/CAM implementation";
var searchst = "[Name] = '" + Oppty + "' AND [Account] = '" + Account + "'";

TheApplication().TraceOn("c:\\temp\\trace.txt", "Allocation", "All");

TheApplication().Trace("the search expression is: " + searchst);
BC.ClearToQuery();
BC.SetSearchExpr(searchst);
BC.ExecuteQuery();

Related Topics
ClearToQuery Method on page 185
ExecuteQuery Method on page 190
SetSearchSpec Method on page 238
SetSortSpec Method on page 242

SetSearchSpec Method
SetSearchSpec sets the search specification for a particular field. This method must be called before
ExecuteQuery.

Syntax
BusComp.SetSearchSpec FieldName, searchSpec

Argument Description

FieldName String containing the name of the field on which to set the search specification.

searchSpec String containing the search specification.

238 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Returns
Not applicable

Usage
To avoid an unpredicted compound search specification on a business component, it is recommended
to call ClearToQuery before calling SetSearchSpec. It is not necessary to use ActivateField on a field
that is used in SetSearchSpec.

If multiple calls are made to SetSearchSpec for a business component, then the multiple search
specifications are handled as follows:

If the existing search specification is on the same field as the new search specification, then the
new search specification replaces the existing search specification. For example:

myBusComp.SetSearchSpec("Status", "<> 'Renewal'");

myBusComp.SetSearchSpec("Status", "<> 'Dropped'");

results in the following WHERE clause:

WHERE Status <> 'Dropped'

If the existing search specification is not on the same field as the new search specification, then
the resultant search specification is a logical AND of the existing and the new search
specifications. For example:

myBusComp.SetSearchSpec("Type", "<> 'Renewal'");

myBusComp.SetSearchSpec("Status", "<> 'Sold' AND [Status] <> 'Cancelled' AND
[Status] <> 'Renewed'");

results in the following WHERE clause:

WHERE Type <> 'Renewal' AND (Status<> 'Sold' AND Status <> 'Cancelled' AND Status
<> 'Renewed')

If the existing search specification includes one or more of the same fields as the new search
specification, then the new search specification on those common fields only replaces the existing
search specification on the common fields. For example, if:

myBusComp.SetSearchSpec("Status", "<> 'In Progress'")

is subsequently applied to the result of the previous example, then the following WHERE clause
results:

WHERE Type <> 'Renewal' AND Status <> 'In Progress'

Only the search specification on Status is replaced in the compound WHERE clause.

If a search specification is set declaratively in Siebel Tools, and another search specification is
set with script using SetSearchSpec(), then the resultant search specification is a logical AND of
the existing Tools-created specification and the scripted specification. For example:

myBusComp.SetSearchSpec("Status", "<> 'Cancelled'")

is applied to the following existing search specification created declaratively in Tools:

[Type] <> 'Renewal' AND [Status] <> 'Sold'

Siebel Object Interfaces Reference Version 8.1 23 9

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Then the following WHERE clause results:

WHERE Type <> 'Renewal' AND (Status <> 'Sold' AND Status <> 'Cancelled')

NOTE: When an existing Tools-created search specification includes the same field as a
subsequent search specification set with SetSearchSpec(), the behavior is not like the
replacement behavior that results when both specifications are set by using SetSearchSpec().

The maximum length of a predefined query is 2000 characters.

CAUTION: Do not use SetSearchExpr and SetSearchSpec together because they are mutually
exclusive.

Using logical and comparison operators. Any search specification that can be created in the user
interface can be duplicated in Siebel VB or eScript. Both logical operators and comparison operators
may be used, provided that they are handled correctly. For example, in VB:

BC.SetSearchSpec "Status", "<> 'Closed' AND ([Owner] = LoginName () OR [Refer To] =

LoginName ()) OR ([Owner] IS NULL AND [Support Group] = 'TS-AE')"

Using special characters. If the search specification contains any of the following characters.

= > < ( ) , ~ " ' [

it must be enclosed in quotes. This rule applies to operators that are part of the search expression
as well as text to search for. If the search expression contains quotes, those quotes must be doubled.
For example, in the preceding line of code, notice that the entire search specification is enclosed in
double quotes, whereas fields and values referred to within the specification each have single quotes.

If the search object includes a single double quote, that quote must be doubled; for example, if you
wanted to search for text containing:

"We must

the VB search specification would take this form:

SetSearchSpec "Comments", "'""We must'"

so that the initial quote is doubled, and the string containing it is placed within single quotes, and
the entire expression, including the single quotes, is placed within double quotes.

If the search specification includes single quotes (including apostrophes), the expression must be
placed within single quotes, apostrophes must be doubled, and double quotes must be placed around
the entire string. Thus, for example, if you wanted to search for Phillies Cheese Steaks in the Name
field, you would have to enter the specification in VB as follows:

SetSearchSpec "Name", "'Phillie''s Cheese Steaks'"

NOTE: eScript and Browser Script require backslashes instead of double quotes for marking special
characters. For example: SetSearchSpec("Comments", "\'\"We must\'"); and
SetSearchSpec("Name", "\'Phillie\'\'s Cheese Steaks\'");

Searching for text in non-text fields. If the search expression queries a field of any type other
than text, or if it is an expression other than a field-level query, text must be placed within quotes
if it contains any characters other than the following:

ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz _ ? \ " ' [

240 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

As with text field search expressions, quotes must be doubled.

Retrieving all records. To retrieve all records efficiently, use ClearToQuery followed by
ExecuteQuery, without using SetSearchSpec.

Searching for a null field. To search for null fields, use the following form:

SetSearchSpec "Account", "is NULL"

If your search specification requests an empty string, then the search returns every record. For
example:

SetSearchSpec "Account", ""

Any dates used with SetSearchSpec must use the format MM/DD/YYYY, regardless of the Regional
control panel settings of the server or client computer.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
For Siebel VB examples, read FirstRecord Method on page 192, SetFormattedFieldValue Method on
page 232, and BusComp_PreQuery Event on page 260. For a Siebel eScript example, read
ClearToQuery Method on page 185.

Example
This Siebel VB code searches for a contact by name and then navigates to the record displayed in a
view:

(general) (declarations)
Option Explicit

Sub Button1_Click
Dim theCurrComp As BusComp
Dim TargetView As String
Dim TargetBusObj As String
Dim TargetBusComp As String
Dim NewBusObj As BusObject
Dim NewComp As BusComp
Dim RecId1 As String
Dim RecId2 As String
Dim RecId3 As String

TargetView = "Visible Contact List View"

TargetBusObj = "Contact"
TargetBusComp = "Contact"
Set theCurrComp = Me.BusComp
RecId1 = theCurrComp.GetFieldValue("Last Name")
RecId2 = theCurrComp.GetFieldValue("First Name")
RecId3 = theCurrComp.GetFieldValue("Account Id")

Siebel Object Interfaces Reference Version 8.1 24 1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Set NewBusObj = TheApplication.GetBusObject(TargetBusObj)

Set NewComp = NewBusObj.GetBusComp(TargetBusComp)
NewComp.ClearToQuery
NewComp.SetSearchSpec "Last Name", RecId1
NewComp.SetSearchSpec "First Name", RecId2
NewComp.SetSearchSpec "Account Id", RecId3
NewComp.ExecuteQuery ForwardBackward

TheApplication.GotoView TargetView , NewBusObj

End Sub

The following example is in Siebel eScript:

var oAccntBO = TheApplication().GetBusObject("Account");

var oAccntBC = oAccntBO.GetBusComp("Account");
var oAddrBC;

with (oAccntBC)
{
SetViewMode(SalesRepView);
ClearToQuery();
SetSearchSpec("Name", "Hong Kong Flower Shop");
ExecuteQuery();
oAddrBC = GetMVGBusComp("Street Address");
}

with (oAddrBC)
{
NewRecord(NewAfter);
SetFieldValue("City", "Denver");
WriteRecord();
}

oAddrBC = null;
oAccntBC = null;
oAccntBO = null;

Related Topics
ExecuteQuery Method on page 190
ClearToQuery Method on page 185
SetSearchExpr Method on page 237
SetSortSpec Method

SetSortSpec Method
SetSortSpec sets the sort specification for a query.

242 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
BusComp.SetSortSpec sortSpec

Argument Description

sortSpec String containing the sort specification

Returns
Not applicable

Usage
SetSortSpec, if used, must be called after ClearToQuery and before ExecuteQuery. The sortSpec
argument is a string of the form:

"fieldName1,fieldName2,...(ASCENDING)"

or

"fieldName1,fieldName2,...(DESCENDING)"

The entire string must be placed in quotes. You can sort on various fields in different orders by
separating the field names and order specifications with commas, as in the example.

The argument assigned to SetSortSpec is the same used after the equal sign in a predefined query.
For example, the first line following is a sort specification in a predefined query; the second is the
equivalent sort specification used with the various interface methods. Note that Name is the name
of a business component field.

'Account'.Sort = "Name(ASCENDING)"

BC.SetSortSpec "Name(ASCENDING)"

Any dates used with SetSortSpec must use the format MM/DD/YYYY, regardless of the Regional
control panel settings of the server or client computer.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
This Siebel VB example sorts the Opportunity list first by Account in reverse order, then in
alphabetical order by Site. Note that the column names in the Opportunity list applet are not the
same as those in the underlying business component.

NOTE: This example merely demonstrates how to sort in ascending and descending order. In actual
practice you should not sort in both directions in a single sort specification, as it degrades
performance considerably.

Function BusComp_PreQuery As Integer

Siebel Object Interfaces Reference Version 8.1 24 3

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

With Me
.ActivateField("Account")
.ActivateField("Account Location")
.ClearToQuery
.SetSortSpec "Account(DESCENDING), Account Location(ASCENDING)"
.ExecuteQuery
End With

BusComp_PreQuery = ContinueOperation

End Function

The following is the equivalent example in Siebel eScript:

Function BusComp_PreQuery

with (this)
{
ActivateField("Account");
ActivateField("Account Location");
ClearToQuery();
SetSortSpec("Account(DESCENDING), Account Location(ASCENDING)");
ExecuteQuery();
}

return (ContinueOperation);

Related Topics
GetSortSpec Method on page 209
SetSearchExpr Method on page 237
SetSearchSpec Method on page 238

SetUserProperty Method
Sets the value of a named business component user property. The user properties are similar to
instance variables of a BusComp.

Syntax
BusComp.SetUserProperty propertyName, newValue

Argument Description

propertyName String containing the name of the user property to set

newValue String containing the property value

244 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Returns
Not applicable

Usage
The advantage of user properties is that they can be accessed from anywhere in the code (including
from other applications through COM) using GetUserProperty. An instance variable, on the other
hand, can be accessed only from within Siebel VB from the same object on which the variable is
declared.

The value of the property is reset every time you instantiate a new business component.

NOTE: SetUserProperty does not interact directly with user properties defined in Siebel Tools.

Used With
COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server Script

Example
The following example is in Siebel VB:

Sub BusComp_SetFieldValue (FieldName As String)

Select Case FieldName
Case "Committed"
me.SetUserProperty "Flagged", "Y"
End Select
End Sub

The following is the equivalent example in Siebel eScript:

function BusComp_SetFieldValue (FieldName)

{
switch (FieldName)
{
case "Committed":
this.SetUserProperty("Flagged", "Y");
}
}

Related Topic
GetUserProperty Method on page 209

SetViewMode Method
SetViewMode sets the visibility type for the business component. This is used prior to a query.

Syntax
BusComp.SetViewMode mode

Siebel Object Interfaces Reference Version 8.1 24 5

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

where mode is a Siebel ViewMode constant or its corresponding integer value. The constants shown
are defined in three environments.

Siebel ViewMode constants correspond to applet visibility types. For more information about applet
visibility types, see Siebel Security Guide.

Siebel ViewMode Integer

Constant Value Comments

SalesRepView 0 Applies single position or sales team access control, and

displays records owned by the users position or records
whose sales team contains the users position, as
determined by the business components Visibility field or
Visibility MVField. To use this visibility applet type, the
business component must have a view mode with an Owner
Type of Position.

ManagerView 1 Displays records that the user and the users direct reports
have access to. Example: My Teams Accounts. Typically
used by managers.

If the business component on which the view is based uses

single position access control, then this constant displays
records associated directly with the users active position
and with subordinate positions.

If the business component on which the view is based uses

sales team access control, then this constant displays
records for which the users active position is the primary
position on the team or a subordinate position is the primary
member on the team.

If a users position has no subordinate positions, then no

data is displayed, not even the users own data.

To use this visibility applet type, the business component

must have a view mode with an Owner Type of Position.

PersonalView 2 Displays records the user has direct access to, as

determined by the business components Visibility field. To
use this visibility applet type, the business component must
have a view mode with an Owner Type of Person. Example:
My Accounts. Typically used by individual contributors.

AllView 3 Displays all records for which there is a valid owner.

Example: All Accounts Across Organizations.

246 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Siebel ViewMode Integer

Constant Value Comments

OrganizationView 5 Applies single-organization or multiple-organization access

control, as determined by the business components
Visibility field or Visibility MVField. To use this visibility
applet type, the business component must have a view
mode with an Owner Type of Organization. Displays records
for organizations where a valid owner has been assigned to
the record and the users position is associated with the
organization. Example: All Accounts List View.

GroupView 7 Displays either a list of the categorys first level

subcategories (child categories) to which the user has
access or displays records in the current category,
depending on the applet being used. If the user is at the
catalog level, then this displays the first level categories.

CatalogView 8 Displays a flat list of records in categories across every

catalog to which the user has access. To use this visibility
applet type, the business component must have a view
mode with an Owner Type of Catalog Category. Typically
used in product pick lists and other lists of products, such as
a recommended product list.

SubOrganizationView 9 If the business component on which the view is based uses

single organization access control, then this constant
displays records associated directly with the users active
organization or with a descendent organization. Descendent
organizations are defined by the organization hierarchy. To
use this visibility applet type, the business component must
have a view mode with an Owner Type of Organization.

If the business component on which the view is based uses

multiple organization access control, then this constant
displays records for which the users active organization or
a descendent organization is the primary organization.

Example: All Opportunities Across My Organization. Typically

used by executives.

Returns
Not applicable

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Siebel Object Interfaces Reference Version 8.1 24 7

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Related Topic
GetViewMode Method on page 210

Example
The following example is in Siebel VB. For another example, see BusComp_PreDeleteRecord Event
on page 257.

(general) (declarations)
Option Explicit
Dim oBO as BusObject
Dim oBC as BusComp

Set oBO = TheApplication.GetBusObject(Me.BusObject.Name)

Set oBC = oBO.GetBusComp(Me.Name)
With oBC
.SetViewMode SalesRepView
.ClearToQuery
.SetSearchSpec "Name", Me.GetFieldValue("Name")
.SetSearchSpec "Id", "<> " & Me.GetFieldValue("Id")
.ExecuteQuery ForwardOnly
If .FirstRecord Then
TheApplication.Trace"Entry for name " & Me.GetFieldValue("Name") & " exists."
End If
End With

Set oBC = Nothing

Set oBO = Nothing

The following is the equivalent example in Siebel eScript:

var oBO = TheApplication().GetBusObject(this.BusObject().Name());

var oBC = oBO.GetBusComp(this.Name);

TheApplication().TraceOn("c:\\trace.txt","Allocation","All");
with (oBC)
{
SetViewMode(SalesRepView);
ClearToQuery();
SetSearchSpec("Name", this.GetFieldValue("Name"));
SetSearchSpec("Id", "<> " + this.GetFieldValue("Id");
ExecuteQuery(ForwardOnly);
if (FirstRecord())
TheApplication().Trace("Entry for name " + this.GetFieldValue("Name") + "
exists.");
}

TheApplication().TraceOff();
oBC = null;
oBO = null;

248 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

UndoRecord Method
UndoRecord reverses any uncommitted changes made to the record. This includes reversing
uncommitted modifications to fields, as well as deleting an active record that has not yet been
committed to the database.

Syntax
BusComp.UndoRecord

Argument Description

Not applicable

Returns
Not applicable

Usage
If you are using UndoRecord to delete a new record, it is useful only after NewRecord has been called
and before the new record has been committed. If you are using UndoRecord to reverse changes
made to field values, it is useful only before the changes have been committed through a call to
WriteRecord, or before the user has stepped off the record through the user interface. UndoRecord
reverses uncommitted changes to a record. Therefore, if you wish to have a fine degree of control
over which changes are reversed, place the code in the PreNewRecord, PreSetFieldValue, or
PreWriteRecord event, and issue a CancelOperation to cancel the change invoked by the particular
event.

Used With
COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Related Topic
NewRecord Method on page 221

WriteRecord Method
Commits to the database any changes made to the current record.

Siebel Object Interfaces Reference Version 8.1 24 9

 For Oracle internal distribution only
Interfaces Reference Business Component Methods

Syntax
oBusComp.WriteRecord

Argument Description

Not applicable

Returns
Not applicable

Usage
After creating new records and assigning values to fields, call WriteRecord to commit the new record
to the database.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Example
This Siebel VB example inserts an activity if the Sales Stage field is set to 02. For other examples,
see GetMVGBusComp Method on page 203 and NewRecord Method on page 221.

(general) (declarations)
Option Explicit

Sub BusComp_SetFieldValue (FieldName As String)

' Run this code from the Opportunities Activities view.
' Opportunity is presumed to be the parent business component.

Select Case FieldName

Case "Sales Stage"
if Me.GetFieldValue(FieldName) LIKE "02*" Then
' reference the Action business component
Dim oBCact as BusComp
Set oBCact = me.BusObject.GetBusComp("Action")
With oBCact
.NewRecord NewAfter
.SetFieldValue "Type", "Event"
.SetFieldValue "Description", "THRU SVB, Stage _
changed to 02"
.SetFieldValue "Done", Format(Now(), _
"mm/dd/yyyy hh:mm:ss")
.SetFieldValue "Status", "Done"
.WriteRecord
End With
set oBCact = Nothing
end if
End Select
End Sub

250 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Business Component Events

The following topics describe business component events:

BusComp_Associate Event on page 251

BusComp_ChangeRecord Event on page 252

BusComp_CopyRecord Event on page 253

BusComp_DeleteRecord Event on page 254

BusComp_InvokeMethod Event on page 255

BusComp_NewRecord Event on page 255

BusComp_PreAssociate Event on page 256

BusComp_PreCopyRecord Event on page 256

BusComp_PreDeleteRecord Event on page 257

BusComp_PreGetFieldValue Event on page 258

BusComp_PreInvokeMethod Event on page 259

BusComp_PreNewRecord Event on page 260

BusComp_PreQuery Event on page 260

BusComp_PreSetFieldValue Event on page 261

BusComp_PreWriteRecord Event on page 263

BusComp_Query Event on page 264

BusComp_SetFieldValue Event on page 265

BusComp_WriteRecord Event on page 266

BusComp_Associate Event
The Associate event is called after a record is added to a business component to create an
association.

Syntax
BusComp_Associate

Argument Description

Not applicable

Returns
Not applicable

Siebel Object Interfaces Reference Version 8.1 25 1

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Usage
The semantics are the same as for BusComp_NewRecord.

Used With
Server Script

Related Topic
BusComp_NewRecord Event on page 255

BusComp_ChangeRecord Event
The ChangeRecord event is called after a record becomes the current row in the business component.

Syntax
BusComp_ChangeRecord

Argument Description

Not applicable

Returns
Not applicable

Usage
Code in the ChangeRecord event handler is executed each time that the focus changes to another
record. Avoid lengthy operations in this event handler to enable smooth scrolling in list applets.

Used With
Server Script

Example
This Siebel VB example uses two subprograms in the (general) (declarations) section to set up an
audit trail for service requests. The ChangeRecord event handler is used to initialize the values from
the service record so that they can be compared with current values.

(general) (declarations)
Option Explicit
Dim OldClosedDate, OldCreated, OldOwner, OldOwnerGroup
Dim OldSeverity, OldSource, OldStatus
Declare Sub CreateAuditRecord
Declare Sub InitializeOldValues

252 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Sub CreateAuditRecord (FieldName As String, NewValue As String, OldValue As String,

ChangedText As String)

Dim ActionBC As BusComp

Dim CurrentBO As BusObject
Dim theSRNumber

Set CurrentBO = TheApplication.GetBusObject("Service Request")

Set ActionBC = CurrentBO.GetBusComp("Action")
theSRNumber = GetFieldValue("SR Number")

With ActionBC
.ActivateField "Activity SR Id"
.ActivateField "Description"
.ActivateField "Private"
.ActivateField "Service request id"
.ActivateField "Type"
.NewRecord NewAfter

.SetFieldValue "Activity SR Id", theSRNumber

.SetFieldValue "Description", ChangedText
.SetFieldValue "Private", "Y"
.SetFieldValue "Type", "Administration"
.WriteRecord
End With
End Sub

Sub InitializeOldValues
OldClosedDate = GetFieldValue("Closed Date")
OldOwner = GetFieldValue("Owner")
OldSeverity = GetFieldValue("Severity")
If GetFieldValue("Severity") <> OldSeverity Then
NewValue = GetFieldValue("Severity")
ChangedText = "Changed Priority from " + OldSeverity + _
" to " + NewValue
CreateAuditRecord "Severity", NewValue, OldSeverity, _
ChangedText
End If
End Sub

Sub BusComp_ChangeRecord
InitializeOldValues
End Sub

BusComp_CopyRecord Event
The CopyRecord event is called after a row has been copied in the business component and that row
has been made active.

Siebel Object Interfaces Reference Version 8.1 25 3

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Syntax
BusComp_CopyRecord

Argument Description

Not applicable

Returns
Not applicable

Usage
BusComp_CopyRecord is called instead of BusComp_NewRecord when a new record is created:

Through BusComp.NewRecord NewAfterCopy|NewBeforeCopy

Through any UI copy record mechanism (Edit > Copy Record; CTRL+B)

Used With
Server Script

BusComp_DeleteRecord Event
The DeleteRecord event is called after a row is deleted. The current context is a different row (the
Fields of the just-deleted row are no longer available).

Syntax
BusComp_DeleteRecord

Argument Description

Not applicable

Usage
When a user reads and deletes an existing record or creates and undoes a new record, this invokes
DeleteRecord. This invocation causes any associated scripts to be executed.

Returns
Not applicable

Used With
Server Script

254 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Events

BusComp_InvokeMethod Event
The InvokeMethod event is called when the InvokeMethod method is called on a business component.

Syntax
BusComp_InvokeMethod(methodName)

Argument Description

methodName String containing the name of the method that was invoked

Returns
Not applicable

Usage
The InvokeMethod event is called when a specialized method is called on a business component, or
when the InvokeMethod method has been explicitly called on a business component.

Used With
Server Script

BusComp_NewRecord Event
The NewRecord event is called after a new row has been created in the business component and that
row has been made active. The event may be used to set up default values for Fields.

Syntax
BusComp_NewRecord

Argument Description

Not applicable

Returns
Not applicable

Usage
BusComp_NewRecord is called when a new record is created unless the new record was created:

Through BusComp.NewRecord NewAfterCopy|NewBeforeCopy

Through any UI copy record mechanism (Edit > Copy Record; CTRL+B)

Siebel Object Interfaces Reference Version 8.1 25 5

 For Oracle internal distribution only
Interfaces Reference Business Component Events

In these cases, BusComp_CopyRecord is called instead of BusComp_NewRecord.

Used With
Server Script

Example
For an example, read Pick Method on page 224.

BusComp_PreAssociate Event
The PreAssociate event is called before a record is added to a business component to create an
association. The semantics are the same as for BusComp_PreNewRecord.

Syntax
BusComp_PreAssociate

Argument Description

Not applicable

Returns
ContinueOperation or CancelOperation

Usage
CancelOperation stops the execution of the underlying Siebel code associated with the event.
However, if there is code in the same script following CancelOperation, that code runs regardless of
the CancelOperation.

Used With
Server Script

BusComp_PreCopyRecord Event
The PreCopyRecord event is called before a new row is copied in the business component. The event
may be used to perform pre-copy validation.

256 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Syntax
BusComp_PreNewRecord

Argument Description

Not applicable

Returns
ContinueOperation or CancelOperation

Usage
CancelOperation stops the execution of the underlying Siebel code associated with the event.
However, if there is code in the same script following CancelOperation, that code runs regardless of
the CancelOperation.

Used With
Server Script

BusComp_PreDeleteRecord Event
The PreDeleteRecord event is called before a row is deleted in the business component. The event
may be used to prevent the deletion or to perform any actions in which you need access to the record
that is to be deleted.

Syntax
BusComp_PreDeleteRecord

Argument Description

Not applicable

Returns
ContinueOperation or CancelOperation

Usage
This event is called after the user has confirmed the deletion of the record, but before the record is
deleted from the database.

CancelOperation stops the execution of the underlying Siebel code associated with the event.
However, if there is code in the same script following CancelOperation, that code runs regardless of
the CancelOperation.

Siebel Object Interfaces Reference Version 8.1 25 7

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Used With
Server Script

Example
This Siebel VB example prevents the deletion of an account that has associated opportunities:

(general) (declarations)
Option Explicit

Function BusComp_PreDeleteRecord As Integer

Dim oBC as BusComp
Dim oBO as BusObject
Dim sAcctRowId as string

sAcctRowId = me.GetFieldValue("Id")
set oBO = TheApplication.GetBusObject("Opportunity")
set oBC = oBO.GetBusComp("Opportunity")

With oBC
.SetViewMode AllView
.ClearToQuery
.SetSearchSpec "Account Id", sAcctRowId
.ExecuteQuery ForwardOnly
If (.FirstRecord = 1) Then
RaiseErrorText("Opportunities exist for the Account - _
Delete is not allowed")
End If
End With

BusComp_PreDeleteRecord = ContinueOperation

Set oBC = Nothing

Set oBO = Nothing

End Function

BusComp_PreGetFieldValue Event
The PreGetFieldValue event is called when the value of a business component field is accessed.

Syntax
BusComp_PreGetFieldValue(FieldName, FieldValue)

Argument Description
FieldName String containing the name of the field accessed

FieldValue String containing the value accessed

258 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Returns
ContinueOperation or CancelOperation

Usage
PreGetFieldValue is called at least once for each user interface element that displays the BusComp
field value, and it may also be called as a result of other internal uses.

NOTE: PreGetFieldValue is called every time the user interface is updated to repaint fields on the
screen. Therefore, a script attached to this event runs very frequently, which may cause the
computer to appear to be unresponsive.

Even empty scripts are invoked by the framework and thus cause a performance impact. If you want
to remove an existing script from BusComp_PreInvokeMethod to improve performance, you must
inactivate the appropriate record using Siebel Tools.

CancelOperation stops the execution of the underlying Siebel code associated with the event.
However, if there is code in the same script following CancelOperation, that code runs regardless of
the CancelOperation.

Used With
Server Script

BusComp_PreInvokeMethod Event
The PreInvokeMethod event is called before a specialized method is invoked on the business
component.

Syntax
BusComp_PreInvokeMethod(methodName)

Argument Description

methodName String containing the name of the method invoked

Returns
ContinueOperation or CancelOperation

Usage
The PreInvokeMethod event is called just before a specialized method is invoked on the business
component. Specialized methods are methods based on applet or business component classes other
than CSSFrame and CSSBusComp, respectively, that is, specialized classes.

CancelOperation stops the execution of the underlying Siebel code associated with the event.
However, if there is code in the same script following CancelOperation, that code runs regardless of
the CancelOperation.

Siebel Object Interfaces Reference Version 8.1 25 9

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Used With
Server Script

BusComp_PreNewRecord Event
The PreNewRecord event is called before a new row is created in the business component. The event
may be used to perform preinsert validation.

Syntax
BusComp_PreNewRecord

Argument Description

Not applicable

Returns
ContinueOperation or CancelOperation

Usage
CancelOperation stops the execution of the underlying Siebel code associated with the event.
However, if there is code in the same script following CancelOperation, that code runs regardless of
the CancelOperation.

Used With
Server Script

BusComp_PreQuery Event
The PreQuery event is called before query execution.

Syntax
BusComp_PreQuery

Argument Description

Not applicable

Returns
ContinueOperation or CancelOperation

260 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Usage
This event may be used to modify the search criteria or to restrict the execution of certain queries.

CancelOperation stops the execution of the underlying Siebel code associated with the event.
However, if there is code in the same script following CancelOperation, that code runs regardless of
the CancelOperation.

Used With
Server Script

Example
The following example is in Siebel VB:

Function BusComp_PreQuery() As Integer

Dim strPosition As String
Dim strSearchSpec As String
Dim intReturn As Integer
intReturn = ContinueOperation
strPosition = TheApplication.PositionName
strSearchSpec = Me.GetSearchSpec("Owned By")
If strPosition <> "System Administrator" Then
if Len(strSearchSpec) = 0 or InStr(strSearchSpec,
strPosition) = 0 Then
Me.SetSearchSpec "Owned By", strPosition
end if
End if
BusComp_PreQuery = intReturn
End Function

BusComp_PreSetFieldValue Event
The PreSetFieldValue event is called before a value is pushed down into the business component from
the user interface or through a call to SetFieldValue.

Syntax
BusComp_PreSetFieldValue(FieldName, FieldValue)

Argument Description

FieldName String containing the name of the changed field

FieldValue String containing the changed value

Returns
ContinueOperation or CancelOperation

Siebel Object Interfaces Reference Version 8.1 26 1

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Usage
The PreSetFieldValue event is called each time a field is to be changed or populated for a given
business component.

When using a picklist to populate multiple fields, PreSetFieldValue is fired for each field that is
populated. For example, you have an applet that you use to populate Last Name, First Name, and
Contact ID. Therefore, PreSetFieldValue fires three times, once for each field.

CancelOperation stops the execution of the underlying Siebel code associated with the event.
However, if there is code in the same script following CancelOperation, that code runs regardless of
the CancelOperation. In the preceding example, if your script returns CancelOperation for a field,
that field is not populated. However, PreSetFieldValue still fires for the other two fields populated by
the picklist.

NOTE: To prevent infinite recursions, if the PreSetFieldValue event is running it does not run again
for the same business component instance, even if used on a different field in the business
component.

Used With
Browser Script, Server Script

Example
This Siebel VB example uses the PreSetFieldValue event to check if a quote discount is greater than
20 percent, and to take appropriate action if it is. For other examples of BusComp_PreSetFieldValue,
read LoginId Method on page 147, and ExecuteQuery Method on page 190.

Function BusComp_PreSetFieldValue (FieldName As String,

FieldValue As String) As Integer
Routine to check if a quote discount>20%
if it is, notify user and cancel operation
Dim value as Integer
Dim msgtext as String
If FieldName = "Discount" then
value = Val(FieldValue)
If value > 20 then
msgtext = "Discounts greater than 20% must be approved"
RaiseError msgtext
BusComp_PreSetFieldValue = CancelOperation
Else
BusComp_PreSetFieldValue = ContinueOperation
End if
End If
End Function

The following is the equivalent example in Siebel eScript:

function BusComp_PreSetFieldValue (FieldName, FieldValue)

{
var msgtext = "Discounts greater than 20% must be approved";
if (FieldName == "Discount")
{
if (FieldValue > 20)

262 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Events

{
TheApplication().RaiseErrorText(msgtext);
}
else
{
return (ContinueOperation);
}
}
else
{
return (ContinueOperation);
}
}

BusComp_PreWriteRecord Event
The PreWriteRecord event is called before a row is written to the database. The event may perform
any final validation necessary before the actual save occurs.

Syntax
BusComp_PreWriteRecord

Argument Description

Not applicable

Returns
ContinueOperation or CancelOperation

Usage
CancelOperation stops the execution of the underlying Siebel code associated with the event.
However, if there is code in the same script following CancelOperation, that code runs regardless of
the CancelOperation.

The PreWriteRecord event triggers only if a field value was modified or inserted, or when a record is
deleted. When a record is deleted, PreWriteRecord is called to delete the implied join records to the
initial record.

When associating a multivalue group record (based on an M:M relationship) with the business
component that invokes the association, the PreWriteRecord and WriteRecord events execute. These
events execute even if no fields on the base or invoking business component are updated by the
association. The PreWriteRecord and WriteRecord events are executed to acknowledge the update to
the intersection table.

CAUTION: Do not use the RaiseError or RaiseErrorText method in the BusComp_PreWriteRecord or

BusCompWriteRecord event. Termination of the event will cause the application to stop responding,
for example preventing users from stepping off records.

Siebel Object Interfaces Reference Version 8.1 26 3

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Used With
Server Script

Example
Function BusComp_PreWriteRecord As Integer

' This code resets the probability before the write

' if necessary

if Me.GetFieldValue("Sales Stage") LIKE "07*" then

' Resets the Probability to 75 if less than 75
if Val(Me.GetFieldValue("Rep %")) < 75 then
Me.SetFieldValue "Rep %", "75"
end If
end if

BusComp_PreWriteRecord = ContinueOperation
End Function

BusComp_Query Event
The Query event is called just after the query is complete and the rows have been retrieved, but
before the rows are actually displayed.

Syntax
BusComp_Query

Argument Description

Not applicable

Returns
Not applicable

Used With
Server Script

Example
In this Siebel VB example, important information is defined using the Action business component
with a special activity type. If the user starts an account query, the code checks whether important
information is available. If so, the information is displayed in a message box.

Sub BusComp_Query

264 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Dim oBusObj As BusObject, oCurrFinAct As BusComp,

Dim oActivities as BusComp, oAppl as Applet
Dim sName as String, sDescription as String

On error goto leave

set oBusObj = TheApplication.ActiveBusObject

Set oCurrFinAct = TheApplication.ActiveBusComp

If oCurrFinAct.FirstRecord <> 0 then

sName = oCurrFinAct.GetFieldValue("Name")
Set oActivities = oBusObj.GetBusComp("Finance _
Important Info Activity")
With oActivities
.ActivateField("Description")
.ClearToQuery
.SetSearchSpec "Account Name", sName
.SetSearchSpec "Type", "Important Info"
.ExecuteQuery ForwardOnly
If .FirstRecord <> 0 then
sDescription = .GetFieldValue("Description")
TheApplication.Trace("Important Information: " + sDescription)
do while .NextRecord <> 0
sDescription = .GetFieldValue("Description")
TheApplication.Trace("Important Information: " + sDescription)
loop
End If
End With
End If

leave:

Set oCurrFinAct = Nothing

set oBusObj = Nothing

End Sub

BusComp_SetFieldValue Event
The SetFieldValue event is called when a value is pushed down into the business component from
the user interface or through a call to SetFieldValue. This event is not triggered for any predefaulted
or calculated fields in Siebel Tools.

Syntax
BusComp_SetFieldValue(FieldName)

Argument Description

FieldName String containing the name of the affected field

Siebel Object Interfaces Reference Version 8.1 26 5

 For Oracle internal distribution only
Interfaces Reference Business Component Events

Returns
Not applicable

Used With
Server Script

Example
This Siebel VB example shows how to invoke methods on an existing business component when the
SetFieldValue event is triggered:

Sub BusComp_SetFieldValue (FieldName As String)

Dim desc As String
Dim newDesc As String
If FieldName = "Type" Then
newDesc = [can be any valid string containing the new description]
desc = GetFieldValue("Description")
SetFieldValue "Description", newDesc
End If
End Sub

The following is the equivalent example in Siebel eScript:

function BusComp_SetFieldValue (FieldName)

{
if (FieldName == "Type" && GetFieldValue(FieldName) == "Account")
{
SetFieldValue("Description", "Record is of Type 'Account'." );
}
}

BusComp_WriteRecord Event
The WriteRecord event is called after a row is written out to the database.

The WriteRecord event triggers after the record has been committed to the database. Do not use
SetFieldValue in a WriteRecord event. If you need to use SetFieldValue, put it in a PreWriteRecord
event (explained in BusComp_PreWriteRecord Event on page 263).

Syntax
BusComp_WriteRecord

Argument Description

Not applicable

Returns
Not applicable

266 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Object Methods

Usage
When associating a multi-value group record (based on an M:M relationship) with the business
component that invokes the association, the PreWriteRecord and WriteRecord events execute. These
events execute even if no fields on the base or invoking business component are updated by the
association. The PreWriteRecord and WriteRecord events are executed to acknowledge the update to
the intersection table.

CAUTION: Do not use the RaiseError or RaiseErrorText method in the BusComp_PreWriteRecord or

BusCompWriteRecord event. Termination of the event will cause the application to stop responding,
for example preventing users from stepping off records.

Used With
Server Script

Business Object Methods

In the method descriptions, the term oBusObj indicates a variable containing a BusObject:

GetBusObject Method on page 127

GetLastErrCode Method on page 268

GetLastErrText Method on page 269

Name Method on page 270

Release Method on page 270

GetBusComp Method
The GetBusComp method returns the specified business component.

Syntax
oBusObj.GetBusComp (BusCompName)

Argument Description

BusCompName String containing the desired business component in the business object

Returns
The requested business component

Siebel Object Interfaces Reference Version 8.1 26 7

 For Oracle internal distribution only
Interfaces Reference Business Object Methods

Usage
BusCompName is case-sensitive, and must match in case the form of the name as it appears in Siebel
Tools. If an instance of BusCompName already exists, that instance is returned. The interpreter
instantiates and returns a new instance of a business component using BusCompName if one does
not already exist.

If you already have a BusComp but you want to create a new one (without getting any existing ones),
use GetBusObject() first. This creates a new BusComp() that is not the same as the one already
existing (for example in an applet). Then use the new business object to do a GetBusComp() to
create new business components. If you use the business object that already exists you pick up any
child business components that already exist, even if you use GetBusComp() to get them.

The Nothing function should be used to destroy the instantiated business component when it is no
longer necessary.

NOTE: In Browser Script, the GetBusComp() method can only access business components in the
current view; in Server Script, the GetBusComp() method can access every business component that
has been instantiated in the active business object.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Server Script

Examples
The following examples are in Siebel eScript:

To access a business component in the UI context:

var ActiveBO = TheApplication().ActiveBusObject();

var ConBC = ActiveBO.GetBusComp("Contact");

To access a business component in the non-UI context:

var BO = TheApplication().GetBusObject("Account");
var ConBC = BO.GetBusComp("Contact");

GetLastErrCode Method
The GetLastErrCode method returns the last error code.

Syntax
oBusObj.GetLastErrCode

Argument Description
Not applicable

268 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Object Methods

Returns
The last error code as a short integer; 0 indicates no error.

Usage
After execution of a method, the GetLastErrCode can be invoked to check if any error was returned
from the previous operation. The GetLastErrText method can be invoked to retrieve the text of the
error message.

Used With
COM Data Control, Mobile Web Client Automation Server

Related Topic
GetLastErrText Method on page 269

GetLastErrText Method
The GetLastErrText method returns the last error text.

Syntax
oBusObj.GetLastErrText

Argument Description

Not applicable

Returns
A string containing the last error text message.

Usage
After execution of a method, the GetLastErrCode can be invoked to check if any error was returned
from the previous operation. The GetLastErrText method can be invoked to retrieve the text of the
error message.

Used With
COM Data Control, Mobile Web Client Automation Server

Related Topic
GetLastErrCode Method on page 268

Siebel Object Interfaces Reference Version 8.1 26 9

 For Oracle internal distribution only
Interfaces Reference Business Object Methods

Name Method
The Name method returns the name of the business object.

Syntax
oBusObj.Name

Argument Description

Not applicable

Returns
A string containing the business object name

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script

Example
For an example, read Name Method on page 220.

Release Method
The Release()method enables the release of the Business Object and its resources on the Siebel
Server.

Syntax
oBusObj.release()

Argument Description

Not applicable

Returns
Not applicable

Used With
Java Data Bean

Example
The following example is for Java Data Bean:

270 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Service Methods

import com.siebel.data.*;

{
...

// create Siebel Data Bean

// login into Siebel Data Bean

...

// Create Siebel Bus Object.

// get the Bus Object from SiebelDataBean

...

// Use the business Object

// Release the business object resources

...

busObj.release();
}

Business Service Methods

In the method descriptions, the placeholder oService represents a business service instance:

GetFirstProperty Method

GetNextProperty Method on page 273

GetProperty Method on page 275

InvokeMethod Method on page 275

Name Method on page 277

PropertyExists Method on page 277

Release Method on page 278

RemoveProperty Method on page 279

SetProperty Method on page 280

GetFirstProperty Method
This method retrieves the name of the first property of a business service.

Siebel Object Interfaces Reference Version 8.1 27 1

 For Oracle internal distribution only
Interfaces Reference Business Service Methods

Syntax
oService.GetFirstProperty()

Argument Description

Not applicable

Returns
A string containing the name of the first property of the business service

Usage
This method retrieves the name of the first property, in order of definition, of a business service. Use
GetFirstProperty and GetNextProperty to retrieve the name of a property. You can then use the
retrieved name as an argument to GetProperty to retrieve the property value, or with SetProperty
to assign property values.

Used With
Browser Script, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Examples
This function returns the number of Property Sets that belong to the Business Service given in the
parameter.

The following example is in Siebel eScript:

function countPropSets(busService)
{
var propSetName = busService.GetFirstProperty();
var count = 0;

while(propSetName != null && propSetName != "")

{
count++;
propSetName = busService.GetNextProperty();
}

return count;
}

The following example is in Java:

public int countPropSets(SiebelService busService)

{
int count = 0;
try
{
String propSetName = busService.getFirstProperty();
while(propSetName != null && propSetName != "")

272 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Service Methods

{
count++;
propSetName = busService.getNextProperty();
}

catch(SiebelException sExcept)
{
return 0;
}

return count;
}

Related Topics
GetNextProperty Method on page 273
GetProperty Method on page 275
SetProperty Method on page 280

GetNextProperty Method
When the name of the first property has been retrieved, this method retrieves the name of the next
property of a business service.

Syntax
oService.GetNextProperty()

Argument Description

Not applicable

Returns
A string containing the name of the next property of a business service, or a null string ("") if no
more properties exist.

Usage
After retrieving the name of the first property with GetFirstProperty, the GetNextProperty method
should be used in a loop, to be terminated when a null string ("") is returned. When property names
have been retrieved, they can be used as arguments to GetProperty to retrieve the property value,
or with SetProperty to assign property values.

Used With
Browser Script, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Siebel Object Interfaces Reference Version 8.1 27 3

 For Oracle internal distribution only
Interfaces Reference Business Service Methods

Examples
This function returns the number of Property Sets that belong to the Business Service given in
parameter.

The following example is in Siebel eScript:

function countPropSets(busService)
{
var propSetName = busService.GetFirstProperty();
var count = 0;

while(propSetName != null && propSetName != "")

{
count++;
propSetName = busService.GetNextProperty();
}

return count;
}

The following example is in Java:

public int countPropSets(SiebelService busService)

{
int count = 0;
try
{
String propSetName = busService.getFirstProperty();
while(propSetName != null && propSetName != "")
{
count++;
propSetName = busService.getNextProperty();
}

catch(SiebelException sExcept)
{
return 0;
}

return count;
}

Related Topics
GetFirstProperty Method on page 302
GetProperty Method
SetProperty Method on page 280

274 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Service Methods

GetProperty Method
The GetProperty method returns the value of the property whose name is specified in its argument.

Syntax
oService.GetProperty(propName)

Argument Description

propName The name of the property whose value is to be returned

Returns
A string containing the value of the property indicated by propName or NULL if the property does not
exist.

Usage
You must know the name of a property to retrieve its value. To retrieve property names, use the
GetFirstProperty and GetNextProperty methods.

Used With
Browser Script, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Related Topics
GetFirstProperty Method on page 302
GetNextProperty Method on page 273
SetProperty Method on page 280

InvokeMethod Method
The InvokeMethod method calls a method on the business service. This can be a documented
specialized method or a user-created method.

eScript Syntax
oService.InvokeMethod(methodName, InputArguments, OutputArguments)

Siebel Object Interfaces Reference Version 8.1 27 5

 For Oracle internal distribution only
Interfaces Reference Business Service Methods

Siebel VB Syntax
oService.InvokeMethod methodName, InputArguments, OutputArguments

Argument Description

methodName A string representing the name of the method to execute

InputArguments A property set containing the arguments required by the method

OutputArguments A property set containing the arguments to be returned by the method

(passed by reference)

Browser Script Syntax

outputPropSet=Service.InvokeMethod(MethodName, inputPropSet)

Argument Description

methodName The name of the method

inputPropSet A property set containing the method arguments

outputPropSet A property set containing the output arguments of the Property Set

Returns
Not applicable

Usage
Built-in business services work the same way as business component invoke methods. That is, you
can call specialized methods on the service that are not exposed directly through the object
interface.

Run-time business services can hold user-defined methods, which must be implemented in scripts
written in Siebel VB or Siebel eScript. The scripts must be written in these languages within Siebel
Tools; however, they can be called through external interfaces.

Although the InvokeMethod function does not return a value, the properties in the OutputArguments
property set may have been modified.

NOTE: The InvokeMethod method should be used only with documented specialized methods. Oracle
does not support calling specialized methods with InvokeMethod, unless they are listed in this book.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Related Topics
Service_InvokeMethod Event on page 281
Service_PreInvokeMethod Event on page 284

276 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Service Methods

Name Method
The Name property contains the name of the service.

Syntax
oService.Name

Argument Description

Not applicable

Returns
A string containing the service name

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Example
The following example is in Browser Script:

var svc = theApplication().GetService("Data Quality Manager"):

theApplication().SWEAlert("The active service is " + svc.Name());

PropertyExists Method
This method returns a Boolean value indicating whether a specified property exists.

Syntax
oService.PropertyExists(propName)

Argument Description

propName A string representing the name of a property of the specified service

Returns
In Siebel VB, an integer (0 for false, 1 for true); in other interfaces, a Boolean

Usage
Because GetProperty returns a null string ("") for nonexistent properties, you should use
PropertyExists() in an if statement to determine whether a specific property has been set.

Siebel Object Interfaces Reference Version 8.1 27 7

 For Oracle internal distribution only
Interfaces Reference Business Service Methods

Used With
Browser Script, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Release Method
The Release method() enables the release of the Business Service and its resources on the Siebel
Server.

Syntax
oBusSvc.release()

Argument Description

not applicable

Returns
Not applicable

Used With
Java Data Bean

Example
The following example logs in to a Siebel Server. It then instantiates a business object, a business
component, and a business service. Then, it releases them in reverse order.

import com.siebel.data.*;
import com.siebel.data.SiebelException;

public class JDBReleaseDemo

{
private SiebelDataBean m_dataBean = null;
private SiebelBusObject m_busObject = null;
private SiebelBusComp m_busComp = null;
private SiebelService m_busServ = null;

public static void main(String[] args)

{
JDBReleaseDemo demo = new JDBReleaseDemo();
}

public JDBReleaseDemo()
{
try
{

278 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Service Methods

// instantiate the Siebel Data Bean

m_dataBean = new SiebelDataBean();

// login to the servers

m_dataBean.login("siebel.tcpip.none.none://<gateway>:<port>/<enterprise>/
<object manager>","<user id>","<password>");
System.out.println("Logged in to the Siebel server ");

// get the business object

m_busObject = m_dataBean.getBusObject("Account");

// get the business component

m_busComp = m_busObject.getBusComp("Account");

// get the business service

m_busServ = m_dataBean.getService("Workflow Process Manager");

//release the business service

m_busServ.release();
System.out.println("BS released ");

//release the business component

m_busComp.release();

System.out.println("BC released ");

//release the business object

m_busObject.release();
System.out.println("BO released ");

// logoff
m_dataBean.logoff();
System.out.println("Logged off the Siebel server ");
}

catch (SiebelException e)
{
System.out.println(e.getErrorMessage());
}

RemoveProperty Method
This method removes a property from a business service.

Siebel Object Interfaces Reference Version 8.1 27 9

 For Oracle internal distribution only
Interfaces Reference Business Service Methods

Syntax
oService.RemoveProperty(propName)

Argument Description

propName A string indicating the name of the property to be removed

Returns
Not applicable

Usage
This method removes the property propName from the business service oService. As a result,
subsequent calls to PropertyExists for that property returns FALSE.

Used With
Browser Script, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Related Topic
PropertyExists Method on page 277

SetProperty Method
This method assigns a value to a property of a business service.

Syntax
oService.SetProperty(propName, propValue)

Argument Description

propName A string indicating the name of the property whose value is to be set

propValue A string containing the value to assign to the property indicated by propName

Returns
Not applicable

Usage
SetProperty is used to set the value of a property of the business service from one of the methods
of the service or from an external object.

280 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Service Events

Used With
Browser Script, COM Data Server, Java Data Bean, Mobile Web Client Automation Server, Server
Script

Example
For an example, read Service_PreInvokeMethod Event on page 284.

Related Topic
GetProperty Method on page 275

Business Service Events

The following topics describe business service events:

Service_InvokeMethod Event

Service_PreCanInvokeMethod Event on page 283

Service_PreInvokeMethod Event on page 284

Service_InvokeMethod Event
The InvokeMethod event is called after the InvokeMethod method is called on a business service.

Server Script Syntax

Service_InvokeMethod(MethodName, InputArguments, OutputArguments)

Argument Description

MethodName A string representing the name of the method to execute

InputArguments A property set containing the arguments required by the method

OutputArguments A property set containing the arguments to be returned by the method

Browser Script Syntax

OutputArguments=oService.InvokeMethod(methodName, InputArguments)

Argument Description

methodName A string representing the name of the method to execute

Siebel Object Interfaces Reference Version 8.1 28 1

 For Oracle internal distribution only
Interfaces Reference Business Service Events

Argument Description

InputArguments A property set containing the arguments required by the method

OutputArguments A property set containing the arguments to be returned by the method.

NOTE: In Browser Script, output property sets are not supported for this
event.

Returns
Not applicable

Usage
Although this event does not return a value, in Server Script it can add properties to, or alter the
values of the properties in, the property set OutputArguments. In Browser Script it cannot add to,
store, or update the values of the properties in the output property set.

When you invoke business service methods through Browser Script, the business service can be
implemented as a browser-based business service (written in JavaScript) or a server-based business
service. Initially, the high interactivity mode framework checks if the business service resides in the
browser, and if it does not find it, it sends the request to the server for execution.

NOTE: Browser Script can invoke a browser-based or server-based business service, but Server
Script can only invoke a server-based business service.

NOTE: Although the InvokeMethod function does not return a value in Server Script, it can modify
the properties in the OutputArguments property set.

Used With
Browser Script, Server Script

Example
This eScript example invokes the Shipping Engine business service created in
Service_PreInvokeMethod Event on page 284 in response to a button click. The InvokeMethod
property on the button is set to CalcShipping. It gets values from the Order Entry - Test business
component, passes a property set to the service, gets return values by means of another property
set, and then passes these values back to the Order Entry - Test business component.

function Service_InvokeMethod (MethodName, Inputs, Outputs)

{
if (MethodName == "CalcShipping") {

var oBusObject = TheApplication().GetBusObject("Order Entry");

var oBusComp = oBusObject.GetBusComp("Order Entry - Test");
var oBusSvc = TheApplication().GetService("Shipping Engine");
var Inputs = TheApplication().NewPropertySet();
var Outputs = TheApplication().NewPropertySet();

with (oBusComp) {

282 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Service Events

ActivateField(Ship Via Id);

ActivateField(Carrier Type);
Activate Field(Freight Total);
ClearToQuery();
SetSearchSpec(Id, 12-123456); // dummy search spec
ExecuteQuery(ForwardOnly);

if (FirstRecord())

{
var size = GetFieldValue(Total Volume);
var shipper = GetFieldValue("Ship Via Id");
var shipMethod = GetFieldValue("Carrier Type");
var weight = GetFieldValue("Total Weight");
}

with (Inputs) {

Set Property (Volume, size);

SetProperty ("Shipping Company", shipper);
SetProperty ("Ship Method", shipMethod);
SetProperty ("Weight", weight);
}

Outputs = oBusSvc.InvokeMethod("CalculateShipping", Inputs);

var cost = Outputs.GetProperty("Cost");
var delDate = Outputs.GetProperty("Delivery Date");
oBusComp.SetFieldValue(Freight Total, cost);
oBusComp.SetFieldValue(Requested Ship Date, delDate);

return (CancelOperation);

else

return (ContinueOperation);

Related Topic
Service_PreInvokeMethod Event on page 284

Service_PreCanInvokeMethod Event
The PreCanInvokeMethod event is called before the PreInvokeMethod, allowing the developer to
determine whether or not the user has the authority to invoke the business service method.

Siebel Object Interfaces Reference Version 8.1 28 3

 For Oracle internal distribution only
Interfaces Reference Business Service Events

Server Script Syntax

Service_PreCanInvokeMethod(MethodName, &CanInvoke)

Argument Description

MethodName A string representing the name of the method to be executed

&CanInvoke A string representing whether or not the business service method can be
invoked. Valid values are TRUE and FALSE.

Browser Script Syntax

Service_PreCanInvokeMethod(MethodName)

Argument Description

MethodName A string representing the name of the method to be executed

Returns
CancelOperation or ContinueOperation

Used With
Browser Script, Server Script

Service_PreInvokeMethod Event
The PreInvokeMethod event is called before a specialized method on the business service is invoked.

Server Script Syntax

Service_PreInvokeMethod(MethodName, InputArguments, OutputArguments)

Argument Description

MethodName A string representing the name of the method to execute

InputArguments A property set containing the arguments required by the method

OutputArguments A property set containing the arguments to be returned by the method

284 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Service Events

Browser Script Syntax

OutputArguments=oService.PreInvokeMethod(methodName, InputArguments)

Argument Description

methodName A string representing the name of the method to execute

InputArguments A property set containing the arguments required by the method

OutputArguments A property set containing the arguments to be returned by the method.

NOTE: In Browser Script, output property sets are not supported for this
event.

Returns
ContinueOperation or CancelOperation

Siebel Object Interfaces Reference Version 8.1 28 5

 For Oracle internal distribution only
Interfaces Reference Business Service Events

Usage
If implementing a new method, or overriding the behavior of a method implemented in a specialized
business service, the script should return CancelOperation to avoid invoking an Unknown method
name error. As Figure 8 illustrates, this error is predictable if the PreInvokeMethod event is scripted.
This occurs because there is no native code to execute in the InvokeMethod event. CancelOperation
tells the Siebel application to cancel the remaining operations associated with the event.

NOTE: The example in Figure 8 applies only to new and user-defined methods. For existing standard
Siebel methods, it is not necessary to use CancelOperation.

Figure 8. Effects of CancelOperation and ContinueOperation

Service_InvokeMethod is rarely scripted, but can be used for such post-operation events as posting
a notice to a log when the event completes successfully.

Used With
Browser Script, Server Script

286 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Business Service Events

Example
This Siebel VB example creates the new service Shipping Engine:

Function Service_PreInvokeMethod (MethodName As String, Inputs As PropertySet,

Outputs As PropertySet) As Integer

If MethodName = "CalculateShipping" Then

Dim sShipper As String, sShipMethod As String

Dim dWeight As Double, dSize As Double, dCost As Double
Dim sZone As String, DelDate As Variant
Dim sCost As String, iReturn As Integer

iReturn = ContinueOperation
sShipper = Inputs.GetProperty("Shipping Company")
sShipMethod = Inputs.GetProperty("Ship Method")
dWeight = Val(Inputs.GetProperty("Weight"))
dSize = Val(Inputs.GetProperty("Volume"))
iZone = Val(Inputs.GetProperty("Zone"))
DelDate = DateValue(Now)

Select Case sShipper

Case "GlobalEx"
Select Case sShipMethod
Case "Next-Day Air"
dCost = 14 + dWeight
DelDate = DelDate + 1
Case "Second-Day Air"
dCost = 11 + (dWeight * .54)
DelDate = DelDate + 2
End Select

Case "Airline"
Select Case sShipMethod
Case "Next-Day Air"
dCost = 5 + (dWeight * .3) + (dSize * .33) + _
(Val(sZone) * .5)
DelDate = DelDate + 1
Case "Second-Day Air"
dCost = 4 + (dWeight * .3) + (dSize * .2) + _
(Val(sZone) * .3)
DelDate = DelDate + 2

Case "Ground"
dCost = 3 + (dWeight * .18) + (dSize * .1) + _
(Val(sZone) * .1)
DelDate = DelDate + 2 + Int(Val(sZone) * .8)
End Select
End Select

sCost = Format(dCost, "Currency")

Outputs.SetProperty "Cost", sCost
Outputs.SetProperty "Delivery Date", DelDate
iReturn = CancelOperation

Siebel Object Interfaces Reference Version 8.1 28 7

 For Oracle internal distribution only
Interfaces Reference Control Methods

End If

Service_PreInvokeMethod = iReturn

End Function

Related Topic
Service_InvokeMethod Event on page 281

Control Methods
In the method descriptions, the placeholder controlVar stands for the name of the control on which
the method is invoked; for example, Button1_Click.

NOTE: Control Methods do not work with ActiveX controls.

Applet Method on page 288

BusComp Method on page 289

GetProperty Method on page 289

GetValue Method on page 290

Name Method on page 291

SetProperty Method on page 293

SetValue Method on page 294

Applet Method
The Applet method returns the parent applet object for a control.

Syntax
controlVar.Applet

Argument Description

Not applicable

Returns
The parent applet of the control

Usage
Obtaining the parent applet allows you to perform operations on the applet object, not just the
control.

288 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Control Methods

Used With
Browser Script

BusComp Method
The BusComp method returns the corresponding business component for the control.

Syntax
controlVar.BusComp

Argument Description

Not applicable

Returns
The business component associated with the controls parent applet.

Used With
Browser Script

For an example, read Name Method on page 220.

GetProperty Method
The GetProperty method returns the value of the property of a control.

Syntax
controlVar.GetProperty(propName)

Argument Description

propName The name of the property to be retrieved

Returns
The value of the property of a control.

Usage
GetProperty can be used with the following controls: CheckBox, ComboBox, TextBox, TextArea, and
Label.

Use GetProperty to call the following properties: Background Color, Enabled, FontType, FontColor,
FontSize, FontStyle, Height, Width, Shown, Read Only, Visible.

Siebel Object Interfaces Reference Version 8.1 28 9

 For Oracle internal distribution only
Interfaces Reference Control Methods

If more than one property is to be retrieved, each must be retrieved in a separate statement.

Used With
Browser Script

Example
This code sample uses GetProperty to return values for FontSize, Background Color, Width, and
Height:

theApplication().SWEAlert("checkbox.FontSize : " +
objCheckBox.GetProperty("FontSize"));
theApplication().SWEAlert("checkbox.BgColor : " +
objCheckBox.GetProperty("BgColor"));
theApplication().SWEAlert("checkbox.Width : " + objCheckBox.GetProperty("Width"));
theApplication().SWEAlert("checkbox.Height : " +
objCheckBox.GetProperty("Height"));

GetValue Method
The GetValue method returns the value of the control. The type of the return value depends on the
specific control object.

Syntax
controlVar.GetValue

Argument Description

Not applicable

Returns
The value displayed by the control for the data type of the underlying field.

NOTE: GetValue cannot return a literal value input into a control by a user. The method instead
returns the value that the users entry has been stored as, based on the data type of the underlying
field.

Usage
The GetValue and SetValue methods work only for controls that are associated with business
component fields. Therefore, these methods are not applicable to labels.

Used With
Browser Script

290 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Control Methods

Name Method
The Name method returns the name of the object.

Syntax
controlVar.Name

Argument Description

Not applicable

Returns
A string containing the object name

Used With
Browser Script

Example
For an example, read Name Method on page 220.

SetLabelProperty Method
The SetLabelProperty method sets visual properties of a label.

Syntax
controlVar.SetLabelProperty(propName, propValue)

Argument Description
propName The name of the property to be set, as described in the following table

propValue The value to assign to the property, as described in the following table

Returns
Not applicable

Usage
If more than one property is to be set, each must be set in a separate statement.

Siebel Object Interfaces Reference Version 8.1 29 1

 For Oracle internal distribution only
Interfaces Reference Control Methods

The following table lists the properties that can be set for a label, and the values that can be assigned
to them:

Property Value Description

BgColor string Determines Background Color for a label; for example, red is
ff0000, green is 00ff00, and blue is 0000ff

FontColor string Determines FontColor for a label; for example, green is 00ff00

FontType string Determines FontType for a label; for example, Times Roman

FontSize string Determines FontSize for a label; for example, 12 pt

FontStyle string Determines FontStyle for a label; for example, Italic

FontWeight string Determines FontWeight for a label. Acceptable values are bold,
bolder, lighter, normal, 100, 200, 300, 400 (equivalent to normal),
500, 600, 700 (equivalent to bold), 800, and 900. Default is normal.

Height string Determines Height for a label, in pixels; for example, 5

Visible visible Determines whether the label is visible. Defaults to repository

or hidden definition unless explicitly modified by using SetLabelProperty.

Width string Determines Width for a label, in pixels; for example, 80

The SetLabelProperty method is not enabled by default. You must enable it in Siebel Tools before
using it in a script. To enable the SetLabelProperty, expand the Control node in the Tools Object
Explorer and select the Control User Prop node. Then add a new Control User Prop named
useLabelID with a value of TRUE.

Used With
Browser Script

Example
The following code shows the use of SetLabelProperty:

function Applet_PreInvokeMethod (name, inputPropSet){

// example of changing the Font Size of the Location label
if (name == "fontsize") {
var ctl = this.FindControl("Location");
var fSize = prompt("Please specify the desired label font size (numeric value
only).");
ctl.SetLabelProperty("FontSize", fSize);
return ("CancelOperation");
}

// example of changing the Background Color of the Location label

else if (name == "bgcolor") {
var ctl = this.FindControl("Location");
var bgColor = prompt("Specify the background color of the label. Please enter
a valid six hexadecimal digit RGB value");

292 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Control Methods

ctl.SetLabelProperty("BgColor", bgColor);
return ("CancelOperation");
}

// example of changing the Font Type of the Location label

else if (name == "fonttype") {
var ctl = this.FindControl("Location");
var fontType = prompt("Please specify the font type for the label");
ctl.SetLabelProperty("FontType", fontType);
return ("CancelOperation");
}

// example of changing the Font Color of the Location label

else if (name == "fontcolor") {
var ctl = this.FindControl("Location");
var fontColor = prompt("Specify the font color of the label. Please enter a
valid six hexadecimal digit RGB value");
ctl.SetLabelProperty("FontColor", fontColor);
return ("CancelOperation");
}
else
return ("ContinueOperation");
}

SetProperty Method
The SetProperty method sets visual properties of a control.

Syntax
controlVar.SetProperty(propName, propValue)

Argument Description
propName The name of the property to be set, as described in the following table
propValue The value to assign to the property, as described in the following table

Returns
Not applicable

Usage
SetProperty can be used with the following controls: CheckBox, ComboBox, TextBox, and TextArea.

If more than one property is to be set, each must be set in a separate statement.

Siebel Object Interfaces Reference Version 8.1 29 3

 For Oracle internal distribution only
Interfaces Reference Control Methods

The following table lists the properties that can be set for a control, and the values that can be
assigned to them:

Property Value Description

BgColor string Determines Background Color for a control; for example, red is
ff0000, green is 00ff00, and blue is 0000ff

Enabled TRUE or FALSE Is the button active? (Unless explicitly modified by using
SetProperty, default is TRUE.)

FontColor string Determines FontColor for a control; for example, green is 00ff00

FontType string Determines FontType for a control; for example, Times Roman

FontSize string Determines FontSize for a control; for example, 12 pt

FontStyle string Determines FontStyle for a control; for example, Bold

Height string Determines Height for a control, in pixels; for example, 5

Shown TRUE or FALSE Is the control shown? (Unless explicitly modified by using
SetProperty, default is as defined in the repository.)

ReadOnly TRUE or FALSE Determines whether the control is read-only. Defaults to repository
definition unless explicitly modified by using SetProperty.

Visible TRUE or FALSE Determines whether the control is visible. Defaults to repository
definition unless explicitly modified by using SetProperty.

Width string Determines Width for a control, in pixels; for example, 80

Used With
Browser Script

Example
The following code shows the use of SetProperty:

objCheckBox.SetProperty("FontColor", "00ff00");
objCheckBox.SetProperty("FontStyle", "italic");
objCheckBox.SetProperty("FontType", "Verdana");
objCheckBox.SetProperty("FontSize", "25pt");
objCheckBox.SetProperty("BgColor", "00f000");
objCheckBox.SetProperty("Width", "100");
objCheckBox.SetProperty("Height", "100");

SetValue Method
The SetValue method sets the contents of the specified control to the value indicated.

294 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Control Methods

Syntax
controlVar.SetValue (controlValue)

Argument Description

controlValue String containing the value to which to set the control

Returns
Not applicable

Usage
The GetValue and SetValue methods work only for controls that are associated with business
component fields. Therefore, these methods are not applicable to labels. SetValue sets the contents
of a control. The user can still change those contents before they are committed to the BusComp
field.

SetValue does not validate the format of the data. Data validation occurs at the time user commits
the record by stepping off the field/record or saving the record. SetValue can also set the value for
a read-only control. However, such value is lost when the record is committed. Also, these methods
only work on form applets.

Used With
Browser Script

Example
The following code shows the use of GetValue and SetValue:

function Applet_PreInvokeMethod (name, inputPropSet)

{
// Example of changing the value of the Abstract control to uppercase

if(name == "SR Abstract")

{
var ctlName = "Abstract";
var ctl = this.FindControl(ctlName);
var ctlVal = ctl.GetValue();
ctl.SetValue(ctlVal.toUpperCase());
ctl= null;
return("CancelOperation");
}

// Example of changing the value of a checkbox control

if(name == "SR Billable")

{
var ctlName = "Billable Flag";
var ctl = this.FindControl(ctlName);
var ctlVal = ctl.GetValue();
if (ctlVal == "Y")

Siebel Object Interfaces Reference Version 8.1 29 5

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

ctl.SetValue("N"); // clear the box

else
ctl.SetValue("Y"); // check the box
ctl= null;
return("CancelOperation");
}

// Example of changing the value of a date/time control

if(name == "SR Commit time")
{
var ctlName = "Agent Committed";
var ctl = this.FindControl(ctlName);
ctl.SetValue("12/1/2001 1:09:31 AM");
// format is not validated until user commits the record
ctl= null;
return("CancelOperation");
}

Property Set Methods

In the method descriptions, the placeholder oPropSet refers to a variable containing a property set:

AddChild Method on page 297

Copy Method on page 298

GetByteValue Method on page 299

GetChild Method on page 300

GetChildCount Method on page 301

GetFirstProperty Method on page 302

GetLastErrCode Method on page 303

GetLastErrText Method on page 304

GetNextProperty Method on page 305

GetProperty Method on page 305

GetPropertyCount Method on page 306

GetType Method on page 307

GetValue Method on page 307

InsertChildAt Method on page 308

PropertyExists Method on page 309

RemoveChild Method on page 309

RemoveProperty Method on page 310

Reset Method on page 311

296 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

SetByteValue Method on page 311

SetProperty Method on page 312

SetType Method on page 313

SetValue Method on page 314

ToString Method on page 315

AddChild Method
The AddChild method is used to add subsidiary property sets to a property set, so as to form
hierarchical (tree-structured) data structures.

Syntax
oPropSet.AddChild(childPropSet as PropertySet)

Argument Description

childObject A property set to be made subsidiary to the property set indicated by oPropSet

Returns
An integer indicating the index of the child property set.

Usage
Property sets can be used to create tree-structured data structures. Any number of arbitrarily
structured child property sets can be added to a property set. You may use child property sets to
structure a property set in a manner similar to the data model. For example, the parent property set
might be Account, with child property sets for opportunities, contacts, activities, and so on. At the
same time, you could construct an independent property set called Opportunity, to which accounts,
contacts, and activities might be children.

If a property set is instantiated within script and then added to a parent property set, the child
property set is not released when the parent property set is released. This is because a reference to
the child property set still exists independently.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Example
The following fragment of eScript code shows how child property sets may be added to a parent
property set:

Siebel Object Interfaces Reference Version 8.1 29 7

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

var Account = TheApplication().NewPropertySet();

var Opportunity = TheApplication().NewPropertySet();
var Contact = TheApplication().NewPropertySet();
var Activity = TheApplication().NewPropertySet();

Account.AddChild(Opportunity);
Account.AddChild(Contact);
Account.AddChild(Activity);

Related Topics
GetChild Method on page 300
InsertChildAt Method on page 308
RemoveChild Method on page 309

Copy Method
This method returns a copy of a property set.

Syntax
oPropSet.Copy()

Argument Description

Not applicable

Returns
A copy of the property set indicated by oPropSet

Usage
This method creates a copy of a property set, including any properties and children it may have.
Because property sets are generally passed by reference, making a copy allows the method to
manipulate the property set without affecting the original definition.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Example
This Siebel VB example uses a copy of a property set to store the original values of its properties,
and displays both the original and Pig-Latin forms of the properties:

(general) (declarations)
Option Explicit

298 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Function PigLatin (Name1 As String) As String

Dim Name2 As String, FirstLetter As String
Name2 = Right$(Name1, len(Name1) - 1)
FirstLetter = Left$(Name1, 1)
Name2 = UCase(Mid$(Name1, 2, 1)) & _
Right$(Name2, Len(Name2) - 1)
Name2 = Name2 & LCase(FirstLetter) & "ay"
PigLatin = Name2
End Function

(Sub ClickMe_Click)

Dim Inputs As PropertySet, Outputs As PropertySet

Dim message As String, propName, propVal, newPropVal
set Inputs = TheApplication.NewPropertySet

Inputs.SetProperty "Name", "Harold"

Inputs.SetProperty "Assistant", "Kathryn"
Inputs.SetProperty "Driver", "Merton"

set Outputs = Inputs.Copy()

propName = Outputs.GetFirstProperty()
do while propName <> ""
propVal = Outputs.GetProperty(propName)
newPropVal = PigLatin(propVal)
Outputs.SetProperty propName, newPropVal
message = message & propVal & " has become " & _
newPropVal & Chr$(13)
propName = Outputs.GetNextProperty()
loop
TheApplication.RaiseErrorText message

End Sub

GetByteValue Method
This method returns a byte array if a byte value has been set.

Syntax
oPropSet.getByteValue()

Argument Description

Not applicable

Returns
A byte array if a byte value has been set, null if a string value has been set.

Siebel Object Interfaces Reference Version 8.1 29 9

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Used With
Java Data Bean

Example
The following example takes a binary value and outputs binary.

SiebelPropertySet input = new SiebelPropertySet();

SiebelPropertySet output = new SiebelPropertySet();

input.setProperty("ProcessName", "LMS3 Jason");

// XML to send
String str="<?xml version=\"1.0\" encoding=\"UTF8\"
?><GetCommunicationDataInput><MemberID>20048963</MemberID></
GetCommunicationDataInput>";

// convert string to byte array

byte [] bvalue = new String(str).getBytes();

input.setByteValue(bvalue);
businessService.invokeMethod("RunProcess",input,output);

// Use getByteValue to retrieve the value..and pop it in a String..for example

String out2 = new String (output.getByteValue());
System.out.println(out2);

Related Topic
SetByteValue Method on page 311

GetChild Method
This method returns a specified child property set of a property set.

Syntax
oPropSet.GetChild(index)

Argument Description

index An integer representing the index number of the child property set to be retrieved

Returns
The property set at index index of the parent property set

300 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Usage
When child property sets are created, each is given an index number within the parent property set,
starting at 0. Property sets added using AddChild get the next available index number. However, a
property set added using InsertChildAt inserts a new property set at a specified index. The property
set previously at that index, and every property set after it, have their indexes increased by 1.
Similarly, a property set removed using RemoveChild decreases the indexes of following child
property sets by 1.

NOTE: This method returns the number of direct descendants only. That is, if the child property sets
have children of their own, these grandchildren are not included in the computation of the return
value.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

NOTE: When using the Web Client Automation Server, the child object retrieved is a copy of the
actual object. Any update to the object retrieved will not update the originating object.

Example
This Siebel eScript example sets the Name property of child property sets to the same value:

function Test1_Click ()
{
var Account = TheApplication().NewPropertySet();
var Opportunity = TheApplication().NewPropertySet();
var Contact = TheApplication().NewPropertySet();
var Activity = TheApplication().NewPropertySet();
var j;

Account.AddChild(Opportunity);
Account.AddChild(Contact);
Account.AddChild(Activity);

for (var i = 0; i < Account.GetChildCount(); i++)

{
j = Account.GetChild(i);
j.SetProperty('Name', 'Allied Handbooks');
}
}

Related Topics
AddChild Method on page 297
InsertChildAt Method on page 308

GetChildCount Method
This method returns the number of child property sets attached to a parent property set.

Siebel Object Interfaces Reference Version 8.1 30 1

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Syntax
oPropSet.GetChildCount()

Argument Description

Not applicable

Returns
The number of child property sets subordinate to oPropSet

Usage
This method returns the actual number of child property sets of oPropSet. Because index numbers
for child property sets start at 0, a child count of 3 indicates that there are child property sets at
indexes 0, 1, and 2.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Example
For an example, read GetChild Method on page 300.

GetFirstProperty Method
This method returns the name of the first property in a property set.

Syntax
oPropSet.GetFirstProperty()

Argument Description

Not applicable

Returns
A string representing the name of the first property in a property set

Usage
GetFirstProperty() retrieves the name of the first property, in order of definition, of a business
service. Use GetFirstProperty and GetNextProperty to retrieve the name of a property. You can then
use the retrieved name as an argument to GetProperty to retrieve the property value, or with
SetProperty to assign property values.

302 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Example
This example uses GetFirstProperty to get the first property, then retrieves all subsequent properties
using GetNextProperty. The loop terminates when GetNextProperty retrieves a null.

function Service_PreInvokeMethod (MethodName, Inputs, Outputs)

{
var propName = "";
var propVal = "";

propName = Inputs.GetFirstProperty();

// stay in loop if the property name is not null

// or a null string
while ((propName != "") && (propName != null)) {
propVal = Inputs.GetProperty(propName);

// if a property with the same name does not exist

// add the name value pair to the output
if (!Outputs.PropertyExists(propName)) {
Outputs.SetProperty(propName, propVal);
}

propName = Inputs.GetNextProperty();

}
return (CancelOperation);
}

Related Topics
GetNextProperty Method
GetProperty Method on page 305

GetLastErrCode Method
The GetLastErrCode method returns the most recent error code.

Syntax
oPropSet.GetLastErrCode

Argument Description

Not applicable

Siebel Object Interfaces Reference Version 8.1 30 3

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Returns
The last error code as a short integer; 0 indicates no error.

Usage
After execution of a method, the GetLastErrCode can be invoked to check if any error was returned
from the previous operation. The GetLastErrText method can be invoked to retrieve the text of the
error message.

Used With
Mobile Web Client Automation Server, Web Client Automation Server

Related Topic
GetLastErrText Method

GetLastErrText Method
The GetLastErrText method returns the last error text message.

Syntax
oPropSet.GetLastErrText

Argument Description

Not applicable

Returns
The most recent error text message as a string

Usage
After execution of a method, the GetLastErrCode can be invoked to check if any error was returned
from the previous operation. The GetLastErrText method can be invoked to retrieve the text of the
error message.

Used With
Mobile Web Client Automation Server, Web Client Automation Server

Related Topic
GetLastErrCode Method on page 303

304 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

GetNextProperty Method
This method returns the next property in a property set.

Syntax
oPropSet.GetNextProperty()

Argument Description

Not applicable

Returns
A string representing the name of the next property in a property set

Usage
After retrieving the name of the first property with the GetFirstProperty method, GetNextProperty
should be used in a loop, to be terminated when a null string ("") is returned. When property names
have been retrieved, they may be used as arguments to GetProperty to retrieve the property value,
or with SetProperty to assign property values.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Example
For an example, read GetFirstProperty Method on page 302.

Related Topics
GetFirstProperty Method on page 302
GetProperty Method

GetProperty Method
This method returns the value of a property when given the property name.

Siebel Object Interfaces Reference Version 8.1 30 5

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Syntax
oPropSet.GetProperty(propName)

Argument Description

propName A string representing the name of a property as returned by GetFirstProperty or

GetNextProperty

Returns
A string representing the value stored in the property indicated by propName, or an empty string
("") if the property does not exist

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Example
The following fragment of Siebel eScript code receives a set of input properties used with the
Shipping Engine service described in Service_PreInvokeMethod Event on page 284:

var Inputs = TheApplication().NewPropertySet();

var sShipper = Inputs.GetProperty("Shipping Company");

var dWeight = Val(Inputs.GetProperty("Weight"));
var dSize = Val(Inputs.GetProperty("Total Dimensions"));
var iZone = Val(Inputs.GetProperty("Zone"));

Related Topics
GetFirstProperty Method on page 302
GetNextProperty Method on page 305
SetProperty Method on page 312

GetPropertyCount Method
This method returns the number of properties attached to a property set.

Syntax
oPropSet.GetPropertyCount

Argument Description

Not applicable

306 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Returns
The number of properties contained within a property set

Used With
Browser Script, COM Data Control, COM Data Server, Mobile Web Client Automation Server, Server
Script, Web Client Automation Server

GetType Method
This method retrieves the data value stored in the type attribute of a property set.

Syntax
oPropSet.GetType

Argument Description

Not applicable

Returns
A string representing the value stored in the type attribute of the property set

Usage
Type, like value, is a special storage location for a data value.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Related Topics
GetValue Method
SetType Method on page 313

GetValue Method
This method retrieves the data value stored in the value attribute of a property set.

Siebel Object Interfaces Reference Version 8.1 30 7

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Syntax
oPropSet.GetValue

Argument Description

Not applicable

Returns
A string representing the data value stored in the value attribute of a property set

Usage
Value, like type, is a special storage location for a data value.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Related Topics
GetProperty Method on page 305
GetType Method on page 307
SetValue Method on page 314

InsertChildAt Method
This method inserts a child property set into a parent property set at a specific location.

Syntax
oPropSet.InsertChildAt childObject, index

Argument Description

childObject A property set to be made subsidiary to the property set indicated by oPropSet

index An integer representing the position at which childObject is to be inserted

Returns
Not applicable

308 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Usage
This method inserts the property set childObject at the location index. Index numbers start at 0.
When a child property set is inserted, the property set previously at the location index has its index
increased by 1, as do subsequent child property sets.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Related Topic
AddChild Method on page 297

PropertyExists Method
This method returns a Boolean value indicating whether a specified property exists in a property set.

Syntax
oPropSet.PropertyExists(propName)

Argument Description

propName A string representing the name of the property to be found

Returns
In Siebel VB, an integer (0 for false, 1 for true); in other interfaces, a Boolean

Usage
Because GetProperty returns a null string ("") for every nonexistent property, use PropertyExists()
in an if statement to determine whether a specific property has been set.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Example
For an example, read GetFirstProperty Method on page 302.

RemoveChild Method
This method removes a child property set from a parent property set.

Siebel Object Interfaces Reference Version 8.1 30 9

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Syntax
oPropSet.RemoveChild index

Argument Description

index An integer representing the index number of the child property set to be removed

Returns
Not applicable

Usage
When a child property set is removed, every child property set with an index higher than that of the
removed set has its index decremented by 1.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Example
The following Siebel VB code fragment removes every child property set of a property set:

Dim i As Integer
for i = 0 to outputs.GetChildCount()
outputs.RemoveChild(0)
Next i

Related Topics
AddChild Method on page 297
InsertChildAt Method on page 308

RemoveProperty Method
This method removes a property from a property set.

Syntax
oPropSet.RemoveProperty propName

Argument Description

propName The name of the property to be removed

310 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Returns
Not applicable

Usage
This method removes the property propName from the property set oPropSet.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Reset Method
This method removes every properties and child property set from a property set.

Syntax
oPropSet.Reset()

Argument Description

Not applicable

Returns
Not applicable

Usage
This method removes every property and children from a property set, allowing the property set to
be reused with new properties.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

SetByteValue Method
This method sets the value portion of a property set.

Siebel Object Interfaces Reference Version 8.1 31 1

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Syntax
oPropSet.setByteValue(value)

Argument Description

value The byte array containing the value to be set

Returns
Not applicable

Used With
Java Data Bean

Example
The following example takes a binary value and outputs binary.

SiebelPropertySet input = new SiebelPropertySet();

SiebelPropertySet output = new SiebelPropertySet();

input.setProperty("ProcessName", "LMS3 Jason");

// XML to send
String str="<?xml version=\"1.0\" encoding=\"UTF8\"
?><GetCommunicationDataInput><MemberID>20048963</MemberID></
GetCommunicationDataInput>";

// convert string to byte array

byte [] bvalue = new String(str).getBytes();

input.setByteValue(bvalue);
businessService.invokeMethod("RunProcess",input,output);

// use getByteValue to retrieve the value and put it into a String

String out2 = new String (output.getByteValue());
System.out.println(out2);

Related Topic
GetByteValue Method on page 299

SetProperty Method
This method assigns a data value to a property in a property set.

312 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Syntax
oPropSet.SetProperty propName, propValue

Argument Description

propName A string representing the name of a property

propValue A string representing the value to be assigned to propName

Returns
Not applicable

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Example
This Siebel VB fragment makes use of the business service Shipping Engine, which is illustrated in
Service_PreInvokeMethod Event on page 284:

Dim Svc As Service

Dim Inputs As PropertySet, Outputs As PropertySet
Set Svc = TheApplication.GetService("Shipping Engine")
Set Inputs = TheApplication.NewPropertySet()

With Inputs
.SetProperty "Shipping Company", "Airline"
.SetProperty "Weight", "12"
.SetProperty "Total Dimensions", "48"
.SetProperty "Shipping Method", "Second-Day Air"
End With

Related Topic
GetProperty Method on page 305

SetType Method
This method assigns a data value to the type attribute of a property set.

Syntax
oPropSet.SetType type

Argument Description

type A string representing data to be stored in the type attribute

Siebel Object Interfaces Reference Version 8.1 31 3

 For Oracle internal distribution only
Interfaces Reference Property Set Methods

Returns
Not applicable

Usage
Type, like value, is a special storage location for a data value.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Related Topics
GetType Method on page 307
SetValue Method on page 314

SetValue Method
This method assigns a data value to the value attribute of a property set.

Syntax
oPropSet.SetValue value

Argument Description

value A string representing data to be stored in the value attribute

Returns
Not applicable

Usage
Values, like properties and types, are storage locations for a data value.

Used With
Browser Script, COM Data Control, COM Data Server, Java Data Bean, Mobile Web Client Automation
Server, Server Script, Web Client Automation Server

Related Topics
GetValue Method on page 307
SetProperty Method on page 312
SetValue Method

314 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Miscellaneous Methods

ToString Method
This method converts the value of a property set to a string.

Syntax
oPropSet.toString();

Argument Description

Not applicable

Returns
The value of a property set as a string

Usage
This method is used in business service server scripts when it is necessary to convert property set
values to strings.

Used With
Server Script

Miscellaneous Methods
The following methods do not belong to any other category:

GetErrorCode Method on page 315

GetErrorMessage Method on page 316

TheApplication Method on page 317

GetErrorCode Method
This method is used with the Java Data Bean to display numeric error codes.

Syntax
public int getErrorCode()

Argument Description

Not applicable

Siebel Object Interfaces Reference Version 8.1 31 5

 For Oracle internal distribution only
Interfaces Reference Miscellaneous Methods

Returns
A numeric error code

Used With
Java Data Bean

Example
This example for the Siebel Java Data Bean retrieves the first record in the Account business
component. If an error occurs during execution, the script displays the error code and error message.

try
{
//Instantiate the Siebel Data Bean
Sieb_dataBean = new SiebelDataBean();
String Cstr = "GatewayServer, EntServer, FINSObjMgr";
Sieb_dataBean.login(Cstr, "SADMIN", "SADMIN");
SiebelBusObject m_busObject = Sieb_dataBean.getBusObject("Account");
SiebelBusComp m_busComp = m_busObject.getBusComp("Account");
m_busComp.activateField("Name");
m_busComp.executeQuery(true);
m_busComp.firstRecord();
Name = m_busComp.getFieldValue("Name");
System.out.println("Account Name : " + Name);

m_busComp.release();
m_busComp = null;

m_busObject.release();
m_busObject = null;

Sieb_dataBean.logoff();
Sieb_dataBean = null;
}

catch (SiebelException e)
{
ErrorText = "Code: " + e.getErrorCode() + "\n" + "Description: " +
e.getErrorMessage();
System.out.println("Error Occurred\n " + ErrorText);
}

...

Related Topic
GetErrorMessage Method

GetErrorMessage Method
This method is used with the Java Data Bean to display error messages.

316 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Interfaces Reference Miscellaneous Methods

Syntax
public string getErrorMessage()

Argument Description

Not applicable

Returns
A string containing an error message

Used With
Java Data Bean

Related Topic
GetErrorCode Method

TheApplication Method
TheApplication is a global method that returns the unique object of type Application. This is the root
of objects within the Siebel Applications object hierarchy. Use this method to determine the object
reference of the application, which is later used to find other objects or to invoke methods on the
application object.

Browser Script Syntax

theApplication()

VB Syntax
TheApplication

eScript Syntax
TheApplication()

Argument Description

Not applicable

Returns
Application, an object for use in finding other objects or invoking methods

Siebel Object Interfaces Reference Version 8.1 31 7

 For Oracle internal distribution only
Interfaces Reference Miscellaneous Methods

Usage
For example, when using Siebel eScript to determine whether you are logged in to a server database
or local database, use TheApplication().InvokeMethod("GetDataSource").

Used With
Browser Script, Server Script

Example
The following example is in Siebel VB. It retrieves the login name from the application object and
creates the Employee business object.

Dim oEmpBusObj as BusObject

Dim sLoginName as String

sLoginName = TheApplication.LoginName
Set oEmpBusObj = TheApplication.GetBusObject("Employee")

Set oEmpBusObj = Nothing

318 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

5 Accessing Siebel COM Data

Server with C++

This chapter presents a series of steps to build a simple COM client in Visual C++ and the Microsoft
Foundation Class (MFC) library, which accesses the Siebel Data Server. Use this to build real-time
interfaces to Siebel using C++ for integration purposes:

Building the Siebel COM Client in C++ on page 319

Testing Your Program on page 325

Building the Siebel COM Client in C++

The following procedure explains how to build the Siebel COM Client in C++.

To build the Siebel COM client in C++

1 In Microsoft Visual C++, choose File > New > Project.

2 Select the MFC AppWizard (exe) project type.

3 In the Project name field, enter SiebelCOM, and then click OK.

The MFC AppWizard starts.

4 Select the Dialog-based option and then click Next.

5 In the What other support would you like to include? frame, check Automation and clear
ActiveX Controls, and then click Next. Click Next again.

Siebel Object Interfaces Reference Version 8.1 31 9

 For Oracle internal distribution only
Accessing Siebel COM Data Server with C++ Building the Siebel COM Client in C++

6 Click Finish.

Microsoft Visual C++ displays the project information.

7 Click OK.

The Application Wizard generates the standard MFC code that serves as the skeleton for this
project. Headers and libraries necessary to support COM automation are included. Refer to the
Microsoft Visual Studio [MSDN] documentation for a detailed description of the MFC libraries.

8 The newly created dialog box appears in the workspace. You can resize the box and change the
text in the label by editing its properties. Right-click the label in the dialog box to edit its
properties. Modify the dialog box so that it looks something like the following illustration.

9 Choose View > ClassWizard > Automation.

10 Click Add Class > From a type library.

11 Navigate to the C:\Sea750\client\bin folder. Choose sobjsrv.tlb.
12 In the Confirm Classes dialog box, make sure all five Siebel classes are selected, and then click
OK. Click OK again to close the Class Wizard.

320 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Accessing Siebel COM Data Server with C++ Building the Siebel COM Client in C++

13 Add code to communicate with the Siebel COM Server.

a In the workspace window, click the FileView tab.

b Expand the Source Files and Header Files folders.

c Double-click the SiebelCOMDlg.h file.

The code window opens.

Siebel Object Interfaces Reference Version 8.1 32 1

 For Oracle internal distribution only
Accessing Siebel COM Data Server with C++ Building the Siebel COM Client in C++

d Enter the code that is highlighted in boldface in Figure 9 into the SiebelCOMDlg.h file.

#if _MSC_VER > 1000

#pragma once
#endif // _MSC_VER > 1000

#include "sobjsrv.h" //include Siebel wrapper classes

class CSiebelCOMDlgAutoProxy;

//////////////////////////////////////////////////////////////
// CSiebelCOMDlg dialog

class CSiebelCOMDlg : public CDialog{

DECLARE_DYNAMIC(CSiebelCOMDlg);
friend class CSiebelCOMDlgAutoProxy;
SiebelApplication sApp;//declare Siebel object

// Construction
public:
CSiebelCOMDlg(CWnd* pParent = NULL);// standard constructor
virtual ~CSiebelCOMDlg();
Figure 9. Code for SiebelCOMDlg.h

322 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Accessing Siebel COM Data Server with C++ Building the Siebel COM Client in C++

e Choose File > Open and select the SiebelCOMDlg.cpp file. Add the code that is highlighted in
boldface in Figure 10 to the OnInitDialog procedure.

BOOL CSiebelCOMDlg::OnInitDialog()
{
CDialog::OnInitDialog();

// Add About... menu item to system menu

// IDM_ABOUTBOX must be in the system command range.

ASSERT((IDM_ABOUTBOX & 0xFFF0) == IDM_ABOUTBOX);
ASSERT(IDM_ABOUTBOX < 0xF000);

CMenu* pSysMenu = GetSystemMenu(FALSE);

if (pSysMenu != NULL)
{
CString strAboutMenu;
strAboutMenu.LoadString(IDS_ABOUTBOX);
if (!strAboutMenu.IsEmpty())
{
pSysMenu->AppendMenu(MF_SEPARATOR);
pSysMenu->AppendMenu(MF_STRING, IDM_ABOUTBOX, strAboutMenu);
}
}

// Set the icon for this dialog. The framework does this
// automatically when the applications main window
// is not a dialog
SetIcon(m_hIcon, TRUE); // Set big icon
SetIcon(m_hIcon, FALSE); // Set small icon

// TODO: Add extra initialization here

// Start the Siebel Data Server
if (!sApp.CreateDispatch(_T("SiebelDataServer.ApplicationObject")))
{
AfxMessageBox("Cannot start Siebel Data Server.");
EndDialog(-1); //fail
} else
{
AfxMessageBox("Siebel Data Server initialized.");
}

return TRUE; // return TRUE unless you set the focus to a control
}

Figure 10. Code to Be Added to OnInitDialog Routine in SiebelCOMDlg.cpp

Siebel Object Interfaces Reference Version 8.1 32 3

 For Oracle internal distribution only
Accessing Siebel COM Data Server with C++ Building the Siebel COM Client in C++

f In the same file, add the code that is highlighted in boldface in Figure 11 and Figure 12 to the
OnOKDialog procedure. Make sure that the line beginning with sApp.LoadObjects points to the
location of the CFG file you intend to use. In the line beginning with sApp.Login, make sure that
you have entered a valid logon name and password.

void CSiebelCOMDlg::OnOK()
{

short sErr;

//Load Configuration File

// Make sure that The following line points to the configuration
// file you intend to use!
sApp.LoadObjects("C:\\siebel\\bin\\siebel.cfg", &sErr);
if(sErr)
{
AfxMessageBox("LoadObjects failed.");
return;
} else
{
AfxMessageBox("CFG file loaded.");
}

//Login as Sadmin
sApp.Login("SADMIN", "SADMIN", &sErr);
if (sErr)
{
AfxMessageBox("Login failed.");
return;
} else
{
AfxMessageBox("Logged into Siebel database.");
}

//Get Account BusObject

LPDISPATCH lpdBo;
lpdBo = sApp.GetBusObject("Account", &sErr);
if (sErr)
{
AfxMessageBox("GetBusObject failed.");
return;
} else
{
AfxMessageBox("Account BusObject retrieved.");
}
SiebelBusObject Bo(lpdBo);

Figure 11. Code to be Added to OnOKDialog Routine in SiebelCOMDlg.cpp

324 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Accessing Siebel COM Data Server with C++ Testing Your Program

//Get Account BusComp

LPDISPATCH lpdBc;
lpdBc = Bo.GetBusComp("Account", &sErr);
if (sErr)
{
AfxMessageBox("GetBusComp failed.");
return;
} else
{
AfxMessageBox("Account BusComp retrieved.");
}
SiebelBusComp Bc(lpdBc);

//Get the name of the first account

if (sErr) return;
Bc.ClearToQuery(&sErr);
if (sErr) return;
Bc.SetSearchSpec("Name","*",&sErr);
if (sErr) return;
Bc.ExecuteQuery(0,&sErr);
if (sErr) return;
Bc.FirstRecord(&sErr);
if (sErr) return;

//Display the account name in a message box

CString csAcctName;
csAcctName = Bc.GetFieldValue("Name", &sErr);
AfxMessageBox(csAcctName);

return;

if (CanExit())
CDialog::OnOK();
}

Figure 12. Code to Be Added to OnOKDialog Routine in SiebelCOMDlg.cpp

When you have finished creating your program, test it to make sure it works properly.

Testing Your Program

Use the following procedure to test your program.

To test your program

1 Start your Siebel client application using the same CFG file and login arguments you specified in
the code.

Siebel Object Interfaces Reference Version 8.1 32 5

 For Oracle internal distribution only
Accessing Siebel COM Data Server with C++ Testing Your Program

2 Choose Screens > Accounts > All Accounts. Verify that there is at least one account visible in the
Account list applet. If there is not, create one. Exit the Siebel client.

3 Open the CFG file you specified in the code and make sure that the DataSource key indicates the
database source you specified at logon in Step 2.

4 In Microsoft Visual C++, choose Build > Build SiebelCOM.exe, or press F7. If there are any errors
or warnings reported in the output window, correct the errors and repeat this step.

5 Choose Build > Execute SiebelCOM.exe, or press F5.

A message box displays the message Siebel Data Server initialized.

6 Click OK.

The customized dialog box opens.

7 The application displays a series of message boxes, with the following messages:

CFG file loaded.

Logged into Siebel database.
Account BusObject retrieved.
Account BusComp retrieved.

The application displays the name of the first account in the All Accounts view.

326 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

6 COM Data Control Quick

Reference

This chapter provides a quick reference for Siebel COM Data Control methods. It has the following
topics:

Application Methods for COM Data Control

Business Component Methods for COM Data Control on page 330

Business Object Methods for COM Data Control on page 334

Business Service Methods for COM Data Control on page 334

Property Set Methods for COM Data Control on page 335

Application Methods for COM Data

Control
Table 34 lists a summary of the application methods syntax.

Table 34 does not include methods that are not invoked directly from an Application object instance.
For information on methods that are called with InvokeMethod on the Application object, see
InvokeMethod Methods for the Application Object on page 139.

Table 34. Application Methods Syntax Summary

Method Description Syntax

Attach Method Allows an external Dim application as SiebelDataControl

application to reconnect to Dim status as Boolean
an existing Siebel session. status = application.Attach(sessionID
As String)
CurrencyCode Returns the three-letter Dim application as SiebelDataControl
Method operating currency code. Dim sCur as String
sCur = Application.CurrencyCode
Detach Method Returns a string containing Dim application as SiebelDataControl
the Siebel session ID. Dim sessionId as String
sessionId = application.Detach()

EnableExceptions Enables/disables native COM Dim application as SiebelDataControl

Method error handling. Dim bEnable as Boolean
bEnable =
application.EnableExceptions(bEnable)

Siebel Object Interfaces Reference Version 8.1 32 7

 For Oracle internal distribution only
COM Data Control Quick Reference Application Methods for COM Data Control

Table 34. Application Methods Syntax Summary

Method Description Syntax

GetBusObject Instantiates and returns a Dim application as SiebelDataControl

Method new instance of the business Dim busObject as SiebelBusObject
object specified in the set busObject =
argument. application.GetBusObject(busobjName as
String)
GetLastErrCode Returns the last error code. Dim application as SiebelDataControl
Method Dim iErr as Integer
iErr = application.GetLastErrCode

GetLastErrText Returns the last error text Dim application as SiebelDataControl

Method message. Dim sText as String
sText = application.GetLastErrText
GetProfileAttr Returns the value of an Dim application as SiebelDataControl
Method attribute in a user profile. Dim sText as String
sText =
application.GetProfileAttr(profileAttr
ibuteName as string)
GetService Method Instantiates and returns a Dim application as SiebelDataControl
new instance of the Dim service as SiebelService
argument-specified service. set service = application.GetService(
serviceName as String)
GetSharedGlobal Returns the shared user- Dim application as SiebelDataControl
Method defined global variables. Dim sText as string
sText =
application.GetSharedGlobal(globalVari
ableName as string)
InvokeMethod Calls the named specialized Dim application as SiebelDataControl
Method method. Dim sReturn as String
sReturn =
application.InvokeMethod(methodName as
String, methodArgs as String or
StringArray)

Login Method Allows external applications Dim application as SiebelDataControl

to log in to the COM Data Dim sErr as String
Server. sErr = application.Login(connectString
as String, userName as String, password
as String)
LoginId Method Returns the login ID of the Dim application as SiebelDataControl
user who started the Siebel Dim sID as String
application. sID = application.LoginId

LoginName Method Returns the login name of Dim application as SiebelDataControl

the user who started the Dim sUser as String
Siebel application. sUser = application.LoginName

328 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
COM Data Control Quick Reference Application Methods for COM Data Control

Table 34. Application Methods Syntax Summary

Method Description Syntax

Logoff Method Disconnects the client from Dim SiebApp as SiebelDataControl

the server. boolVal=siebApp.LogOff()

NewPropertySet Constructs and returns a new Dim application as SiebelDataControl

Method property set object. Dim PropSet as ProperySet
PropSet = oApplication.NewPropertySet()
PositionId Method Returns the position ID that Dim application as SiebelDataControl
describes the users current Dim sRow as String
position. sRow = application.PositionId

PositionName Returns the position name of Dim application as SiebelDataControl

Method the users current position. Dim sPosition as String
sPosition = application.PositionName
SetPositionId Sets the active position to Dim application as SiebelDataControl
Method the Position ID specified in Dim status as Boolean
the argument. status =
application.SetPositionId(sPosId)
SetPositionName Sets the active position to Dim application as SiebelDataControl
Method the position name specified Dim status as Boolean
in the argument. Returns a status =
Boolean value indicating application.SetPositionName(sPosName)
whether or not method
succeeded.

SetProfileAttr Used in personalization to Dim application as SiebelDataControl

Method assign values to attributes in application.SetProfileAttr(name as
a user profile. String, value as String)

SetSharedGlobal Sets a shared user-defined Dim application as SiebelDataControl

Method global variable, which may Dim SiebApp as SiebelDataControl
be accessed using boolVal=SetSharedGlobal(varName As
GetSharedGlobal. String, value As String)

Trace Method Appends a message to the Dim application as SiebelDataControl

trace file. Dim SiebApp as SiebelDataControl
boolVal=siebApp.TraceOn(msg As String)
As Boolean
TraceOff Method Turns off the tracing started Dim application as SiebelDataControl
by the TraceOn method. Dim SiebApp as SiebelDataControl
boolVal=siebApp.TraceOff as Boolean

TraceOn Method Turns on the tracking of Dim application as SiebelDataControl

allocations and deallocations Dim SiebApp as SiebelDataControl
of Siebel objects, and SQL boolVal=siebApp.TraceOn(fileName As
statements generated by the String, category As String, src As
Siebel application. String) As Boolean

Siebel Object Interfaces Reference Version 8.1 32 9

 For Oracle internal distribution only
COM Data Control Quick Reference Business Component Methods for COM Data Control

Business Component Methods for COM

Data Control
Table 35 lists a summary of the business component methods syntax.

Table 35 does not include methods that are not invoked directly from a Business Component object
instance. For information on methods that are called with InvokeMethod on the Business Component
object, see InvokeMethod Methods for the Business Component Object on page 213.

Table 35. Business Component Methods Syntax Summary

Method Description Syntax

ActivateField Method Allows queries to retrieve data Dim busComp as SiebelBusComp

for the specified field. BusComp.ActivateField(fieldName
as String)
ActivateMultipleFields Allows queries to retrieve data Dim busComp as SiebelBusComp
Method for the fields specified in the busComp.ActivateMultipleFields(oP
property set. ropSet as SiebelPropertySet)

Associate Method Creates a new many-to-many Dim busComp as SiebelBusComp

relationship for the parent busComp.Associate(whereIndicator
object through an association as Integer)
business component.

BusObject Method Returns the business object Dim busComp as SiebelBusComp

that contains the business Dim busObject as SiebelBusObject
component. Set busObject = busComp.BusObject

ClearToQuery Method Clears the current query and Dim busComp as SiebelBusComp
sort specifications on the busComp.ClearToQuery
business component.

DeactivateFields Method Deactivates every currently Dim busComp as SiebelBusComp

activated field. busComp.DeactivateFields

DeleteRecord Method Removes the current record Dim busComp as SiebelBusComp

from the business component. busComp.DeleteRecord

ExecuteQuery Method Retrieves a set of BusComp Dim buscomp as SiebelBusComp

records. buscomp.ExecuteQuery(cursorMode
As Integer) As Boolean
ExecuteQuery2 Method Retrieves a set of BusComp Dim buscomp as SiebelBusComp
records. buscomp.ExecuteQuery2(cursorMode
As Integer,ignoreMaxCursorSize As
Integer) As Boolean
FirstRecord Method Moves to the first record in the Dim busComp as SiebelBusComp
business component. Dim bIsRecord as Boolean
bIsRecord = busComp.FirstRecord

330 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
COM Data Control Quick Reference Business Component Methods for COM Data Control

Table 35. Business Component Methods Syntax Summary

Method Description Syntax

GetFieldValue Method Returns a value for the field Dim busComp as SiebelBusComp
specified in the argument. Dim sValue as String
sValue =
busComp.GetFieldValue(FieldName
as String)
GetFormattedFieldValue Returns a formatted value for Dim busComp as SiebelBusComp
Method the field specified in the Dim sValue as String
argument. sValue =
busComp.GetFormattedFieldValue(Fi
eldName as String)
GetLastErrCode Method Returns the most recent error Dim errCode As Integer
code. Dim SiebApp as SiebelDataControl
errCode=siebApp.GetLastErrCode
GetLastErrText Method Returns the most recent error Dim busComp as SiebelBusComp
text message. Dim sErr as String
busComp.GetLastErrText

GetMultipleFieldValues Returns a value for the fields Dim busComp as SiebelBusComp

Method specified in the property set. busComp.GetMultipleFieldValues(oF
ieldNames as SiebelPropertySet,
oFieldValues as
SiebelPropertySet)
GetMVGBusComp Returns the MVG business Dim busComp as SiebelBusComp
Method component associated with the Dim mVGBusComp as SiebelBusComp
field specified in the argument. set mVGBusComp =
busComp.GetMVGBusComp(FieldName
as String)
GetNamedSearch Returns the argument-named Dim busComp as SiebelBusComp
Method search specification. Dim sValue as String
sValue =
busComp.GetNamedSearch(SearchName
as String)

GetPicklistBusComp Returns the pick business Dim busComp as SiebelBusComp

Method component associated with the Dim pickBusComp as SiebelBusComp
field specified in the argument. Set pickBusComp =
busComp.GetPicklistBusComp(FieldN
ame as String)
GetSearchExpr Method Returns the current search Dim busComp as SiebelBusComp
expression. Dim sExpr as String
sExpr = busComp.GetSearchExpr

GetSearchSpec Method Returns the current search Dim busComp as SiebelBusComp

specification for the field Dim sSpec as String
specified in the argument. sSpec =
busComp.GetSearchSpec(FieldName
as String)

Siebel Object Interfaces Reference Version 8.1 33 1

 For Oracle internal distribution only
COM Data Control Quick Reference Business Component Methods for COM Data Control

Table 35. Business Component Methods Syntax Summary

Method Description Syntax

GetUserProperty Method Returns the value of a named Dim buscomp as SiebelBusComp

user property. Dim retStr as String
retStr=buscomp.GetUserProp(prop
As String) As String
GetViewMode Method Returns the visibility mode for Dim busComp as SiebelBusComp
the business component. Dim iMode as Integer
iMode = busComp.GetViewMode
InvokeMethod Method Calls the specialized method Dim busComp as SiebelBusComp
named in the argument. Dim sReturn as String
sReturn =
busComp.InvokeMethod(methodName
as String, methodArgs as String or
StringArray)
LastRecord Method Moves to the last record in the Dim busComp as SiebelBusComp
business component. Dim bReturn as Boolean
bReturn = busComp.LastRecord

Name Method Returns the name of the Dim busComp as SiebelBusComp

business component. Dim sName as String
sName = busComp.Name
NewRecord Method Adds a new record to the Dim busComp as SiebelBusComp
business component. busComp.NewRecord(whereIndicator
as Integer)
NextRecord Method Moves to the next record in the Dim busComp as SiebelBusComp
business component. bReturn as Boolean
bReturn = busComp.NextRecord

ParentBusComp Method Returns the parent business Dim busComp as SiebelBusComp

component. Dim parentBusComp as SiebelBusComp
Set parentBusComp =
busComp.ParentBusComp
Pick Method Places the currently selected Dim busComp as SiebelBusComp
record in a picklist business busComp.Pick
component into the
appropriate fields of the parent
business component.

PreviousRecord Method Moves to the previous record in Dim busComp as SiebelBusComp

the business component. Dim bReturn as Boolean
bReturn = busComp.PreviousRecord
RefineQuery Method Refines a query after a query Dim busComp as SiebelBusComp
has been executed. busComp.RefineQuery

SetFieldValue Method Assigns a new value to the Dim busComp as SiebelBusComp

named field for the current row busComp.SetFieldValue(FieldName
of the business component. as String, FieldValue as String)

332 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
COM Data Control Quick Reference Business Component Methods for COM Data Control

Table 35. Business Component Methods Syntax Summary

Method Description Syntax

SetFormattedFieldValue Accepts the field value in the Dim busComp as SiebelBusComp

Method current local format and busComp.SetFormattedFieldValue(Fi
assigns the new value to the eldName as String, FieldValue as
named field for the current row String)
of the business component.

SetMultipleFieldValues Assigns a new value to the Dim busComp as SiebelBusComp

Method fields specified in the property BusComp.SetMultipleFieldValues(oP
set for the current row of the ropSet as SiebelPropertySet)
business component.

SetNamedSearch Sets a named search Dim busComp as SiebelBusComp

Method specification on the business busComp.SetNameSearch(searchName
component. as String, searchSpec as String)

SetSearchExpr Method Sets the search specification Dim busComp as SiebelBusComp

for the business component. busComp.SetSearchExpr(searchSpec
as String)
SetSearchSpec Method Sets the search specification Dim busComp as SiebelBusComp
for the specified field. busComp.SetSearchSpec(FieldName
as String, searchSpec as String)
SetSortSpec Method Sets the sort specification for a Dim busComp as SiebelBusComp
query. busComp.SetSortSpec(sortSpec as
String)

SetViewMode Method Sets the visibility type for the Dim buscomp as SiebelBusComp
business component. Dim boolVal as Boolean
boolVal=buscomp.SetViewMode(mode
As Integer) As Boolean
UndoRecord Method Reverses any uncommitted Dim busComp as SiebelBusComp
changes made to the record. busComp.UndoRecord

WriteRecord Method Commits to the database any Dim busComp as SiebelBusComp

changes made to the current busComp.WriteRecord
record.

Siebel Object Interfaces Reference Version 8.1 33 3

 For Oracle internal distribution only
COM Data Control Quick Reference Business Object Methods for COM Data Control

Business Object Methods for COM Data

Control
Table 36 lists a summary of the business object methods syntax.

Table 36. Business Object Methods Syntax Summary

Method Description Syntax

GetBusComp Returns the specified business Dim busObject as SiebelBusObject

Method component. Dim busComp as SiebelBusComp
set busComp =
BusObject.GetBusComp(BusCompName as
String)

GetLastErrCode Returns the most recent error Dim busObject as SiebelBusObject

Method code. Dim iErr as Integer
busObject.GetLastErrCode
GetLastErrText Returns the most recent error Dim busObject as SiebelBusObject
Method text. Dim sErr as String
busObject.GetLastErrText

Name Method Returns the name of the control. Dim busObject as SiebelBusObject
Dim sName as String
sName = busObject.Name

Business Service Methods for COM Data

Control
Table 37 lists a summary of the business service methods syntax.

Table 37. Business Service Methods Syntax Summary

Method Description Syntax

GetFirstProperty Retrieves the name of the first Dim oService as SiebelService

Method property of a business service. Dim sName as String
sName = oService.GetFirstProperty()

GetNextProperty After the name of the first Dim oService as SiebelService

Method property has been retrieved, Dim sName as String
retrieves the name of the next sName = oService.GetNextProperty()
property of a business service.

GetProperty Retrieves the value stored in the Dim oService as SiebelService

Method specified property. Dim sValue as String
sValue =
oService.GetProperty(propName as
String)

334 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
COM Data Control Quick Reference Property Set Methods for COM Data Control

Table 37. Business Service Methods Syntax Summary

Method Description Syntax

Name Method Returns the name of the Dim oService as SiebelService

business service. Dim sName as String
sName = oService.Name
InvokeMethod Calls a specialized method or a Dim oService as SiebelService
Method user-created method on the Dim Return
business service. Return =
oService.InvokeMethod(methodName as
String, InputArguments as
SiebelPropertySet, OutputArguments as
SiebelPropertySet)
PropertyExists Returns a Boolean value Dim oService as SiebelService
Method indicating whether the property Dim propExists as Boolean
specified in the argument propExists = oService.PropertyExists(
exists. propName as String)

RemoveProperty Removes a property from a Dim oService as SiebelService

Method business service. oService.RemoveProperty(propName as
String)
SetProperty Assigns a value to a property of Dim oService as SiebelService
Method a business service. oService.SetProperty(propName as
String, propValue as String)

Property Set Methods for COM Data

Control
Table 38 lists a summary of the property set methods syntax.

Table 38. Property Set Methods Syntax Summary

Method Description Syntax

AddChild Method Adds subsidiary property sets to Dim oPropSet as SiebelPropertySet

a property set. Dim iIndex as Integer
iIndex = oPropSet.AddChild(
childObject as Property Set)
Copy Method Returns a copy of a property set. Dim oPropSet1 as SiebelPropertySet
Dim oPropSet2 as SiebelPropertySet
oPropSet2 = oPropSet1.Copy()
GetChild Method Returns a specified child Dim oPropSet as SiebelPropertySet
property set of a property set. Dim sPropVal as String
sPropVal = oPropSet.GetChild(index as
Integer)

Siebel Object Interfaces Reference Version 8.1 33 5

 For Oracle internal distribution only
COM Data Control Quick Reference Property Set Methods for COM Data Control

Table 38. Property Set Methods Syntax Summary

Method Description Syntax

GetChildCount Returns the number of child Dim oPropSet as SiebelPropertySet

Method property sets attached to a Dim iCount as Integer
parent property set. iCount = oPropSet.GetChildCount()

GetFirstProperty Returns the name of the first Dim oPropSet as SiebelPropertySet

Method property in a property set. Dim sPropName as String
sPropName =
oPropSet.GetFirstProperty()
GetNextProperty Returns the name of the next Dim oPropSet as SiebelPropertySet
Method property in a property set. Dim sPropName as String
sPropName =
oPropSet.GetNextProperty()
GetProperty Returns the value of a property Dim oPropSet as SiebelPropertySet
Method when given the property name. Dim sPropVal as String
sPropVal =
oPropSet.GetProperty(propName as
String)
GetPropertyCount Returns the number of Dim oPropSet as SiebelPropertySet
Method properties attached to a property Dim count as Long
set. count = oPropSet .GetPropertyCount

GetType Method Returns the value stored in a Dim oPropSet as SiebelPropertySet

type in a property set. Dim sTypeVal as String
sTypeVal = oPropSet.GetType()

GetValue Method Returns a value stored as part of Dim oPropSet as SiebelPropertySet

a property set. Dim sValVal as String
sValVal = oPropSet.GetValue()
InsertChildAt Inserts a child property set into a Dim oPropSet as SiebelPropertySet
Method parent property set at a specific oPropSet.InsertChildAt(childObject as
location. SiebelPropertySet, index as Long)

PropertyExists Returns a Boolean value Dim oPropSet as Property Set

Method indicating whether the property Dim propExists as Boolean
specified in the argument exists. propExists = oPropSet.PropertyExists(
propName as String)
RemoveChild Removes a child property set as Dim oPropSet as SiebelPropertySet
Method a specified index from a parent oPropSet.RemoveChild(index as Long)
property set.

RemoveProperty Removes the property specified Dim oPropSet as SiebelPropertySet

Method in its argument from a property oPropSet.RemoveProperty(propName as
set. String)

Reset Method Removes every property and Dim oPropSet as SiebelPropertySet

child property set from a oPropSet.Reset()
property set.

336 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
COM Data Control Quick Reference Property Set Methods for COM Data Control

Table 38. Property Set Methods Syntax Summary

Method Description Syntax

SetProperty Assigns a value to the property Dim oPropSet as SiebelPropertySet

Method of a property set specified in its oPropSet.SetProperty(propName as
argument. String, propValue as String)

SetType Method Assigns a data value to a type Dim oPropSet as SiebelPropertySet

member of a property set. oPropSet.SetType(value as String)

SetValue Method Assigns a data value to a value Dim oPropSet as SiebelPropertySet

member of a property set. oPropSet.SetValue(value as String)

Siebel Object Interfaces Reference Version 8.1 33 7

 For Oracle internal distribution only
COM Data Control Quick Reference Property Set Methods for COM Data Control

338 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

7 COM Data Server Quick

Reference

This chapter provides a quick reference for Siebel COM Data Server methods. It has the following
topics:

Application Methods for COM Data Server

Business Component Methods for COM Data Server on page 341

Business Object Methods for COM Data Server on page 346

Business Service Methods for COM Data Server on page 347

Property Set Methods for COM Data Server on page 348

Application Methods for COM Data

Server
Table 39 lists a summary of the application methods syntax.

Table 39 does not include methods that are not invoked directly from an Application object instance.
For information on methods that are called with InvokeMethod on the Application object, see
InvokeMethod Methods for the Application Object on page 139.

Table 39. Application Methods Syntax Summary

Method Description Syntax

CurrencyCode Returns the three-letter Dim application as SiebelApplication

Method operating currency code. Dim sCur as String
sCur = Application.CurrencyCode(ErrCode
as Integer)
GetBusObject Instantiates and returns a Dim application as SiebelApplication
Method new instance of the business Dim busObject as SiebelBusObject
object specified in the set busObject =
argument. application.GetBusObject(busobjName as
String, ErrCode as Integer)
GetLastErrCode Returns the last Siebel error Dim application as SiebelApplication
Method number. Dim iErrNum as Integer
iErrNum =
application.GetLastErrCode(ErrCode as
Integer)

Siebel Object Interfaces Reference Version 8.1 33 9

 For Oracle internal distribution only
COM Data Server Quick Reference Application Methods for COM Data Server

Table 39. Application Methods Syntax Summary

Method Description Syntax

GetLastErrText Returns the last error text Dim application as SiebelApplication

Method message. Dim sText as String
sText =
application.GetLastErrText(ErrCode as
Integer)
GetProfileAttr Returns the value of an Dim application as SiebelApplication
Method attribute in a user profile. Dim sText as String
sText = application.GetProfileAttr(Name
as String)
GetService Method Instantiates and returns a Dim Application as SiebelApplication
new instance of the Dim Service as SiebelService
argument-specified service. set Service =
Application.GetService(serviceName as
String, ErrCode as Integer)
GetSharedGlobal Gets the shared user-defined Dim application as SiebelApplication
Method global variables. Dim sName as String
sName =
application.GetSharedGlobal(varName as
String, ErrCode as Integer)

IsViewReadOnly Returns TRUE if a view is Dim sText as String

Method read-only, else returns sText =
FALSE. TheApplication.InvokeMethod(IsViewRead
Only, viewName as String)
TheApplication.RaiseErrorText(sText)
LoadObjects Starts the COM Data Server Dim application as SiebelApplication
Method object and returns a Dim returned as SiebelApplication
reference to the Application application.LoadObjects(pathName\cfgFile
object. Name as String, ErrCode as Integer)

Login Method Allows external applications Dim application as SiebelApplication

to log in to the COM Data application.Login(userName as String,
Server. password as String, ErrCode as Integer)

LoginId Method Returns the login ID of the Dim application as SiebelApplication

user who started the Siebel Dim sID as String
application. sID = application.LoginId(ErrCode as
Integer)
LoginName Returns the login name of Dim application as SiebelApplication
Method the user who started the Dim sUser as String
Siebel application. sUser = application.LoginName(ErrCode as
Integer)
NewPropertySet Constructs and returns a Dim oApplication as SiebelApplication
Method new property set object. Dim oPropSet as ProperySet
oPropSet = oApplication.NewPropertySet()

340 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
COM Data Server Quick Reference Business Component Methods for COM Data Server

Table 39. Application Methods Syntax Summary

Method Description Syntax

PositionId Method Returns the position ID that Dim application as SiebelApplication

describes the users current Dim sRow as String
position. sRow = application.PositionId(ErrCode as
Integer)
PositionName Returns the position name of Dim application as SiebelApplication
Method the users current position. Dim sPosition as String
sPosition =
application.PositionName(ErrCode as
Integer)
SetPositionId Sets the active position to Dim application as SiebelApplication
Method the position ID specified in Dim posId as String
the argument. Returns a Dim status as Boolean
Boolean value indicating if status = application.SetPositionId(posId
the method succeeded. as String, ErrCode as Integer)

SetPositionName Sets the active position to Dim application as SiebelApplication

Method the position name specified Dim posName as String
in the argument. Returns a Dim status as Boolean
Boolean value indicating if status =
the method succeeded. application.SetPositionName(posName as
String, ErrCode as Integer)
SetProfileAttr Used in personalization to Dim application as SiebelApplication
Method assign values to attributes in application.SetProfileAttr(name as
a user profile. String, value as String, ErrCode as
Integer)

SetSharedGlobal Sets a shared user-defined Dim application as SiebelApplication

Method global variable. application.SetSharedGlobal(varName as
String, value as String, ErrCode as
Integer)
Trace Method Appends a message to the Dim application as SiebelApplication
trace file. application.Trace(message as String,
ErrCode as Integer)

TraceOff Method Turns off the tracing started Dim application as SiebelApplication
by TraceOn. application.TraceOff(ErrCode as Integer)

TraceOn Method Turns tracing on Dim application as SiebelApplication

application.TraceOn(filename as String,
type as Integer, Selection as String,
ErrCode as Integer)

Business Component Methods for COM

Data Server
Table 40 on page 342 lists a summary of the business component methods syntax.

Siebel Object Interfaces Reference Version 8.1 34 1

 For Oracle internal distribution only
COM Data Server Quick Reference Business Component Methods for COM Data Server

Table 40 does not include methods that are not invoked directly from a Business Component object
instance. For information on methods that are called with InvokeMethod on the Business Component
object, see InvokeMethod Methods for the Business Component Object on page 213.

Table 40. Business Component Methods Syntax Summary

Method Description Syntax

ActivateField Method Allows queries to retrieve Dim busComp as SiebelBusComp

data for the specified field. busComp.ActivateField(fieldName as
String, ErrCode as Integer)

ActivateMultipleFields Allows queries to retrieve Dim buscomp as SiebelBusComp

Method data for the fields specified buscomp.ActivateMultipleFields(oPr
in the property set. opSet as SiebelPropertySet, ErrCode
as Integer)
Associate Method Creates a new many-to- Dim busComp as SiebelBusComp
many relationship for the busComp.Associate(whereIndicator
parent object through an as Integer, ErrCode as Integer)
association business
component.

BusObject Method Returns the business object Dim busComp as SiebelBusComp

that contains the business Dim busObject as BusObject
component. Set busObject =
busComp.BusObject(ErrCode as
Integer)
ClearToQuery Method Clears the current query and Dim busComp as SiebelBusComp
sort specifications on the busComp.ClearToQuery(ErrCode as
business component. Integer)

DeactivateFields Method Deactivates every currently Dim busComp as SiebelBusComp

activated field. busComp.DeactivateFields(ErrCode
as Integer)
DeleteRecord Method Removes the current record Dim busComp as SiebelBusComp
from the business busComp.DeleteRecord(ErrCode as
component. Integer)

ExecuteQuery Method Retrieves a set of BusComp Dim busComp as SiebelBusComp

records. busComp.ExecuteQuery(cursorMode as
Boolean, ErrCode as Integer)

ExecuteQuery2 Method Retrieves a set of BusComp Dim busComp as SiebelBusComp

records. busComp.ExecuteQuery2(cursorMode
as Boolean, ignoreMaxCursorSize as
Boolean, ErrCode as Integer)

FirstRecord Method Moves to the first record in Dim busComp as SiebelBusComp

the business component. Dim bIsRecord as Boolean
bIsRecord =
busComp.FirstRecord(ErrCode as
Integer)

342 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
COM Data Server Quick Reference Business Component Methods for COM Data Server

Table 40. Business Component Methods Syntax Summary

Method Description Syntax

FirstSelected Method Moves to the first record of Dim busComp as SiebelBusComp

the multiple selection in the Dim iRecord as Integer
business component. iRecord = busComp.FirstSelected

GetAssocBusComp Returns the association Dim busComp as SiebelBusComp

Method business component. Dim AssocBusComp as BusComp
Set AssocBusComp =
busComp.GetAssocBusComp(ErrCode as
Integer)
GetFieldValue Method Returns a value for the field Dim busComp as SiebelBusComp
specified in the argument. Dim sValue as String
sValue =
busComp.GetFieldValue(FieldName as
String, ErrCode as Integer)
GetFormattedFieldValue Returns a formatted value Dim busComp as SiebelBusComp
Method for the field specified in the Dim sValue as String
argument. sValue =
busComp.GetFormattedFieldValue(Fie
ldName as String, ErrCode as
Integer)
GetMultipleFieldValues Returns a value for the fields Dim buscomp as SiebelBusComp
Method specified in the property set. Dim retValue as Boolean
retValue =
buscomp.GetMultipleFieldValues(oPr
opSetName as SiebelPropertySet,
oPropSetValue as
SiebelPropertySet, ErrCode as
Integer)
GetMVGBusComp Method Returns the MVG business Dim busComp as SiebelBusComp
component associated with Dim mVGBusComp as SiebelBusComp
the field specified in the set mVGBusComp =
argument. busComp.GetMVGBusComp(FieldName as
String, ErrCode as Integer)

GetNamedSearch Method Returns the argument- Dim busComp as SiebelBusComp

named search specification. Dim sValue as String
sValue =
busComp.GetNamedSearch(SearchName
as String, ErrCode as Integer)
GetPicklistBusComp Returns the pick business Dim busComp as SiebelBusComp
Method component associated with Dim pickBusComp as SiebelBusComp
the field specified in the Set pickBusComp =
argument. busComp.GetPicklistBusComp(FieldNa
me as String, ErrCode as Integer)

Siebel Object Interfaces Reference Version 8.1 34 3

 For Oracle internal distribution only
COM Data Server Quick Reference Business Component Methods for COM Data Server

Table 40. Business Component Methods Syntax Summary

Method Description Syntax

GetSearchExpr Method Returns the current search Dim busComp as SiebelBusComp

expression. Dim sExpr as String
sExpr =
busComp.GetSearchExpr(ErrCode as
Integer)
GetSearchSpec Method Returns the current search Dim busComp as BusComp
specification for the field Dim sSpec as String
specified in the argument. sSpec =
busComp.GetSearchSpec(FieldName as
String, ErrCode as Integer)

GetUserProperty Method Returns the value for the Dim busComp as SiebelBusComp
property name whose name Dim sValue as String
is specified in the argument. sValue =
busComp.GetUserProperty(propertyNa
me as String, ErrCode as Integer)
GetViewMode Method Returns the visibility mode Dim busComp as SiebelBusComp
for the business component. Dim iMode as Integer
iMode =
busComp.GetViewMode(ErrCode as
Integer)
LastRecord Method Moves to the last record in Dim busComp as SiebelBusComp
the business component. Dim bReturn as Boolean
bReturn =
busComp.LastRecord(ErrCode as
Integer)
Name Method Returns the name of the Dim busComp as SiebelBusComp
business component. Dim sName as String
sName = busComp.Name(ErrCode as
Integer)
NewRecord Method Adds a new record to the Dim busComp as SiebelBusComp
business component. busComp.NewRecord(whereIndicator
as Integer, ErrCode as Integer)
NextRecord Method Moves to the next record in Dim busComp as SiebelBusComp
the business component. Dim bReturn as Boolean
bReturn =
busComp.NextRecord(ErrCode as
Integer)
ParentBusComp Method Returns the parent business Dim busComp as SiebelBusComp
component. Dim parentBusComp as SiebelBusComp
Set parentBusComp =
busComp.ParentBusComp(ErrCode as
Integer)

344 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
COM Data Server Quick Reference Business Component Methods for COM Data Server

Table 40. Business Component Methods Syntax Summary

Method Description Syntax

Pick Method Places the currently selected Dim busComp as SiebelBusComp

record in a picklist business busComp.Pick(ErrCode as Integer)
component into the
appropriate fields of the
parent business component.

PreviousRecord Method Moves to the previous record Dim busComp as SiebelBusComp

in the business component. Dim bReturn as Boolean
bReturn =
busComp.PreviousRecord(ErrCode as
Integer)
RefineQuery Method Refines a query after a query Dim busComp as SiebelBusComp
has been executed. busComp.RefineQuery(ErrCode as
Integer)

SetFieldValue Method Assigns a new value to the Dim busComp as SiebelBusComp

named field for the current
row of the business SetFieldValue(fieldname As String,
component. fieldValue As string,errCode as
Integer)
SetFormattedFieldValue Accepts the field value in the Dim busComp as SiebelBusComp
Method current local format and busComp.SetFormattedFieldValue(Fie
assigns the new value to the ldName as String, FieldValue as
named field for the current String, ErrCode as Integer)
row of the business
component.

SetMultipleFieldValues Assigns a new value to the Dim buscomp as SiebelBusComp

Method fields specified in the buscomp.SetMultipleFieldValues(oPr
property set for the current opSet as SiebelPropertySet, ErrCode
row of the business as Integer)
component.

SetNamedSearch Method Sets a named search Dim busComp as SiebelBusComp

specification on the business busComp.SetNamedSearch(searchName
component. as String, searchSpec as String,
ErrCode as Integer)
SetSearchExpr Method Sets the search specification Dim busComp as SiebelBusComp
for the business component. busComp.SetSearchExpr(searchSpec
as String, ErrCode as Integer)
SetSearchSpec Method Sets the search specification Dim busComp as SiebelBusComp
for the specified field. busComp.SetSearchSpec(FieldName as
String, searchSpec as String,
ErrCode as Integer)
SetSortSpec Method Sets the sort specification for Dim busComp as SiebelBusComp
a query. busComp.SetSortSpec(sortSpec as
String, ErrCode as Integer)

Siebel Object Interfaces Reference Version 8.1 34 5

 For Oracle internal distribution only
COM Data Server Quick Reference Business Object Methods for COM Data Server

Table 40. Business Component Methods Syntax Summary

Method Description Syntax

SetUserProperty Method Sets the value of the Dim busComp as SiebelBusComp

specified User Property. busComp.SetUserProperty(propertyNa
me as String, newValue as String,
ErrCode as Integer)

SetViewMode Method Sets the visibility type for Dim buscomp as SiebelBusComp
the business component. buscomp.SetViewMode(mode As
Integer, errCode As Integer)
UndoRecord Method Reverses any uncommitted Dim busComp as SiebelBusComp
changes made to the record. busComp.UndoRecord(ErrCode as
Integer)
WriteRecord Method Commits to the database any Dim busComp as SiebelBusComp
changes made to the current busComp.WriteRecord(ErrCode as
record Integer)

Business Object Methods for COM Data

Server
Table 41 lists a summary of the business object methods syntax.

Table 41. Business Object Methods Syntax Summary

Method Description Syntax

GetBusComp Method Returns the specified Dim busObject as SiebelBusObject

business component. Dim busComp as SiebelBusComp
set busComp =
busObject.GetBusComp(BusCompName
as String, ErrCode as Integer)
Name Method Returns the name of the Dim busObject as SiebelBusObject
control. Dim sName as String
sName = busObject.Name(ErrCode as
Integer)

346 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
COM Data Server Quick Reference Business Service Methods for COM Data Server

Business Service Methods for COM Data

Server
Table 42 lists a summary of the business service methods syntax.

Table 42. Business Service Methods Syntax Summary

Method Description Syntax

GetFirstProperty Retrieves the name of the Dim oService as SiebelService

Method first property of a business Dim sName as String
service. sName =
oService.GetFirstProperty(ErrCode as
Integer)

GetNextProperty After the name of the first Dim oService as SiebelService

Method property has been Dim sName as String
retrieved, retrieves the sName = oService.GetNextProperty(ErrCode
name of the next property as Integer)
of a business service.

GetProperty Method Retrieves the value stored Dim oService as SiebelService

in the specified property. Dim sValue as String
sValue = oService.GetProperty(propName
as String, ErrCode as Integer)
Name Method Returns the name of the Dim oService as SiebelService
business service. Dim sName as String
sName = oService.Name
InvokeMethod Calls a specialized method Dim oService as SiebelService
Method or a user-created method oService.InvokeMethod(methodName as
on the business service. String, InputArguments as
SiebelPropertySet, OutputArguments as
SiebelPropertySet, ErrCode as Integer)
PropertyExists Returns a Boolean value Dim oService as SiebelService
Method indicating whether the Dim propExists as Boolean
property specified in the propExists = oService.PropertyExists(
argument exists. propName as String)

RemoveProperty Removes a property from a Dim oService as SiebelService

Method business service. oService.RemoveProperty(propName as
String, ErrCode as Integer)
SetProperty Method Assigns a value to a Dim oService as SiebelService
property of a business oService.SetProperty(propName as String,
service. propValue as String, ErrCode as Integer)

Siebel Object Interfaces Reference Version 8.1 34 7

 For Oracle internal distribution only
COM Data Server Quick Reference Property Set Methods for COM Data Server

Property Set Methods for COM Data

Server
Table 43 lists a summary of the property set methods syntax.

Table 43. Property Set Methods Syntax Summary

Method Description Syntax

AddChild Method Adds subsidiary property Dim oPropSet as SiebelPropertySet

sets to a property set. Dim iIndex as Integer
iIndex = oPropSet.AddChild( childObject
as Property Set, errCode as Integer)
Copy Method Returns a copy of a property Dim oPropSet1 as SiebelPropertySet
set. Dim oPropSet2 as SiebelPropertySet
oPropSet2 = oPropSet1.Copy(ErrCode as
Integer)
GetChild Method Returns a specified child Dim oPropSet as SiebelPropertySet
property set of a property Dim oChildPropSet as SiebelPropertySet
set. oChildPropSet = oPropSet.GetChild(
index as Integer, ErrCode as Integer)
GetChildCount Returns the number of child Dim oPropSet as SiebelPropertySet
Method property sets attached to a Dim iCount as Integer
parent property set. iCount = oPropSet.GetChildCount(ErrCode
as Integer)
GetFirstProperty Returns the name of the first Dim oPropSet as SiebelPropertySet
Method property in a property set. Dim sPropName as String
sPropName =
oPropSet.GetFirstProperty(ErrCode as
Integer)
GetNextProperty Returns the name of the next Dim oPropSet as SiebelPropertySet
Method property in a property set. Dim sPropName as String
sPropName =
oPropSet.GetNextProperty(ErrCode as
Integer)
GetProperty Method Returns the value of a Dim oPropSet as SiebelPropertySet
property when given the Dim sPropVal as String
property name. sPropVal =
oPropSet.GetProperty(propName as
String, ErrCode as Integer)
GetPropertyCount Returns the number of Dim oPropSet as SiebelPropertySet
Method properties contained within Dim propCount as Integer
the property set. propCount = oPropSet.GetPropertyCount
(ErrCode as Integer)

348 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
COM Data Server Quick Reference Property Set Methods for COM Data Server

Table 43. Property Set Methods Syntax Summary

Method Description Syntax

GetType Method Returns the value stored in a Dim oPropSet as SiebelPropertySet

type in a property set. Dim sTypeVal as String
sTypeVal = oPropSet.GetType(value as
String)

GetValue Method Returns a value stored as Dim oPropSet as SiebelPropertySet

part of a property set. Dim sValVal as String
sValVal = oPropSet.GetValue(ErrCode as
Integer)

InsertChildAt Inserts a child property set Dim oPropSet as SiebelPropertySet

Method into a parent property set at oPropSet.InsertChildAt(childObject as
a specific location. String, index as Integer, ErrCode as
Integer)

PropertyExists Returns a Boolean value Dim oPropSet as Property Set

Method indicating whether the Dim propExists as Boolean
property specified in the propExists = oPropSet.PropertyExists(
argument exists. propName as String, ErrCode as Integer)

RemoveChild Removes a child property set Dim oPropSet as SiebelPropertySet

Method as a specified index from a oPropSet.RemoveChild(index as Integer,
parent property set. errCode as Integer)

RemoveProperty Removes the property Dim oPropSet as SiebelPropertySet

Method specified in its argument oPropSet.RemoveProperty(propName as
from a property set. String, ErrCode as Integer)

Reset Method Removes every property and Dim oPropSet as SiebelPropertySet

child property set from a oPropSet.Reset(ErrCode as Integer)
property set.

SetProperty Method Assigns a value to the Dim oPropSet as SiebelPropertySet

property of a property set oPropSet.SetProperty(propName as
specified in its argument. String, propValue as String, ErrCode as
Integer)

SetType Method Assigns a data value to a Dim oPropSet as SiebelPropertySet

type member of a property oPropSet.SetType(value as String,
set. ErrCode as Integer)

SetValue Method Assigns a data value to a Dim oPropSet as SiebelPropertySet

value member of a property oPropSet.SetValue(value as String,
set. errCode as Integer)

Siebel Object Interfaces Reference Version 8.1 34 9

 For Oracle internal distribution only
COM Data Server Quick Reference Property Set Methods for COM Data Server

350 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

8 Mobile Web Client Automation

Server Quick Reference

This chapter provides a quick reference for Siebel Mobile Web Client Automation Server methods. It
has the following topics:

Application Methods for Mobile Web Client Automation Server

Business Component Methods for Mobile Web Client Automation Server on page 354

Business Object Methods for Mobile Web Client Automation Server on page 358

Business Service Methods for Mobile Web Client Automation Server on page 359

Property Set Methods for Mobile Web Client Automation Server on page 360

Application Methods for Mobile Web

Client Automation Server
Table 44 lists a summary of the application methods syntax.

Table 44 does not include methods that are not invoked directly from an Application object instance.
For information on methods that are called with InvokeMethod on the Application object, see
InvokeMethod Methods for the Application Object on page 139.

Table 44. Application Methods Syntax Summary

Method Description Syntax

ActiveBusObject Returns the business Dim application as SiebelWebApplication

Method object for the business Dim busObject as SiebelBusObject
component of the active Set busObject =
applet. application.ActiveBusObject

ActiveViewName Returns the name of the Dim application as SiebelWebApplication

Method active view. Dim sView as String
sView = application.ActiveViewName
CurrencyCode Returns the three-letter Dim application as SiebelWebApplication
Method operating currency code. Dim sCur as String
sCur = Application.CurrencyCode

EnableExceptions Enables or disables native Dim application as SiebelWebApplication

Method COM error handling. application.EnableExceptions(bEnable as
Boolean)
Call
application.EnableExceptions(bEnable as
Integer)

Siebel Object Interfaces Reference Version 8.1 35 1

 For Oracle internal distribution only
Mobile Web Client Automation Server Quick Reference Application Methods for Mobile
Web Client Automation Server

Table 44. Application Methods Syntax Summary

Method Description Syntax

GetBusObject Instantiates and returns a Dim application as SiebelWebApplication

Method new instance of the Dim busObject as SiebelBusObject
business object specified set busObject =
in the argument. application.GetBusObject(busobjName as
String)
GetLastErrCode Gets the last error code. Dim application as SiebelWebApplication
Method Dim iErr as Integer
iErr = application.GetLastErrCode

GetLastErrText Returns the last error text Dim application as SiebelWebApplication

Method message. Dim sText as String
sText = application.GetLastErrText
GetProfileAttr Returns the value of an Dim application as SiebelWebApplication
Method attribute in a user profile. Dim profValue as String
profValue =
application.GetProfileAttr(profName as
String)
GetService Method Instantiates and returns a Dim application as SiebelWebApplication
new instance of the Dim oService as SiebelService
argument-specified set oService =
service. Application.GetService(serviceName as
String)
GetSharedGlobal Returns the shared user- Dim application as SiebelWebApplication
Method defined global variables. Dim name as String
name = application.GetSharedGlobal (sName
as String)
InvokeMethod Calls the named Dim application as SiebelWebApplication
Method specialized method. Dim sReturn as String
sReturn =
application.InvokeMethod(methodName as
String, methodArgs as String or
StringArray)

Login Method Allows external Dim application as SiebelWebApplication

applications to log in to Dim sErr as String
the Mobile Web Client sErr = application.Login(connectString as
Automation Server. String, userName as String, password as
String)
LoginId Method Returns the login ID of the Dim application as SiebelWebApplication
user who started the Dim sID as string
Siebel application. sID = application.LoginId

LoginName Method Returns the login name of Dim application as SiebelWebApplication

the user who started the Dim sUser as String
Siebel application. sUser = application.LoginName

352 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Mobile Web Client Automation Server Quick Reference Application Methods for Mobile
Web Client Automation Server

Table 44. Application Methods Syntax Summary

Method Description Syntax

Logoff Method Terminates the Mobile Web Dim application as SiebelWebApplication

Client session. Dim status as Boolean
Status = application.Logoff
NewPropertySet Constructs a new property Dim application as SiebelWebApplication
Method set object. Dim propset As SiebelPropertySet
set propset = application.NewPropertySet
PositionId Method Returns the position ID Dim application as SiebelWebApplication
that describes the users Dim sRow as String
current position. sRow = application.PositionId

PositionName Returns the position name Dim application as SiebelWebApplication

Method of the users current Dim sPosition as String
position. sPosition = application.PositionName

SetPositionId Method Sets the active position to Dim application as SiebelWebApplication

the Position ID specified in Dim posId as String
the argument. Dim status as Boolean
status =
application.SetPositionId(posId)
SetPositionName Sets the active position to Dim application as SiebelWebApplication
Method the position name Dim posName as String
specified in the argument. Dim status as Boolean
status =
application.SetPositionName(posName)
SetProfileAttr Method Used in personalization to Dim oApplication as SiebelWebApplication
assign values to attributes Dim bool as Boolean
in a user profile. bool = oApplication.SetProfileAttr(name
as String, value as String)
SetSharedGlobal Sets a shared user-defined Dim application as SiebelWebApplication
Method global variable. Dim bool as Boolean
bool =
application.SetSharedGlobal(varName as
String, value as String)
Trace Method Appends a message to the Dim application as SiebelWebApplication
trace file. application.Trace(message as String)

TraceOff Method Turns off the tracing Dim application as SiebelWebApplication

started by TraceOn. Dim bool as Boolean
bool = application.TraceOff

TraceOn Method Turns tracing on. Dim application as SiebelWebApplication

Dim bool as Boolean
bool = application.TraceOn(filename as
String, type as String, Selection as
String)

Siebel Object Interfaces Reference Version 8.1 35 3

 For Oracle internal distribution only
Mobile Web Client Automation Server Quick Reference Business Component Methods
for Mobile Web Client Automation Server

Business Component Methods for Mobile

Web Client Automation Server
Table 45 lists a summary of the business component methods syntax.

Table 45 does not include methods that are not invoked directly from a Business Component object
instance. For information on methods that are called with InvokeMethod on the Business Component
object, see InvokeMethod Methods for the Business Component Object on page 213.

Table 45. Business Component Methods Syntax Summary

Method Description Syntax

ActivateField Method Allows queries to retrieve Dim busComp as SiebelBusComp

data for the specified field. Dim bool as Boolean
bool =
BusComp.ActivateField(fieldName as
String)
ActivateMultipleFields Allows queries to retrieve Dim buscomp as SiebelBusComp
Method data for the fields specified buscomp.ActivateMultipleFields(oP
in the property set. ropSet as SiebelPropertySet)

Associate Method Creates a new many-to- Dim busComp as SiebelBusComp

many relationship for the Dim bool as Boolean
parent object through an bool =
association business busComp.Associate(whereIndicator
component. as Integer)

BusObject Method Returns the business object Dim busComp as SiebelBusComp

that contains the business Dim busObject as SiebelBusObject
component. Set BusObject = busComp.BusObject

ClearToQuery Method Clears the current query and Dim busComp as SiebelBusComp
sort specifications on the Dim bool as Boolean
business component. bool = busComp.ClearToQuery

DeactivateFields Method Deactivates every currently Dim busComp as SiebelBusComp

activated field. Dim bool as Boolean
bool = busComp.DeactivateFields

DeleteRecord Method Removes the current record Dim busComp as SiebelBusComp

from the business Dim bool as Boolean
component. bool = busComp.DeleteRecord

ExecuteQuery Method Retrieves a set of BusComp Dim busComp as SiebelBusComp

records. Dim bool as Boolean
bool =
busComp.ExecuteQuery(cursorMode as
Integer)

354 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Mobile Web Client Automation Server Quick Reference Business Component Methods
for Mobile Web Client Automation Server

Table 45. Business Component Methods Syntax Summary

Method Description Syntax

ExecuteQuery2 Method Retrieves a set of BusComp Dim busComp as SiebelBusComp

records. Dim bool as Boolean
bool =
busComp.ExecuteQuery2(cursorMode
as Integer, ignoreMaxCursorSize as
Boolean)

FirstRecord Method Moves to the first record in Dim busComp as SiebelBusComp

the business component. Dim bIsRecord as Boolean
bIsRecord = busComp.FirstRecord
GetAssocBusComp Returns the association Dim busComp as SiebelBusComp
Method business component. Dim AssocBusComp as SiebelBusComp
Set AssocBusComp =
busComp.GetAssocBusComp
GetFieldValue Method Returns a value for the field Dim busComp as SiebelBusComp
specified in the argument. Dim sValue as String
sValue =
busComp.GetFieldValue(FieldName as
String)
GetFormattedFieldValue Returns a formatted value Dim busComp as SiebelBusComp
Method for the field specified in the Dim sValue as String
argument. sValue =
busComp.GetFormattedFieldValue(Fi
eldName as String)
GetLastErrCode Method Returns the last Siebel error Dim buscomp as SiebelBusComp
number. Dim iErr as Integer
iErr = buscomp.GetLastErrCode
GetLastErrText Method Returns the last error text Dim busComp as SiebelBusComp
message. Dim sErr as String
sErr = busComp.GetLastErrText
GetMultipleFieldValues Returns a value for the fields Dim buscomp as SiebelBusComp
Method specified in the property set. buscomp.GetMultipleFieldValues(oP
ropSet as SiebelPropertySet,
PValues as SiebelPropertySet)
GetMVGBusComp Method Returns the MVG business Dim busComp as SiebelBusComp
component associated with Dim mVGBusComp as SiebelBusComp
the field specified in the set mVGBusComp =
argument. busComp.GetMVGBusComp(FieldName as
String)

GetNamedSearch Method Returns the argument- Dim busComp as SiebelBusComp

named search specification. Dim sValue as String
sValue =
busComp.GetNamedSearch(SearchName
as String)

Siebel Object Interfaces Reference Version 8.1 35 5

 For Oracle internal distribution only
Mobile Web Client Automation Server Quick Reference Business Component Methods
for Mobile Web Client Automation Server

Table 45. Business Component Methods Syntax Summary

Method Description Syntax

GetPicklistBusComp Returns the pick business Dim busComp as SiebelBusComp

Method component associated with Dim pickBusComp as SiebelBusComp
the field specified in the Set pickBusComp =
argument. busComp.GetPicklistBusComp(FieldN
ame as String)
GetSearchExpr Method Returns the current search Dim busComp as SiebelBusComp
expression. Dim sExpr as String
sExpr = busComp.GetSearchExpr

GetSearchSpec Method Returns the current search Dim busComp as SiebelBusComp

specification for the field Dim sSpec as String
specified in the argument. sSpec =
busComp.GetSearchSpec(FieldName as
String)
GetUserProperty Method Returns the value for the Dim busComp as SiebelBusComp
property name specified in Dim sValue as String
the argument. sValue =
busComp.GetUserProperty(propertyN
ame as String)
GetViewMode Method Returns the visibility mode Dim busComp as SiebelBusComp
for the business component. Dim iMode as Integer
iMode = busComp.GetViewMode
InvokeMethod Method Calls the specialized method Dim busComp as SiebelBusComp
named in the argument. Dim sReturn as String
sReturn = busComp.InvokeMethod(
methodName as String, methodArgs
as String or StringArray)
LastRecord Method Moves to the last record in Dim busComp as SiebelBusComp
the business component. Dim bReturn as Boolean
bReturn = busComp.LastRecord
Name Method Returns the name of the Dim busComp as SiebelBusComp
business component. Dim sName as String
sName = busComp.Name
NewRecord Method Adds a new record to the Dim busComp as SiebelBusComp
business component. Dim bool as Boolean
bool =
busComp.NewRecord(whereIndicator
as Integer)
NextRecord Method Moves to the next record in Dim busComp as SiebelBusComp
the business component. Dim bReturn as Boolean
bReturn = busComp.NextRecord
ParentBusComp Method Returns the parent business Dim busComp as SiebelBusComp
component. Dim parentBusComp as SiebelBusComp
Set parentBusComp =
busComp.ParentBusComp

356 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Mobile Web Client Automation Server Quick Reference Business Component Methods
for Mobile Web Client Automation Server

Table 45. Business Component Methods Syntax Summary

Method Description Syntax

Pick Method Places the currently selected Dim busComp as SiebelBusComp

record in a picklist business busComp.Pick
component into the
appropriate fields of the
parent business component.

PreviousRecord Method Moves to the previous record Dim busComp as SiebelBusComp

in the business component. Dim bReturn as Boolean
bReturn = busComp.PreviousRecord
RefineQuery Method Refines a query after a query Dim busComp as SiebelBusComp
has been executed. busComp.RefineQuery

SetFieldValue Method Assigns a new value to the Dim busComp as SiebelBusComp

named field for the current busComp.SetFieldValue(FieldName as
row of the business String, FieldValue as String)
component.

SetFormattedFieldValue Accepts the field value in the Dim busComp as SiebelBusComp

Method current local format and busComp.SetFormattedFieldValue(Fi
assigns the new value to the eldName as String, FieldValue as
named field for the current String)
row of the business
component.

SetMultipleFieldValues Assigns a new value to the Dim buscomp as SiebelBusComp

Method fields specified in the buscomp.SetMultipleFieldValues(oP
property set for the current ropSet as SiebelPropertySet)
row of the business
component.

SetNamedSearch Method Sets a named search Dim busComp as SiebelBusComp

specification on the business busComp.SetNamedSearch(searchName
component. as String, searchSpec as String)

SetSearchExpr Method Sets the search expression Dim busComp as SiebelBusComp

for the business component. busComp.SetSearchExpr(searchSpec
as String)
SetSearchSpec Method Sets the search specification Dim busComp as SiebelBusComp
for the specified field. busComp.SetSearchSpec(FieldName as
String, searchSpec as String)
SetSortSpec Method Sets the sort specification for Dim busComp as SiebelBusComp
a query. busComp.SetSortSpec(sortSpec as
String)

SetUserProperty Method Sets the value of the Dim busComp as SiebelBusComp

specified User Property. busComp.SetUserProperty(propertyN
ame as String, newValue as String)

Siebel Object Interfaces Reference Version 8.1 35 7

 For Oracle internal distribution only
Mobile Web Client Automation Server Quick Reference Business Object Methods for
Mobile Web Client Automation Server

Table 45. Business Component Methods Syntax Summary

Method Description Syntax

SetViewMode Method Sets the visibility type for the Dim buscomp as SiebelBusComp
business component. buscomp.SetViewMode(mode As
Integer)
UndoRecord Method Reverses any uncommitted Dim busComp as SiebelBusComp
changes made to the record. busComp.UndoRecord

WriteRecord Method Commits to the database any Dim busComp as SiebelBusComp

changes made to the current busComp.WriteRecord
record.

Business Object Methods for Mobile Web

Client Automation Server
Table 46 lists a summary of the business object methods syntax.

Table 46. Business Object Methods Syntax Summary

Method Description Syntax

GetBusComp Returns the specified business Dim busObject as SiebelBusObject

Method component. Dim busComp as SiebelBusComp
set busComp =
busObject.GetBusComp(BusCompName as
String)
GetLastErrCode Returns the last Siebel error Dim busobject as SiebelBusObject
Method number. Dim iErr as Integer
iErr = busobject.GetLastErrCode
GetLastErrText Returns the last error text Dim busobject as SiebelBusObject
Method message. Dim sValue as String
sValue= busobject.GetLastErrText
Name Method Returns the name of the Dim busObject as SiebelBusObject
business object. Dim sName as String
sName = busObject.Name

358 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Mobile Web Client Automation Server Quick Reference Business Service Methods for
Mobile Web Client Automation Server

Business Service Methods for Mobile

Web Client Automation Server
Table 47 lists a summary of the business service methods syntax.

Table 47. Business Service Methods Syntax Summary

Method Description Syntax

GetFirstProperty Retrieves the name of the first Dim oService as SiebelService

Method property of a business service. Dim sName as String
sName = oService.GetFirstProperty

GetNextProperty After the name of the first Dim oService as SiebelService

Method property has been retrieved, Dim sName as String
retrieves the name of the next sName = oService.GetNextProperty
property of a business service.

GetProperty Retrieves the value stored in Dim oService as SiebelService

Method the specified property. Dim sValue as String
sValue = oService.GetProperty(propName
as String)

InvokeMethod Calls a specialized method or a Dim oService as SiebelService

Method user-created method on the oService.InvokeMethod(methodName as
business service. String, InputArguments as
SiebelPropertySet, OutputArguments as
SiebelPropertySet)
Name Method Returns the name of the Dim oService as SiebelService
business service. Dim sName as String
sName = oService.Name

PropertyExists Returns a Boolean value Dim oService as SiebelService

Method indicating whether the Dim bool as Boolean
property specified in the bool = oService.PropertyExists(propName
argument exists. as String)

RemoveProperty Removes a property from a Dim oService as SiebelService

Method business service. Dim bool as Boolean
bool = oService.RemoveProperty(propName
as String)
SetProperty Assigns a value to a property Dim oService as SiebelService
Method of a business service. oService.SetProperty(propName as
String, propValue as String)

Siebel Object Interfaces Reference Version 8.1 35 9

 For Oracle internal distribution only
Mobile Web Client Automation Server Quick Reference Property Set Methods for
Mobile Web Client Automation Server

Property Set Methods for Mobile Web

Client Automation Server
Table 48 lists a summary of the property set methods syntax.

Table 48. Property Set Methods Syntax Summary

Method Description Syntax

AddChild Method Adds subsidiary property Dim oPropSet as SiebelPropertyset

sets to a property set. oPropSet.AddChild(childObject as
SiebelPropertySet)

Copy Method Returns a copy of a Dim oPropSet1 as SiebelPropertyset

property set. Dim oPropSet2 as SiebelPropertyset
set oPropSet2 = oPropSet1.Copy
GetChild Method Returns a specified child Dim oPropSet as SiebelPropertySet
property set of a property Dim childPropSet as SiebelPropertySet
set. set childPropSet =
oPropSet.GetChild(index as Long)
GetChildCount Returns the number of Dim oPropSet as SiebelPropertySet
Method child property sets Dim iCount as Long
attached to a parent iCount = oPropSet.GetChildCount
property set.

GetFirstProperty Returns the name of the Dim oPropSet as SiebelPropertySet

Method first property in a property Dim sPropName as String
set. sPropName = oPropSet.GetFirstProperty

GetNextProperty Returns the last Siebel Dim oPropSet as SiebelPropertySet

Method error number. Dim iErr as Integer
iErr = oPropSet.GetLastErrCode
GetLastErrText Returns the last error text Dim oPropSet as SiebelPropertySet
Method message. Dim sValue as String
sValue = oPropSet.GetLastErrText
GetNextProperty Returns the name of the Dim oPropSet as SiebelPropertySet
Method next property in a property Dim sPropName as String
set. sPropName = oPropSet.GetNextProperty

GetProperty Method Returns the value of a Dim oPropSet as SiebelPropertySet

property when given the Dim sPropVal as String
property name. sPropVal = oPropSet.GetProperty(propName
as String)

GetPropertyCount Returns the number of Dim oPropSet as SiebelPropertySet

Method properties contained Dim lCount as Long
within the property set. lCount = oPropSet.GetPropertyCount

360 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Mobile Web Client Automation Server Quick Reference Property Set Methods for
Mobile Web Client Automation Server

Table 48. Property Set Methods Syntax Summary

Method Description Syntax

GetType Method Retrieves the data value Dim oPropSet as SiebelPropertySet

stored in the type attribute Dim sTypeVal as String
of a property set. sTypeVal = oPropSet.GetType

GetValue Method Retrieves the data value Dim oPropSet as SiebelPropertySet

stored in the value Dim sValVal as String
attribute of a property set. sValVal = oPropSet.GetValue

InsertChildAt Inserts a child property set Dim oPropSet as SiebelPropertySet

Method into a parent property set oPropSet.InsertChildAt(childObject as
at a specific location. SiebelPropertySet, index as Long)

PropertyExists Returns a Boolean value Dim oPropSet as SiebelPropertySet

Method indicating whether the Dim bool as Boolean
property specified in the bool = oPropSet.PropertyExists(propName
argument exists. as String)

RemoveChild Removes a child property Dim oPropSet as SiebelPropertySet

Method set as a specified index oPropSet.RemoveChild(index as Long)
from a parent property set.

RemoveProperty Removes the property Dim oPropSet as SiebelPropertySet

Method specified in its argument oPropSet.RemoveProperty(propName as
from a property set. String)

Reset Method Removes every property Dim oPropSet as SiebelPropertySet

and child property set from oPropSet.Reset
a property set.

SetProperty Method Assigns a value to the Dim oPropSet as SiebelPropertySet

property of a property set oPropSet.SetProperty(propName as String,
specified in its argument. propValue as String)

SetType Method Assigns a data value to a Dim oPropSet as SiebelPropertySet

type member of a property oPropSet.SetType(value as String)
set.

SetValue Method Assigns a data value to a Dim oPropSet as SiebelPropertySet

value member of a oPropSet.SetValue(value as String)
property set.

Siebel Object Interfaces Reference Version 8.1 36 1

 For Oracle internal distribution only
Mobile Web Client Automation Server Quick Reference Property Set Methods for
Mobile Web Client Automation Server

362 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

9 Java Data Bean Quick Reference

This chapter provides a quick reference for Siebel Java Data Bean methods. It has the following
topics:

Data Bean Methods for Java Data Bean

Business Component Methods for Java Data Bean on page 365

Business Object Methods for Java Data Bean on page 369

Business Service Methods for Java Data Bean on page 369

Property Set Methods for Java Data Bean on page 370

SiebelException Methods for Java Data Bean on page 372

Data Bean Methods for Java Data Bean

Table 49 lists a summary of the SiebelDataBean methods syntax.

Table 49. SiebelDataBean Methods Syntax Summary

Method Description Syntax

Attach Method Allows an external application boolean attach(String sessionID) throws

to reconnect to an existing SiebelException
Siebel session.

CurrencyCode Returns the three-letter String currencyCode()

Method operating currency code.

Detach Method Returns a string containing the String detach() throws SiebelException
Siebel session ID.

GetBusObject Instantiates and returns a new SiebelBusObject getBusObject(String

Method instance of the business object boName) throws SiebelException
specified in the argument.

GetProfileAttr Returns the value of an String getProfileAttr(String attrName)

Method attribute in a user profile. throws SiebelException

GetService Method Returns a specified service. If SiebelService getService(string

the service is not already serviceName) throws SiebelException
running, it is constructed.

InvokeMethod Calls the named specialized String invokeMethod(String name,

Method method. String[] args) throws SiebelException

Siebel Object Interfaces Reference Version 8.1 36 3

 For Oracle internal distribution only
Java Data Bean Quick Reference Data Bean Methods for Java Data Bean

Table 49. SiebelDataBean Methods Syntax Summary

Method Description Syntax

Login Method Allows external applications to boolean login(String connString, String

log in to the Data Bean. userName, String passWord) throws
SiebelException
LoginId Method Returns the login ID of the String loginId()
user who started the Siebel
application.

LoginName Method Returns the login name of the String loginName()

user who started the Siebel
application.

Logoff Method Disconnects the client from boolean logoff() throws SiebelException
the server.

NewPropertySet Constructs and returns a new SiebelPropertySet newPropertySet()

Method property set object.

PositionId Method Returns the position ID that String positionId()

describes the users current
position.

PositionName Returns the position name of String positionName()

Method the users current position.

SetPositionId Sets the active position to the boolean setPositionId(String posId)

Method Position ID specified in the throws SiebelException
argument.

SetPositionName Sets the active position to the boolean setPositionName(String posName)

Method position name specified in the throws SiebelException
argument. Returns a Boolean
value indicating if the method
succeeded.

SetProfileAttr SetProfileAttr is used in boolean setProfileAttr(String

Method personalization to assign attrName,String attrValue) throws
values to attributes in a user SiebelException
profile.

Trace Method The Trace method appends a boolean trace(String message) throws
message to the trace file. SiebelException
Trace is useful for debugging
SQL query execution. This
method does not trace Java
standard output.

364 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Java Data Bean Quick Reference Business Component Methods for Java Data Bean

Table 49. SiebelDataBean Methods Syntax Summary

Method Description Syntax

TraceOff Method TraceOff turns off the tracing boolean traceOff() throws
started by the TraceOn SiebelException
method. This method does not
trace Java standard output.

TraceOn Method TraceOn turns on the tracking boolean traceOn(String filename, String
of allocations and Category, String selection)throws
deallocations of Siebel objects, SiebelException
and SQL statements generated
by the Siebel application. This
method does not trace Java
standard output.

Business Component Methods for Java

Data Bean
Table 50 lists a summary of the SiebelBusComp methods syntax.

Table 50 does not include methods that are not invoked directly from a Business Component object
instance. For information on methods that are called with InvokeMethod on the Business Component
object, see InvokeMethod Methods for the Business Component Object on page 213.

Table 50. SiebelBusComp Methods Syntax Summary

Method Description Syntax

ActivateField Method Allows queries to retrieve boolean activateField(String

data for the specified field. fieldName) throws SiebelException

ActivateMultipleFields Allows queries to retrieve boolean

Method data for the fields specified in activateMultipleFields(SiebelProp
the property set. ertySet psFields) throws
SiebelException
Associate Method Creates a new many-to-many boolean associate(boolean
relationship for the parent isInsertBefore) throws
object through an association SiebelException
business component.

BusObject Method Returns the business object SiebelBusObject busObject()

that contains the business throws SiebelException
component.

ClearToQuery Method Clears the current query and boolean clearToQuery() throws
sort specifications on the SiebelException
business component.

Siebel Object Interfaces Reference Version 8.1 36 5

 For Oracle internal distribution only
Java Data Bean Quick Reference Business Component Methods for Java Data Bean

Table 50. SiebelBusComp Methods Syntax Summary

Method Description Syntax

DeactivateFields Method Deactivates every currently boolean deactivateFields()

activated field.

DeleteRecord Method Removes the current record boolean deleteRecord() throws

from the business SiebelException
component.

ExecuteQuery Method Retrieves a set of BusComp boolean executeQuery(boolean

records. cursorMode) throws
SiebelException

NOTE: When using the ExecuteQuery

method with Java Data Bean, use True
for ForwardOnly and False for
ForwardBackward.

ExecuteQuery2 Method Retrieves a set of BusComp boolean executeQuery2(boolean

records. cursorMode, boolean
ignoreMaxCursorSize) throws
SiebelException
FirstRecord Method Moves to the first record in boolean firstRecord() throws
the business component. SiebelException

GetFieldValue Method Returns a value for the field String getFieldValue(String

specified in the argument. fieldName) throws SiebelException

GetFormattedFieldValue Returns a formatted value for String

Method the field specified in the getFormattedFieldValue(String
argument. fieldName) throws SiebelException

GetMultipleFieldValues Returns values for the fields boolean

Method specified in the property set. getMultipleFieldValues(SiebelProp
ertySet Src, SiebelPropertySet
result) throws SiebelException
GetMVGBusComp Method Returns the MVG business SiebelBusComp
component associated with getMVGBusComp(String fieldName)
the field specified in the throws SiebelException
argument.

GetNamedSearch Method Returns the argument-named String getNamedSearch(String

search specification. searchName) throws
SiebelException
GetPicklistBusComp Returns the pick business SiebelBusComp
Method component associated with getPicklistBusComp(String
the field specified in the fieldName) throws SiebelException
argument.

GetSearchExpr Method Returns the current search String getSearchExpr() throws

expression. SiebelException

366 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Java Data Bean Quick Reference Business Component Methods for Java Data Bean

Table 50. SiebelBusComp Methods Syntax Summary

Method Description Syntax

GetSearchSpec Method Returns the current search String getSearchSpec(String

specification for the field fieldName) throws SiebelException
specified in the argument.

GetUserProperty Method Returns the value for the String getUserProperty(String

specified property. property) throws SiebelException

GetViewMode Method Returns the visibility mode for int getViewMode()

the business component.

InvokeMethod Method Calls the specialized method String invokeMethod(String

named in the argument. The methodName, String[] methodArgs)
methodArgs parameter must throws SiebelException
be an array of strings.

LastRecord Method Moves to the last record in the boolean lastRecord() throws
business component. SiebelException

Name Method Returns the name of the String name()

business component.

NewRecord Method Adds a new record to the boolean newRecord(boolean

business component. isInsertBefore) throws
SiebelException
NextRecord Method Moves to the next record in boolean nextRecord() throws
the business component. SiebelException

ParentBusComp Method Returns the parent business SiebelBusComp parentBusComp()

component. throws SiebelException

Pick Method Places the currently selected boolean pick() throws

record in a picklist business SiebelException
component into the
appropriate fields of the
parent business component.

PreviousRecord Method Moves to the previous record boolean previousRecord() throws

in the business component. SiebelException

RefineQuery Method Refines a query after a query boolean refineQuery() throws

has been executed. SiebelException

Release Method Enables the release of the void release()

business component and its
resources on the Siebel
Server.

SetFieldValue Method Assigns a new value to the boolean setFieldValue(String

named field for the current fieldName, String fieldValue)
row of the business throws SiebelException
component.

Siebel Object Interfaces Reference Version 8.1 36 7

 For Oracle internal distribution only
Java Data Bean Quick Reference Business Component Methods for Java Data Bean

Table 50. SiebelBusComp Methods Syntax Summary

Method Description Syntax

SetFormattedFieldValue Accepts the field value in the boolean

Method current local format and setFormattedFieldValue(String
assigns the new value to the fieldName, String fieldValue)
named field for the current throws SiebelException
row of the business
component.

SetMultipleFieldValues Assigns new values to the boolean

Method multiple fields specified in the setMultipleFieldValues(SiebelProp
property set for the current ertySet psFields) throws
row of the business SiebelException
component.

SetNamedSearch Method Sets a named search boolean setNamedSearch(String

specification on the business searchName, String searchText)
component. throws SiebelException

SetSearchExpr Method Sets an entire search boolean setSearchExpr(String

expression on the business searchExpr) throws
component. SiebelException

SetSearchSpec Method Sets the search specification boolean setSearchSpec(String

for the specified field. fieldName, String searchSpec)
throws SiebelException
SetSortSpec Method Sets the sort specification for boolean setSortSpec(String
a query. sortSpec) throws SiebelException

SetUserProperty Method Sets the value of the specified boolean setUserProperty(String

User Property. propName, String propVal)

SetViewMode Method Sets the visibility type for the boolean setViewMode(int mode)
business component. throws SiebelException

UndoRecord Method Reverses any uncommitted boolean undoRecord() throws

changes made to the record. SiebelException

WriteRecord Method Commits to the database any boolean writeRecord() throws

changes made to the current SiebelException
record.

368 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Java Data Bean Quick Reference Business Object Methods for Java Data Bean

Business Object Methods for Java Data

Bean
Table 51 lists a summary of the SiebelBusObject methods syntax.

Table 51. SiebelBusObject Methods Syntax Summary

Method Description Syntax

GetBusComp Method Returns the specified business SiebelBusComp getBusComp(String

component. busCompName) throws SiebelException

Name Method Returns the name of the String name()

business object.

Release Method Enables the release of the void release()

business object and its
resources on the Siebel
Server.

Business Service Methods for Java Data

Bean
Table 52 lists a summary of the SiebelService methods syntax.

Table 52. SiebelService Methods Syntax Summary

Method Description Syntax

GetFirstProperty Retrieves the name of the first String getFirstProperty()

Method property of a business service.

GetNextProperty After the name of the first String getNextProperty()

Method property has been retrieved,
retrieves the name of the next
property of a business service.

GetProperty Retrieves the value stored in the String getProperty(String propName)

Method specified property. throws SiebelException

InvokeMethod Calls a specialized method or a boolean invokeMethod(String

Method user-created method on the methodName, SiebelPropertySet
business service. inputPropertySet, SiebelPropertySet
outputPropertySet) throws
SiebelException
Name Method Returns the name of the business String Name()
service.

Siebel Object Interfaces Reference Version 8.1 36 9

 For Oracle internal distribution only
Java Data Bean Quick Reference Property Set Methods for Java Data Bean

Table 52. SiebelService Methods Syntax Summary

Method Description Syntax

PropertyExists Returns a Boolean value boolean propertyExists(String

Method indicating whether the property propName) throws SiebelException
specified in the argument exists.

Release Method Enables the release of the void release()

Business Service and its
resources on the Siebel Server.

RemoveProperty Removes a property from a void removeProperty(String propName)

Method business service. throws SiebelException

SetProperty Method Assigns a value to a property of a void setProperty(String propName,

business service. String propValue) throws
SiebelException

Property Set Methods for Java Data Bean

Table 53 lists a summary of the SiebelPropertySet methods syntax.

Table 53. SiebelPropertySet Methods Syntax Summary

Method Description Syntax

AddChild Method Adds subsidiary property sets to int addChild(SiebelPropertySet

a property set. propertySet)

Copy Method Returns a copy of a property set. SiebelPropertySet

copy(SiebelPropertySet propertySet)
GetByteValue Returns a byte array if a byte public byte[] getByteValue()
Method value has been set.

GetChild Method Returns a specified child SiebelPropertySet getChild(int

property set of a property set. index)

GetChildCount Returns the number of child int getChildCount()

Method property sets attached to a
parent property set.

GetFirstProperty Returns the name of the first String getFirstProperty()

Method property in a property set.

GetNextProperty Returns the name of the next String getNextProperty()

Method property in a property set.

GetProperty Returns the value of a property String getProperty(String

Method when given the property name. propertyName)

GetPropertyCount Returns the number of int GetPropertyCount()

Method properties attached to a property
set.

370 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Java Data Bean Quick Reference Property Set Methods for Java Data Bean

Table 53. SiebelPropertySet Methods Syntax Summary

Method Description Syntax

GetType Method Returns the value stored in the String getType()

Type attribute of a PropertySet.

GetValue Method Returns the value stored in the String getValue()

Value attribute of a PropertySet.

InsertChildAt Inserts a child property set into a boolean

Method parent property set at a specific insertChildAt(SiebelPropertySet
location. propertySet, int index)

PropertyExists Returns a Boolean value boolean propertyExists(String

Method indicating whether the property propertyName)
specified in the argument exists.

RemoveChild Removes a child property set as boolean removeChild(int index)

Method a specified index from a parent
property set.

RemoveProperty Removes the property specified boolean removeProperty(String

Method in its argument from a property propertyName)
set.

Reset Method Removes every property and boolean reset()

child property set from a
property set.

SetByteValue Sets the value portion of a public void setByteValue(byte[]

Method property set. value)

SetProperty Method Assigns a value to the property boolean setProperty(String

of a property set specified in its propertyName, String propertyValue)
argument.

SetType Method Assigns a data value to a type boolean setType(String type)

member of a property set.

SetValue Method Assigns a data value to a value boolean setValue(String value)

member of a property set.

Siebel Object Interfaces Reference Version 8.1 37 1

 For Oracle internal distribution only
Java Data Bean Quick Reference SiebelException Methods for Java Data Bean

SiebelException Methods for Java Data

Bean
Table 54 lists a summary of the SiebelException methods syntax.

Table 54. SiebelException Methods Syntax Summary

Method Description Syntax

GetErrorCode Method Gets a numeric error code. int getErrorCode()

GetErrorMessage Method Gets an error message. String getErrorMessage()

For more information on the Java Data Bean Interface, read the Javadoc files, which are contained
in a file named Siebel_JavaDoc.jar. This file is normally located in: \siebsrvr\CLASSES.

372 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

10 Siebel Web Client Automation

Server Quick Reference

This chapter provides a quick reference for Siebel Web Client Automation Server methods. It has the
following topics:

SiebelHTMLApplication Methods for Siebel Web Client Automation Server

SiebelService Methods for Siebel Web Client Automation Server on page 374

Property Set Methods for Siebel Web Client Automation Server on page 375

SiebelHTMLApplication Methods for

Siebel Web Client Automation Server
Table 55 lists a summary of the SiebelHTMLApplication methods syntax.

Table 55 does not include methods that are not invoked directly from an Application object instance.
For information on methods that are called with InvokeMethod on the Application object, see
InvokeMethod Methods for the Application Object on page 139.

Table 55. SiebelHTMLApplication Methods Syntax Summary

Method Description Syntax

GetLastErrCode Returns the last error code. Dim siebelApp As

Method SiebelHTMLApplication
Dim iErr as Long
iErr = siebelApp.GetLastErrCode
GetLastErrText Returns the last error text message. Dim siebelApp As
Method SiebelHTMLApplication
Dim sText as String
sText = siebelApp.GetLastErrText
GetService Method Instantiates and returns a new Dim siebelApp As
instance of the service specified in the SiebelHTMLApplication
argument. Dim svc As SiebelService
Set svc =
siebelApp.GetService(ServiceName
as String)

Siebel Object Interfaces Reference Version 8.1 37 3

 For Oracle internal distribution only
Siebel Web Client Automation Server Quick Reference SiebelService Methods for
Siebel Web Client Automation Server

Table 55. SiebelHTMLApplication Methods Syntax Summary

Method Description Syntax

Name Method Returns the name of the current Dim siebelApp As

application as defined in the SiebelHTMLApplication
repository. Dim name as String
name = siebelApp.Name
NewPropertySet Constructs and returns a new Dim siebelApp As
Method property set object. SiebelHTMLApplication
Dim propSet as SiebelPropertySet
Set propSet =
siebelApp.NewPropertySet

SiebelService Methods for Siebel Web

Client Automation Server
Table 56 lists a summary of the SiebelService methods syntax.

Table 56. SiebelService Methods Syntax Summary

Method Description Syntax

GetNextProperty Returns the last error code. Dim svc As SiebelService

Method Dim iErr as Long
iErr = svc.GetLastErrCode
InvokeMethod Calls a specialized method or a Dim svc As SiebelService
Method user-created method on the svc.InvokeMethod(MethodName as
business service. String, inputPropSet as
SiebelPropertySet, outputPropSet as
SiebelPropertySet)
Name Method Returns the name of the business Dim svc As SiebelService
service. Dim name as String
name = svc.Name

374 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel Web Client Automation Server Quick Reference Property Set Methods for
Siebel Web Client Automation Server

Property Set Methods for Siebel Web

Client Automation Server
Table 57 lists a summary of the SiebelPropertySet methods syntax.

Table 57. SiebelPropertySet Methods Syntax Summary

Method Description Syntax

AddChild Method Adds subsidiary property sets to a Dim oPropSet as SiebelPropertySet

property set. oPropSet.AddChild(childObject as
SiebelPropertySet)

Copy Method Returns a copy of a property set. Dim oPropSet1 as SiebelPropertySet

Dim oPropSet2 as SiebelPropertySet
Set oPropSet2 = oPropSet1.Copy
GetChild Method Returns a specified child property Dim oPropSet as SiebelPropertySet
set of a property set. Dim oChildPropSet as
SiebelPropertySet
Set oChildPropSet =
oPropSet.GetChild(index as Long)
GetChildCount Returns the number of child Dim oPropSet as SiebelPropertySet
Method property sets attached to a Dim iCount as Long
parent property set. iCount = oPropSet.GetChildCount

GetFirstProperty Returns the name of the first Dim oPropSet as SiebelPropertySet

Method property in a property set. Dim sPropName as String
sPropName =
oPropSet.GetFirstProperty
GetLastErrCode Returns the last error code. Dim oPropSet as SiebelPropertySet
Method Dim iErr as Long
iErr = oPropSet.GetLastErrCode
GetLastErrText Returns the last error text Dim oPropSet as SiebelPropertySet
Method message. Dim sText as String
sText = oPropSet.GetLastErrText
GetNextProperty Returns the name of the next Dim oPropSet as SiebelPropertySet
Method property in a property set. Dim sPropName as String
sPropName = oPropSet.GetNextProperty

GetProperty Returns the value of a property Dim oPropSet as SiebelPropertySet

Method when given the property name. Dim sValue as String
sValue =
oPropSet.GetProperty(propName as
String)
GetPropertyCount Returns the number of properties Dim oPropSet as SiebelPropertySet
Method attached to a property set. Dim iCount as Long
iCount = oPropSet.GetPropertyCount

Siebel Object Interfaces Reference Version 8.1 37 5

 For Oracle internal distribution only
Siebel Web Client Automation Server Quick Reference Property Set Methods for
Siebel Web Client Automation Server

Table 57. SiebelPropertySet Methods Syntax Summary

Method Description Syntax

GetType Method Returns the value stored in a type Dim oPropSet as SiebelPropertySet
in a property set. Dim type as String
type = oPropSet.GetType
GetValue Method Returns a value stored as part of Dim oPropSet as SiebelProperty
a property set. SetDim sValue as String
sValue = oPropSet.GetValue
InsertChildAt Inserts a child property set into a Dim oPropSet as SiebelPropertySet
Method parent property set at a specific oPropSet.InsertChildAt(childObject
location. as SiebelPropertySet, index as Long)

PropertyExists Returns a Boolean value Dim oPropSet as SiebelProperty

Method indicating whether the property Dim bool as Boolean
specified in the argument exists. bool =
oPropSet.PropertyExists(propName as
String)
RemoveChild Removes a child property set as a Dim oPropSet as SiebelPropertySet
Method specified index from a parent oPropSet.RemoveChild(index as Long)
property set.

RemoveProperty Removes the property specified in Dim oPropSet as SiebelPropertySet

Method its argument from a property set. oPropSet.RemoveProperty(propName as
String)
Reset Method Removes every property and child Dim oPropSet as SiebelPropertySet
property set from a property set. oPropSet.Reset

SetProperty Assigns a value to the property of Dim oPropSet as SiebelPropertySet

Method a property set specified in its oPropSet.SetProperty(propName as
argument. String, propValue as String)

SetType Method Assigns a data value to a type Dim oPropSet as SiebelPropertySet

member of a property set. oPropSet.SetType(value as String)

SetValue Method Assigns a data value to a value Dim oPropSet as SiebelPropertySet

member of a property set. oPropSet.SetValue(value as String)

376 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

11 Siebel VB Quick Reference

This chapter provides a quick reference for Siebel VB methods and events. It has the following topics:

Applet Methods for Siebel VB

WebApplet Events for Siebel VB on page 378

Application Methods for Siebel VB on page 379

Application Events for Siebel VB on page 382

Business Component Methods for Siebel VB on page 382

Business Component Events for Siebel VB on page 387

Business Object Methods for Siebel VB on page 389

Business Service Methods for Siebel VB on page 389

Business Service Events for Siebel VB on page 390

Property Set Methods for Siebel VB on page 391

Miscellaneous Methods for Siebel VB on page 393

Applet Methods for Siebel VB

Table 58 lists a summary of the applet methods syntax.

Table 58. Applet Methods Syntax Summary

Method Description Syntax

BusComp Method Function that returns the business Dim oApplet as Applet
component that is associated with Dim oBusComp as BusComp
the applet. Set oBusComp = oApplet.BusComp

BusObject Method Function that returns the business Dim oApplet as Applet
object for the business component Dim oBusObject as BusObject
of the applet. Set oBusObject = oApplet.BusObject

InvokeMethod Invokes the specialized or custom Dim oApplet as Applet

Method method specified by its argument. oApplet.InvokeMethod methodName as
String, methodArgs as String or
StringArray
Name Method Function that returns the name of Dim oApplet as Applet
the applet. Dim sApplet as String
sApplet = oApplet.Name

Siebel Object Interfaces Reference Version 8.1 37 7

 For Oracle internal distribution only
Siebel VB Quick Reference WebApplet Events for Siebel VB

WebApplet Events for Siebel VB

Table 59 lists a summary of the WebApplet events.

Table 59. WebApplet Events Summary

Event Description Syntax

WebApplet_InvokeMethod Event Called after a WebApplet_InvokeMethod(MethodName as

specialized String)
method or a user-
defined method
on the Web applet
has been
executed.

WebApplet_PreCanInvokeMethod Called before the WebApplet_PreCanInvokeMethod(MethodN

Event PreInvokeMethod, ame as String, &CanInvoke as String)
allowing the
developer to
determine
whether or not the
user has the
authority to
invoke the applet
method.

WebApplet_PreInvokeMethod Called before a WebApplet_PreInvokeMethod(MethodName

Event specialized as String)
method for the
Web applet is
invoked or a user-
defined method is
invoked through
oWebApplet.Invok
e
Method.

WebApplet_Load Event Called just after WebApplet_Load

an applet is
loaded.

378 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel VB Quick Reference Application Methods for Siebel VB

Table 59. WebApplet Events Summary

Event Description Syntax

WebApplet_ShowControl Event Allows scripts to WebApplet_ShowControl

modify the HTML
generated by the
Siebel Web Engine
to render a control
on a Web page in a
standard
interactivity
application.

WebApplet_ShowListColumn Allows scripts to WebApplet_ShowListColumn

Event modify the HTML
generated by the
Siebel Web Engine
to render a list
column on a Web
page in a standard
interactivity
application.

Application Methods for Siebel VB

Table 60 lists a summary of the application methods syntax.

Table 60 does not include methods that are not invoked directly from an Application object instance.
For information on methods that are called with InvokeMethod on the Application object, see
InvokeMethod Methods for the Application Object on page 139.

Table 60. Application Methods Syntax Summary

Method Description Syntax

ActiveBusObject Returns the business object Dim oApplication as Application

Method of the active view. Dim oBusObject as BusObject
Set oBusObject =
oApplication.ActiveBusObject
ActiveViewName Function that returns the Dim oApplication as Application
Method name of the active view. Dim sView as String
sView = oApplication.ActiveViewName
CurrencyCode Returns the three-letter Dim oApplication as Application
Method operating currency code. Dim sCur as String
sCur = oApplication.CurrencyCode

Siebel Object Interfaces Reference Version 8.1 37 9

 For Oracle internal distribution only
Siebel VB Quick Reference Application Methods for Siebel VB

Table 60. Application Methods Syntax Summary

Method Description Syntax

GetBusObject Instantiates and returns a Dim oApplication as Application

Method new instance of the Dim oBusObject as BusObject
argument-specified business set oBusObject =
object. oApplication.GetBusObject busobject as
String
GetProfileAttr Returns the value of an Dim oApplication as Application
Method attribute in a user profile. Dim sAttr as String
SAttr = oApplication.GetProfileAttr(name
as String)
GetService Instantiates and returns a Dim oApplication as Application
Method new instance of the Dim oService as Service
argument-specified service. set oService =
oApplication.GetService(serviceName as
String)
GetSharedGlobal Gets the shared user-defined Dim oApplication as Application
Method global variables. Dim sName as String
sName =
Application.GetSharedGlobal(varName as
String)

GotoView Method Activates the named view and Dim oApplication as Application
its business object. oApplication.GotoView viewName as
String, [BusinessObjectName as
BusObject]

InvokeMethod Calls the named specialized Dim oApplication as Application

Method method. Dim sReturn as String
sReturn =
oApplication.InvokeMethod(methodName as
String, methodArgs as String or
StringArray)
LoginId Method Function that returns the Dim oApplication as Application
login ID of the user who Dim sID as String
started the Siebel application. iID = oApplication.LoginId

LoginName Function that returns the Dim oApplication as Application

Method login name of the user who Dim sUser as String
started the Siebel application. sUser = oApplication.LoginName

NewPropertySet Constructs and returns a new Dim oApplication as Application

Method property set object. Dim oPropSet as ProperySet
oPropSet = oApplication.NewPropertySet()
PositionId Method Function that returns the Dim oApplication as Application
position ID that describes the Dim sRow as String
users current position. sRow = oApplication.PositionId

380 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel VB Quick Reference Application Methods for Siebel VB

Table 60. Application Methods Syntax Summary

Method Description Syntax

PositionName Function that returns the Dim oApplication as Application

Method position name of the users Dim sPosition as String
current position. sPosition = oApplication.PositionName

RaiseError Method Raises a scripting error Dim oApplication as Application

message to the browser. The oApplication.RaiseError keyValue as
error code is a canonical String, param1 as String, ...
number.

RaiseErrorText Raises a scripting error Dim oApplication as Application

Method message to the browser. The oApplication.RaiseErrorText message as
error text is the specified String
literal string.

SetPositionId Sets the active position to the Dim oApplication as Application

Method position ID specified in the oApplication.SetPositionId posId as
argument. string

SetPositionName Sets the active position to the Dim oApplication as Application

Method position name specified in the oApplication.SetPositionName posName as
argument. Returns a Boolean string
value indicating whether or
not method succeeded.

SetProfileAttr Used in personalization to Dim oApplication as Application

Method assign values to attributes in oApplication.SetProfileAttr name as
a user profile. String, value as String

SetSharedGlobal Sets a shared user-defined Dim oApplication as Application

Method global variable. oApplication.SetSharedGlobal varName as
String, value as String
Trace Method Appends a message to the Dim oApplication as Application
trace file. oApplication.Trace message as String

TraceOff Method Turns off the tracing started Dim oApplication as Application
by TraceOn. oApplication.TraceOff

TraceOn Method Turns tracing on. Dim oApplication as Application

oApplication.TraceOn filename as String,
type as String, selection as String

Siebel Object Interfaces Reference Version 8.1 38 1

 For Oracle internal distribution only
Siebel VB Quick Reference Application Events for Siebel VB

Application Events for Siebel VB

Table 61 lists a summary of the application events.

Table 61. Application Events Summary

Event Description Syntax

Application_Close Event Called before the Application_Close

application exits.

Application_Navigate Event Called after the client has Application_Navigate

navigated to a view.

Application_InvokeMethod Called after a specialized Application_InvokeMethod(methodN

Event method is invoked. ame as String)

Application_PreInvokeMethod Called before a Application_PreInvokeMethod(meth

Event specialized method is odName as String)
invoked.

Application_PreNavigate Event Called before the client Application_PreNavigate

has navigated from one (DestViewName As String,
view to the next. DestBusObjName As String)

Application_Start Event Called when the client Application_Start(commandLine as

starts. String)

Business Component Methods for

Siebel VB
Table 62 lists a summary of the business component methods syntax.

Table 62 does not include methods that are not invoked directly from a Business Component object
instance. For information on methods that are called with InvokeMethod on the Business Component
object, see InvokeMethod Methods for the Business Component Object on page 213.

Table 62. Business Component Methods Syntax Summary

Method Description Syntax

ActivateField Method Allows queries to retrieve Dim oBusComp as BusComp

data for the specified field. oBusComp.ActivateField fieldName
as String

ActivateMultipleFields Allows queries to retrieve Dim oBusComp as BusComp

Method data for the fields specified in oBusComp.ActivateMultipleFields
the property set. oPropSet as PropertySet

382 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel VB Quick Reference Business Component Methods for Siebel VB

Table 62. Business Component Methods Syntax Summary

Method Description Syntax

Associate Method Creates a new many-to-many Dim oBusComp as BusComp

relationship for the parent oBusComp.Associate whereIndicator
object through an association as Integer
business component.

BusObject Method Function that returns the Dim oBusComp as BusComp

business object that contains Dim oBusObject as BusObject
the business component. Set oBusObject =
oBusComp.BusObject
ClearToQuery Method Clears the current query and Dim oBusComp as BusComp
sort specifications on the oBusComp.ClearToQuery
business component.

DeactivateFields Method Deactivates every currently Dim oBusComp as BusComp

activated field. oBusComp.DeactivateFields

DeleteRecord Method Removes the current record Dim oBusComp as BusComp

from the business oBusComp.DeleteRecord
component.

ExecuteQuery Method Retrieves a set of BusComp Dim oBusComp as BusComp

records. oBusComp.ExecuteQuery cursorMode
as Integer
ExecuteQuery2 Method Retrieves a set of BusComp Dim oBusComp as BusComp
records. oBusComp.ExecuteQuery2 cursorMode
as Integer, ignoreMaxCursorSize as
Integer
FirstRecord Method Moves to the first record in Dim oBusComp as BusComp
the business component. Dim iIsRecord as Integer
iIsRecord = oBusComp.FirstRecord
FirstSelected Method Moves the focus to the first Dim oBusComp as BusComp
record of the multiple Dim iIsMultipleSection as Integer
selection in the business iIsMultipleSelection =
component. oBusComp.FirstSelected

GetAssocBusComp Function that returns the Dim oBusComp as BusComp

Method association business Dim AssocBusComp as BusComp
component. Set AssocBusComp =
oBusComp.GetAssocBusComp
GetFieldValue Method Function that returns a value Dim oBusComp as BusComp
for the argument-specified Dim sValue as String
field. sValue =
oBusComp.GetFieldValue(FieldName
as String)

Siebel Object Interfaces Reference Version 8.1 38 3

 For Oracle internal distribution only
Siebel VB Quick Reference Business Component Methods for Siebel VB

Table 62. Business Component Methods Syntax Summary

Method Description Syntax

GetFormattedFieldValue Function that returns a Dim oBusComp as BusComp

Method formatted value for the Dim sValue as String
argument-specified field. sValue =
oBusComp.GetFormattedFieldValue(F
ieldName as String)
GetMultipleFieldValues Returns a value for the fields Dim oBusComp as BusComp
Method specified in the property set. oBusComp.GetMultipleFieldValues
oFields as PropertySet, oValues as
PropertySet
GetMVGBusComp Method Function that returns the MVG Dim oBusComp as BusComp
business component Dim MvgBusComp as BusComp
associated with the set MvgBusComp =
argument-specified field. oBusComp.GetMVGBusComp(FieldName
as String)
GetNamedSearch Method Function that returns the Dim oBusComp as BusComp
argument-named search Dim sValue as String
specification. sValue =
oBusComp.GetNamedSearch(SearchNam
e as String)
GetPicklistBusComp Function that returns the pick Dim oBusComp as BusComp
Method business component Dim pickBusComp as BusComp
associated with the Set pickBusComp =
argument-specified field. oBusComp.GetPicklistBusComp(Field
Name as String)
GetSearchExpr Method Function that returns the Dim oBusComp as BusComp
current search expression. Dim sExpr as String
sExpr = oBusComp.GetSearchExpr
GetSearchSpec Method Function that returns the Dim oBusComp as BusComp
current search specification Dim sSpec as String
for the argument-specified sSpec =
field. oBusComp.GetSearchSpec(FieldName
as String)
GetSortSpec Method Function that returns the Dim sSortSpec as String
active sort specification of the sSortSpec = GetSortSpec
object that has context.

GetUserProperty Method Function that returns the Dim oBusComp as BusComp

value for an argument- Dim sValue as String
specified property name. sValue =
oBusComp.GetUserProperty(property
Name as String)
GetViewMode Method Function that returns the Dim oBusComp as BusComp
visibility mode for the Dim iMode as Integer
business component. iMode = oBusComp.GetViewMode

384 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel VB Quick Reference Business Component Methods for Siebel VB

Table 62. Business Component Methods Syntax Summary

Method Description Syntax

InvokeMethod Method Calls the specialized method Dim oBusComp as BusComp

or user-created method Dim Return
specified in the argument. Return =
oBusComp.InvokeMethod(methodName
as String, methodArgs as String or
StringArray)

LastRecord Method Moves to the last record in the Dim oBusComp as BusComp
business component. Dim iReturn as Integer
iReturn = oBusComp.LastRecord
Name Method Function that returns the Dim oBusComp as BusComp
name of the business Dim sName as String
component. sName = oBusComp.Name

NewRecord Method Adds a new record to the Dim oBusComp as BusComp

business component. oBusComp.NewRecord(whereIndicator
as Integer)

NextRecord Method Moves to the next record in Dim oBusComp as BusComp

the business component. Dim iReturn as Integer
iReturn = oBusComp.NextRecord
NextSelected Method Moves to the next record of Dim oBusComp as BusComp
the current multiple selection. Dim iReturn as Integer
iReturn = oBusComp.NextSelected
ParentBusComp Method Function that returns the Dim oBusComp as BusComp
parent business component. Dim parentBusComp as BusComp
Set parentBusComp =
oBusComp.ParentBusComp
Pick Method Places the currently selected Dim oBusComp as BusComp
record in a picklist business oBusComp.Pick
component into the
appropriate fields of the
parent business component.

PreviousRecord Method Moves to the previous record Dim oBusComp as BusComp

in the business component. Dim iReturn as Integer
iReturn = oBusComp.PreviousRecord

RefineQuery Method Refines a query after a query Dim oBusComp as BusComp

has been executed. oBusComp.RefineQuery

Siebel Object Interfaces Reference Version 8.1 38 5

 For Oracle internal distribution only
Siebel VB Quick Reference Business Component Methods for Siebel VB

Table 62. Business Component Methods Syntax Summary

Method Description Syntax

SetFieldValue Method Assigns a new value to the Dim oBusComp as BusComp

named field for the current oBusComp.SetFieldValue FieldName
row of the business as String, FieldValue as String
component.

SetFormattedFieldValue Accepts the field value in the Dim oBusComp as BusComp

Method current local format and oBusComp.SetFormattedFieldValue
assigns the new value to the FieldName as String, FieldValue as
named field for the current String
row of the business
component.

SetMultipleFieldValues Assigns a new value to the Dim oBusComp as BusComp

Method fields specified in the property oBusComp.SetMultipleFieldValues
set for the current row of the oPropSet as PropertySet
business component.

SetNamedSearch Method Sets a named search Dim oBusComp as BusComp

specification on the business oBusComp.SetNamedSearch
component. searchName as String, searchSpec
as String

SetSearchExpr Method Sets the entire search Dim oBusComp as BusComp

expression for the business oBusComp.SetSearchExpr searchSpec
component. as String

SetSearchSpec Method Sets the search specification Dim oBusComp as BusComp

for the specified field. oBusComp.SetSearchSpec fieldName
as String, searchSpec as String )
SetSortSpec Method Sets the sort specification for Dim oBusComp as BusComp
a query. oBusComp.SetSortSpec sortSpec as
String
SetUserProperty Method Sets the value of the specified Dim oBusComp as BusComp
User Property. oBusComp.SetUserProperty
propertyName as String, newValue
as String
SetViewMode Method Sets the visibility type for the Dim oBusComp as BusComp
business component. oBusComp.SetViewMode viewMode as
Integer
UndoRecord Method Reverses any uncommitted Dim oBusComp as BusComp
changes made to the record. oBusComp.UndoRecord

WriteRecord Method Commits to the database any Dim oBusComp as BusComp

changes made to the current oBusComp.WriteRecord
record.

386 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel VB Quick Reference Business Component Events for Siebel VB

Business Component Events for

Siebel VB
Table 63 lists a summary of the business component events.

Table 63. Business Component Events Summary

Event Description Syntax

BusComp_Associate Event Called after a record is added BusComp_Associate

to a business component to
create an association.

BusComp_ChangeRecord Called after the current row BusComp_ChangeRecord

Event changes in the business
component.

BusComp_CopyRecord Event Called after a new row is BusComp_CopyRecord

copied in the business
component.

BusComp_DeleteRecord Called after a row is deleted in BusComp_DeleteRecord

Event the business component.

BusComp_InvokeMethod Called after a custom or BusComp_InvokeMethod(methodNa

Event specialized method is called me as String)
on a business component.

BusComp_NewRecord Event Called after a new row has BusComp_NewRecord

been created and made active
in the business component.

BusComp_PreAssociate Event Called before a record is BusComp_PreAssociate

added to a business
component to create an
association.

BusComp_PreCopyRecord Called before a new row is BusComp_PreCopyRecord

Event copied in the business
component.

BusComp_PreDeleteRecord Called before a row is deleted BusComp_PreDeleteRecord

Event in the business component.

BusComp_PreGetFieldValue Called when the value of a BusComp_PreGetFieldValue(Fiel

Event business component field is dName as String, FieldValue as
accessed. String)

Siebel Object Interfaces Reference Version 8.1 38 7

 For Oracle internal distribution only
Siebel VB Quick Reference Business Component Events for Siebel VB

Table 63. Business Component Events Summary

Event Description Syntax

BusComp_PreInvokeMethod Called before a specialized or BusComp_PreInvokeMethod(metho

Event custom method is invoked on dName as String)
a business component.

BusComp_PreNewRecord Called before a new row is BusComp_PreNewRecord

Event created in the business
component.

BusComp_PreQuery Event Called before query BusComp_PreQuery

execution.

BusComp_PreSetFieldValue Called when a value is pushed BusComp_PreSetFieldValue(Fiel

Event down into the business dName as String,FieldValue as
component from the user String)
interface or through a call to
SetFieldValue.

BusComp_PreWriteRecord Called before a row is written BusComp_PreWriteRecord

Event out to the database.

BusComp_Query Event Called after the query is BusComp_Query

complete and every row has
been retrieved, but before
they have been displayed.

BusComp_SetFieldValue Called after a value has been BusComp_SetFieldValue(fieldNa

Event pushed down into the me as String)
business component from the
user interface or through a
call to SetFieldValue.

BusComp_WriteRecord Event Called after a row is written to BusComp_WriteRecord

the database.

388 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel VB Quick Reference Business Object Methods for Siebel VB

Business Object Methods for Siebel VB

Table 64 lists a summary of the business object methods syntax.

Table 64. Business Object Methods Syntax Summary

Method Description Syntax

GetBusComp Function that returns the Dim oBusObject as BusObject

Method specified business Dim oBusComp as BusComp
component. set oBusComp =
BusObject.GetBusComp(BusCompName as
String)
Name Method Function that returns the Dim oBusObject as BusObject
name of the business Dim sName as String
object. sName = oBusObject.Name

Business Service Methods for Siebel VB

Table 65 lists a summary of the business service methods syntax.

Table 65. Business Service Methods Syntax Summary

Method Description Syntax

GetFirstProperty Retrieves the name of the Dim oService as Service

Method first property of a business Dim sName as String
service. sName = oService.GetFirstProperty()

GetNextProperty After the name of the first Dim oService as Service

Method property has been retrieved, Dim sName as String
retrieves the name of the sName = oService.GetNextProperty()
next property of a business
service.

GetProperty Retrieves the value stored in Dim oService as Service

Method the specified property. Dim sValue as String
sValue = oService.GetProperty(propName as
String)

InvokeMethod Calls a specialized method or Dim oService as Service

Method a user-created method on Dim Return
the business service. Return = oService.InvokeMethod(methodName
as String, InputArguments as PropertySet,
OutputArguments as PropertySet)
Name Method Returns the name of the Dim oService as Service
business service. Dim sName as String
sName = oService.Name

Siebel Object Interfaces Reference Version 8.1 38 9

 For Oracle internal distribution only
Siebel VB Quick Reference Business Service Events for Siebel VB

Table 65. Business Service Methods Syntax Summary

Method Description Syntax

PropertyExists Returns a Boolean value Dim oService as Service

Method indicating whether the oService.PropertyExists(propName as
property specified in the String)
argument exists.

RemoveProperty Removes a property from a Dim oService as Service

Method business service. oService.RemoveProperty propName as
String

SetProperty Assigns a value to a property Dim oService as Service

Method of a business service. oService.SetProperty propName as String,
propValue as String

Business Service Events for Siebel VB

Table 66 lists a summary of the business service events.

Table 66. Business Service Events Syntax Summary

Method Description Syntax

Service_InvokeMethod Event Called after the Service_InvokeMethod(methodNam

InvokeMethod method is e as String)
called on a business service.

Service_PreCanInvokeMethod Called before the Service_PreCanInvokeMethod(met

Event PreInvokeMethod, allowing hodName as String, CanInvoke As
the developer to determine String)
whether or not the user has
the authority to invoke the
business service method.

Service_PreInvokeMethod Called before a specialized Service_PreInvokeMethod(method

Event or user-defined method is Name as String, Inputs as
invoked on a business PropertySet, Outputs as
service. PropertySet)

390 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel VB Quick Reference Property Set Methods for Siebel VB

Property Set Methods for Siebel VB

Table 67 lists a summary of the property set methods syntax.

Table 67. Property Set Methods Syntax Summary

Method Description Syntax

AddChild Method Adds subsidiary Dim oPropSet as PropertySet

property sets to a oPropSet.AddChild(childObject as Property
property set. Set)

Copy Method Returns a copy of a Dim oPropSet1 as PropertySet

property set. Dim oPropSet2 as PropertySet
set oPropSet2 = oPropSet1.Copy()
GetChild Method Returns a specified Dim oPropSet as PropertySet
child property set of a Dim childPropSet as SiebelPropertySet
property set. set childPropSet = oPropSet.GetChild(index as
Long)
GetChildCount Returns the number of Dim oPropSet as PropertySet
Method child property sets Dim iCount as Integer
attached to a parent iCount = oPropSet.GetChildCount()
property set.

GetFirstProperty Returns the name of Dim oPropSet as PropertySet

Method the first property in a Dim sPropName as String
property set. sPropName = oPropSet.GetFirstProperty()

GetNextProperty Returns the name of Dim oPropSet as PropertySet

Method the next property in a Dim sPropName as String
property set. sPropName = oPropSet.GetNextProperty()

GetProperty Method Returns the value of a Dim oPropSet as PropertySet

property when given Dim sPropVal as String
the property name. sPropVal = oPropSet.GetProperty(propName as
String)

GetPropertyCount Returns the number of Dim oPropSet as PropertySet

Method properties attached to Dim count as Long
a property set. count = oPropSet.GetPropertyCount

GetType Method Returns the value Dim oPropSet as PropertySet

stored in a type in a Dim sTypeVal as String
property set. sTypeVal = oPropSet.GetType

GetValue Method Returns a value stored Dim oPropSet as PropertySet

as part of a property Dim sValVal as String
set. sValVal = oPropSet.GetValue

InsertChildAt Inserts a child Dim oPropSet as PropertySet

Method property set into a oPropSet.InsertChildAt childObject as
parent property set at SiebelPropertySet, index as Integer
a specific location.

Siebel Object Interfaces Reference Version 8.1 39 1

 For Oracle internal distribution only
Siebel VB Quick Reference Property Set Methods for Siebel VB

Table 67. Property Set Methods Syntax Summary

Method Description Syntax

PropertyExists Returns a Boolean Dim oPropSet as PropertySet

Method value indicating oPropSet.PropertyExists(propName as String)
whether the property
specified in the
argument exists.

GetPropertyCount Returns the number of Dim oPropSet as PropertySet

Method properties attached to Dim count as Long
a property set. count=oPropSet.GetPropertyCount

RemoveChild Removes a child Dim oPropSet as PropertySet

Method property set as a oPropSet.RemoveChild index as Integer
specified index from a
parent property set.

RemoveProperty Removes the property Dim oPropSet as PropertySet

Method specified in its oPropSet.RemoveProperty propName as String
argument from a
property set.

Reset Method Removes every Dim oPropSet as PropertySet

property and child oPropSet.Reset()
property set from a
property set.

SetProperty Method Assigns a value to the Dim oPropSet as PropertySet

property of a property oPropSet.SetProperty propName as String,
set specified in its propValue as String
argument.

SetType Method Assigns a data value to Dim oPropSet as PropertySet

a type member of a oPropSet.SetType value as String
property set.

SetValue Method Assigns a data value to Dim oPropSet as PropertySet

a value member of a oPropSet.SetValue value as String
property set.

392 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel VB Quick Reference Miscellaneous Methods for Siebel VB

Miscellaneous Methods for Siebel VB

Table 68 lists a summary of the miscellaneous methods syntax.

Table 68. Miscellaneous Methods Syntax Summary

Method Description Syntax

TheApplication Global method that TheApplication

Method returns the unique
object of type
Application.

Siebel Object Interfaces Reference Version 8.1 39 3

 For Oracle internal distribution only
Siebel VB Quick Reference Miscellaneous Methods for Siebel VB

394 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

12 Browser Scripting
This chapter provides information about Browser Scripting and its available events and methods:

About Browser Script on page 395

Applet Methods for Browser Script on page 396

Applet Events for Browser Script on page 397

Application Methods for Browser Script on page 397

Application Events for Browser Script on page 398

Business Component Methods for Browser Script on page 399

Business Component Events for Browser Script on page 400

Business Object Methods for Browser Script on page 401

Business Service Methods for Browser Script on page 401

Business Service Events for Browser Script on page 402

Property Set Methods for Browser Script on page 403

Control Methods for Browser Script on page 404

Supported DOM Events for High Interactivity Mode on page 405

Supported DOM Events for Standard Interactivity Mode on page 407

About Browser Script

Browser Script executes in and is interpreted by the browser. Browser Scripts are written in
JavaScript and interact with the Document Object Model (DOM) as well as with the Siebel Object
Model available in the browser through the Browser Interaction Manager. A developer can script the
behavior of Siebel events as well as the browser events that are exposed through the DOM. The DOM
for Internet Explorer and Netscape Navigator are different. Using Siebel Tools you can write scripts
for the appropriate browser type by selecting the appropriate User Agent.

NOTE: Browser Script may only be used with applications which run in high interactivity mode,
except when scripting Control events supported by the Browser Document Object Model. Refer to
Table 80 and Table 81 for a list of supported DOM events.

Do not use browser scripts to manipulate the location of a frame or form in the Siebel application
because this causes a new page to be loaded. The result is a permission denied error, as it is a
violation of good security practices.

Siebel Object Interfaces Reference Version 8.1 39 5

 For Oracle internal distribution only
Browser Scripting Applet Methods for Browser Script

A high interactivity application can contain standard interactivity views (Home Page view and
Dashboard view for example). Applet-level browser scripts cannot be used on applets in those views
(the same as in standard interactivity applications). Instead the server script
WebApplet_ShowControl that is not supported in high interactivity is triggered on the applets for
those standard interactivity views.

For information on generating browser scripts, see Configuring Siebel Business Applications.

Applet Methods for Browser Script

Table 69 lists a summary of the applet methods syntax.

Table 69. Applet Methods Syntax Summary

Method Description Syntax

ActiveMode Method Returns a string containing var oApplet;

the name of the current Web var mode = oApplet.ActiveMode();
Template mode.

BusComp Method Returns the business var oApplet;

component that is associated var busComp = oApplet.BusComp();
with the applet.

BusObject Method Returns the business object var oApplet;

for the business component var oBusObject = oApplet.BusObject();
for the applet.

FindActiveXControl Returns the ActiveX control var oApplet;

Method whose name is specified in the var oControl;
argument. oControl =
oApplet.FindActiveXControl(controlNa
me);
FindControl Method Returns the control whose var oApplet;
name is specified in the var oControl;
argument. oControl =
oApplet.FindControl(controlName);
InvokeMethod Calls an argument-specified var oApplet;
Method specialized method. var outPs =
theApplication().NewPropertySet();
outPs =
oApplet.InvokeMethod(MethodName,
inputPropSet);
Name Method Returns the name of the var oApplet;
applet. var name = oApplet.Name();

396 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Browser Scripting Applet Events for Browser Script

Applet Events for Browser Script

Table 70 lists a summary of the applet events.

Table 70. Applet Events Summary

Event Description Syntax

Applet_ChangeFieldValue Called when the user updates a Applet_ChangeFieldValue

Event field value in the browser. (field, value)

Applet_ChangeRecord Called when the user moves to a Applet_ChangeRecord()

Event different row or view.

Applet_InvokeMethod Called after a specialized method Applet_InvokeMethod (name,

Event or a user-defined method is inputPropSet)
invoked.

Applet_Load Event Triggered after an applet has Applet_Load()

loaded and after data is
displayed.

Applet_PreInvokeMethod Called before a specialized Applet_PreInvokeMethod

Event method for the Web applet is (name, inputPropSet)
invoked or a user-defined method
is invoked through
oWebApplet.InvokeMethod.

Application Methods for Browser Script

Table 71 lists a summary of the application methods syntax.

Table 71 does not include methods that are not invoked directly from an Application object instance.
For information on methods that are called with InvokeMethod on the Application object, see
InvokeMethod Methods for the Application Object on page 139.

Table 71. Application Methods Syntax Summary

Method Description Syntax

ActiveApplet Returns the name of the var applet;

Method applet that has input focus. applet =
theApplication().ActiveApplet();
ActiveBusComp Returns the business var busComp;
Method component associated with busComp =
the active applet. theApplication().ActiveBusComp();

ActiveBusObject Returns the business object var busObject;

Method for the business component of busObject =
the active applet. theApplication().ActiveBusObject();

Siebel Object Interfaces Reference Version 8.1 39 7

 For Oracle internal distribution only
Browser Scripting Application Events for Browser Script

Table 71. Application Methods Syntax Summary

Method Description Syntax

ActiveViewName Returns the name of the var viewName;

Method active view. viewName =
theApplication().ActiveViewName();
FindApplet Method Returns the applet object var applet;
identified in the argument. applet =
theApplication().FindApplet(appletName
);

GetProfileAttr Returns the value of an var sAttr;

Method attribute in a user profile. sAttr =
theApplication().GetProfileAttr(name);
GetService Method Instantiates and returns a var svc;
new instance of the service svc =
specified in the argument. theApplication().GetService(serviceNam
e);
InvokeMethod Calls the named specialized var outPs;
Method method. outPs =
theApplication().InvokeMethod(methodNa
me, inputPropSet);
Name Method Returns name of the var appName;
application. appName = theApplication().Name();

NewPropertySet Constructs and returns a new var PropSet;

Method property set object. PropSet =
theApplication().NewPropertySet();

SetProfileAttr Used in personalization to theApplication().SetProfileAttr(name,

Method assign values to attributes in value);
a user profile.

SWEAlert Method Displays a modal dialog box theApplication().SWEAlert(message);

containing a message to the
user.

Application Events for Browser Script

Table 72 lists a summary of the application events.

Table 72. Application Events Syntax Summary

Event Description Syntax

Application_InvokeMethod Event Called after a specialized Application_InvokeMethod

method is invoked. (name, inputPropSet)

Application_PreInvokeMethod Called before a specialized Application_PreInvokeMetho

Event method is invoked. d (name, inputPropSet)

398 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Browser Scripting Business Component Methods for Browser Script

Business Component Methods for

Browser Script
Table 73 lists a summary of the business component methods syntax.

Table 73 does not include methods that are not invoked directly from a Business Component object
instance. For information on methods that are called with InvokeMethod on the Business Component
object, see InvokeMethod Methods for the Business Component Object on page 213.

Table 73. Business Component Methods Syntax Summary

Method Description Syntax

BusObject Method Returns the business object var busComp;

that contains the business var busObject;
component. busObject = busComp.BusObject();

GetFieldValue Method Returns a value for the field var busComp;

specified in the argument. var value;
value =
busComp.GetFieldValue(fieldName)
;
GetFormattedFieldValue Returns a formatted value for var busComp;
Method the field specified in the var sValue;
argument. sValue =
busComp.GetFormattedFieldValue(f
ieldName);
GetSearchExpr Method Returns the current search var busComp;
expression. var sExpr;
sExpr = busComp.GetSearchExpr();
GetSearchSpec Method Returns the current search var busComp;
specification for the field var sSpec;
specified in the argument. sSpec =
busComp.GetSearchSpec(fieldName)
;

InvokeMethod Method Calls the specialized method var BusComp;

named in the argument. var sReturn;
sReturn =
BusComp.InvokeMethod(methodName,
methodArg1, methodArg2,...,
methodArgn);
Name Method Returns the name of the var busComp;
business component. var sName;
sName = busComp.Name();
SetFieldValue Method Assigns a new value to the var busComp;
named field for the current busComp.SetFieldValue(fieldName,
row of the business fieldValue);
component.

Siebel Object Interfaces Reference Version 8.1 39 9

 For Oracle internal distribution only
Browser Scripting Business Component Events for Browser Script

Table 73. Business Component Methods Syntax Summary

Method Description Syntax

SetFormattedFieldValue Accepts the field value in the var busComp;

Method current local format and busComp.SetFormattedFieldValue(f
assigns the new value to the ieldName, fieldValue);
named field for the current
row of the business
component.

WriteRecord Method Commits to the database any var busComp;

changes made to the current busComp.WriteRecord();
record.

Business Component Events for Browser

Script
Table 74 lists a summary of the business component events.

Table 74. Business Component Events Syntax Summary

Event Description Syntax

BusComp_PreSetFieldValue Called when a value is pushed BusComp_PreSetFieldValue

Event down into the business (fieldName, value);
component from the user
interface.

This Browser Script event is

invoked after the server round
trip if the Immediate Post
Changes property of the
Business Component field is set
to TRUE.

NOTE: This event is not invoked

on picklists and multivalue
fields.

400 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Browser Scripting Business Object Methods for Browser Script

Business Object Methods for Browser

Script
Table 75 lists a summary of the business object methods syntax.

Table 75. Business Object Methods Syntax Summary

Method Description Syntax

GetBusComp Returns the specified business var busObject;

Method component. var Comp;
busComp =
busObject.GetBusComp(busCompName);
Name Method Returns the name of the Var sName;
business object. var busObject;
sName = budObject.Name();

Business Service Methods for Browser

Script
Table 76 lists a summary of the business service methods syntax.

Table 76. Business Service Methods Syntax Summary

Method Description Syntax

GetFirstProperty Retrieves the name of the first var svc;

Method property of a business service. var sName = svc.GetFirstProperty();

GetNextProperty After the name of the first var svc;

Method property has been retrieved, var sName = svc.GetNextProperty();
retrieves the name of the next
property of a business service.

GetProperty Retrieves the value stored in var svc;

Method the specified property. var value;
value = svc.GetProperty(name);
InvokeMethod Calls a specialized method or a var svc;
Method user-created method on the var oPropSet
business service. =theApplication().NewPropertySet();
oPropSet = svc.InvokeMethod(methodName,
inputPropSet);
Name Method Returns the name of the var svc;
business service. var name;
name = svc.Name();

Siebel Object Interfaces Reference Version 8.1 40 1

 For Oracle internal distribution only
Browser Scripting Business Service Events for Browser Script

Table 76. Business Service Methods Syntax Summary

Method Description Syntax

PropertyExists Returns a Boolean value var svc;

Method indicating whether the var bool;
property specified in the bool = svc.PropertyExists(name);
argument exists.

RemoveProperty Removes a property from a var svc;

Method business service. svc.RemoveProperty(name);

SetProperty Assigns a value to a property var svc;

Method of a business service. svc.SetProperty(name, value);

Business Service Events for Browser

Script
Table 77 lists a summary of the business service events.

Table 77. Business Service Events Syntax Summary

Method Description Syntax

Service_InvokeMethod Event Called when a business service Service_InvokeMethod(metho

is accessed. dName,input, output);
Service_PreCanInvokeMethod Called before the Service_PreCanInvokeMethod
Event PreInvokeMethod, allowing the (methodName);
developer to determine
whether or not the user has the
authority to invoke the
business service method.

Service_PreInvokeMethod Called before a specialized Service_PreInvokeMethod(me

Event method is invoked on a thodName,
business service. inputPropSet,outputPropSet
);

402 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Browser Scripting Property Set Methods for Browser Script

Property Set Methods for Browser Script

Table 78 lists a summary of the property set methods syntax.

Table 78. Property Set Methods Syntax Summary

Method Description Syntax

AddChild Method Adds subsidiary property var oPropSet;

sets to a property set. var iIndex;
iIndex = oPropSet.AddChild(childObject);
Copy Method Returns a copy of a var oPropSet1;
property set. var oPropSet2;
oPropSet2 = oPropSet1.Copy();
GetChild Method Returns a specified child var oPropSet;
property set of a property var oChildPropSet;
set. oChildPropSet =
oPropSet.GetChild(index);
GetChildCount Returns the number of var oPropSet;
Method child property sets var iCount;
attached to a parent iCount = oPropSet.GetChildCount();
property set.

GetFirstProperty Returns the name of the var oPropSet;

Method first property in a property var sPropName;
set. sPropName = oPropSet.GetFirstProperty();

GetNextProperty Returns the name of the var oPropSet;

Method next property in a var sPropName;
property set. sPropName = oPropSet.GetNextProperty();

GetProperty Method Returns the value of a var oPropSet;

property when given the var sValue;
property name. sValue = oPropSet.GetProperty(propName);

GetPropertyCount Returns the number of var oPropSet;

Method properties attached to a var iCount;
property set. iCount = oPropSet.GetPropertyCount();

GetType Method Returns the value stored var oPropSet;

in a type in a property set. var type;
type = oPropSet.GetType();

GetValue Method Returns a value stored as var oPropSet;

part of a property set. var sValue;
sValue = oPropSet.GetValue();

Siebel Object Interfaces Reference Version 8.1 40 3

 For Oracle internal distribution only
Browser Scripting Control Methods for Browser Script

Table 78. Property Set Methods Syntax Summary

Method Description Syntax

InsertChildAt Method Inserts a child property var oPropSet;

set into a parent property oPropSet.InsertChildAt(childObject,
set at a specific location. index);

PropertyExists Returns a Boolean value var oPropSet;

Method indicating whether the var bool;
property specified in the bool =
argument exists. oPropSet.PropertyExists(propName);

RemoveChild Method Removes a child property var oPropSet;

set as a specified index oPropSet.RemoveChild(index);
from a parent property
set.

RemoveProperty Removes the property var oPropSet;

Method specified in its argument oPropSet.RemoveProperty(propName);
from a property set.

Reset Method Removes every property var oPropSet;

and child property set oPropSet.Reset();
from a property set.

SetProperty Method Assigns a value to the var oPropSet;

property of a property set oPropSet.SetProperty(propName,
specified in its argument. propValue);

SetType Method Assigns a data value to a var oPropSet;

type member of a property oPropSet.SetType(value);
set.

SetValue Method Assigns a data value to a var oPropSet;

value member of a oPropSet.SetValue(value);
property set.

Control Methods for Browser Script

Table 79 lists a summary of the control methods syntax.

Table 79. Control Methods Syntax Summary

Method Description Syntax

Applet Method Returns the parent applet for the var oControl;
control. var oApplet;
oApplet = oControl.Applet();
BusComp Method Returns the corresponding var oControl;
business component for the var busComp;
control. busComp = oControl.Buscomp();

404 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Browser Scripting Supported DOM Events for High Interactivity Mode

Table 79. Control Methods Syntax Summary

Method Description Syntax

GetProperty Returns the value of the property var oControl;

Method of a control. var propVal;
propVal = oControl.GetProperty(
propName);
GetValue Method Returns the value of a control. var oControl;
var sValue;
sValue = oControl.GetValue();
Name Method Returns the name of the control. var oControl;
var sName;
sName = oControl.Name();
SetProperty Sets the visual properties of a var oControl;
Method control. oControl.SetProperty(propName,
propValue);
SetValue Method Sets the contents of the control to var oControl;
the indicated value. oControl.SetValue(value);

Supported DOM Events for High

Interactivity Mode
Table 80 lists the supported Document Object Model (DOM) events for high interactivity mode.

Table 80. Supported DOM Events for High Interactivity Mode

Siebel Control
Control Type Supported Events Comments
Button Native OnFocus None
OnBlur

CheckBox Native OnFocus Rendered as Input

OnBlur Type=CHECKBOX.

Link Native OnFocus Rendered through paired anchor

OnBlur tags or as INPUT TYPE = TEXT in
edit mode.

List Column Native This control does not None

expose any scriptable
events.

Mailto Native OnFocus Rendered as anchor tags with

OnBlur HREF=mailto or as INPUT
TYPE=TEXT in Edit mode.

Siebel Object Interfaces Reference Version 8.1 40 5

 For Oracle internal distribution only
Browser Scripting Supported DOM Events for High Interactivity Mode

Table 80. Supported DOM Events for High Interactivity Mode

Siebel Control
Control Type Supported Events Comments

MiniButton Native OnFocus None

OnBlur

Password Native OnFocus Rendered as Input Type =

OnBlur password.

Text Native OnFocus Rendered as INPUT TYPE = TEXT

OnBlur or as SELECT when attached to a
pick list. If there is a pop-up
window, it renders as an editbox
plus a button.

TextArea Native OnFocus Rendered as TEXTAREA.

OnBlur

Tree Native Tree applets and controls None

do not expose any
scriptable events.

URL Native OnFocus Rendered through paired anchor

OnBlur tags with an HREF = underlying
field value or as INPUT TYPE =
TEXT in edit mode.

NOTE: Siebel objects (business components, applets, and so on) cannot be accessed from DOM
events.

Usually in scripting you can call routines in the General section from anywhere in the object. However
you cannot call routines written in the General section from the DOM events.

To associate a script with the control_OnClick event (high interactivity mode only), use the
Applet_PreInvokeMethod event associated with the applet. For additional information and example,
read Chapter 14, Invoking Custom Methods with MiniButton Controls.

406 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Browser Scripting Supported DOM Events for Standard Interactivity Mode

Supported DOM Events for Standard

Interactivity Mode
Table 81 lists the supported Document Object Model (DOM) events and template modes for standard
interactivity mode.

Table 81. Supported DOM Events and Template Modes for Standard Interactivity Mode

Siebel Control
Control Type Supported Events Comments

Button Native OnFocus (Base/Edit) None

OnBlur (Base/Edit)
OnMouseOut (Base/
Edit)
OnMouseOver (Base/
Edit)

CheckBox Native OnBlur (Base/Edit) In Base mode, a CheckBox appears

OnFocus (Edit) as a Y or N text value.
OnChange (Edit)
In Edit mode, a CheckBox is
OnMouseOut (Edit)
rendered as Input
OnMouseOver(Edit)
Type=CHECKBOX.

Link Native OnFocus (Base/Edit) Rendered through paired anchor

OnBlur (Base/Edit) tags or as INPUT TYPE = TEXT in
OnMouseOut (Base/ Edit mode.
Edit)
OnMouseOver (Base/
Edit)
OnClick (Base/Edit)

List Column Native List Columns currently None

do not expose any
scriptable events.

Mailto Native OnChange (Edit) Rendered as anchor tags with

OnFocus (Base/Edit) HREF=mailto or as INPUT
OnBlur (Base/Edit) TYPE=TEXT in Edit mode.
OnMouseOut (Base/
Edit)
OnMouseOver (Base/
Edit)

Siebel Object Interfaces Reference Version 8.1 40 7

 For Oracle internal distribution only
Browser Scripting Supported DOM Events for Standard Interactivity Mode

Table 81. Supported DOM Events and Template Modes for Standard Interactivity Mode

Siebel Control
Control Type Supported Events Comments

MiniButton Native OnFocus (Base/Edit) None

OnBlur (Base/Edit)
OnMouseOut (Base/
Edit)
OnMouseOver (Base/
Edit)
OnClick (Base/Edit)

Password Native OnChange (Edit) In Edit mode, a Password control is

OnFocus (Edit) rendered as Input type =
OnBlur (Edit) password.
OnMouseOut (Edit)
OnMouseOver (Edit)

Text Native OnChange (Edit) In base mode, a text control is

OnFocus (Edit) rendered as plain text, unless
OnBlur (Edit) there is a pop-up window
OnMouseOut (Edit) associated with it. In Edit mode, a
OnMouseOver (Edit) TEXT control is rendered as INPUT
TYPE = TEXT or as SELECT when
attached to a pick list.

TextArea Native OnChange (Edit) In base mode, a TEXTAREA control

OnFocus (Edit) is rendered as plain text, unless
OnBlur (Edit) there is a pop-up window
OnMouseOut (Base/ associated with it. In Edit mode, a
Edit) TEXTAREA is rendered as INPUT
OnMouseOver (Edit) TYPE = TEXTAREA.

Tree Native At this time, tree None

applets and controls
do not expose any
scriptable events.

URL Native OnChange (Edit) Rendered through paired anchor

OnFocus (Base/Edit) tags with an HREF = underlying
OnBlur (Base/Edit) field value or as INPUT TYPE =
OnMouseOut (Base/ TEXT in Edit mode.
Edit)
OnMouseOver (Base/
Edit)

408 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

13 Siebel eScript Quick Reference

This chapter provides a quick reference for Siebel eScript methods and events. It has the following
topics:

Applet Methods for eScript

WebApplet Events for eScript on page 410

Application Methods for eScript on page 411

Application Events for eScript on page 413

Business Component Methods for eScript on page 414

Business Component Events for eScript on page 418

Business Object Methods for eScript on page 420

Business Service Methods for eScript on page 420

Business Service Events for eScript on page 421

Property Set Methods for eScript on page 422

Miscellaneous Methods for eScript on page 423

NOTE: The ST eScript engine is the default eScript scripting engine in version 8.0. For information
on syntax differences between it and the T engine, see Siebel eScript Language Reference.

Applet Methods for eScript

Table 82 lists a summary of the applet methods syntax.

Table 82. Applet Methods Syntax Summary

Method Description Syntax

BusComp Returns the business component that var applet;

Method is associated with the applet. var myBusComp;
myBusComp = applet.BusComp();
BusObject Returns the business object for the var applet;
Method business component for the applet. var busObject;
busObject = applet.BusObject();

Siebel Object Interfaces Reference Version 8.1 40 9

 For Oracle internal distribution only
Siebel eScript Quick Reference WebApplet Events for eScript

Table 82. Applet Methods Syntax Summary

Method Description Syntax

InvokeMethod Calls an argument-specified var applet;

Method specialized method. applet.InvokeMethod(methodName,
methodArg1, methodArg2, ,
methodArgn);
Name Method Returns the name of the applet. var applet;
var sApplet;
sApplet = applet.Name();

WebApplet Events for eScript

Table 83 lists a summary of the WebApplet events.

Table 83. WebApplet Events Summary

Event Description Syntax

WebApplet_InvokeMethod Event Called after a WebApplet_InvokeMethod(Method

specialized method or a Name);
user-defined method on
the Web applet has
been executed.

WebApplet_Load Event Called just after the WebApplet_Load

Web applet is loaded.

WebApplet_PreCanInvokeMethod Called before the WebApplet_PreCanInvokeMethod(

Event PreInvokeMethod, MethodName, &CanInvoke);
allowing the developer
to determine whether
the user has the
authority to invoke the
applet method.

WebApplet_PreInvokeMethod Event Called before a WebApplet_PreInvokeMethod(Met

specialized method for hodName);
the Web applet is
invoked or a user-
defined method is
invoked through
oWebApplet.InvokeMet
hod.

410 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel eScript Quick Reference Application Methods for eScript

Table 83. WebApplet Events Summary

Event Description Syntax

WebApplet_ShowControl Event Allows scripts to modify WebApplet_ShowControl

the HTML generated by (controlName, property, mode,
the Siebel Web Engine &HTML);
to render a control on a
Web page in a Standard
Activity application.

WebApplet_ShowListColumn Event Allows scripts to modify WebApplet_ShowListColumn

the HTML generated by (columnName, property, mode,
the Siebel Web Engine &HTML);
to render a list column
on a Web page in a
Standard Activity
application.

Application Methods for eScript

Table 84 lists a summary of the application methods syntax.

Table 84 does not include methods that are not invoked directly from an Application object instance.
For information on methods that are called with InvokeMethod on the Application object, see
InvokeMethod Methods for the Application Object on page 139.

Table 84. Application Methods Syntax Summary

Method Description Syntax

ActiveBusObject Returns the business object for var busObject;

Method the business component for the busObject =
active applet. TheApplication().ActiveBusObject();

ActiveViewName Returns the name of the active var sView;

Method view. sView =
TheApplication().ActiveViewName();
CurrencyCode Returns the three-letter var sCur;
Method operating currency code. sCur =
TheApplication().CurrencyCode();
GetBusObject Instantiates and returns a new var myBusObject;
Method instance of the business object myBusObject =
specified in the argument. TheApplication().GetBusObject(
BusObjectName);
Name Method Returns the name of the var name;
application. name = TheApplication().Name();

Siebel Object Interfaces Reference Version 8.1 41 1

 For Oracle internal distribution only
Siebel eScript Quick Reference Application Methods for eScript

Table 84. Application Methods Syntax Summary

Method Description Syntax

GetService Method Instantiates and returns a new var Service;

instance of the service specified Service =
in the argument. TheApplication().GetService(serviceN
ame);
GetSharedGlobal Gets the shared user-defined var sName;
Method global variables. sName =
TheApplication().GetSharedGlobal(var
Name);
GotoView Method Activates the named view and TheApplication().GotoView(
its business object. viewName,[BusinessObject]);
InvokeMethod Calls the named specialized TheApplication().InvokeMethod(
Method method. methodName, methodArg1,
methodArg2,..., methodArgn);
LoginId Method Returns the login ID of the user var sID;
who started the Siebel sID = TheApplication().LoginId();
application.

LoginName Method Returns the login name of the var sUser;

user who started Oracles Siebel sUser =
application. TheApplication().LoginName();

NewPropertySet Constructs and returns a new var oPropSet;

Method property set object. oPropSet =
TheApplication().NewPropertySet();
PositionId Method Returns the position ID that var sRow;
describes the users current sRow =
position. TheApplication().PositionId();

PositionName Returns the position name of var sPosition;

Method the users current position. sPosition =
TheApplication().PositionName();
RaiseError Method Raises a scripting error message var keyVal;
to the browser. The error code is var arg1 ...;
a canonical number. TheApplication().RaiseError(keyVal,
arg1, );
RaiseErrorText Raises a scripting error message var message;
Method to the browser. The error text is TheApplication().RaiseErrorText(mess
the specified literal string. age);

SetPositionId Sets the active position to the var success;

Method position ID specified in the success =
argument. TheApplication().SetPositionId(posId
);

412 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel eScript Quick Reference Application Events for eScript

Table 84. Application Methods Syntax Summary

Method Description Syntax

SetPositionName Sets the active position to the var success;

Method position name specified in the success =
argument. Returns a Boolean TheApplication().SetPositionName(pos
value indicating whether the Name);
method succeeded.

SetProfileAttr Used in personalization to TheApplication().SetProfileAttr(name

Method assign values to attributes in a , value);
user profile.

SetSharedGlobal Sets a shared user-defined TheApplication().SetSharedGlobal(var

Method global variable. Name, value);
Trace Method Appends a message to the trace TheApplication().Trace(message);
file.

TraceOff Method Turns off the tracing started by TheApplication().TraceOff();

TraceOn.

TraceOn Method Turns tracing on. TheApplication().TraceOn(filename,

type, selection);

Application Events for eScript

Table 85 lists a summary of the application events.

Table 85. Application Events Syntax Summary

Event Description Syntax

Application_Close Event Called before the Application_Close();
application exits.

Application_InvokeMethod Called after a Application_InvokeMethod(methodNa

Event specialized method is me);
invoked.

Application_Navigate Event Called after the client Application_Navigate()

has navigated to a view.

Application_PreInvokeMethod Called before a Application_PreInvokeMethod(metho

Event specialized method is dName);
invoked.

Application_PreNavigate Event Called before the client Application_PreNavigate

has navigated from one (DestViewName, DestBusObjName)
view to the next.

Application_Start Event Called when the client Application_Start(commandLine);

starts.

Siebel Object Interfaces Reference Version 8.1 41 3

 For Oracle internal distribution only
Siebel eScript Quick Reference Business Component Methods for eScript

Business Component Methods for

eScript
Table 86 lists a summary of the business component methods syntax.

Table 86 does not include methods that are not invoked directly from a Business Component object
instance. For information on methods that are called with InvokeMethod on the Business Component
object, see InvokeMethod Methods for the Business Component Object on page 213.

Table 86. Business Component Methods Syntax Summary

Method Description Syntax

ActivateField Method Allows queries to retrieve var myBusComp;

data for the specified myBusComp.ActivateField(fieldName);
field.

ActivateMultipleFields Allows queries to retrieve var myBusComp;

Method data for the fields myBusComp.ActivateMultipleFields(oPr
specified in the property opSet);
set.

Associate Method Creates a new many-to- var myBusComp;

many relationship for the myBusComp.Associate(whereIndicator);
parent object through an
association business
component.

BusObject Method Returns the business var myBusComp;

object that contains the var busObject;
business component. busObject = myBusComp.BusObject();

ClearToQuery Method Clears the current query var myBusComp;

and sort specifications on myBusComp.ClearToQuery();
the business component.

DeactivateFields Method Deactivates every var myBusComp;

currently activated field. myBusComp.DeactivateFields();

DeleteRecord Method Removes the current var myBusComp;

record from the business myBusComp.DeleteRecord();
component.

ExecuteQuery Method Retrieves a set of var myBusComp;

BusComp records. myBusComp.ExecuteQuery(cursorMode);

ExecuteQuery2 Method Retrieves a set of var myBusComp;

BusComp records. myBusComp.ExecuteQuery2(cursorMode,
ignoreMaxCursorSize);
FirstRecord Method Moves to the first record var myBusComp;
in the business var bIsRecord;
component. bIsRecord = myBusComp.FirstRecord();

414 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel eScript Quick Reference Business Component Methods for eScript

Table 86. Business Component Methods Syntax Summary

Method Description Syntax

FirstSelected Method Moves to the first record var myBusComp;

of the multiple selection in var bIsMultipleSelection;
the business component. bIsMultipleSelection =
myBusComp.FirstSelected();
GetAssocBusComp Returns the association var myBusComp;
Method business component. var AssocBusComp;
AssocBusComp =
myBusComp.GetAssocBusComp();
GetFieldValue Method Returns a value for the var myBusComp;
field specified in the var sValue;
argument. sValue =
myBusComp.GetFieldValue(FieldName);
GetFormattedFieldValue Returns a formatted value var myBusComp;
Method for the field specified in var sValue;
the argument. sValue =
myBusComp.GetFormattedFieldValue(Fie
ldName);
GetMultipleFieldValues Returns a value for the var myBusComp;
Method fields specified in the myBusComp.GetMultipleFieldValues(oFi
property set. elds, oValues );

GetMVGBusComp Method Returns the MVG business var myBusComp;

component associated var MvgBusComp;
with the field specified in MvgBusComp=
the argument. myBusComp.GetMVGBusComp(FieldName);

GetNamedSearch Method Returns the named search var myBusComp;

specification specified in var sValue;
the argument. sValue =
myBusComp.GetNamedSearch(SearchName)
;
GetPicklistBusComp Returns the pick business var myBusComp;
Method component associated var pickBusComp;
with the field specified in pickBusComp =
the argument. myBusComp.GetPicklistBusComp(FieldNa
me);
GetSearchExpr Method Returns the current var myBusComp;
search expression. var sExpr;
sExpr = myBusComp.GetSearchExpr();
GetSearchSpec Method Returns the current var myBusComp;
search specification for var sSpec;
the field specified in the sSpec =
argument. myBusComp.GetSearchSpec(FieldName);

Siebel Object Interfaces Reference Version 8.1 41 5

 For Oracle internal distribution only
Siebel eScript Quick Reference Business Component Methods for eScript

Table 86. Business Component Methods Syntax Summary

Method Description Syntax

GetSortSpec Method Returns the active sort var sSortSpec:chars =

specification of the object this.GetSortSpec();
that has context.

GetUserProperty Method Returns the value for a var myBusComp;

property name specified var sValue;
in the argument. sValue =
myBusComp.GetUserProperty(propertyNa
me);
GetViewMode Method Returns the visibility var myBusComp;
mode for the business var iMode;
component. iMode = myBusComp.GetViewMode();

InvokeMethod Method Calls the specialized var myBusComp;

method named in the var sReturn;
argument. sReturn =
myBusComp.InvokeMethod(methodName,
methodArg1, methodArg2,...,
methodArgn);
LastRecord Method Moves to the last record in var myBusComp;
the business component. var iReturn;
iReturn = myBusComp.LastRecord();
Name Method Returns the name of the var myBusComp;
business component. var sName;
sName = myBusComp.Name();
NewRecord Method Adds a new record to the var myBusComp;
business component. myBusComp.NewRecord(whereIndicator);

NextRecord Method Moves to the next record var myBusComp;

in the business var bFound;
component. bFound = myBusComp.NextRecord();

NextSelected Method Moves to the next record var myBusComp;

of the current multiple var iReturn;
selection. iReturn = myBusComp.NextSelected();

ParentBusComp Method Returns the parent var myBusComp;

business component. var parentBusComp;
parentBusComp =
myBusComp.ParentBusComp();
Pick Method Places the currently var myBusComp;
selected record in a myBusComp.Pick();
picklist business
component into the
appropriate fields of the
parent business
component.

416 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel eScript Quick Reference Business Component Methods for eScript

Table 86. Business Component Methods Syntax Summary

Method Description Syntax

PreviousRecord Method Moves to the previous var myBusComp;

record in the business var iReturn;
component. iReturn = myBusComp.PreviousRecord();

RefineQuery Method Refines a query after a var myBusComp;

query has been executed. myBusComp.RefineQuery();

SetFieldValue Method Assigns a new value to the var myBusComp;

named field for the myBusComp.SetFieldValue(FieldName,
current row of the FieldValue);
business component.

SetFormattedFieldValue Accepts the field value in var myBusComp;

Method the current local format myBusComp.SetFormattedFieldValue(Fie
and assigns the new value ldName, FieldValue);
to the named field for the
current row of the
business component.

SetMultipleFieldValues Assigns a new value to the var myBusComp;

Method fields specified in the myBusComp.SetMultipleFieldValues(oPr
property set for the opSet);
current row of the
business component.

SetNamedSearch Method Sets a named search var myBusComp;

specification on the myBusComp.SetNamedSearch(searchName,
business component. searchSpec);

SetSearchExpr Method Sets the search var myBusComp;

specification for the myBusComp.SetSearchExpr(searchSpec);
business component.

SetSearchSpec Method Sets the search var myBusComp;

specification for the myBusComp.SetSearchSpec(FieldName,
specified field. searchSpec);

SetSortSpec Method Sets the sort specification var myBusComp;

for a query. myBusComp.SetSortSpec(sortSpec);

SetUserProperty Method Sets the value of the var myBusComp;

specified User Property. myBusComp.SetUserProperty(propertyNa
me, newValue);
SetViewMode Method Sets the visibility type for var myBusComp;
the business component. myBusComp.SetViewMode(viewMode);

Siebel Object Interfaces Reference Version 8.1 41 7

 For Oracle internal distribution only
Siebel eScript Quick Reference Business Component Events for eScript

Table 86. Business Component Methods Syntax Summary

Method Description Syntax

UndoRecord Method Reverses any var myBusComp;

uncommitted changes myBusComp.UndoRecord();
made to the record.

WriteRecord Method Commits to the database var myBusComp;

any changes made to the myBusComp.WriteRecord();
current record.

Business Component Events for eScript

Table 87 lists a summary of the business component events.

Table 87. Business Component Events Syntax Summary

Event Description Syntax

BusComp_Associate Event Called after a record is BusComp_Associate();

added to a business
component to create an
association.

BusComp_ChangeRecord Called after the current BusComp_ChangeRecord();

Event row changes in the
business component.

BusComp_CopyRecord Event Called after a new row is BusComp_CopyRecord();

copied in the business
component.

BusComp_DeleteRecord Event Called after a row is BusComp_DeleteRecord();

deleted in the business
component.

BusComp_InvokeMethod Called after a specialized BusComp_InvokeMethod(methodName)

Event method is invoked in the ;
business component.

BusComp_NewRecord Event Called after a new row has BusComp_NewRecord();

been created and made
active in the business
component.

BusComp_PreAssociate Event Called before a record is BusComp_PreAssociate();

added to a business
component to create an
association.

418 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel eScript Quick Reference Business Component Events for eScript

Table 87. Business Component Events Syntax Summary

Event Description Syntax

BusComp_PreCopyRecord Called before a new row is BusComp_PreCopyRecord();

Event copied in the business
component.

BusComp_PreDeleteRecord Called before a row is BusComp_PreDeleteRecord();

Event deleted in the business
component.

BusComp_PreGetFieldValue Called when the value of BusComp_PreGetFieldValue(FieldNa

Event the business component me, &FieldValue);
field is accessed.

BusComp_PreInvokeMethod Called before a specialized BusComp_PreInvokeMethod(methodNa

Event method is invoked on a me);
business component.

BusComp_PreNewRecord Called before a new row is BusComp_PreNewRecord();

Event created in the business
component.

BusComp_PreQuery Event Called before query BusComp_PreQuery();

execution.

BusComp_PreSetFieldValue Called before a value is BusComp_PreSetFieldValue(FieldNa

Event pushed down into the me, FieldValue);
business component from
the user interface.

BusComp_PreWriteRecord Called before a row is BusComp_PreWriteRecord();

Event written out to the
database.

BusComp_Query Event Called after the query is BusComp_Query();

complete and every row
has been retrieved, but
before they have been
displayed.

BusComp_SetFieldValue Event Called after a value has BusComp_SetFieldValue(FieldName)

been pushed down into ;
the business component
from the user interface.

BusComp_WriteRecord Event Called after a row is BusComp_WriteRecord();

written to the database.

Siebel Object Interfaces Reference Version 8.1 41 9

 For Oracle internal distribution only
Siebel eScript Quick Reference Business Object Methods for eScript

Business Object Methods for eScript

Table 88 lists a summary of the business object methods syntax.

Table 88. Business Object Methods Syntax Summary

Method Description Syntax

GetBusComp Returns the specified business var myBusObject;

Method component. var myBusComp;
myBusComp =
myBusObject.GetBusComp(BusCompName);
Name Method Returns the name of the var myBusObject as BusObject;
business object. var sName;
sName = myBusObject.Name();

Business Service Methods for eScript

Table 89 lists a summary of the business service methods syntax.

Table 89. Business Service Methods Syntax Summary

Method Description Syntax

GetFirstProperty Retrieves the name of the first var oService;

Method property of a business service. var sName;sName =
oService.GetFirstProperty();
GetNextProperty After the name of the first var oService;
Method property has been retrieved, var sName;
retrieves the name of the next sName = oService.GetNextProperty();
property of a business service.

GetProperty Retrieves the value stored in the var oService;

Method specified property. var sValue;
sValue =
oService.GetProperty(propName);
Name Method Returns the name of the business var oService;
service. var sName;
sName = oService.Name();
InvokeMethod Calls a specialized method or a var oService;
Method user-created method on the oService.InvokeMethod(methodName,
business service. InputArguments, OutputArguments);

PropertyExists Returns a Boolean value indicating var oService;

Method whether the property specified in var propExists;
the argument exists. propExists =
oService.PropertyExists( propName);

420 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel eScript Quick Reference Business Service Events for eScript

Table 89. Business Service Methods Syntax Summary

Method Description Syntax

RemoveProperty Removes a property from a var oService;

Method business service. oService.RemoveProperty(propName);

SetProperty Method Assigns a value to a property of a var oService;

business service oService.SetProperty(propName,
propValue);

Business Service Events for eScript

Table 90 lists a summary of the business service events.

Table 90. Business Service Events Syntax Summary

Method Description Syntax

Service_InvokeMethod Event Called after a method is Service_InvokeMethod(methodName

invoked in a business );
service.

Service_PreCanInvokeMethod Called before the Service_PreCanInvokeMethod

Event PreInvokeMethod, (MethodName, &CanInvoke)
allowing the developer to
determine whether or not
the user has the authority
to invoke the business
service method.

Service_PreInvokeMethod Event Called before a Service_PreInvokeMethod(methodN

specialized method is ame, Inputs, Outputs);
invoked on a business
service.

Siebel Object Interfaces Reference Version 8.1 42 1

 For Oracle internal distribution only
Siebel eScript Quick Reference Property Set Methods for eScript

Property Set Methods for eScript

Table 91 lists a summary of the property set methods syntax.

Table 91. Property Set Methods Syntax Summary

Method Description Syntax

AddChild Method Adds subsidiary property sets to var oPropSet;

a property set. var iIndex;
iIndex = oPropSet.AddChild(
childObject);
Copy Method Returns a copy of a property set. var oPropSet1;
var oPropSet2;
oPropSet2 = oPropSet1.Copy();
GetChild Method Returns a specified child var oPropSet;
property set of a property set. var sPropVal;
sPropVal =
oPropSet.GetChild(index);
GetChildCount Returns the number of child var oPropSet;
Method property sets attached to a var iCount;
parent property set. iCount = oPropSet.GetChildCount();

GetFirstProperty Returns the name of the first var oPropSet;

Method property in a property set. var sPropName;
sPropName =
oPropSet.GetFirstProperty();
GetNextProperty Returns the name of the next var oPropSet;
Method property in a property set. var sPropName
sPropName =
oPropSet.GetNextProperty();
GetProperty Method Returns the value of a property var oPropSet;
when given the property name. var sPropVal
sPropVal =
oPropSet.GetProperty(propName);
GetPropertyCount Returns the number of var count;
Method properties attached to a property count =
set. oPropSet.GetPropertyCount();

GetType Method Returns the value stored in a var oPropSet;

type in a property set. var sTypeVal
sTypeVal = oPropSet.GetType(value);
GetValue Method Returns a value stored as part of var oPropSet;
a property set. var sValVal;
sValVal = oPropSet.GetValue(value);
InsertChildAt Method Inserts a child property set into a var oPropSet;
parent property set at a specific oPropSet.InsertChildAt(childObject,
location. index);

422 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Siebel eScript Quick Reference Miscellaneous Methods for eScript

Table 91. Property Set Methods Syntax Summary

Method Description Syntax

PropertyExists Returns a Boolean value Dim oService as SiebelService

Method indicating whether the property Dim propExists as Boolean
specified in the argument exists. propExists =
oService.PropertyExists(propName as
String)
RemoveChild Method Removes a child property set as var oPropSet;
a specified index from a parent oPropSet.RemoveChild(index);
property set.

RemoveProperty Removes the property specified var oPropSet;

Method in its argument from a property oPropSet.RemoveProperty(propName);
set.

Reset Method Removes every property and var oPropSet;

child property set from a oPropSet.Reset();
property set.

SetProperty Method Assigns a value to the property var oPropSet;

of a property set specified in its oPropSet.SetProperty (propName,
argument. propValue);

SetType Method Assigns a data value to a type var oPropSet;

member of a property set. oPropSet.SetType(value);

SetValue Method Assigns a data value to a value var oPropSet;

member of a property set. oPropSet.SetValue(value);

ToString Method Converts the value of a property var oPropSet;

set to a string. oPropSet.toString();

Miscellaneous Methods for eScript

Table 92 lists a summary of the miscellaneous methods syntax.

Table 92. Miscellaneous Methods Syntax Summary

Method Description Syntax

TheApplication Global method that returns the TheApplication().Application_

Method unique object of type Application. method;

Siebel Object Interfaces Reference Version 8.1 42 3

 For Oracle internal distribution only
Siebel eScript Quick Reference Miscellaneous Methods for eScript

424 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

14 Invoking Custom Methods with

MiniButton Controls

This chapter provides a procedure to invoke a custom method with a MiniButton control.

Invoking Custom Methods with

MiniButton Controls
Be sure to set the appropriate Target Browser Group in Siebel Tools.

To invoke a custom method with a MiniButton control

1 Choose an applet (for example, Account List Applet) and create a control with the following
properties:

Name = ButtonTest
Caption = Test
HTML Type = MiniButton
Method Invoked = MyTest

2 Right click the applet and choose Edit Web Layout.

The Web Layout Editor appears. The Controls/Columns window opens with the available controls,
including the one you just created.

3 Change the template mode in the Controls/Columns window to 4: Edit List.

4 Drag and drop the ButtonTest control onto an available location. When you release the mouse
button, the button appears.

5 Click Save, and then close the Web Layout Editor.

6 Enable the button using one of the following:

To add a server script to the applet, right-click the applet and choose Edit Server Scripts. Add
the following script to the WebApplet_PreCanInvokeMethod() function.

function WebApplet_PreCanInvokeMethod (MethodName, &CanInvoke)

if (MethodName == "MyTest")

CanInvoke = "TRUE";

return(CancelOperation);

Siebel Object Interfaces Reference Version 8.1 42 5

 For Oracle internal distribution only
Invoking Custom Methods with MiniButton Controls Invoking Custom Methods with
MiniButton Controls

return(ContinueOperation);

To enable the button declaratively, select the applet in the Object List Editor, expand the
Applet object in the Object Explorer, select the Applet User Prop object, and then create a
new user property for the applet in the Object List Editor:

Name Value

CanInvokeMethod: MyTest TRUE

For more information on the CanInvokeMethod user property, see Siebel Developers
Reference.

7 Add the following browser script to the applet you are using (for example, the Account List
Applet):

function Applet_PreInvokeMethod (name, inputPropSet)

{

switch (name) {

case "MyTest":

alert("Browser script!");

return("CancelOperation");

break;

return("ContinueOperation");

8 Compile the applet object by right-clicking on it and then choosing Compile Selected Objects.

9 Run any application that has access to accounts, and navigate to My Accounts.

The new button appears.

10 Click Test.
The Browser Script displays an alert box indicating Browser Script!

426 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only

Index

A Applet_PreInvokeMethod event, about 104

ActivateField business component method, applets
about 179 ActiveApplet. about returning reference to
ActivateMultipleFields business component currently focused applet 116
method, about 181 applet methods syntax summary (Browser
ActiveApplet application method, about 116 Script), table of 396
ActiveBusObject application method, applet methods syntax summary (eScript),
about 118 table of 409
ActiveMode applet method, about 92 applet methods syntax summary (Siebel VB),
ActiveViewName application method, about table of 377
returning name of active view 120 Browser or Server script, adding to applet 36
ActiveX control, about using Login events, about and list of 70
method 145 FindApplet, about returning applet identified
AddChild property set method, about 297, by argument 127
298 object type, described 36
allocations, about using TraceOn application parent applet object, about returning for
method to track 168 control 288
applet events WebApplet events summary (Siebel VB), table
Applet_ChangeFieldValue, about 99 of 378
Applet_ChangeRecord even, about 101 WebApplet events summary, table of
Applet_InvokeMethod, about 101 (eScript), table of 410
Applet_Load, about 103 WebApplet events syntax summary (Browser
Applet_PreInvokeMethod, about 104 Script), table of 397
object interface events, table of 89 application events
WebApplet_InvokeMethod, about 105 about and list of 71
WebApplet_Load applet event 106 Application_Close event, about 172
WebApplet_Load, about 103 Application_InvokeMethod, about 172
WebApplet_PreCanInvokeMethod, Application_Navigate, about 173
about 108 Application_PreNavigate, about 175
WebApplet_PreInvokeMethod, about 109 Application_Start, about 176
WebApplet_ShowControl 110 PreInvokeMethod, about 173
WebApplet_ShowListColumn, about 112 syntax summary, table of (eScript) 413
applet methods table of object interface events 90
ActiveMode, about 92 application methods
BusComp, about 93 ActiveApplet, about 116
BusObject, about 93 ActiveBusComp, about returning business
Find control, about 95 component associated with 117
FindActiveXControl, about 94 ActiveBusObject, about 118
InvokeMethod, about 96 ActiveViewName, about returning name of
Name, about 98 active view 120
syntax summary (Browser Script), table Attach, about 121
of 396 CurrencyCode, about 123
syntax summary (eScript), table of 409 Detach, about 124
Applet_ChangeFieldValue event, about 99 EnableExceptions, about 125
Applet_ChangeRecord event, about 101 FindApplet, about 127
Applet_InvokeMethod event, about 101 GetBusObject, about 127
Applet_Load event, about 103 GetDataSource, InvokeMethod method 139

Siebel Object Interfaces Reference Version 8.1 42 7

 For Oracle internal distribution only
Index B

GetLastErrCode, about 129 application methods syntax summary (COM

GetLastErrText, about 130 data control), table 327
GetProfileAttr, about 131 application methods syntax summary (COM
GetService, about 131 data server), table 339
GetSharedGlobal, about 134 application methods syntax summary
GotoView, about 135 (eScript), table of 411
InvokeMethod, about 138 application methods syntax summary (Mobile
IsViewReadOnly, InvokeMethod method 140 Web client), table 351
Language, InvokeMethod method 141 events summary (Siebel VB), table of 382
LoadObjects, about 143 methods syntax summary (Browser Script),
LoadUserAttributes, about using to load user table of 397
profile 144 registering business services in Siebel
Login. about 145 Tools 132
LoginID, about 147 association business component
LoginName, about 147 Associate, about creating many-to-many
Logoff, about 148 relationship 182
LookupMessage, about 149 BusComp_Associate, about calling after
LookupValue, InvokeMethod method 141 record added to create
Name, about 150 association 251
NewPropertySet, about 150 GetAssocBusComp, returning association
PositionID, about 152 business component 196
PositionName, about 153 Attach application method, about 121
RaiseError, about 154
RaiseErrorText, about 155 B
SetPositionID, about 157 Browser Script
SetPositionName, about 158 about 16
SetProfileAttr, about 158 applet methods syntax summary, table 396
SetSharedGlobal, about 160 application methods syntax summary,
syntax summary (COM data control), table 397
table 327 business component methods syntax
syntax summary (COM data server), summary, table 399
table 339 business object methods syntax summary,
syntax summary, table of (eScript) 411 table 401
Trace, about 165 business service events syntax summary,
TraceOff, about 167 table 402
TraceOn, about 168 business service methods syntax summary,
application object type table 401
described 34 Control methods syntax summary, table 404
unique object type, about using to property set methods syntax summary,
return 317 table 403
Application_Close event, about 172 WebApplet events syntax summary,
Application_InvokeMethod application table 397
event, about 172 Browser, adding to applet 36
Application_Navigate application event, BusComp
about 173 applet method, about 93
Application_PreNavigate application event, control method, about 289
about 175 ExecuteQuery, about return record using
Application_Start application event, method 190
about 176 ExecuteQuery2, about returning records using
applications method 192
application events syntax summary (eScript), object interface events, table of 90
table of 413 BusComp_Associate business component
application methods summary (Siebel VB), event, about 251
table of 379

428 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Index B

BusComp_ChangeRecord business BusComp_WriteRecord, about 266

component event, about 252 syntax summary, table of (eScript) 418
BusComp_CopyRecord business component business component methods
event, about 253 ActivateField, about 179
BusComp_DeleteRecord business ActivateMultipleFields, about 181
component event, about 254 Associate, about 182
BusComp_InvokeMethod business BusObject, about 184
component event, about 255 ClearLOVCache, InvokeMethod method 214
BusComp_NewRecord business component ClearToQuery, about 185
event, about 255 CreateFile, InvokeMethod method 215
BusComp_PreAssociate business component DeactivateFields, about 187
event, about 256 DeleteRecord, about 189
BusComp_PreCopyRecord business ExecuteQuery, about 190
component event, about 256 ExecuteQuery2, about 192
BusComp_PreDeleteRecord business FirstRecord, about 192
component event, about 257 FirstSelected, about 194
BusComp_PreGetFieldValue business GenerateProposal, InvokeMethod
component event, about 258 method 216
BusComp_PreInvokeMethod business GetAssocBusComp, about 196
component event, about 259 GetFieldValue, about 197
BusComp_PreNewRecord business GetFile, InvokeMethod method 216
component event, about 260 GetFormattedFieldValue, about 199
BusComp_PreQuery business component GetLasErrCode, about 201
event, about 260 GetLastErrText, about 202
BusComp_PreSetFieldValue business GetMultipleFieldValues, about 203
component event, about 261 GetMVGBusComp, about 203
BusComp_PreWriteRecord business GetNamedSearch, about 205
component event, about 263 GetPicklistBusComp, about 205
BusComp_Query business component event, GetSearchExpr, about 207
about 264 GetSearchSpec, about 208
BusComp_SetFieldValue business GetSortSpec, about 209
component event, about 265 GetUserProperty, about 209
BusComp_WriteRecord business component InvokeMethod, about 211
event, about 266 LastRecord, about 219
business active application associated Name, about 220
with 117 NewRecord, about 221
business component events NextRecord, about 222
BusComp_Associate, about 251 NextSelected, about 223
BusComp_ChangeRecord, about 252 ParentBusComp, about 224
BusComp_CopyRecord, about 253 Pick, about 224
BusComp_DeleteRecord, about 254 PreviousRecord, about 226
BusComp_InvokeMethod, about 255 PutFile, InvokeMethod method 217
BusComp_NewRecod, about 255 RefineQuery, about 227
BusComp_PreAssociate, about 256 RefreshBusComp, InvokeMethod
BusComp_PreCopyRecord, about 256 method 218
BusComp_PreDeleteRecord, about 257 RefreshRecord, InvokeMethod method 218
BusComp_PreGetFieldValue, about 258 Release, about 228
BusComp_PreInvokeMethod, about 259 SetAdminMode, InvokeMethod method 219
BusComp_PreNewRecord, about 260 SetFieldValue, about 230
BusComp_PreQuery, about 260 SetFormattedFieldValue, about 232
BusComp_PreSetFieldValue, about 261 SetMultipleFieldValues, about 233
BusComp_PreWriteRecord, about 263 SetNamedSearch, about 235
BusComp_Query, about 264 SetSearchExpr, about 237
BusComp_SetFieldValue, about 265 SetSearchSpec, about 238

Siebel Object Interfaces Reference Version 8.1 42 9

 For Oracle internal distribution only
Index B

SetSortSpec, about 242 table 334

SetUserProperty, about 244 syntax summary (COM data server),
SetViewMode, about 245 table 346
syntax summary (COM data control), table of 85
table 330 business objects
syntax summary (COM data server), active applet, about returning for business
table 342 component 118
UndoRecord, about 249 business object methods syntax summary
WriteRecord, about 249 (COM data control), table 334
business components business object methods syntax summary
about 55 (COM data server), table 346
applet, associated with 93 business object methods syntax summary
BusComp method, about returning for the (eScript), table of 420
control 289 business object methods syntax summary
BusComp object, logical flow of (Siebel VB), table of 389
instantiating 56 BusObject, about returning business object
business component events summary (Siebel for applet 93
VB), table of 387 BusObject, about returning business object
business component events syntax summary that contains business
(eScript), table of 418 component 184
business component methods syntax methods syntax summary (Browser Script),
summary (COM data control), table of 401
table 330 methods syntax summary (Mobile Web
business component methods syntax client), table 358
summary (COM data server), Name, about using to return name of business
table 342 object 270
business component methods syntax object type, described 34
summary (eScript), table of 414 business rules
business component methods syntax business component, adding to 18
summary (Siebel VB), table of 382 described 17
business rules, adding to 18 business service events
database, committing records to 55 Service_InvokeMethod, about 281
GetBusComp, about returning for a business Service_PreCanInvokeMethod, about 284
component 267 Service_PreInvokeMethod, about 284
methods for accessing, list of 58 syntax summary, table of (eScript) 421
methods syntax summary (Browser Script), business service methods
table of 399 GetFirstProperty, about 271
methods syntax summary (mobile Web GetLastErrCode, about 303
client), table 354 GetLastErrText, about 304
methods syntax summary, table of GetNextProperty, about 273
(eScript) 414 GetProperty, about 275
name property, returning 220 InvokeMethod, about 275
object type, described 35 Name, about 277
records, adding and inserting 55 PropertyExists, about 277
scenarios 56 Release, about 278
SiebelBusComp methods syntax summary RemoveProperty, about 279
(Java), table of 365 SetProperty, about 280
business object methods syntax summary (COM data control),
GetBusComp, about 267 table 334, 335
GetLastErrCode, about 268 syntax summary (COM data server),
GetLastErrText, about 269 table 347
Name, about 270 syntax summary, table of (eScript) 420
Release, about 270 business service object type, described 35
syntax summary (COM data control), business services

430 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Index C

business service events syntax summary business service methods syntax summary
(eScript), table of 421 (table) 334, 335
business service events syntax summary installation, about 33
(Siebel VB), table of 390 load balancing with 73
business service methods syntax summary property set methods syntax summary
(COM data control), table 334, 335 (table) 335
business service methods syntax summary COM data server
(COM data server), table 347 application methods syntax summary
business service methods syntax summary (table) 339
(eScript), table of 420 business component methods syntax
business service methods syntax summary summary (table) 342
(Siebel VB), table of 389 business object methods syntax summary
events syntax summary (Browser Script), (table) 346
table of 402 business service methods syntax summary
methods syntax summary (Browser Script), (table) 347
table of 401 installation, about 33
methods syntax summary (mobile Web interface method, about COM error
client), table 359 handling 74
object interface events, table of 91 LoadObjects method, about using to start
object interface methods, table of 85 object and return reference 143
registering in Siebel Tools 132 property set methods syntax summary
retrieving property names 273 (table) 348
SetProperty, about assigning values to COM error handling, about and methods 74
members of 280 COM interfaces
SiebelService methods syntax summary Siebel COM client in C++, building 319
(Java), table of 369 Siebel COM client in C++, testing
BusObject program 325
applet method, about 93 comparison operators, using in search
business component method, about 184 expressions 240
connect string
C about, syntax, and example 71
C++ leveraging load balancing with 73
Siebel COM Server, building in 319 Siebel Server, substitutions when logging into
Siebel COM Server, testing program 325 (table) 72
CanInvokeMethod applet user property, constants, table of 91
using instead of control methods
PreCanInvokeMethod applet Applet method, about returning parent applet
event 108, 426 object 288
ChangeFieldValue, about 99 BusComp, about 289
ChangeRecord event, about 101 GetProperty, about 289
ClearLOVCache business component GetValue, about returning control value 290
method, about 214 Name, about returning object name 291
ClearToQuery business component method, SetProperty, about 291, 293
about 185 SetValue, about using to set contents of the
coding, caution, about and using Siebel control 294
Tools 15 syntax summary, table of (Browser Script),
COM data control table of 404
application methods syntax summary controls
(table) 327 FindControl, about argument specified in 95
business component methods syntax GetProperty, returning values of control
summary (table) 330 properties 289
business object methods syntax summary GetValue, returning value of control 290
(table) 334 object interface methods, table of 86
SetLabelProperty, assigning values to control

Siebel Object Interfaces Reference Version 8.1 43 1

 For Oracle internal distribution only
Index D

properties 291 error handling

SetProperty, assigning values to control See also individual Siebel object interface
properties 293 entries
SetValue, using to set the contents of the COM error handling, about and examples 74
control 294 error message tracking 75
Copy property set method, about 298 native COM error handling, enabling and
copying records, using NewRecord disabling 125
method 221 error messages
CreateFile business component method, business component methods, about using
about 215 GetLastErrText 202
CurrencyCode application method, business object methods, about using
about 123 GetLastErrText 269
custom methods, invoking with MiniButton business service methods, about using
controls 425 GetLastErrText 304
function_name Is An Unknown Function,
D about and correcting 21
data bean. See Java Data Bean, GetErrorMessage, about using with Java Data
SiebelDataBean, individual Siebel Bean to display message 317
Java entries 363 GetLastErrText, about returning last text error
data value message 130
SetProperty, about using to assign value event method syntax 63
to 313 events, object interface events, table of 89
SetType, about using to assign data value of ExecuteQuery business component method,
type to property set 313 about 190
database, about using WriteRecord to ExecuteQuery2 business component
commit to database 249 method, about 192
DeactivateFields business component exposed object types, table of 37
method, about 187 external applications
deallocations, using TraceOn application logging in 145
method to track 168
debug tracings methods, table of 63 F
DeleteRecord business component method, field value, method of retuning in the current
about 189 local format 199
Detach application method, about 124 FindActiveXControl applet method,
about 94
E FindApplet application method, about 127
EnableExceptions application method, FindControl applet method, about 95
about 125 FirstRecord business component method,
error code about 192
application methods, about using FirstSelected business component method,
GetLastErrCode to return last error about 194
code 129
business component methods, about using G
GetLastErrCode to return most GenerateProposal business component
recent 201 method, about 216
business object methods, about using GetAssocBusComp business component
GetLastErrCode to return last error method, about 196
code 268 GetBusComp business object method,
business service methods, about using about 267
GetLastErrCode to return most GetBusObject application method,
recent 303 about 127
GetErrorCode, about using with Java Data GetByteValue property set method 299
Bean to display numeric code 315 GetChild property set method, about 300

432 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Index H

GetChildCount property set method, about 134

about 302 GetSortSpec business component method,
GetDataSource application method, about 209
about 139 GetType property set method 307
GetErrorCode method, about 315 GetUserProperty business component
GetErrorMessage method, about using to method, about 209
display error messages 317 GetValue
GetFieldValue business component method, control method, about 290
about 197 property set method, about 308
GetFile business component method, global state, properties and functions 60
about 216 global variables
GetFirstProperty about and VB example 62
business service method, about 271 GetSharedGlobal application method,
property set method, about 302 about 134
GetFormattedFieldValue business GotoView application method, about 135
component method, about 199
GetLastErrCode H
application method, about 129 high interactivity mode, about running
business component method, about 201 Browser scripts 395
business object method, about 268
business service method, about 303
GetLastErrText I
application method, about 130 InsertChildAt property set method,
business component method, about 202 about 308
business object method, about 269 installation procedures, object
business service method, about 304 interfaces 33
note, about availability to interfaces 23 inter-application variable methods, table
GetMultipleFieldValues business component of 63
method, about 203 interface methods, table grouped by object
GetMVGBusComp business component interface type 77
method, about 203 InvokeMethod
GetNamedSearch business component applet method, about 96
method, about 205 Applet_InvokeMethod, about 101
GetNextProperty application method, about 138
business service method, about 273 application methods invoked 139
property set method, about 305 business component method, about 211
GetPicklistBusComp business component business component methods invoked 213
method, about 205 business service method, about 275
GetProfileAttr application method, ClearLOVCache method invoked 214
about 131 CreateFile method invoked 215
GetProperty GenerateProposal method invoked 216
business service method, about 275 GetDataSource method invoked 139
control method, about 289 GetFile method invoked 216
controls, about returning values of IsViewReadOnly method invoked 140
properties 289 Language method invoked 141
property set method, about 306 LookupValue method invoked 141
GetPropertyCount property set method, PutFile method invoked 217
about 306 RefreshBusComp method invoked 218
GetSearchExpr business component method, RefreshRecord method invoked 218
about 207 SetAdminMode method invoked 219
GetSearchSpec business component method, WebApplet_InvokeMethod, about 105
about 208 IsViewReadOnly application method,
GetService application method, about 131 about 140
GetSharedGlobal application method,

Siebel Object Interfaces Reference Version 8.1 43 3

 For Oracle internal distribution only
Index J

J Siebel Mobile Web Client Automation Server,

java Bean. See individual Siebel Java entries setting up to access 42
Java Cryptography Extension (JCE), Siebel Web Client Automation Server, setting
enabling 53 up to access 40
Java Data Bean MiniButton controls, using to invoke custom
GetErrorCode, about using to display numeric methods 425
error codes 315 Mobile Web client
GetErrorMessage, about using to display error application methods syntax summary, table
messages 317 of 351
table of SiebelDataBean method syntax 363 business component methods syntax
JavaScript. See Siebel eScript summary, table of 354
JCE (Java Cryptography Extension), business object methods syntax summary,
enabling 53 table of 358
business service methods syntax summary,
table of 359
L property set methods syntax summary, table
Language application method, about 141 of 360
LastRecord business component method, module variables, about and VB example 62
about 219 MVG business component, returning 203
load balancing 73
Load event
Applet_Load, about triggering after applet is N
loaded 103 Name
WebApplet_Load event, about triggering just applet method, about 98
after applet is loaded 106 application method, about 150
LoadObjects application method, about 143 business component method, about 220
LoadUserAttributes application method, business object method, about 270
about 144 business service method, about 277
local variables, described and VB control method, about 291
example 61 named field value, about using SetFieldValue
locating objects method, about and list of to assign new value to 230
methods 54 navigation methods, object interfaces 60
logical operators in search expressions 240 NewPropertySet application method,
Login method application method, about 150
about 145 NewRecord business component method,
LoginId application method, about 147 about 221
LoginName application method, about 147 NextRecord business component method,
Logoff application method, about 148 about 222
LookupMessage application method, NextSelected business component method,
about 149 about 223
LookupValue application method, about 141
O
M object interface events
methods See also Siebel object interfaces, events
custom methods, invoking with MiniButton applet, table of 89
controls 425 application, table of 90
table grouped by interface type 77 BusComp, table of 90
Microsoft Foundation Class (MFC) library. business service, table of 91
See Siebel COM Data Server object interface methods
Microsoft Visual Basic See also Siebel object interfaces, methods
Siebel COM Data Control Interface, setting up applet, table of 77
to access 46 application, table of 78
Siebel COM Data Server, setting up to business component, table of 81
access 44 business object, table of 85

434 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Index P

business service, table of 85 SetProperty, about assigning visual

control, table of 86 properties 293
miscellaneous methods and events, table property set methods
of 88 AddChild, about adding subsidiary property
property set, table of 87 set to 297
object interfaces. See Siebel object Copy, about returning copy of set 298
interfaces GetByteValue 299
object types GetChild, about returning child property of
applet object type, described 36 property set 300
application, described 34 GetChildCount, about returning child property
business component, described 35 sets attached to 302
business object, described 34 GetFirstProperty, about returning name of
business service, described 35 first property 302
property set, described 36 GetNextProperty, about returning next
Siebel object interfaces, object types, table property 305
of 37 GetProperty, about returning property value
object, about using Name method to return when given name 306
object name 291 GetPropertyCount, about returning number of
operating currency code, returning 123 properties attached to 306
GetValue, about retrieving data value 308
P InsertChildAt, about inserting child property
ParentBusComp business component set into parent property 308
method, about 224 object interface methods, table of 87
Pick business component method RemoveChild, about removing child property
GetPicklistBusComp, returns component 205 set from parent property set 310
Pick method, about 224 RemoveProperty, about removing a property
Pick Method business component from property set 310
method 224 SetByteValue 311
PositionId application method, about 152 SetProperty, about assigning a data value to
PositionName application method, property 313
about 153 SetType, about assigning data value of
PreCanInvokeMethod type 313
WebApplet_PreCanInvokeMethod, syntax summary (COM data control),
about 108 table 335
PreInvokeMethod syntax summary (COM data server),
Applet_PreInvokeMethod, about 104 table 348
Application_PreInvokeMethod, about 173 syntax summary table (eScript) 422
WebApplet_PreInvokeMethod, about 109 property set object type, described 36
PreviousRecord business component property sets
method, about 226 business service methods syntax summary
programming (COM data control), table 335
custom extension routines, about extending business service methods syntax summary
data validation 17 (COM data server), table 348
environment, component of 16 Copy, about returning copy of 298
languages, about 15 GetChild, about retrieving child property
user interface components, about customizing set 300
behavior 17 GetFirstProperty, about retrieving property
programming with Siebel Object interfaces, names 302
about 27 GetNextProperty, about retrieving property
properties of controls names 305
GetProperty, about returning values 289 GetProperty, about retrieving property
SetLabelProperty, about assigning visual values 305
properties 291 GetPropertyCount, about retrieving values of
type members 306

Siebel Object Interfaces Reference Version 8.1 43 5

 For Oracle internal distribution only
Index Q

GetType, about retrieving values of type records

members 307 LastRecord, about using to move to 219
GetValue, about retrieving value values 307 NewRecord, about adding a new record
InsertChildAt, about adding subsidiary 308 (row) 221
methods syntax summary (Browser Script), NextSelected, about using to move focus to
table of 403 next record 223
methods syntax summary (eScript), table Pick, about placing record in a picklist 224
of 422 PreviousRecord, about moving to previous
methods syntax summary (Mobile Web record 226
client), table 360 UndoRecord, about using to reverse
methods syntax summary (Siebel VB), table uncommitted changes 249
of 391 WriteRecord, about committing database
methods syntax summary (Siebel Web client), changes 249
table of 375 RefineQuery business component method,
RemoveChild, about removing child property about 227
set 309 RefreshBusComp business component
RemoveProperty, about removing properties method, about 218
of 310 RefreshRecord business component method,
Reset, about removing properties and child about 218
properties 311 Release
SetProperty, about assigning values to business component method, about 228
members of 312 business object method, about 270
SetType, about assigning values to type business service method, about 278
members 313 RemoveChild property set method,
SetValue, about assigning values to value about 310
member 314 RemoveProperty
SiebelPropertySet methods syntax summary business service method, about 279
(Java), table of 370 property set method, about 310
tree-structured data structures, for 297 Reset property set method, about removing
PropertyExists properties and child property
business service method, about 277 sets 311
property set method, about retuning Boolean run-time engine, invoking 21
value 309
PutFile business component method, S
about 217 Script Profiler, about 20
script tracing 18
Q search expression
queries GetSearchExpr, about using to return current
ClearToQuery, about using to clear search expression 207
query 185 SetSearchExpr, about setting on entire search
GetSortSpec, using to get sort expression 237
specification 209 search specification
RefineQuery, about using to define after Field name argument, about returning for field
execution 227 specified in 208
SetSortSpec, using to set sort searchName, returns named search
specification 242 specification 205
quotation marks, about using in search SetNamedSearch, about setting a named
expressions 240 search specification on the business
component 235
R SetSearchSpec, about setting for a particular
RaiseError application method, about 154 field 238
RaiseErrorText application method, SetSearchSpec, about setting for particular
about 155 field 238

436 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Index S

server components, logging events 18 and list of 68

Server Script, components 16 Siebel COM Data Control
server, about Logoff method 148 about and diagram 28
Service_InvokeMethod business service instantiating 46
event, about 281 Siebel COM Data Server
Service_PreCanInvokeMethod business about and diagram 30
service event, about 284 building in C++ 319
Service_PreInvokeMethod business service C++, testing program 325
event, about 284 instantiating 44
SetAdminMode business component method, Siebel COM interfaces
about 219 accessing 40
SetByteValue property set method 311 COM Data Control interfaces, about and
SetFieldValue business component method, diagram 28
about 230 COM Data Server, about and diagram 30
SetFormattedFieldValue business COM error handling 74
component method, about 232 Siebel Mobile Web Client Automation Server,
SetLabelProperty about and diagram 31
controls, about setting visual properties 291 Siebel Web Client Automation Server, about
SetMultipleFieldValues business component and diagram 30
method, about 233 Siebel Compiler
SetNamedSearch business component compiler/interpreter described 16
method, about 235 order considerations and error message 21
SetPositionID application method, Siebel compiler
about 157 invoking 21
SetPositionName application method, Siebel constants table 91
about 158 Siebel eScript
SetProfileAttr application method, about 15
about 158 applet methods, syntax summary
SetProperty (table) 409
business service method, about application events syntax summary, table
assigning 280 of 413
controls, about setting visual properties 293 application methods syntax summary, table
property set method, about assigning data of 411
value to 312 business component events syntax summary,
SetSearchExpr business component method, table of 418
about 237 business component methods syntax
SetSearchSpec business component method, summary, table of 414
about 238 business object methods syntax summary,
SetSharedGlobal application method, table of 420
about 160 business service events syntax summary,
SetSortSpec business component method, table of 421
about 242 business service methods syntax summary,
SetType property set method, about 313 table of 420
SetUserProperty business component naming conventions, about using
method, about 244 standardized 25
SetValue property set methods syntax summary, table
control, about using to set contents of 294 of 422
property set, about assigning data value Siebel VB, differences between 24
to 314 ST eScript engine 21
SetViewMode business component method, Switch construct, making effective use of 26
about 245 syntax conventions 39
ShowModalDialog application method, theApplication, method syntax summary,
about 162 table of 423
Siebel business components, about events this object reference, about using and

Siebel Object Interfaces Reference Version 8.1 43 7

 For Oracle internal distribution only
Index S

example 25 events occur, determining when 68

variables, declaring 25 method syntax 63
WebApplet event summary, table of 410 program flow, process affected by script 64
with shortcut, about and example 25 Siebel business component events, about and
Siebel eScript language, about 16 list of 68
Siebel extension events Siebel object interfaces, getting started
applet events, about and list of 70 See also individual Siebel object interface
application events, about and list of 71 entries
events occur, determining when 68 connect string, about, syntax, and
method syntax 63 example 71
program flow, process affected by script 64 connect string, substitutions when logging
Siebel business component events, about and into a Siebel Server (table) 72
list of 68 Siebel COM Data Control, accessing and
Siebel Java Bean screen example 46
codepage support (table) 51 Siebel COM interfaces, accessing 40
data Bean, about installation 33 Siebel mobile Web client automation server,
JDB and Siebel Server, encrypting accessing 42
communication between 52 Siebel Web Client Automation Server,
SiebelBusComp methods syntax summary, accessing 40
table of 365 Siebel object interfaces, methods
SiebelDataBean methods syntax summary, See also individual Siebel object interface
table of 363 entries
SiebelExceptions methods syntax summary, business components, accessing 55
table of 372 examples 38
SiebelPropetySet methods syntax summary, global state properties and functions 60
table of 370 list of 53
SiebelService methods syntax summary, locating objects, about and list of
table of 369 methods 54
Siebel Java interfaces navigation methods 60
multiple threads, using with 32 syntax 37
object, about using to access 32 user interaction, about and methods 60
Siebel Mobile Web Client Automation Server Siebel programming
about and diagram 31 constants, table of 91
accessing 42 custom extension routines, about extending
installation 34 data validation 17
Siebel object interfaces environment, components of 16
See also error handling user interface components, about customizing
about 28 behavior 17
component of Siebel programming Siebel script
environment described 16 debug tracing methods, table of 63
interface installations, about 33 global variables, about and VB example 62
Java Data Bean 48 inter-application communication methods, list
Siebel COM Data Control, instantiating 46 of 63
Siebel COM Data Server, instantiating 44 local variables. about and VB example 61
Siebel COM interfaces, accessing method 28 module variables, about and VB example 62
Siebel Java interfaces 32 Siebel Script Editor
Siebel methods and events, about accessing about 16
from scripts 32 Script Assist 16
usage evaluation matrix, table 33 Siebel Server
Siebel object interfaces, events applet, adding to 36
See also individual Siebel object interface JDB and Siebel Server, encrypting
entries between 52
applet events, about and list of 70 Siebel session ID, about returning string
application events, about and list of 71 containing Id 124

438 Siebel Object Interfaces Reference Version 8.1

 For Oracle internal distribution only
Index T

Siebel VB SiebelHTMLApplication methods syntax

about 15 summary, table of 373
applet methods syntax summary, table SiebelPropertySet methods syntax summary
of 377 (Java), table of 370
application events summary, table of 382 SiebelService methods
application methods syntax summary, table syntax summary (Java), table of 369
of 379 syntax summary (Siebel Web client), table
business component methods syntax of 374
summary, table of 382 sort specification
business components events summary, table getting 209
of 387 setting 242
business object methods syntax summary, special characters, using in search
table of 389 expressions 240
business service events syntax summary, specialized methods, calling 211
table of 390 ST eScript engine
business service methods syntax summary, about 21
table of 389 Script Profiler 20
components of 16 subsidiary property sets, about using
date variables, about working with 23 AddChild to add to a property set 297
getting started 21
Me object reference, about using and T
example 22 theApplication method
naming conventions, using standardized 22 object type, about using to return 317
objects, destroying and example 24, 26 syntax summary (eScript), table of 423
picklist, picking a value from 206 syntax summary (Siebel VB) 393
property set methods syntax summary, table Trace application method, about 165
of 391 TraceOff application method
run-time errors, about trapping 22 about 167
Select Case, making effective use of 23 debug tracing, about 63
Siebel eScript, differences between 24 TraceOn application method
syntax conventions 38 about 168
theApplication method, syntax debug tracing, about 63
summary 393 tracing scripts 18
variables, declaring 21 tree-structured data structures, creating
WebApplet events, summary (table) 378 using property sets 297
With shortcut, using and example 23
Siebel VB language, about 16
Siebel Web client U
property set methods syntax summary, table UndoRecord business component method,
of 375 about 249
Siebel Service methods syntax summary, user interaction, object interface
table of 374 methods 60
SiebelHTMLApplication methods syntax user interface control object type 36
summary, table of 373 user property value
Siebel Web Client Automation Server GetUserProperty, about using to return
about and diagram 30 value 209
accessing 40 SetUserProperty, about using to set the value
installation, about 34 of named business user
SiebelBusComp methods syntax summary property 244
(Java), table of 365 user-created methods, calling 211
SiebelDataBean methods syntax summary
(Java), table of 363 V
SiebelException methods value, returning value of control 290
syntax summary (Java), table of 372 visibility type

Siebel Object Interfaces Reference Version 8.1 43 9

 For Oracle internal distribution only
Index W

SetViewMode, about setting for business WebApplet_Load event, about 106

component 245 WebApplet_PreCanInvokeMethod event,
about 108
W WebApplet_PreInvokeMethod event,
Web Client Automation Server, enabling 30 about 109
WebApplet events WebApplet_ShowControl event, about 110
summary, table of (eScript) 410 WebApplet_ShowListColumn event,
syntax summary, table of (Browser about 112
Script) 397 WriteRecord business component method,
WebApplet_InvokeMethod event, about 249
about 103

440 Siebel Object Interfaces Reference Version 8.1