5Siebel Object Interfaces Reference
Siebel Object Interfaces Reference
This chapter describes object interface methods and events. It includes the following topics:
Format of the Object Interface Method
This topic describes formats for object interface methods, arguments, and return values. A Siebel object interface method uses the following format:
ObjectType.MethodName(arg1[, arg2, ..., argn])
where:
Italicized text indicates a variable.
Square brackets [ ] indicate an optional argument. The description of the argument indicates the default value for each optional argument.
ObjectType is the object type. For example, BusComp indicates the business component that Siebel CRM defines for the object interface method.
MethodName is the name of the object interface method that you call. A method can be a subroutine that does not return a value, such as SetViewMode, or a method that returns a value, such as GetFieldValue.
arg1, arg2, or argn is a string, constant, integer, or object. Use parenthesis in the following ways:
In Siebel VB, if an object interface method returns a value, then enclose these arguments in parentheses.
in Siebel VB, if an object interface method does not return a value, then do not enclose these arguments in parentheses.
In Siebel eScript, always enclose these arguments in parentheses.
If you use parentheses ( ) when none are required, or if you fail to use them if they are required, then Siebel CRM creates a Type Mismatch error that includes error code 13. Siebel CRM also creates this error if you use an incorrect number of arguments.
If you use the COM Data Server interface, then you must include the errCode argument as the last argument.
Note how this book uses the following terms:
ObjectReference is an ObjectType variable name that identifies the object that calls the object interface method. If you call a method on an object in the event handler of that object, then you are not required to explicitly specify the ObjectReference.
returnValue is the value that the object interface method returns. Some methods, such as GetBusComp, return a business component object. Some methods return a string or integer. Some methods do not return any value.
Formats for Siebel VB
If there is a return value, then use the following format:
returnValue = ObjectReference.MethodName(arg1, arg2, ..., argn)
If there are no arguments, then use the following format:
returnValue = ObjectReference.MethodName
If there is no return value, then use the following format:
ObjectReference.MethodName arg1, arg2, ..., argn
The following examples use Siebel VB:
acctName = acctBC.GetFieldValue("Name")
acctBC.SetViewMode AllView
Formats for Siebel eScript
If there is a return value, then use the following format:
returnValue = ObjectReference.MethodName(arg1, arg2, ..., argn);
If there are no arguments, then use the following format:
returnValue = ObjectReference.MethodName();
If there is no return value, then use the following format:
ObjectReference.MethodName(arg1, arg2, ..., argn);
The following examples use Siebel eScript:
acctName = acctBC.GetFieldValue("Name");
acctBC.SetViewMode(AllView);
Formats for the Component Object Model
The format that Siebel CRM uses for the Component Object Model (COM) depends on the language you use to call the COM interface. For Microsoft Visual Basic and equivalent languages, the format is similar to the format you use for Siebel VB, except that if you use COM Data Control, then Siebel CRM passes an error code as the final argument.
Technologies You Can Use to Access Object Interface Methods and Events
This topic describes technologies you can use to access object interface methods and events. It includes the following topics:
Technologies You Can Use to Access Object Interface Methods
This topic lists the technologies you can use to access object interface methods. It includes the following topics:
The term Yes indicates an object interface that you can use with an application method.
Applet Methods
The following information lists the technologies you can use to access applet object interface methods. You can use an applet object interface method only with Server Script and Browser Script.
Table Applet Methods
| Method | Server Script | Browser Script |
|---|---|---|
No |
Yes |
|
Yes |
Yes |
|
Yes |
Yes |
|
No |
Yes |
|
No |
Yes |
|
| InvokeMethod Method for an Applet | Yes |
Yes |
Yes |
Yes |
Application Methods
The following information lists the technologies you can use to access application methods.
Table Application Methods
| Method | Server Script | Browser Script | Web Client Automation Server | Mobile Web Client Automation Server | COM Data Control | COM Data Server | Java Data Bean |
|---|---|---|---|---|---|---|---|
No |
Yes |
No |
No |
No |
No |
No |
|
No |
Yes |
No |
No |
No |
No |
No |
|
Yes |
Yes |
No |
Yes |
No |
No |
No |
|
Yes |
Yes |
No |
Yes |
No |
No |
No |
|
No |
No |
No |
No |
Yes |
No |
Yes |
|
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
No |
No |
No |
No |
Yes |
No |
Yes |
|
No |
No |
No |
Yes |
Yes |
No |
No |
|
No |
Yes |
No |
No |
No |
No |
No |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
GetDataSource Method for an Application Called only with InvokeMethod |
Yes |
No |
No |
Yes |
Yes |
No |
Yes |
No |
No |
Yes |
Yes |
Yes |
No |
No |
|
No |
No |
Yes |
Yes |
Yes |
Yes |
No |
|
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
No |
No |
No |
No |
|
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
IsViewReadOnly Method for an Application Called only with InvokeMethod |
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
Language Method for an Application Called only with InvokeMethod |
Yes |
No |
No |
No |
No |
No |
No |
No |
No |
No |
No |
No |
Yes |
No |
|
Yes |
No |
No |
No |
No |
No |
No |
|
No |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
No |
No |
No |
No |
Yes |
No |
Yes |
|
Yes |
No |
No |
No |
No |
No |
No |
|
LookupValue Method for an Application Called only with InvokeMethod |
Yes |
No |
No |
Yes |
Yes |
No |
Yes |
No |
Yes |
Yes |
No |
No |
No |
No |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
No |
No |
No |
No |
|
Yes |
No |
No |
No |
No |
No |
No |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
No |
Yes |
No |
No |
No |
No |
No |
|
No |
Yes |
No |
No |
No |
No |
No |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
Yes |
Yes |
Yes |
Yes |
Business Component Methods
The following information lists the technologies you can use to access business component methods. You cannot use these method with the Web Client Automation Server.
Table Business Component Methods
| Method | Server Script | Browser Script | Mobile Web Client Automation Server | COM Data Control | COM Data Server | Java Data Bean |
|---|---|---|---|---|---|---|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
ClearLOVCache Method for a Business Component Called only with InvokeMethod |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
CreateFile Method for a Business Component Called only with InvokeMethod |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
No |
No |
No |
|
GenerateProposal Method for a Business Component Called only with InvokeMethod |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
GetFile Method for a Business Component Called only with InvokeMethod |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
No |
No |
Yes |
Yes |
No |
No |
|
No |
No |
Yes |
Yes |
No |
No |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
No |
No |
No |
No |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
PutFile Method for a Business Component Called only with InvokeMethod |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
RefreshBusComp Method for a Business Component Called only with InvokeMethod |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
RefreshRecord Method for a Business Component Called only with InvokeMethod |
Yes |
Yes |
Yes |
Yes |
No |
Yes |
No |
No |
No |
No |
No |
Yes |
|
SetAdminMode Method for a Business Component Called only with InvokeMethod |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Business Object Methods
The following information lists the technologies you can use to access business object methods. You cannot use these methods with the Web Client Automation Server.
Table Business Object Methods
| Method | Server Script | Browser Script | Mobile Web Client Automation Server | COM Data Control | COM Data Server | Java Data Bean |
|---|---|---|---|---|---|---|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
No |
No |
Yes |
Yes |
No |
No |
|
No |
No |
Yes |
Yes |
No |
No |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
No |
No |
No |
No |
No |
Yes |
Business Service Methods
The following information lists the technologies you can use to access business service methods.
Table Business Service Methods
| Method | Server Script | Browser Script | Web Client Automation Server | Mobile Web Client Automation Server | COM Data Control | COM Data Server | Java Data Bean |
|---|---|---|---|---|---|---|---|
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
No |
No |
No |
No |
No |
No |
Yes |
|
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
No |
Yes |
Yes |
Yes |
Yes |
Control Methods
You can use the following control methods. You can use these methods only with Browser Script:
Property Set Methods
The following information lists the technologies you can use to access property set methods.
Table Property Set Methods
| Method | Server Script | Browser Script | Web Client Automation Server | Mobile Web Client Automation Server | COM Data Control | COM Data Server | Java Data Bean |
|---|---|---|---|---|---|---|---|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
No |
No |
No |
No |
No |
No |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
No |
No |
No |
Yes |
No |
No |
No |
|
No |
No |
No |
Yes |
No |
No |
No |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
No |
No |
No |
No |
No |
No |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Miscellaneous Methods
The following information lists technologies you can use to access other methods that you can use. You cannot use these methods with the following technologies:
Web Client Automation Server
Mobile Web Client Automation Server
COM Data Control
COM Data Server
Table Miscellaneous Methods
| Method | Server Script | Browser Script | Java Data Bean |
|---|---|---|---|
No |
No |
Yes |
|
No |
No |
Yes |
|
Yes |
Yes |
No |
Technologies You Can Use to Access Object Interface Events
This topic lists the types of object interface events. It includes the following topics:
These object interface events are available in Server Script or Browser Script in Siebel Tools.
Applet Events
The following information lists applet events. You can use these events only with Server Script or Browser Script.
Table Applet Events
| Event | Server Script | Browser Script |
|---|---|---|
No |
Yes |
|
No |
Yes |
|
No |
Yes |
|
No |
Yes |
|
No |
Yes |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
Application Events
The following information lists application events. You can use these events only with Server Script or Browser Script.
Table Application Events
| Event | Server Script | Browser Script |
|---|---|---|
Yes |
No |
|
Yes |
Yes |
|
Yes |
No |
|
Yes |
Yes |
|
Yes |
No |
|
Yes |
No |
Business Component Events
The following information lists business component events. You can use these events only with Server Script or Browser Script.
Table Business Component Events
| Event | Server Script | Browser Script |
|---|---|---|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
BusComp_PreSetFieldValue Event Requires you to set a field property for the event that Siebel CRM immediately runs on the Siebel Server. |
Yes |
Yes |
Yes |
No |
|
Yes |
No |
|
Yes |
No |
|
Yes |
No |
Business Service Events
The following table lists business service events. You can use these events only with Server Script or Browser Script.
Table Business Service Events
| Event | Server Script | Browser Script |
|---|---|---|
Yes |
Yes |
|
Yes |
Yes |
|
Yes |
Yes |
Object Interfaces Reference
This topic describes reference information for Siebel object interfaces. It includes the following topics:
About Specialized and Custom Methods
A specialized method is a Siebel object interface method that references one of the following specialized class:
A specialized applet class
A specialized business component class
A specialized applet class or a specialized business component class is a class other than the CSSFrame class or the CSSBusComp class.
A custom method is a Siebel object interface method that you modify.
Applet Methods
This topic describes applet methods. It includes the following topics:
In these methods, the Applet variable represents an applet instance.
ActiveMode Method for an Applet
The ActiveMode method returns a string that contains the name of the current Web template mode.
Format
Applet.ActiveMode
No arguments are available.
Used With
Browser Script
Examples
The following example is in Browser Script:
function Applet_Load ()
{
var currMode = this.ActiveMode();
theApplication().SWEAlert("The active mode for the selected applet is: " +
currMode);
}
BusComp Method for an Applet
The BusComp method when used in the context of an applet returns the current business component instance that this applet references.
Format
Applet.BusComp();
No arguments are available.
Used With
Browser Script, Server Script
BusObject Method for an Applet
The BusObject method returns the name of the business object that the business component references.
Format
Applet.BusObject()
No arguments are available.
Used With
Browser Script, Server Script
Examples
The following example is in Browser Script:
function Applet_Load ()
{
var appletname = this.Name();
var currBO = this.BusObject();
var currBOName = currBO.Name();
theApplication().SWEAlert("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 for an Applet
The FindActiveXControl method returns the name of a control that is a Document Object Model element.
Format
Applet.FindActiveXControl(controlName)
The following table describes the arguments for the Browser Script format of the FindActiveXControl method.
Table Arguments for the Browser Script Format of the FindActiveXControl Method
| Argument | Description |
|---|---|
controlName |
Literal string or string variable that contains the name of the control. |
Usage
You can use the FindActiveXControl method to find a control on a form applet. It does not locate a list column on a list applet.
Used With
Browser Script
Examples
The following Browser Script example interacts with a Microsoft slide ActiveX control that resides 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.visibility = "hidden"; // Use a Style sheet property
FindControl Method for an Applet
The FindControl method returns the name of a control. This applet must be part of the view that Siebel CRM displays.
Format
Applet.FindControl(controlName)
The arguments you can use with this format are the same as the arguments described in FindActiveXControl Method for an Applet.
Usage
The FindControl method does not do the following:
Locate a control in an MVG applet, pick applet, associate applet, or detail applet. In Siebel Tools, these applets do not appear in the child View Web Template Items list of the view.
Locate list columns in a list applet.
Used With
Browser Script
Examples of Using the FindControl Method
The following example is in Browser Script:
function Applet_PreInvokeMethod (name, inputPropSet)
{
// Code to modify 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");
}
}
To use this example, see SetLabelProperty Method for a Control.
InvokeMethod Method for an Applet
The InvokeMethod method calls a specialized method. It returns the following:
In Server Script, returns a string that contains the result of the method.
In Browser Script, returns a property set.
Browser Script Format
Applet.InvokeMethod(methodName, methodArgs_PropSet);
The following table describes the arguments for the Browser Script format of the InvokeMethod method.
Table Arguments for the Browser Script Format of the InvokeMethod Method
| Argument | Description |
|---|---|
methodName |
The name of the method. |
methodArgs_PropSet |
Property set that contains the method arguments. |
Server Script Format
Applet.InvokeMethod(methodName, methArg1, methArg2, methArgN);
The following table describes the arguments for the Server Script format of the InvokeMethod method.
Table Arguments for the Server Script Format of the InvokeMethod Method
| Argument | Description |
|---|---|
methodName |
The name of the method. |
You can use the following arguments:
|
One or more strings that contain arguments for the methodName argument. |
Usage
Available with Server Script and Browser Script. Note the following:
If the method that the methodName argument identifies exists in the browser, then Siebel CRM runs this method in the browser.
If the method that the methodName argument identifies exists on the Siebel Server, then Siebel CRM runs this method on the Siebel Server.
Caution About Using the InvokeMethod Method
You must use InvokeMethod only to call a method that this book describes.
Used With
Browser Script, Server Script
Examples
The following example is in Siebel eScript:
function WebApplet_PreInvokeMethod (MethodName)
{
//Call 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;
}
return(iReturn);
}
Name Method for an Applet
The Name method for an applet returns the name of an applet.
Format
Applet.Name()
No arguments are available.
Used With
Browser Script, Server Script
Examples
The following example is in Browser Script:
function Applet_Load ()
{
//Display the name of the applet if the applet loads using the
//applet.Name() method that gets the name of the applet
var appletName;
appletName = this.Name();
theApplication().SWEAlert("The name of the applet is: " + appletName);
}
The following example is in Siebel eScript:
function WebApplet_Load ()
{
//Display the name of the applet if the applet loads using the
//applet.Name() method that gets 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:
Sub WebApplet_Load ' Display the name of the applet if the applet loads using the ' applet.Name() method that gets 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
This topic describes applet events. It includes the following topics:
Overview of Applet Events
Siebel CRM calls an applet event in reply to a user interaction. You can manage each event for each applet.
The format for an applet event that you use on the browser is:
Applet_event
where:
event is the name of the event.
For example:
Applet_ChangeFieldValue
If the event includes the Applet prefix, then you can use it only on the browser.
The format for an applet event that you use on the Siebel Server is:
WebApplet_event
where:
event is the name of the event.
For example:
WebApplet_InvokeMethod
If the event includes the WebApplet prefix, then you can use it only on the Siebel Server.
Applet_ChangeFieldValue Event
The Applet_ChangeFieldValue event starts if the user uses an applet to modify data in a field. It does not return any information. For more information, see Applet_ChangeRecord Event.
Format
Applet_ChangefieldValue(fieldname, fieldValue)
The following table describes the arguments for the Applet_ChangeFieldValue event.
Table Arguments for the Applet_ChangeFieldValue Event
| Argument | Description |
|---|---|
FieldName |
A string that contains the name of the field that the user modified. |
FieldValue |
A string that contains the value that the user modified. |
Usage
Note the following usage of the Applet_ChangeFieldValue event:
If the user moves to a different record but does not modify a value in the previous record, then the ChangeFieldValue event does not start.
If the user modifies the value of a field, and if Siebel CRM modifies the value in another field that depends on some way on the value that the user modified, such as a calculated field, then the event starts once for each field whose value Siebel CRM modifies.
If the user uses a pick applet or popup applet to modify the data that a field contains, then this event does not start.
Used With
Browser Script
Examples
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");
theApplication().SWEAlert("Changing the Committed Flag to NO as
$500,000 in Revenue and Upside amount is required");
}
}
break;
}
}
catch(e)
{
// error handling routine
}
Applet_ChangeRecord Event
Siebel CRM calls the Applet_ChangeRecord event if the user moves to a different record or view. It does not return any information. For more information, see Applet_ChangeFieldValue Event.
Format
Applet_ChangeRecord()
No arguments are available.
Used With
You use the Applet_ChangeRecord event with Browser Script. Note the following:
To return the value of the field the user navigates to, use the BusComp.GetFieldValue method.
To return the value of the field the user navigates away from, use the control.GetValue method.
Examples
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")
{
theApplication().SWEAlert("This record cannot be updated because it has
been committed");
}
}
catch(e)
// error handling routine
}
Applet_InvokeMethod Event
The Applet_InvokeMethod event can start if any of the following items occur:
A call to applet.InvokeMethod occurs
A call to a specialized method occurs
A user chooses a menu item in a menu that the user defines
For more information, see About Specialized and Custom Methods.
This method does not return any information.
Format
Applet_InvokeMethod(name, inputPropSet)
The following table describes the arguments for the Applet_InvokeMethod event.
Table Arguments for the Applet_InvokeMethod Event
| Argument | Description |
|---|---|
name |
The name of the method that Siebel CRM calls. |
inputPropSet |
A property set that identifies arguments that Siebel CRM sends to the event. |
Usage
This method sends information you specify in the inputPropSet argument to the PreInvokeMethod event. You can use the Applet_InvokeMethod event to display or hide controls, or to set a search specification. To access a business component from this event handler, do the following:
Use this.BusComp.
Do not use TheApplication.ActiveBusComp.
Used With
Browser Script
Examples
Some methods can create, modify, or delete records. These actions might call an event at the applet or business component level. If you require Siebel CRM to perform a specific action before or after the method run, then you can use these events. The following example includes custom code in the PreInvokeMethod event and the InvokeMethod applet event. For more information, see Applet_PreInvokeMethod Event.
To set the fields, this code sets and resets the flag and uses the NewRecord server event:
function Applet_PreInvokeMethod (name, inputPropSet)
{
if (name == "Quote")
{
// Add code that Siebel CRM must run 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 Siebel CRM must run AFTER the special method
// 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");
. . . . .
}
}
Applet_Load Event
Siebel CRM calls the Applet_Load event after it loads an applet and displays the data for that applet. It does not return any information.
Format
Applet_Load()
No arguments are available.
Usage
To hide or manipulate controls or to set properties on an ActiveX Control in a form applet, you can use the Applet_Load event. You can manipulate the following types of controls:
CheckBox
ComboBox
TextBox
TextArea
Label
If you must display a dialog box, then do not use the SWEAlert method or the RaiseErrorText method with the Applet_Load event. This technique can cause the browser to fail if Siebel CRM has not fully rendered the Siebel application in the browser.
Used With
Browser Script
Examples
You can use the following example only with code on a form applet:
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
Siebel CRM calls the Applet_PreInvokeMethod event immediately before it calls a specialized method on an applet. The Applet_PreInvokeMethod event can start if any of the following items occur:
A call to the InvokeMethod method on an applet occurs.
A user chooses a custom menu item that you define in Siebel Tools.
This event returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
For more information, see About Specialized and Custom Methods.
Format
Applet_PreInvokeMethod(name, inputPropSet)
The arguments you use with this format are the same as the arguments described in Applet_InvokeMethod Event.
Used With
Browser Script
Examples
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");
}
}
WebApplet_InvokeMethod Event
Siebel CRM calls the WebApplet_InvokeMethod event after a specialized method on the Web applet runs. WebApplet_InvokeMethod starts only for a predefined method. It does not start for a custom method. For more information, see About Specialized and Custom Methods.
This method does not return any information.
Format
WebApplet_InvokeMethod(methodName)
The following table describes the arguments for the WebApplet_InvokeMethod event.
Table Arguments for the WebApplet_InvokeMethod Event
| Argument | Description |
|---|---|
methodName |
String variable or literal that contains the name of the method that Siebel CRM calls. |
Used With
Server Script
Examples
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" Case "ExecuteQuery" TheApplication.SetSharedGlobal "EnableButton", "" Case "UndoQuery" TheApplication.SetSharedGlobal "EnableButton", "" End Select
Related Topics
For more information, see the following topics:
WebApplet_Load Event
Siebel CRM calls the WebApplet_Load event immediately after it loads an applet. It does not return any information.
Format
WebApplet_Load()
No arguments are available.
Usage
To avoid returning a null value, do not call TheApplication.ActiveBusObject from the WebApplet_Load event. Instead, you can use this.BusObject to get a reference to the current business object.
Used With
Server Script
Examples
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
For more information, see the following topics:
WebApplet_PreCanInvokeMethod Event
The WebApplet_PreCanInvokeMethod event allows a script to determine if the user possesses the authority to call the applet method. Siebel CRM calls this method in the following situations:
Before it calls the PreInvokeMethod event.
If the user steps to a different record.
If it loads an applet.
If it calls a different method from Browser Script. For example, the GetProfileAttr method or the SetProfileAttr method.
This method returns CancelOperation or ContinueOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
Format
WebApplet_PreCanInvokeMethod(MethodName, &CanInvoke)
The following table describes the arguments for the WebApplet_PreCanInvokeMethod event.
Table Arguments for the WebApplet_PreCanInvokeMethod Event
| Argument | Description |
|---|---|
MethodName |
A string that contains the name of the method that Siebel CRM must run. |
&CanInvoke |
A string that indicates if Siebel CRM call the applet method. You can use the following values:
|
Usage
Using the FirstSelected business component method with the PreCanInvokeMethod event can cause unexpected behavior in a pick applet that Siebel CRM calls from the applet where this event is called.
To enable and disable a method, it can be easier to use the CanInvokeMethod applet user property at the applet level. For an example, see Using a MiniButton Control to Call a Custom Method. For information about the CanInvokeMethod user property, see Siebel Developer's Reference.
Used With
Server Script
Examples
The following example is in Siebel eScript:
function WebApplet_PreCanInvokeMethod (MethodName, &CanInvoke)
{
if ( MethodName == "CustomMethod" )
{
CanInvoke = "TRUE";
return( CancelOperation );
}
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
Siebel CRM calls the WebApplet_PreInvokeMethod event before it calls any of the following:
A specialized method for the Web applet.
A custom method that Siebel CRM calls through the oWebApplet object of the InvokeMethod method.
This method returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
For more information, see About Specialized and Custom Methods.
Format
WebApplet_PreInvokeMethod(methodName)
The arguments you can use with this format are the same as the arguments described in WebApplet_InvokeMethod Event.
Used With
Server Script
Examples
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
Application Methods
This topic describes application methods. It includes the following topics:
Overview of Application Methods
An application method is a predefined method that returns the current Siebel application object instance:
TheApplication, if called from Siebel VB that resides in the Siebel runtime repository
TheApplication(), if called from Siebel eScript that resides in the Siebel runtime repository
theApplication(), if called from Browser Script that resides in the Siebel runtime repository
Note the following:
If an application method applies to only one scripting language, then the Syntax definition in the method includes one of these methods.
If a method applies to an external interface or to more than one scripting language, then it must use more than one format. In this situation, the Syntax definition includes Application and results in the following situation:
If you use Siebel VB, Siebel eScript, or Browser Script, then Siebel CRM substitutes the applicable statement for Application
If you use an external interface, then Siebel CRM substitutes the name of an application instance for Application
Some examples in this chapter include an Application method that uses an external interface. These examples use SiebelApplication as the application instance. The examples assume that the script starts an instance of the Siebel application. This situation is true even if the example does not include the code that starts this instance.
ActiveApplet Method for an Application
The ActiveApplet method returns a reference to the applet that Siebel CRM displays.
Format
theApplication().ActiveApplet();
No arguments are available.
Usage
Use this method to identify the applet that Siebel CRM currently displays. This applet typically includes a blue border to indicate that it is active.
Used With
Browser Script
Examples
function Applet_PreInvokeMethod (name, inputPropSet)
{
switch (name)
{
case "Drilldown":
var activeapplet = theApplication().ActiveApplet();
var activeappletname = activeapplet.Name();
theApplication().SWEAlert("Here is the applet we are drilling down from "
+ activeappletname);
break;
}
return ("ContinueOperation");
}
ActiveBusComp Method for an Application
The ActiveBusComp method returns the name of the business component that the active applet references.
Format
theApplication().ActiveBusComp();
No arguments are available.
Used With
Browser Script
Examples
function Applet_Load ()
{
var activeBC = theApplication().ActiveBusComp();
activeBC = activeBC.Name();
theApplication().SWEAlert(activeBC);
}
ActiveBusObject Method for an Application
The ActiveBusObject method returns the name of the business object that the active view references.
Format
Application.ActiveBusObject
No arguments are available.
Usage for the ActiveBusObject Method
Do not use the ActiveBusObject method in an event handler that any of the following technologies can start:
COM Data Server
COM Data Control
Siebel Java Data Bean
Used With
Browser Script, Mobile Web Client Automation Server, Server Script
Example in Browser Script
The following example is in Browser Script:
function Applet_Load ()
{
var oBusObj;
oBusObj = theApplication().ActiveBusObject();
theApplication().SWEAlert("The active business object is " + oBusObj.Name() +
".")
}
Example of Using the ActiveBusObject Method to Call from a Custom Button on a Child Applet
The following examples include script that runs on the Siebel Server that Siebel CRM can call from a custom button on a child applet in a view. This script does the following work:
Determines if the Contact business object is active. If it is active, then Siebel CRM returns the email address of the currently active parent Contact record.
Uses the contact email address to call the custom SendEmail function.
Objects that the script references are currently active in the Siebel client, so Siebel CRM does not delete these objects at the end of the script.
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)
sEmail =""
End If
iRtn = CancelOperation
End If
WebApplet_PreInvokeMethod = iRtn
End Function
ActiveViewName Method for an Application
The ActiveViewName method returns the name of the active view.
Format
Application.ActiveViewName
No arguments are available.
Usage
Usage for the ActiveViewName method is very similar to usage for the ActiveBusObject method. For more information, see Usage for the ActiveBusObject Method.
Used With
Browser Script, Mobile Web Client Automation Server, Server Script
Examples
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":
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 for an Application
The Attach method allows an external application to reconnect to an existing Siebel session. It returns a Boolean value that indicates if Siebel CRM successfully ran the method.
Format
Application.Attach(sessionString)
The following table describes the arguments for the Attach method.
Table Arguments for the Attach Method
| Argument | Description |
|---|---|
sessionString |
A string that contains the Siebel Session Id. This argument is typically the output of the Detach method. |
Used With
COM Data Control, Siebel Java Data Bean
Examples
The examples in this topic do the following work:
Start an instance of COM Data Control.
Log in to a Siebel Server.
Detach the instance.
Determine the session string.
Start another instance of COM Data Control.
The script does not log in again. Instead, it uses the session string to access the existing session. This technique reuses the connection that the first instance created.
The following example uses 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 uses the Siebel 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;
public static void main(String[] args)
{
JDBAttachDetachDemo demo = new JDBAttachDetachDemo();
}
public JDBAttachDetachDemo()
{
try
{
// Instantiate the Siebel Java Data Bean
m_dataBean_first = new SiebelDataBean();
// Login to the Siebel 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 Siebel 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 for an Application
The CurrencyCode method returns the currency code that is associated with the division of the user position. For example, USD for U.S. dollars, EUR for the euro, or JPY for the Japanese yen.
Format
Application.CurrencyCode
No arguments are available.
Used With
Browser Script, COM Data Control, COM Data Server, Web Client Automation Server, and Server Script
Examples
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 for an Application
The Detach method returns a string that contains the Siebel session Id.
Format
Application.Detach
No arguments are available.
Usage
Use the string that the Detach method returns only with the Attach method.
Used With
COM Data Control, Siebel Java Data Bean
Examples
For a Siebel Java Data Bean example and a native VB example that uses COM Data Control, see Attach Method for an Application.
EnableExceptions Method for an Application
The EnableExceptions method enables or disables native Component Object Model (COM) error handling. This method does not return any information.
Format
Application.EnableExceptions(bEnable)
The following table describes the arguments for the EnableExceptions method.
Table Arguments for the Enable Exceptions Method
| Argument | Description |
|---|---|
bEnable |
You can one of the following values:
|
Usage
Setting the argument to TRUE enables native error handling. This allows Siebel CRM 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
Example of Using the EnableExceptions Method with Siebel ActiveX Data Control
The native Visual Basic script in this example does the following work:
Uses the Siebel ActiveX Data Control to connect to the Siebel application and to create an instance of a business object.
Prompts the user to use or not use the native error handling.
If the user answers yes, and if the script encounters an error, then it issues the error immediately.
If the user answers no, then the script suppresses errors.
You can detect errors only with the GetLastErrCode method.
The following code is an example of using the EnableExceptions method with Siebel ActiveX Data Control:
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
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 nonexisting 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
Example of Using the EnableExceptions Method with Siebel Mobile Automation Server
The script in this example performs the same work that is described in the example of using the EnableExceptions method with Siebel ActiveX Data Control earlier in this topic, except that the script in this example uses the Siebel Mobile Automation Server:
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 nonexisting 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
FindApplet Method for an Application
The FindApplet method returns the name of an applet.
Format
theApplication().FindApplet(appletName)
The following table describes the arguments for the FindApplet method.
Table Arguments for the FindApplet Method
| Argument | Description |
|---|---|
appletName |
String variable or literal that contains the name of an applet. |
Usage
The only applets available are applets that are visible in the active view.
Used With
Browser Script
Examples
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();
theApplication().SWEAlert(entryappletvalue);
}
}
GetBusObject Method for an Application
The GetBusObject method creates a new instance of a business object. It returns the name of this new business object instance.
Format
Application.GetBusObject(busObjectName)
The following table describes the arguments for the GetBusObject method.
Table Arguments for the GetBusObject Method
| Argument | Description |
|---|---|
busObjectName |
String variable or literal that contains the name of the business object. |
Usage
To delete the business object instance after it is no longer needed, you can set the business object to Nothing.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The examples in this topic create a new instance of the Account business object and returns the name of the instance of the Account business object.
The following example is in Siebel eScript:
var oBusObject = TheApplication().GetBusObject("Account");
var oBusComp = oBusObject.GetBusComp("Account");
Your custom code
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 custom code
Set AccntBO = Nothing
Set AccntBC = Nothing
Examples of Using the GetBusObject Method to Refer to the Business Object That Is Currently Active
The name of the business object instance that Siebel CRM returns might vary depending on the location where it calls the code, such as a Web applet event. The examples in this topic are useful if you must refer to the business object instance that is currently active.
The following example is for Siebel 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)
GetDataSource Method for an Application
The GetDataSource method returns the name of the data source that Siebel CRM defines in the DataSource server parameter for the session. The default value is ServerDataSrc.
Format
dataSrc = Application.InvokeMethod("GetDataSource")
No arguments are available.
Used With
To use this method, you can use an Application.InvokeMethod call with the following interfaces:
COM Data Control
Siebel Java Data Bean
Mobile Web Client Automation Server
Server Script
Examples
The following Siebel eScript code detects the data source and displays the name of the data source in a dialog box:
var dataSrc = TheApplication().InvokeMethod("GetDataSource");
TheApplication().RaiseErrorText(dataSrc);
The following example is in Siebel VB:
Dim dataSrc As String
dataSrc = TheApplication.InvokeMethod("GetDataSource")
TheApplication.RaiseErrorText(dataSrc)
GetLastErrCode Method for an Application
The GetLastErrCode method returns the error code for the error that Siebel CRM logged most recently. This code is a short integer. 0 (zero) indicates no error.
Format
Application.GetLastErrCode
No arguments are available.
Usage for the GetLastErrCode Method
After you run an object interface method, you can call the GetLastErrCode method to determine if Siebel CRM returned an error from the previous operation. You can use the GetLastErrText method to return the text of the error message. Each call to a method resets the run status. For more information, see GetLastErrText Method for an Application.
Used With
COM Data Control, Mobile Web Client Automation Server, Web Client Automation Server
Examples
The following example is for COM Data Control:
errcode = SiebelApplication.GetLastErrCode If errcode <> 0 Then ErrText = SiebelApplication.GetLastErrText MsgBox ErrText Exit Sub End If
GetLastErrText Method for an Application
The GetLastErrText method returns a string that contains the text message for the error that Siebel CRM logged most recently.
Format
Application.GetLastErrText
No arguments are available.
Usage for the GetLastErrText Method
The text that the GetLastErrText method returns includes a Siebel error code that you can use to investigate the error. For more information, see GetLastErrCode Method for an Application. For more information about a specific error, see My Oracle Support.
Used With
COM Data Control, COM Data Server, Mobile Web Client Automation Server, Web Client Automation Server
Examples
The following example is for COM Data Control:
errcode = SiebelApplication.GetLastErrCode If errcode <> 0 Then ErrText = SiebelApplication.GetLastErrText MsgBox ErrText Exit Sub End If
GetProfileAttr Method for an Application
The GetProfileAttr method returns the name of an attribute in a user profile. For more information, see SetProfileAttr Method for an Application.
Format
Application.GetProfileAttr(name)
The following table describes the arguments for the GetProfileAttr method.
Table Arguments for the GetProfileAttr Method
| Argument | Description |
|---|---|
name |
A string that indicates the name of the attribute. |
Usage
For more information, see Using System Fields with the SetProfileAttr Method.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel 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")
GetService Method for an Application
The GetService method locates a business service. If this business service is not already running, then Siebel CRM starts it. This method returns the name of the business service.
Format
Application.GetService(serviceName)
The following table describes the arguments for the GetService method.
Table Arguments for the GetService Method
| Argument | Description |
|---|---|
serviceName |
The name of the business service to start. |
Usage
The GetService method searches through the predefined services that are stored in the Siebel runtime repository. If it does not find the business service that you specify in the serviceName argument, then it searches the business services defined in the run-time Business Services table.
Siebel CRM normally deletes a business service from memory as soon as it clears all references to this business service. The act of setting the business service to another value usually clears these references. If you set the Cache property on the business service to TRUE, then Siebel CRM keeps this business service in memory as long as the Siebel application is running.
Registering a Business Service with a Siebel Application
Starting with Siebel CRM version 8, if you use the Web Client Automation Server or Browser Script to call a business service, then you must register that business service with the Siebel application. You must do this to prevent a Service Not Found error. It is not necessary to specify this business service in the CFG file. This requirement does not apply to Server Script.
To register a business service with a Siebel application
In Siebel Tools, in the Object Explorer, click Application.
In the Applications list, locate the Siebel application you must modify.
For example, Siebel Universal Agent.
In the Object Explorer, expand the Application tree, and then click Application User Prop.
In the Application User Props list, create new application user properties using values from the following table.
Name Value ClientBusinessService0
XML Converter
ClientBusinessService1
My Business Service
You must enter the ClientBusinessService records sequentially, starting with ClientBusinessService0 and incrementing by 1 for each new ClientBusinessService user property you add.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
The following examples start a new instance of a business service named Workflow Process Manager.
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
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
GotoView Method for an Application
The GotoView method does the following work:
Deactivates any business object, business component, applet, or control that is active.
Activates a view.
Creates an instance of the business object that the view references. This business object instance becomes the active business object.
Activates the primary applet of the view and the business component that this applet references.
Activates the first tab sequence control of the primary applet.
This method does not return any information.
Format
Application.GotoView(ViewName[, BusinessObjectName])
The following table describes the arguments for the GotoView method.
Table Arguments for the GotoView Method
| Argument | Description |
|---|---|
ViewName |
The name of the view that the Siebel application must display. |
BusinessObjectName |
Optional. The business object that Siebel CRM uses to display the view. You cannot specify the current active business object. If you do not provide this argument, or if you specify Nothing in this argument, then Siebel CRM activates a new business object in the normal way. |
Usage
If an instance of the business object does not exist, then you must set the value for the BusinessObjectName argument to Nothing.
You cannot use the GotoView method in the following events:
Application_Navigate
Application_PreNavigate
Application_Start
Navigate
PreNavigate
WebApplet_Load
The following Siebel VB script uses GotoView to programmatically navigate to the Opportunity List view:
TheApplication.GotoView "Opportunity List View", Nothing
If your Siebel application already started an instance of an Opportunity object with the object reference of objOppty, then the following usage in Siebel VB is acceptable:
TheApplication.GotoView "Opportunity List View", objOppty
If you use the GotoView method in a Siebel VB or Siebel eScript script, then Siebel CRM runs the method last. This situation is true regardless of where you use this method in the script.
If script on a control uses the GotoView method, then do not set the Show Popup property on this control to TRUE. If you set the Show Popup to TRUE in this situation, then Siebel CRM opens the view in a new browser window. You cannot use a Multiple Document Interface (MDI) with the Siebel client, so you cannot use this configuration.
Used With
Server Script
Examples
The following examples use the GoToView method 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")
{
//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(ForwardBackward);
}
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
Else
TheApplication.GotoView "Opportunity Detail - Activities View"
End If
Set actBC = Nothing
Set actBO = Nothing
End Sub
InvokeMethod Method for an Application
The InvokeMethod method calls a method. It returns the following values:
In Server Script, it returns a string that contains the result of the method.
In Browser Script, it returns a Boolean value.
For more information, see About Specialized and Custom Methods.
Browser Script Format
theApplication().InvokeMethod(methodName, methArg1, methArg2, methArgN);
The following table describes the arguments for the InvokeMethod method.
Table Arguments for the InvokeMethod Method
| Argument | Description |
|---|---|
methodName |
The name of the method. |
You can use the following arguments:
|
One or more strings that contain arguments for the methodName argument. |
Server Script Format
Application.InvokeMethod(methodName, methArg1, methArg2, methArgN);
The arguments you can use with this format are the same as those described in the table of arguments for the browser script format.
Usage
The InvokeMethod method allows you to call a method on an application object that is made available directly through the Siebel application interface. For more information, see Caution About Using the InvokeMethod Method and LoadObjects Method for an Application.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
For an example, see Examples of Using the FindControl Method.
IsViewReadOnly Method for an Application
You can use the IsViewReadOnly method to determine if a view is read-only. This method returns the following information:
TRUE if the view is read-only
FALSE if the view is not read-only
If this method does not return TRUE or FALSE, then an error occurred. If this method does not return TRUE or FALSE, then your script must provide a handler.
Format
Application.InvokeMethod("IsViewReadOnly",viewName)
The following table describes the arguments for the IsViewReadOnly method.
Table Arguments for the IsViewReadOnly Method
| Argument | Description |
|---|---|
viewName |
The name of a view. You can include the name of this view in double quotes or in a variable that contains the name of the view. |
Usage
You can set a view as read-only for a particular responsibility in the Responsibility Administration view. You can use the IsViewReadOnly method to determine if a view is read-only for the current responsibility before you attempt to edit a field.
Siebel CRM does not automatically set a button to read-only when that button resides in a view that is read-only. You can use the IsViewReadOnly method to set a button to read-only in a view where IsViewReadOnly returns TRUE.
Used With
To use this method, you can use an Application.InvokeMethod call with the following interfaces:
Browser Script
COM Data Control
COM Data Server
Siebel Java Data Bean
Mobile Web Client Automation Server
Server Script
Examples
The following example for Siebel eScript determines if the active view is read only:
function ShowViewROStatus()
{
var sActive = TheApplication().ActiveViewName();
if (TheApplication().InvokeMethod("IsViewReadOnly",sActive) == "TRUE")
TheApplication().RaiseErrorText(sActive + "is read only.");
else
TheApplication().RaiseErrorText(sActive + "is not read only.");
}
Language Method for an Application
The Language method returns the language code of the language that the active Siebel application is running. For example, ENU.
Format
Application.InvokeMethod("Language");
No arguments are available.
Used With
To use this method, you can use an Application.InvokeMethod call with Server Script.
Examples
The following example uses Siebel VB:
Dim curLang As String
curLang = TheApplication.InvokeMethod("Language")
The following example uses Siebel eScript:
var curLang;
curLang = TheApplication().InvokeMethod("Language");
LoadObjects Method for an Application
The LoadObjects method starts the COM Data Server. This method must be the first call to the COM Data Server. This method returns the following information:
If the COM Data Server starts successfully, then the LoadObjects method returns nothing.
If the COM Data Server does not start successfully, then the LoadObjects method returns an error.
Format
Application.LoadObjects(absoluteCFGfileName)
The following table describes the arguments for the LoadObjects method.
Table Arguments for the LoadObjects Method
| Argument | Description |
|---|---|
absoluteCFGfileName |
The path and name of the Siebel application configuration (CFG) file to open. For example: C:\Siebel\8.1\Server\BIN\ENU As an option, to identify the data source you can append the CFG file string with the data source, separated by a comma. For example: C:\Siebel\8.1\Server\BIN\ENU\siebel.cfg,ServerDataSrc If you do not specify the data source, then the LoadObjects method assumes the data source is local. |
Usage
Prior to calling the LoadObjects method, you must modify the current folder to the Siebel\bin folder.
If you use the COM Data Server, then the COM client cannot create multiple connections to the COM Server. For example, a second attempt to call the LoadObjects method causes an error message that is similar to the following:
The object definition manager has already been initialized.
You must restart the COM client before you can make another successful connection. Use COM Data Control instead.
Used With
COM Data Server
Examples
The following example uses COM Data Server:
Private Sub LoadConfig_Click()
Dim errCode As Integer
LoadConfig.Enabled = False
SiebelApplication.LoadObjects "C:\Siebel\8.1\Client_2\BIN\ENU\uagent.cfg", _
errCode
If errCode = 0 Then
ConfigOK = 1
End If
Status.Text = SiebelApplication.GetLastErrText
End Sub
LoadUserAttributes Method for an Application
The LoadUserAttributes method loads a user profile to the session. This method does not return any information.
Format
LoadUserAttributes(row_id)
The following table describes the arguments for the LoadUserAttributes method.
Table Arguments for the LoadUserAttributes Method
| Argument | Description |
|---|---|
row_id |
The row ID of the user whose profile Siebel CRM must load. |
Usage
To access the user profile, you can use the You profile from personalization rules, with the following exception: if the row ID is the row ID of the current user, then Siebel CRM loads the profile to the Me profile.
If you call this function with no argument, then it unloads the loaded user profile.
For information about user profiles, see Siebel Personalization Administration Guide.
Used With
Server Script
Examples
The following Siebel VB example loads a user profile to the session. The function is made available 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
Login Method for an Application
The Login method allows an external application to do the following:
Log in to the COM Data Server, COM Data Control, or Siebel Java Data Bean.
Access Siebel objects.
The Login method allows the end user to call 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.
This method returns a string that contains the error code.
Format
Application.Login([connectString,] username, password)
The following table describes the arguments for the Login method.
Table Arguments for the Login Method
| Argument | Description |
|---|---|
connectString |
Connect string that uses a token. |
username |
Username for the login. |
password |
User password for the login. |
Usage
Verify that the Siebel\bin folder is the current folder. To access Data Control, you must do the following work:
Make sure the default Data Source references the Siebel database that you must access. For more information, see Setting the Connect String.
In the Siebel application configuration (CFG) file, make sure the EnableOLEAutomation parameter is TRUE.
Used With
COM Data Control, COM Data Server, Mobile Web Client Automation Server, Siebel Java Data Bean
Examples
The connect string for COM Data Control uses a token. For example:
host = "Siebel://my_computer/SIEBEL/objsrvr/my_computer" lang = "ENU"
Most languages use quotes to enclose a text string, so you must use quotes in parentheses. For example:
To use COM Data Control in Visual Basic:
m_dataBean.login("siebel.tcpip.none.none://gateway:gatewayport/ enterpriseserver/SCCObjMgr", "username", "password");To use COM Data Control in C++:
Login("host=\"siebel://my_computer/SIEBEL/objsvr/my_computer\" lang = \"ENU\"","user","password");
The following example logs in to the Siebel Server and determines if errors exist:
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 Siebel Java Data Bean example that logs in to 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 Java Data Bean
m_dataBean = new SiebelDataBean();
// login to the Siebel 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());
}
}
}
LoginId Method for an Application
The LoginId method returns the login ID of the user who started the Siebel application.
Format
Application.LoginId
No arguments are available.
Usage
The login ID is the value of the ROW_ID column in the user login record in the S_USER table. You can use the login ID as a search specification.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
In this Siebel VB example in the BusComp_PreSetFieldValue event, the LoginId method determines if the user possesses the rights 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 modify Account Status " & _
"because you did not create the record.")
end if
End Select
BusComp_PreSetFieldValue = ContinueOperation
End Function
LoginName Method for an Application
The LoginName method returns the login name of the user who started the Siebel application. This login name is the name that the user types in the login dialog box. For more information, see Login Method for an Application.
Format
Application.LoginName
No arguments are available.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
For examples, see ExecuteQuery Method for a Business Component and TheApplication Method.
Logoff Method for an Application
The Logoff method disconnects the Siebel client from the Siebel Server. This method does not return any information.
Format
Application.Logoff
No arguments are available.
Usage
For clients that include a user interface, the Logoff method removes every window except for the topmost window. Logoff also removes every object, except for the topmost object, on the Siebel client and Siebel Server.
If you remove the main object, then Siebel CRM automatically calls the Logoff method.
Used With
COM Data Control, Siebel Java Data Bean, Mobile Web Client Automation Server
LookupMessage Method for an Application
The LookupMessage method returns message text for a key. It returns this information in the current language.
Format
Application.LookupMessage (category, key, [arg1], [arg2],...., [argN])
The following table describes the arguments for the LookupMessage method.
Table Arguments for the Lookup Message Method
| Argument | Description |
|---|---|
category |
Name of the Message Category object that is the parent of the Key value. You can define this value in Siebel Tools. |
key |
Name of the Message object whose text contains the value that Siebel CRM must format. You can define this value in Siebel Tools. |
Other arguments:
|
If the error message contains a substitution argument, such as %1, then Siebel CRM uses these optional arguments to format the error message. |
Usage
Useful for retrieving locale specific custom error messages.
Used With
Server Script
Examples
The following Siebel eScript example returns the following text:
Enter Account Title before stepping off.
To test this code in the User Defined Errors message category, create a new record with the following text:
Enter %1 before stepping off.
Siebel CRM uses the Account Title parameter to substitute the %1 variable:
var sVal = TheApplication().LookupMessage("User Defined Errors", "Test", "Account
Title");
LookupValue Method for an Application
If all of the following items are true, then the LookupValue method locates a row in the S_LST_OF_VAL table:
The value in the TYPE column matches the value in the type argument.
The value in the CODE column matches the value in the lang_ind_code argument.
The value in the LANG_ID column matches the language code of the currently active language.
You can use this method to get the translation of the untranslated value in the LOV to the language that is currently active.
The LookupValue method returns a string that contains the display value from the VAL column for the row. If it does not find the display value, then it returns the language independent code as the value.
Format
val = Application.InvokeMethod("LookupValue", type, lang_ind_cd)
The following table describes the arguments for the LookupValue method.
Table Arguments for the LookupValue Method
| Argument | Description |
|---|---|
type |
The type that is specified in the List of Values administration view. |
lang_ind_cd |
Value for the language independent code that is specified in the List of Values administration view. |
Used With
To use the LookupValue method, you can use an Application.InvokeMethod call with the following interfaces:
COM Data Control
Siebel Java Data Bean
Mobile Web Client Automation Server
Server Script
Examples
The following example is in Siebel eScript:
var LOVText = TheApplication().InvokeMethod("LookupValue","SR_AREA","Network");
Name Method for an Application
The Name method returns the name of the Siebel application.
Format
Application.Name
No arguments are available.
Used With
Browser Script, Web Client Automation Server
NewPropertySet Method for an Application
The NewPropertySet method creates a new property set. It returns a property set.
Format
Application.NewPropertySet
No arguments are available.
Usage
You can use the NewPropertySet method to create input and output arguments for a business service.
If you use the NewPropertySet method on an existing PropertySet object, then old references to this PropertySet are lost. If you reuse a PropertySet, then use the Reset method on this PropertySet.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
This example creates a new property set. It uses 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 the Component Object Model (COM):
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");
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 for an Application
The PositionId method returns the position ID of the user position. This position ID is the ROW_ID from the S_POSTN table. Siebel CRM sets this value by default when the Siebel application starts. To modify this value, the user can use the Edit menu, and then the Change Position menu item.
Format
Application.PositionId
No arguments are available.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
PositionName Method for an Application
The PositionName method returns the name of the current user position. Siebel CRM sets this value by default when it starts the Siebel application.
Format
Application.PositionName
No arguments are available.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following Siebel VB example determines the position of a user who is attempting to modify the sales stage. If the position does not allow this modification, then this code prevents the modification:
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 modified 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
RaiseError Method for an Application
The RaiseError method sends a scripting error message to the browser. The error code is a standard number.
To determine the error text, Siebel CRM uses the key to look up the current language from the User-Defined Errors category. To define these errors in Siebel Tools, you can use the Message Category object. You can use the optional arguments to format the string if it contains a substitution argument, such as %1 or %2. This method does not return any information.
Format
Application.RaiseError(key, [arg1], [arg2],...., [argN])
The arguments you can use in this format are the same as the arguments that are described in LookupMessage Method for an Application except that the RaiseError Method does not include a category argument.
Usage for the Raise Error Method
The RaiseError method causes Siebel CRM to terminate the script and send a notification to the browser. Therefore, you are not required to use CancelOperation after you use the RaiseError method. For more information, see Caution About Using the Cancel Operation Event Handler.
The RaiseError method and the RaiseErrorText method create a Server Script exception. If you use error handling in your script, then the error handling can suppress RaiseError and RaiseErrorText functionality.
If you use On Error Goto error handling in Siebel VB, and if you use the RaiseError method or the result from the RaiseErrorText method, then Siebel CRM transfers the script run to the error handler. If you use On Error Resume Next error handling, then Siebel CRM suppresses the RaiseError method and the RaiseErrorText method.
Used With
Server Script
Examples
In the following Siebel eScript example, the RaiseError method results in Siebel CRM raising a scripting exception and transferring control to the Catch statement. To display the error message, you must use the Throw statement:
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;
}
}
In the following Siebel eScript example, if the user deletes an opportunity that includes the Pipeline revenue class, then Siebel CRM sends an error message:
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;
}
}
Siebel CRM sends the following error message:
This user-defined test error is used in PreDelete, as an example for RaiseError Method
Note the following key:
user-defined test error1
This key is predefined as the following:
This user-defined test error is used in %1, as an example for %2.
When the script runs, Siebel CRM does the following:
Substitutes PreDelete for %1
Substitutes Raise Error Method for %2
RaiseErrorText Method for an Application
The RaiseErrorText method sends a scripting error message to the browser. This method does not return any information.
Format
Application.RaiseErrorText(value, [arg1], [arg2],...., [argN])
The following table describes the arguments for the RaiseErrorText method.
Table Arguments for the RaiseErrorText Method
| Argument | Description |
|---|---|
value |
The error text message. |
Other arguments:
|
If the error message contains a substitution argument, such as %1, then Siebel CRM uses these optional arguments to format the error message. |
Usage
Usage for the RaiseErrorText method is very similar to usage for the RaiseError method. For more information, see Usage for the Raise Error Method.
Used With
Server Script
Examples
In the following Siebel eScript example, the RaiseErrorText method causes Siebel CRM to raise a scripting exception and then transfer control to the Catch statement. To display the error message, you must use the Throw statement.
function BusComp_PreDeleteRecord ()
{
try {
var status = this.GetFieldValue("Account Status");
if (status == "Gold") {
TheApplication().RaiseErrorText("Unable to delete Gold Account");
}
else {
return (ContinueOperation);
}
}
catch (e) {
throw e;
}
}
In the following Siebel eScript example, if the user deletes an opportunity that includes Pipeline as the revenue class, then Siebel CRM sends an error:
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 for an Application
The SetPositionId method sets the active position to a Position Id. This method returns a Boolean value that indicates if Siebel CRM successfully completed the operation.
Format
Application.SetPositionId(positionId)
The following table describes the arguments for the SetPositionId method.
Table Arguments for the SetPositionId Method
| Argument | Description |
|---|---|
positionId |
A string that contains the Position Id. |
Usage
The positionId argument must contain the Position Id that is associated with the user who is currently logged in to the Siebel application.
Used With
COM Data Server, COM Data Control, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
SetPositionName Method for an Application
The SetPositionName method sets the active position to a position name. The method returns a Boolean value that indicates if the method succeeded.
Format
Application.SetPositionName(positionName)
The following table describes the arguments for the SetPositionName method.
Table Arguments for the SetPositionName Method
| Argument | Description |
|---|---|
positionName |
A string that contains the name of the position. |
Usage
The positionName argument must contain the Position name that is associated with the user who is currently logged in to the Siebel application.
Used With
COM Data Server, COM Data Control, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
SetProfileAttr Method for an Application
Personalization uses the SetProfileAttr method to set a value for an attribute in a user profile. This method does not return any information.
Format
Application.SetProfileAttr(name, value)
The following table describes the arguments for the SetProfileAttr method.
Table Arguments for the SetProfileAttr Method
| Argument | Description |
|---|---|
name |
A string that contains the name of the attribute. |
value |
The value of the attribute. |
Usage
The SetProfileAttr method sets the value of the value argument to an attribute in the user profile that the name argument contains. Siebel CRM does the following work:
If this attribute already exists, then Siebel CRM updates the corresponding persistent profile attribute in the Siebel application. This value is defined in the Personalization Profile business component.
If the profile attribute does not exist in the list of persistent profile attributes, then Siebel CRM creates it as a dynamic profile attribute. It does not include quotation marks at the beginning or end of the name.
If you use the SetProfileAttr method in Browser Script, then Siebel CRM performs a round trip to the Siebel Server and back to the browser each time it uses this method. This processing creates a performance overhead.
For more information about user profile attributes, see Siebel Applications Administration Guide.
Using System Fields with the SetProfileAttr Method
You cannot use the SetProfileAttr method with a system field. These fields are not explicitly defined in the Personalization Profile business component. You cannot use the SetProfileAttr method with the Id field because attempting to modify the ROW_ID column of a table creates an error. For more information about system fields, see Configuring Siebel Business Applications.
Personalization uses the GetProfileAttr method. Siebel CRM does not explicitly define system fields in the Personalization Profile business component, so you cannot use this method with a system field, except for the Id field. For more information, see Siebel Personalization Administration Guide.
Used With
Browser Script, COM Data Control, COM Data Server, Server Script, Siebel Java Data Bean, Mobile Web Client Automation Server
Examples
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");
}
else
return ("ContinueOperation");
}
The following examples exchange information between an applet Server Script and an applet Browser Script:
In the applet Server Script, Siebel CRM uses the SetProfileAttr method to set a customer profile attribute named MyProAttr to Hello World.
In the applet Browser Script, you can use the GetProfileAttr method to return the profile attribute.
The following example is in Siebel eScript:
function WebApplet_PreInvokeMethod (MethodName)
{
if (MethodName == "MyCustomMethod") {
TheApplication().SetProfileAttr("MyProAttr", "Hello World Siebel 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
ShowModalDialog Method for an Application
The ShowModalDialog method allows you to display a dialog box with the cursor in the default state. This application object method calls the equivalent object method in Microsoft Windows. This method returns the value of the returnValue property. The window of the document specified in the url argument sets this property.
Format
theApplication().ShowModalDialog (url[, argin][, options])
The following table describes the arguments for the ShowModalDialog method.
Table Arguments for the ShowModalDialog Method
| Argument | Description |
|---|---|
url |
The URL of the document that Siebel CRM finished loading and displaying. |
argin |
Passes arguments to use if Siebel CRM displays the document. This argument can be a value of any type, including an array of values. For more information, see the window.dialogArguments property of the object in the Document Object Model. For example:
|
options |
String that specifies the attributes for the dialog box. More information about values for the options argument is provided later in this topic. |
Values for the Options Argument
The following describes values you can use for the options argument of the ShowModalDialog method. You must use a semicolon to separate these values.
Table Values for the Options Argument of the ShowModalDialog Method
| Option | Description |
|---|---|
dialogHeight |
Sets the height of the dialog box. You must use an integer or floating-point number followed by one of the following items:
For consistent results, specify the dialogHeight and dialogWidth in pixels. The minimum height is 100 pixels. |
dialogLeft |
Sets the left position of the dialog box relative to the upper-left corner of the desktop. |
dialogTop |
Sets the top position of the dialog box relative to the upper-left corner of the desktop. |
dialogWidth |
Sets the width of the dialog box. |
center |
Sets centering for the dialog box. You can use one of the following values:
The default value is yes. |
dialogHide |
Specifies how to hide the dialog box if the user prints or uses print preview. This option is available only if the user opens the dialog box from a trusted application. You can use the same values that you use with the center option. The default value is no. |
edge |
Specifies the edge style of the dialog box. You can use one of the following values:
The default value is raised. |
help |
Specifies how to display the dialog box with the context-sensitive Help icon. You can use the same values that you use with the center option. The default value is yes. |
resizable |
Specifies if the dialog box dimensions are fixed. You can use the same values that you use with the center option. The default value is no. |
scroll |
Specifies if the dialog box displays scrollbars. You can use the same values that you use with the center option. The default value is yes. |
status |
Specifies how the dialog box displays a status bar. You can use the same values that you use with the center option. The default value is one of the following:
|
unadorned |
Specifies how the dialog box displays the border window chrome. This feature is available only if the user opens the dialog box from a trusted application. A trusted application is an application that includes a trust certificate. You can use the same values that you use with the center option. The default value is no. |
Used With
Browser Script
Examples
This example uses Browser Script to display a dialog box that includes a URL:
function Applet_Load ()
{
var sOptions="dialogHeight: 1000px;edge:sunken;resizable;yes";
theApplication().ShowModalDialog("http://www.yahoo.com", "", sOptions)
}
SWEAlert Method for an Application
The SWEAlert method displays a modal dialog box that includes a message. This method does not return any information.
Format
the Application().SWEAlert(message)
Usage
Use the SWEAlert method instead of alert. Note the following:
If you use the SWEAlert method, then Siebel CRM does not send the parent applet to the background.
If you use alert, then Siebel CRM sends pop-up applets to the background. MVGs and pick applets are examples of pop-up applets. If a browser event sends a JavaScript alert, then Siebel CRM hides the pop-up applet.
Used With
Browser Script
Examples
The following Browser Script example displays a status message:
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
return ("ContinueOperation");
}
else
return ("ContinueOperation");
}
Trace Method for an Application
The Trace method appends a message to the trace file. Trace helps to debug an SQL query and to monitor how Siebel CRM allocates objects. This method does not return any information.
This tracing is not the same as the tracing that you can activate in the Siebel application configuration (CFG) file. For more information, see Tracing a Script.
It is recommended that you do not use the Trace method or the TraceOn method in a production environment. For more information, see TraceOn Method for an Application.
Format
Application.Trace(message)
The following table describes the arguments for the Trace method.
Table Arguments for the Trace Method
| Argument | Description |
|---|---|
message |
String variable or literal that contains message text that Siebel CRM appends to the trace file. |
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is for COM Data Server:
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:
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
Example Trace Output
The following is example 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 example 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
For more information, see the following topics:
TraceOff Method for an Application
The TraceOff method turns off tracing that the TraceOn method starts. This method does not return any information.
Format
Application.TraceOff
No arguments are available.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
This following example in Siebel VB sets the value in the Sales Stage field to the first value in the drop-down list for the field. It 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
TraceOn Method for an Application
The TraceOn method turns on tracing for allocations and deallocations of Siebel objects and SQL statements that Siebel CRM creates. This method does not return any information.
Format
Application.TraceOn(filename, type, selection)
The following table describes the arguments for the TraceOn method.
Table Arguments for the TraceOn Method
| Argument | Description |
|---|---|
filename |
Output filename for trace messages. If you do not use this argument, then Siebel CRM logs tracing information to the Object Manager log file. More information about the filename argument is provided later in this topic. |
type |
The type of tracing to start. You can use the following values:
|
selection |
Identifies the Siebel objects that Siebel CRM must trace for the Allocation trace type. This argument is "" if the trace type is SQL:
|
Filename Argument of the TraceOn Method
You can use the following values for the filename argument:
$p. Substitutes the process Id for the filename.
$t. Substitutes the thread Id for the file name.
For example:
TheApplication().TraceOn("C:\\temp\\trace_$p_$t.txt", "Allocation", "All");
This code causes Siebel CRM to log trace files to the trace_1496_1412.txt file in the C:\temp\trace folder.
To make sure the filename argument is unique, you must place a separator between the $p and $t values. For example, assume you do not use a separator and the following items are true:
The process id for user A is 1 and the thread id is 12.
The process id for user B is 11 and the thread id is 2.
In this situation, the file name is trace_112.txt for user A and for user B, so Siebel CRM logs trace information for each user to the same file.
If you add a separator between the process id and the thread id, then the file names are unique and Siebel CRM logs trace information to a separate file for each user. For example:
trace_1_12.txt
trace_11_2.txt
Usage
To turn off tracing, you must call the TraceOff method. If you attempt to call the TraceOn method with a different filename without first calling TraceOff, then Siebel CRM writes trace information to the new trace file name. The old file remains open and is locked. You can issue multiple TraceOn statements to the same trace file.
It is recommended that you do not use the Trace method or the TraceOn method in a production environment. For more information, see Trace Method for an Application.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is for COM Data Server:
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("C:\\temp\\trace.txt", "Allocation", "All");
TheApplication().TraceOn("C:\\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
For example trace output, see Trace Method for an Application.
The following examples use Trace, Traceoff, and TraceOn methods to create 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);
ClearToQuery();
SetSortSpec("Sales Stage Order(ASCENDING)");
ExecuteQuery(ForwardOnly);
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")
With oBC
.SetViewMode AllView
.ClearToQuery
.SetSortSpec "Sales Stage Order(ASCENDING)"
.ExecuteQuery ForwardOnly
If .FirstRecord Then
.Pick
End If
End With
Set oBC = Nothing
TheApplication.Trace "End of tracing!"
TheApplication.TraceOff
End Sub
Related Topics
For more information, see the following topics:
Application Events
This topic describes application events. It includes the following topics:
You can use these events only on the Siebel Server, except for the following events that you can use on the Siebel Server or on the browser:
Application_InvokeMethod Event
Application_PreInvokeMethod Event
Application_Close Event
You can call the Application_Close event before the Siebel application exits. This technique allows scripts to perform cleanup, such as closing a connection to a COM server. Note the following:
If Windows notifies the Siebel application that it must close, then Siebel CRM calls this event.
If the process is terminated directly, then Siebel CRM does not call this event. For example, a direct termination occurs if the user clicks the close (X) icon at the top right of a window.
This event does not return any information.
Format
Application_Close
No arguments are available.
Used With
Server Script
Siebel Business Processes call this event. For more information, see Siebel Business Process Framework: Workflow Guide.
Application_InvokeMethod Event
Siebel CRM calls the Application_InvokeMethod event after a specialized method is called. This method returns TRUE if the call succeeds or FALSE if the call does not succeed. For more information, see About Specialized and Custom Methods.
Browser Script Format
Application_InvokeMethod(name, inputPropSet)
The arguments you use with this format are the same as the arguments described in Applet_InvokeMethod Event.
This method sends the values you enter in the inputPropSet argument to the Invoke Method event.
Server Script Format
Application_InvokeMethod(methodName)
The arguments you use with this format are the same as the arguments described in Applet_InvokeMethod Event except there is no inputPropSet argument.
Used With
Browser Script, Server Script
Related Topics
For more information, see the following topics:
Application_PreInvokeMethod Event
Siebel CRM calls the Application_PreInvokeMethod event before one of the following items calls a specialized method:
A custom applet menu that you define
The InvokeMethod method
This method returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
For more information about this method, see About Specialized and Custom Methods and Customizing the Outcome of an Object Interface Event.
Browser Script Format
Application_PreInvokeMethod (methodName, inputPropSet)
The arguments you use with this format are the same as the arguments described in Applet_InvokeMethod Event.
Server Script Format
Application_PreInvokeMethod(methodName)
The arguments you use with this format are the same as the arguments described in Applet_InvokeMethod Event, except that there is no inputPropSet argument.
Usage
If the method you instruct Siebel CRM to call is part of an If statement, then you must set the return value for the PreInvokeMethod before the End If statement. The following code is an example of this usage:
If MethodName = "ResetQuery" then Application_PreInvokeMethod = CancelOperation End If
Used With
Browser Script, Server Script
Examples
The following example is in Siebel VB:
Function Application_PreInvokeMethod (MethodName _
As String) As Integer
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 example in Siebel eScript. Note that for this script to run, the entire Clib.system statement must reside 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);
}
Application_Start Event
Siebel CRM calls the Application_Start event when the Siebel client starts and again when it displays the client interface for the first time. This event does not return any information.
Format
Application_Start(commandline)
The following table describes the arguments for the Application_Start event.
Table Arguments for the Application_Start Event
| Argument | Description |
|---|---|
commandline |
Text of the command line that starts the Siebel application. |
Siebel Business Processes call this event. For more information, see Siebel Business Process Framework: Workflow Guide.
Used With
Server Script
Examples
This example Siebel VB code returns the first and last name of the user who logs in to 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
Business Component Methods
This topic describes business component methods. It includes the following topics:
The oBusComp and BusComp variables that this topic describes refer to an instance of a business component.
ActivateField Method for a Business Component
The ActivateField method activates a field. This method does not return any information. You must use the ActivateField method to activate a field before you can perform a query for the business component. For more information, see DeactivateFields Method for a Business Component.
Format for the Activate Field Method
BusComp.ActivateField(FieldName)
The following table describes the arguments for the ActivateField method.
Table Arguments for the ActivateField Method
| Argument | Description |
|---|---|
FieldName |
String variable or literal that contains the name of the field. |
You must enclose the FieldName argument in double quotes. The value you enter for the FieldName argument must match exactly the field name that displays in Siebel Tools, including the same case. For example:
ActivateField("ActivityCreatedByName")
Usage for the ActivateField Method
By default, a field is inactive except in the following situations:
The field is a system field, such as Id, Created, Created By, Updated, or Updated By.
The Force Active property of the field is TRUE.
If you write an event handler on a business component, then you must use the ForceActive user property on the control to make sure the field is active. For more information, see Siebel Developer's Reference.
The Link Specification property of the field is TRUE.
The field is included in an applet, and this applet references a business component that is active. For a field in a list applet, the Show In List list column property is TRUE.
Siebel CRM calls the ActivateField method on the field, and then runs the ExecuteQuery method.
Note the following:
If Siebel CRM activates a field after it queries a business component, then it must requery the business component before the user can access the value in that field. If Siebel CRM does not requery the business component, then it returns a value of 0.
If Siebel CRM calls the ActivateField method after it calls the ExecuteQuery method, then the ActivateField method deletes the query context.
The ActivateField method causes Siebel CRM to include the field in the SQL statement that the ExecuteQuery method starts. If Siebel CRM activates a field, and then if a statement in the GetFieldValue method or the SetFieldValue method references the file before Siebel CRM performs a statement from the ExecuteQuery method, then the activation has no effect. The query contains an empty value because Siebel CRM does not return the activated field through this query.
Siebel CRM does not restrict the maximum number of fields that the ActivateField method can activate. This number depends on the SQL query limitations of the database that your deployment uses.
Avoiding a Corrupted Database
If Siebel CRM does not activate a field before it performs a WriteRecord command, then it writes data to the Siebel database, but a corruption problem might occur if a mobile user synchronizes. This situation applies only to mobile users.
To avoid a corrupted database
Use the ActivateField method to call a field.
Call the ExecuteQuery method.
Call the WriteRecord method.
Using this sequence makes sure Siebel CRM writes the field correctly to the transaction log. During synchronization, it saves any modifications that the mobile user makes back to the Siebel database correctly.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is in Siebel VB. For an equivalent Siebel eScript example, see ClearToQuery Method for a Business Component:
Dim oEmpBusObj As BusObject
Dim oEmpBusComp As BusComp
Dim sLoginName As String
Set oEmpBusObj = TheApplication.ActiveBusObject
Set oEmpBusComp = oEmpBusObj.GetBusComp("Employee")
oEmpBusComp.SetViewMode AllView
oEmpBusComp.ClearToQuery
oEmpBusComp.SetSearchSpec "Login Name", sLoginName
oEmpBusComp.ExecuteQuery ForwardBackward
Set oEmpBusComp = Nothing
Set oEmpBusObj = Nothing
ActivateMultipleFields Method for a Business Component
The ActivateMultipleFields method activates multiple fields. This method returns one of the following values:
TRUE if the activation is successful
FALSE if the activation is not successful
Format
BusComp.ActivateMultipleFields(SiebelPropertySet)
The following table describes the arguments for the ActivateMultipleFields method.
Table Arguments for the ActivateMultipleFields Method
| Argument | Description |
|---|---|
SiebelPropertySet |
Property set that identifies a collection of properties. These properties identify the fields that Siebel CRM must activate. |
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is for Siebel Java Data Bean:
import com.siebel.data.*;
...
//Create Siebel Java Data Bean.
//log in to Siebel Java 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","");
ps.setProperty("Description","");
ps.setProperty("Name","");
siebBusComp.ActivateMultipleFields(ps);
...
The following Siebel eScript example queries the Contact business component and returns the First Name and Last Name of the first contact that it finds:
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(ForwardBackward);
if (FirstRecord())
{
GetMultipleFieldValues(fieldsPS, valuesPS);
var slName = valuesPS.GetProperty("Last Name");
var sfName = valuesPS.GetProperty("First Name");
}
}
Related Topics
For more information, see the following topics:
Associate Method for a Business Component
The Associate method creates a new many-to-many relationship for the parent object through an association business component. This method does not return any information. For more information, see GetAssocBusComp Method for a Business Component.
Format
BusComp.Associate(whereIndicator)
The following table describes the arguments for the Associate method.
Table Arguments for the Associate Method
| Argument | Description |
|---|---|
whereIndicator |
You must use one of the following predefined constants:
For more information, see Use Constants to Standardize Code. |
Usage
To set field values on a child record that is associated with a parent record, use the context of the multivalue group business component.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following VB example updates the Opportunity Assignment Type field. The parent business component can be any business component that includes the Sales Rep multivalue 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 when the Last Name is Abanilla, and then adds a new organization named CKS Software to the Organization multivalue group:
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(ForwardOnly);
if (FirstRecord())
{
// Instantiates Organization MVG
var oMvgBC = GetMVGBusComp("Organization");
var oAssocBC = oMvgBC.GetAssocBusComp();
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
oAssocBC = null;
oMvgBC = null;
} // With ContactBC
ContactBC = null;
ContactBO = null;
Related Topics
For more information, see the following topics:
BusObject Method for a Business Component
The BusObject method returns the name of the business object that the business component references. For more information, see ActiveBusObject Method for an Application.
Format
BusComp.BusObject
No arguments are available.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
For an example, see SetViewMode Method for a Business Component.
ClearToQuery Method for a Business Component
The ClearToQuery method clears the current query but does not clear sort specifications on a business component. This method does not return any information. For more information, see RefineQuery Method for a Business Component.
Format
BusComp.ClearToQuery
No arguments are available.
Usage
You must use the ActivateField method to activate a field before you can use the ClearToQuery method. For more information, see ActivateField Method for a Business Component.
Search and sort specifications sent to a business component are cumulative. The business component retains and logically performs an AND operation for the queries that accumulate since the last time Siebel CRM performed the ClearToQuery method. This situation is true except if there is a new search specification on a field, and if that field already included a search specification. In this situation, the new search specification replaces the old search specification.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is in Siebel eScript.
var oEmpBusObj = TheApplication().ActiveBusObject();
var oEmpBusComp = oEmpBusObj ().GetBusComp("Employee");
var sLoginName;
oEmpBusComp.ClearToQuery();
oEmpBusComp.SetSearchSpec("Login Name", sLoginName);
oEmpBusComp.ExecuteQuery(ForwardBackward);
oEmpBusComp = null;
oEmpBusObj = null;
For more examples, see the following:
For Siebel VB examples, see the following topics:
For another Siebel eScript example, see GotoView Method for an Application.
CountRecords Method for a Business Component
The CountRecords method returns the number of records that the most recent call to the ExecuteQuery method returned.
Format
BusComp.CountRecords()
No arguments are available.
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*");
ExecuteQuery(ForwardBackward);
var count = CountRecords();
}
// other code..
bc = null;
bo = null;
return (CancelOperation);
}
return (ContinueOperation);
}
DeactivateFields Method for a Business Component
The DeactivateFields method deactivates fields from the SQL query statement of a business component. It deactivates fields that are currently active. This situation is true except in the following situations:
The Force Active property is TRUE
A link requires the field to remain active.
A business component class requires the field to remain active.
This method does not return any information.
Format
BusComp.DeactivateFields
No arguments are available.
Usage
You must use the ActivateField method to activate a field before you perform a query for a business component. For more information, see ActivateField Method for a Business Component.
After you deactivate a field, you must query the business component again or the Siebel application fails.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is for the Component Object Model (COM):
Dim oBO As BusObject
Dim OBC As BusComp
Dim errCode
Set oBO = SiebelApplication.GetBusObject("Account", errCode)
Set oBC = oBO.GetBusComp("Account", errCode)
oBC.ActivateField "Name", errCode
oBC.ActivateField "Location", errCode
oBC.ClearToQuery errCode
oBC.ExecuteQuery ForwardOnly, errCode
' Manipulate the data
oBC.DeactivateFields 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.ActivateField("Name");
oBC.ActivateField("Location");
oBC.ClearToQuery();
oBC.ExecuteQuery(ForwardOnly);
// Manipulate the data
oBC.DeactivateFields();
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.ActivateField "Name"
oBC.ActivateField "Location"
oBC.ClearToQuery
oBC.ExecuteQuery ForwardOnly
' Manipulate the data
oBC.DeactivateFields
Set oBC = Nothing
Set oBO = Nothing
DeleteRecord Method for a Business Component
The DeleteRecord method removes the current record from a business component. This method does not return any information.
Format
BusComp.DeleteRecord
No arguments are available.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
This Siebel VB example deletes 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
Siebel CRM moves the cursor to the next record after it runs the DeleteRecord method. Do not use the NextRecord method after you use the DeleteRecord method in a loop because this configuration causes Siebel CRM to skip deleting the last record in the loop. If you use the DeleteRecord method on the last record, then the cursor points to nothing.
ExecuteQuery Method for a Business Component
The ExecuteQuery method uses criteria form another method, such as the SetSearchSpec method, to return a set of business component records. This method allows you to specify the order that Siebel CRM uses to process records.
Format
BusComp.ExecuteQuery ([cursorMode])
The following table describes the arguments for the ExecuteQuery method.
Table Arguments for the ExecuteQuery Method
| Argument | Description |
|---|---|
cursorMode |
An integer. You must use one of the following constants:
For more information, see Use Constants to Standardize Code. |
Usage
To achieve maximum performance, use ForwardOnly. If you use ForwardOnly, make sure that your Siebel application code does not use PreviousRecord or FirstRecord to navigate backward without a requery. Do not use ForwardOnly with a UI business component unless the Siebel application code performs a requery with the cursorMode argument set to ForwardBackward.
A UI business component is a type of business component that Siebel CRM is actively using in the Siebel client. You can write a script that creates a UI business component that does not reference the data the user manipulates. A user might scroll up and down a record set, so you must use ForwardBackward.
You Must Activate Fields Before You Can Query Them
Before you can query a business component, you must use the ActivateField method to activate all fields that are involved in the query. If you write an event handler on a business component, then you must use the ForceActive user property on the control to make sure the field is activate.
Reducing a Large Query Set
If you use ForwardBackward, and if the query matches over 10,000 records, then the object manager returns an error message that is similar to the following:
There were more rows than could be returned. Refine your query to bring back fewer rows.
To reduce the number of queries, you can use a parent-child relationship between business components that the business object establishes. For example, the Opportunity business object establishes a parent-child relationship between the Opportunity business component and the Contact business component. If you instruct Siebel CRM to query the Opportunity business component, then it can read values from the corresponding records in the Contact business component without performing another query. You must instruct Siebel CRM to query the parent business component first, and then to query the child business component. If you query the child business component first, then Siebel CRM returns no records.
How Siebel CRM Handles Duplicate Records with the ExecuteQuery Method
A faulty join configuration or duplicate data in joined tables might cause a business component to return duplicate records. If Siebel CRM detects duplicate records when it executes the ExecuteQuery method, then it does the following work depending on the value of the cursorMode argument:
ForwardBackward. It automatically filters duplicate records to make sure each record is unique.
ForwardOnly. It does not filter records. It returns all records that match the criteria, including duplicate records. If you update all records that Siebel CRM returns, then it displays an error that is similar to the following:
The selected record has been modified by another user since it was retrieved. Please continue.
This error can occur if the code attempts to update the duplicate of a record that it already updated.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
This Siebel VB example sets up and runs a query that locates the primary on the account team. Only the primary can modify the primary address.
(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 modify the Primary address
because you are not the Primary on the Account Team")
End If
Exit Do
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
For other examples, see the following topics:
Related Topics
For more information, see the following topics:
ExecuteQuery2 Method for a Business Component
The ExecuteQuery2 method uses criteria form another method, such as SetSearchSpec, to return a set of business component records. Allows you to control the number of records Siebel CRM returns.
Format
BusComp.ExecuteQuery2 ([cursorMode], ignoreMaxCursorSize)
The following table describes the ignoreMaxCursorSize argument for the ExecuteQuery2 method. For information about the cursorMode argument, see ExecuteQuery Method for a Business Component.
Table Arguments for the ExecuteQuery2 Method
| Argument | Description |
|---|---|
ignoreMaxCursorSize |
You can use one of the following values:
|
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
FirstRecord Method for a Business Component
The FirstRecord method moves the record pointer to the first record in a business component, making that record the current record. It also calls any associated script events. This method returns the following information:
An integer in Siebel VB. It returns 1 or nonzero if it finds at least one record. It returns 0 (zero) if it does not find any records.
a Boolean value in Siebel eScript, COM, or ActiveX.
If you issue a query on a business component, then Siebel CRM creates SQL for any child business component that is active. Calling the FirstRecord method starts the BusComp_ChangeRecord event and causes Siebel CRM to run the same SQL for the child business component again.
For more information, see NextRecord Method for a Business Component.
Format
BusComp.FirstRecord
No arguments are available.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
To determine if an account displayed in a child applet includes a service request, the following examples use the FirstRecord method. The outcome of this query can determine if Siebel CRM must run other code for this account record. In this example, the Account List Applet is a child applet in the Contact Detail - Accounts View.
The following example is in Siebel eScript:
function BusComp_PreInvokeMethod (MethodName)
{
// 'CheckSR' method called 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())
{
// more code placed here
}
else
{
TheApplication().RaiseErrorText("No Service Requests Associated To This
Account.")
}
}
return (CancelOperation);
}
return (ContinueOperation);
}
The following example is in Siebel VB:
Function BusComp_PreInvokeMethod (MethodName As String) As Integer
Dim iRtn As Integer
iRtn = ContinueOperation
''CheckSR' method called 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
'[more code placed here]
Else
TheApplication.RaiseErrorText("No Service Requests Associated To This
Account.")
End If
End With
Set oBC = Nothing
Set oBO = Nothing
iRtn = CancelOperation
End If
BusComp_PreInvokeMethod = iRtn
End Function
FirstSelected Method for a Business Component
The FirstSelected method makes the first record of the multiple selection in a business component active. It also calls any associated events. It returns the same information as the FirstRecord method. For more information, see FirstRecord Method for a Business Component.
Format
BusComp.FirstSelected
No arguments are available.
Used With
COM Data Server, Server Script
Examples
The following examples use the FirstSelected method and the NextSelected method to allow you to customize multirecord deletion. If the user clicks a custom button in an applet, then Siebel CRM can call this code and it can call the Delete Selected custom method.
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
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 for a Business Component
The GetAssocBusComp method returns a string that contains the name of the association business component. You can use the association business component to manipulate the association.
Format
BusComp.GetAssocBusComp
No arguments are available.
Usage for the GetAssocBusComp Method
It is appropriate to use the GetAssocBusComp method and the Associate method only with a many-to-many relationship that uses an intersection table. For example, account and industry. In the context of a many-to-many relationship, you can use Siebel VB to do the following:
To associate a new record, add it to the child business component. To add a record, you use the GetAssocBusComp method and the Associate method. You set the GetAssocBusComp method to Nothing in Siebel VB or null in Siebel eScript.
To insert a record, create a new record in the child business component. To insert a record, you use the GetMVGBusComp method and the NewRecord method.
If a many-to-many link exists, and if an association applet is defined for the child applet, then you can use the GetAssocBusComp method with the child business component of a parent-child view. You can use this technique instead of modifying the multivalue group business component.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is in Siebel VB. It uses the GetAssocBusComp method to add a new industry to an account:
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 same example in Siebel eScript:
//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
For more information, see the following topics:
GetFieldValue Method for a Business Component
The GetFieldValue method returns one of the following items:
A string that contains the value of a field from the current record of a business component.
An empty string if the field is empty.
An error message if the field is inactive. To avoid this situation, activate the field before you use the GetFieldValue method. For more information, see ActivateField Method for a Business Component.
The GetFieldValue method uses the MM/DD/YYYY format when it returns a date field regardless of what format the local date uses. To return the date in the same format that the local date uses, you can use the GetFormattedFieldValue method. For more information, see GetFormattedFieldValue Method for a Business Component.
In Browser Script, you can use the GetFieldValue method only if the field is available in the applet and for system fields.
Format
BusComp.GetFieldValue(FieldName)
The arguments you can use in this format are the same as the arguments described in ActivateField Method for a Business Component.
Usage for the GetFieldValue Method
If you require a value from a business component that is a parent of the current business component, then you must make sure the Link Specification property for that field is set to TRUE in Siebel Tools. If it is not, then the child business component cannot access the value in the parent business component. For more information, see Siebel Object Types Reference.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is in Siebel VB:
Function BusComp_PreSetFieldValue (FieldName As String, FieldValue As String) As
Integer
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 example is 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;
}
GetFormattedFieldValue Method for a Business Component
The GetFormattedFieldValue method returns the following information:
A string that contains a field value that is in the same format that the Siebel client uses.
An empty string if the field is inactive or empty.
Format
BusComp.GetFormattedFieldValue(FieldName)
The arguments you can use in this format are the same as the arguments that are described in ActivateField Method for a Business Component.
Usage
You can use the GetFormattedFieldValue method with code that your implementation uses in multiple countries that use different formats for currency, date, or numbers.
Usage with Phone Data and Date Data
The following behavior exists for phone data and date data:
DTYPE_PHONE. If you use the GetFormattedFieldValue method with a field whose Type property is DTYPE_PHONE, then this method returns a formatted phone number.
Example 1:
phone = bc.GetFieldValue("Main Phone Number") TheApplication.Trace "The number is " & phoneResult:
The number is 8869629123
Example 2:
phone = bc.GetFormattedFieldValue("Main Phone Number") TheApplication.Trace "The number is " & phoneResult:
The number is (886) 962-9123
DTYPE_DATE. If you use the GetFormattedFieldValue method with a field whose Type property is DTYPE_DATE, then the result is the same as the GetFieldValue method or the SetFieldValue method except that the GetFormattedFieldValue method returns the value in the same format as the Regional Setting.
The following table describes the formats that the GetFieldValue method and the SetFieldValue method use.
Table Date and Time Formats That the GetFieldValue Method and SetFieldValue Method Use
| Type of Data | Format |
|---|---|
Dates |
mm/dd/yyyy |
Times |
hh:nn:ss |
Date-times |
mm/dd/yyyy hh:nn:ss |
If you attempt to use the SetFieldValue method, and if the Regional Setting format is different, then Siebel CRM displays an error that is similar to the following:
Error: The value '31-Dec-99' can not be converted to a date time value.
To avoid this error, use the GetFormattedFieldValue format or the SetFormattedFieldValue method.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following Siebel VB example uses the GetFormattedFieldValue method and calculates 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
For more information, see the following topics:
GetLastErrCode Method for a Business Component
The GetLastErrCode method returns the error code for the error that Siebel CRM logged most recently. This code is a short integer. 0 (zero) indicates no error.
Format
BusComp.GetLastErrCode
No arguments are available.
Usage
For more information, see Usage for the GetLastErrCode Method.
Used With
COM Data Control, Mobile Web Client Automation Server
GetLastErrText Method for a Business Component
The GetLastErrText method returns a string that contains the text message for the error that Siebel CRM logged most recently.
Format
BusComp.GetLastErrText
No arguments are available.
Usage
For more information, see Usage for the GetLastErrText Method.
Used With
COM Data Control, Mobile Web Client Automation Server
GetMultipleFieldValues Method for a Business Component
The GetMultipleFieldValues method returns a value for each field specified in a property set. It also returns the following information:
TRUE if it finds the fields.
FALSE if it does not find the fields.
For more information, see SetMultipleFieldValues Method for a Business Component.
Format
BusComp.GetMultipleFieldValues(fieldNamesPropSet, fieldValuesPropSet)
The following table describes the arguments for the GetMultipleFieldValues method.
Table Arguments for the GetMultipleFieldValues Method
| Argument | Description |
|---|---|
fieldNamesPropSet |
A property set that identifies a collection of fields. |
fieldValuesPropSet |
A property set that provides values for the fields specified in the fieldNamesPropSet argument. |
Usage
You cannot use the same instance of a property set for the fieldNamesPropSet argument and for the fieldValuesPropSet argument.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is in Siebel eScript:
try {
var oPsDR_Header:PropertySet = TheApplication().NewPropertySet();
// Cannot use the same property set in GetMultipleFieldValues, must use a different
// one for the values. The process will not error, but the values will not be placed
// in the property set.
var lPS_values:PropertySet = TheApplication().NewPropertySet();
oPsDR_Header.SetProperty("Last Name","");
oPsDR_Header.SetProperty("First Name","");
oPsDR_Header.SetProperty("Middle Name","");
var boContact = TheApplication().GetBusObject("Contact");
var bcContact = boContact.GetBusComp("Contact");
with (bcContact) {
ClearToQuery();
SetViewMode(AllView);
ActivateMultipleFields(oPsDR_Header);
SetSearchSpec("Last Name", "Mead*");
ExecuteQuery(ForwardOnly);
var isParent = FirstRecord();
do {
// Use a different property set for the values. If you use the same one
// for arguments you get no values back.
GetMultipleFieldValues(oPsDR_Header, lPS_values);
// Get the value from the output property set.
TheApplication().Trace("Last Name = " +
lPS_values.GetProperty("Last Name"));
} while (NextRecord());
} //end with
} //end try
catch(e) {
TheApplication().Trace(e.toString());
}//end catch
GetMVGBusComp Method for a Business Component
The GetMVGBusComp method returns the multivalue group business component that is associated with a business component field.
Format
BusComp.GetMVGBusComp(FieldName)
The arguments you can use in this format are the same as the arguments that are described in ActivateField Method for a Business Component except that the GetMVGBusComp method uses the FieldName argument to identify the multivalue group business component.
Usage
A multivalue group is a set of detail records attached to the current record in a business component that holds the corresponding multivalue field. After you run the GetMVGBusComp method, it is recommended that you set the multivalue group business component to one of the following:
Nothing in Siebel VB
Null in Siebel eScript
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example Siebel VB code uses the GetMVGBusComp method to add a new address to the Hong Kong Flower Shop account:
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
If (.FirstRecord) Then Set AddrBC = .GetMVGBusComp ("Street Address")
With AddrBC
.NewRecord NewAfter
.SetFieldValue "City", "Denver"
.SetFieldValue "Street Address", "123 Main Street"
.WriteRecord
End With
End If
End With
Set AddrBC = Nothing
Set AccntBC = Nothing
Set AccntBO = Nothing
For more examples, see the following topics:
For more information about inserting records, see Usage for the GetAssocBusComp Method.
GetNamedSearch Method for a Business Component
The GetNamedSearch method returns a string that contains the name of a search specification.
Format
BusComp.GetNamedSearch(searchName)
The following table describes the arguments for the GetNamedSearch method.
Table Arguments for the GetNamedSearchMethod
| Argument | Description |
|---|---|
searchName |
Name of the search specification that references the search string. |
Usage
The search specification uses the same format that a predefined query uses.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Related Topics
For more information, see the following topics:
GetPicklistBusComp Method for a Business Component
The GetPicklistBusComp method returns the name of the pick business component that is associated with a field in the current business component. If there is no picklist associated with this field, then this method returns an error.
Format
BusComp.GetPicklistBusComp(FieldName)
The arguments you can use in this format are the same as the arguments that are described in ActivateField Method for a Business Component, except that the GetPicklistBusComp method uses the FieldName argument to identify the pick business component.
Usage
To manipulate a picklist, you can use the name of the pick business component that the GetPicklistBusComp method returns.
After you run the GetPickListBusComp method, it is recommended that you set the pick business component to one of the following:
Nothing in Siebel VB
Null in Siebel eScript
Picking a Record on a Constrained Picklist
If Siebel CRM uses the GetPickListBusComp method or the Pick method to pick a record on a constrained picklist, then the constraint is active. The pick business component that these methods return contains only those records that fulfill the constraint.
To Pick a Value From a Picklist in Siebel VB
You can pick a value from a picklist in Siebel VB.
To pick a value from a picklist in Siebel VB
Use the GetPicklistBusComp method to create an instance of the picklist business component.
Navigate in the pick business component to the record you must pick.
Use Pick to pick the value.
To explicitly delete this instance of the pick business component, use the following code:
Set objBCPickList = Nothing.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
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();
}
oBCPick = null;
}
The following example is for Siebel Java Data Bean. It chooses 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
For more information, see the following topics:
GetSearchExpr Method for a Business Component
The GetSearchExpr method returns a string that contains the current search expression that is defined for a business component. For example:
[Revenue] > 10000 AND [Probability] > .5
If an instance of the business component does not exist, then the GetSearchExpr method returns nothing. If you use the GetSearchExpr method in Browser Script with the Applet_PreInvokeMethod event, then it returns a null value even if you add a query filter.
Format
BusComp.GetSearchExpr
No arguments are available.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Related Topics
For more information, see the following topics:
GetSearchSpec Method for a Business Component
The GetSearchSpec method returns a string that contains the search specification that is defined for a business component. For example, > 10000.
Format
BusComp.GetSearchSpec(FieldName)
The arguments you can use in this format are the same as the arguments that are described in ActivateField Method for a Business Component, except the GetSearchSpec method uses the FieldName argument to identify the search specification.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Related Topics
For more information, see the following topics:
GetSortSpec Method for a Business Component
The GetSortSpec method returns the sort specification for a business component.
Format
this.GetSortSpec();
No arguments are available.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Related Topics
For more information, see the following topics:
GetUserProperty Method for a Business Component
The GetUserProperty method returns the value of a user property.
Format
BusComp.GetUserProperty(propertyName)
The following table describes the arguments for the GetUserProperty method.
Table Arguments for the GetUserProperty Method
| Argument | Description |
|---|---|
propertyName |
The name of the user property. |
Usage for the GetUserProperty Method
A user property is similar to an instance variable of a business component. You can use the GetUserProperty method to access a user property from anywhere in the code, even from another application through COM.
An instance variable is a type of variable that is defined at the top level of the business component in the general declarations section. You can access an instance variable only in Siebel VB, and in the same object where you declare the instance variable. For more information, see SetUserProperty Method for a Business Component.
Siebel CRM resets the value of a user property every time you create a business component instance.
The GetUserProperty method does not interact directly with user properties that you define in Siebel Tools.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
GetViewMode Method for a Business Component
The GetViewMode returns a Siebel ViewMode constant or the corresponding integer value for this constant. This constant identifies the current visibility mode for a business component. This mode effects the records that queries return according to the visibility rules. For more information, see SetViewMode Method for a Business Component and Use Constants to Standardize Code.
Format
BusComp.GetViewMode
No arguments are available.
Usage
The GetViewMode method returns NoneSetView mode until one of the following situations is true:
Siebel CRM queries a business component.
The SetViewMode method sets the view mode for the business component.
The NoneSetViewMode value indicates that no visibility rules are applied to the business component. If Siebel CRM creates a business component through a call to the GetBusComp method, then the value for that business component is NoneSetViewMode. If you require a specific view mode, then you must use the SetViewMode method to set this view mode. If you do not use the SetViewMode method, then Siebel CRM sets the view mode according to the most restrictive visibility mode that is defined for that business component. It does this the first time that it creates a business component instance.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
InvokeMethod Method for a Business Component
The InvokeMethod method calls a method. It returns a string that contains the result of the method. For more information, see About Specialized and Custom Methods.
Siebel VB Format
BusComp.InvokeMethod methodName, methArg1, methArg2, methArgN
The following table describes the arguments for the Siebel VB format of the InvokeMethod method.
Table Arguments for the Siebel VB Format of the InvokeMethod Method
| Argument | Description |
|---|---|
methodName |
The name of the method. For information about the values you can enter for this argument, see Business Component Invoke Methods. |
You can use the following arguments:
|
A single string that contains arguments for the methodName argument. You can also pass this string in an array that contains the method parameters. |
Siebel eScript Format
BusComp.InvokeMethod(methodName, methArg1, methArg2, …, methArgn);
The arguments you can use in this format are the same as the arguments that are described for the Server Script format in InvokeMethod Method for an Applet.
Usage
You can use the InvokeMethod method to call a method on a business component object that is not available directly through the object interface. For more information, see Caution About Using the InvokeMethod Method.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
For examples of using the InvokeMethod method, see the following topics:
LastRecord Method for a Business Component
The LastRecord method moves the record pointer to the last record in a business component. It returns one of the following items:
An integer in Siebel VB
A Boolean value in ActiveX, COM, Siebel Java Data Bean, or Siebel eScript
For more information, see FirstRecord Method for a Business Component and NextRecord Method for a Business Component.
Format
BusComp.LastRecord
No arguments are available.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is for the Mobile Web Client Automation Server:
Private Sub LastRecord_Click()
Dim errCode As Integer
Dim oBusComp as SiebelBusComp
FieldValue.Text = ""
oBusComp.ClearToQuery
oBusComp.ExecuteQuery ForwardBackward
oBusComp.LastRecord errCode
If errCode = 0 Then
FieldValue.Text = oBusComp.GetFieldValue(FieldName.Text, _
errCode)
End If
Status.Text = SiebelApplication.GetLastErrText
End Sub
Name Method for a Business Component
The Name method returns a string that contains the name of a business component.
Format
BusComp.Name()
No arguments are available.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is in Browser Script:
function BusComp_PreSetFieldValue (fieldName, value)
{
theApplication().SWEAlert(this.Name());
}
NewRecord Method for a Business Component
The NewRecord method adds a new record to a business component. This method does not return any information.
Format
BusComp.NewRecord(whereIndicator)
The following table describes the arguments for the NewRecord method.
Table Arguments for the NewRecord Method
| Argument | Description |
|---|---|
whereIndicator |
Predefined constant that configures where Siebel CRM must add the new record. You can use one of the following values:
For more information, see Use Constants to Standardize Code. If you use Siebel Java Data Bean, then you can use one of the following values:
|
Usage
If you use the NewRecord method to add a new record, then Siebel CRM does the following:
Places the new record before or after the current record, depending on the value you enter for the WhereIndicator argument.
Sets this new record as the current record.
You can use the NewRecord method to copy a record. To place the copy before the original record, you use the following command:
Object.NewRecord NewBeforeCopy
To place the copy after the original record, you use the following command:
Object.NewRecord NewAfterCopy
Performance with the NewRecord Method
In some situations, using the NewRecord method in a Server Script can result in this method performing slowly. In this situation, Siebel CRM does not display an error message. It creates the record but the reply time is not optimal. This situation is due to the expected behavior of the Siebel application when it creates a new record.
To position the new record in the record set, Siebel CRM gets the cursor for the record set. This record set must include data before Siebel CRM creates the new record. In the context of a script, Siebel CRM must run a query on the business component before it calls the NewRecord method. If the script does not explicitly run the query, then Siebel CRM runs a full table query. This situation can cause suboptimal performance. For more information, see Doc ID 477556.1 on My Oracle Support.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
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 for a Business Component
The NextRecord method moves the record pointer to the next record in a business component, making that record the current record. This method returns the following information:
In Siebel VB, an integer that includes one of the following values:
1. Indicates the method successfully moved the record pointer to the next record.
0 (zero). Indicates the method did not move the record pointer because it points to the last record.
In Siebel eScript and COM, a Boolean value.
Format
BusComp.NextRecord
No arguments are available.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Browser Script
Examples
The following example is in Siebel eScript:
var isRecord;
with (this)
{
ClearToQuery();
SetSearchSpec("Name", "A*");
ExecuteQuery(ForwardBackward);
isRecord = FirstRecord();
while (isRecord)
{
// do some record manipulation
isRecord = NextRecord();
}
}
For a similar Siebel VB example, see FirstRecord Method for a Business Component.
NextSelected Method for a Business Component
The NextSelected method makes the next record of the current multiple selection the active record. It returns the same information as the NextRecord method. For more information, see NextRecord Method for a Business Component.
Format
BusComp.NextSelected
No arguments are available.
Used With
Server Script
Examples
For examples, see FirstSelected Method for a Business Component.
ParentBusComp Method for a Business Component
The ParentBusComp method returns the name of the parent business component of a link.
Format
BusComp.ParentBusComp
No arguments are available.
Usage
The ParentBusComp method allows you to write code in the child business component that can access a field value or perform actions in the parent business component. To use this method, it might be necessary to set the Link Specification property. For more information, see Usage for the GetFieldValue Method.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is in Siebel VB. For another example, see ExecuteQuery Method for a Business Component:
Dim strParentName as String
...
strParentName = Me.ParentBusComp.GetFieldValue("Name")
Pick Method for a Business Component
The Pick method places the currently chosen record in a pick business component into the appropriate fields of the parent business component. This method does not return any information.
You cannot use the Pick method to modify the record in a read-only picklist field.
Format
BusComp.Pick
No arguments are available.
Usage
For more information, see Picking a Record on a Constrained Picklist.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following 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
.ClearToQuery
.SetSearchSpec "Sales Stage", "2 - Qualified"
.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)
{
ClearToQuery();
SetSearchSpec("Sales Stage", "2 - Qualified");
ExecuteQuery(ForwardOnly);
if (FirstRecord())
Pick();
}
oBC = null;
}
PreviousRecord Method for a Business Component
The PreviousRecord method moves the record pointer to the previous record in a business component, making that record the current record. This method returns one of the following values:
An integer in Siebel VB that includes one of the following values:
1. Indicates the method successfully moved the record pointer to the next record.
0 (zero). Indicates the method did not move the record pointer because it points to the last record.
A Boolean value in Siebel eScript and COM.
Format
BusComp.PreviousRecord
No arguments are available.
Usage
You can use the PreviousRecord method only on a business component that Siebel CRM has queried with the CursorMode mode argument set to ForwardBackward. For more information, see ExecuteQuery Method for a Business Component.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following Siebel eScript example locates the next-to-last record in a query and then manipulates it:
with (this)
{
ActivateField("Name")
ClearToQuery();
SetSearchSpec("Name", "A*");
ExecuteQuery(ForwardBackward);
isRecord = FirstRecord();
while (isRecord)
{
// do some record manipulation
isRecord = NextRecord();
} // end while loop
nextToLastRecord = PreviousRecord();
if (nextToLastRecord) // verify that there is a penultimate record
{
// do some more record manipulation that applies only to next-to-last record
} // end if
} // end with
For more information, see ExecuteQuery Method for a Business Component.
RefineQuery Method for a Business Component
The RefineQuery method refines a query. This method does not return any information.
Format
BusComp.RefineQuery
No arguments are available.
Usage
Unlike the ClearToQuery method, the RefineQuery method retains the existing query specification and allows you to add search conditions that include those fields that Siebel CRM has not set through a previous search expression. The RefineQuery method is most useful if you use it with the GetNamedSearch method. For more information, see ClearToQuery Method for a Business Component and GetNamedSearch Method for a Business Component.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following Siebel VB code uses RefineQuery:
me.SetSearchSpec "Status", "Open" me.ClearToQuery me.ExecuteQuery me.RefineQuery me.SetSearchSpec "Substatus", "Assigned" me.ExecuteQuery
Release Method for a Business Component
The Release method releases a business component and the resources for this business component that exist on the Siebel Server. This method does not return any information.
Format
BusComp.release()
No arguments are available.
Used With
Siebel Java Data Bean
Examples
The following example is for Siebel Java Data Bean:
import com.siebel.data.*;
{
…
// create Siebel Java Data Bean
// log in to Siebel Java 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
…
// make sure to release the business component and its resources on the Siebel Server
siebBusComp.release();
// release the resources occupied by Siebel Bus Object and Siebel Java Data Bean
after their use.
}
The following example logs in to a Siebel Server. It then creates an instance for each of the following items:
Business object
Business component
Business service
It then releases each of these items 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 Java Data Bean
m_dataBean = new SiebelDataBean();
// login to the Siebel Servers
m_dataBean.login("siebel.tcpip.none.none://gateway:port/enterprise/
object manager","userid","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());
}
}
}
For more information, see Logoff Method for an Application.
SetFieldValue Method for a Business Component
The SetFieldValue method sets a new value for a field in the current record of a business component. This method does not return any information.
Format
BusComp.SetFieldValue FieldName, FieldValue
The following table describes the arguments for the SetFieldValue method.
Table Arguments for the SetFieldValue Method
| Argument | Description |
|---|---|
FieldName |
String that contains the name of the field. |
FieldValue |
String that contains the value to set. |
The format for the FieldName argument uses the same format that is described in Format for the Activate Field Method.
The length of the FieldValue argument must not exceed the length of the field. For example, if you pass a 20 character string to a field that is defined as 16 characters in length, then Siebel CRM creates a run-time error that is similar to the following:
Value too long for field 'xxxxx' (maximum size nnn).
You must make sure the length of the string you pass is no longer than the length of the destination field.
Usage
You can use the SetFieldValue method only on a field that is active. For more information, see ActivateField Method for a Business Component.
You cannot use the SetFieldValue method with a calculated field. You cannot use the SetFieldValue method recursively.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is in Siebel VB:
If Val(Me.GetFieldValue("Rep %")) < 75 Then
Me.SetFieldValue "Rep %", "75"
Me.WriteRecord
End If
The following is the equivalent example in Siebel eScript:
if (ToInteger(this.GetFieldValue("Rep %")) < 75)
{
this.SetFieldValue("Rep %", "75");
this.WriteRecord();
}
The following Siebel VB example sets a field to null:
oBC.SetFieldValue "FieldName", ""
SetFormattedFieldValue Method for a Business Component
The SetFormattedFieldValue method sets a new value in a field in the current record of a business component. It accepts the field value in the current local format. This method does not return any information.
Format
BusComp.SetFormattedFieldValue FieldName, FieldValue
The arguments you can use this format are the same as the arguments described in SetFieldValue Method for a Business Component.
Usage
The SetFormattedFieldValue method is useful if you write code for a Siebel application that you deploy in multiple countries that use different currency, date, and number formats.
You can use the SetFormattedFieldValue method only on a field that is active. For more information, see ActivateField Method for a Business Component.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following Siebel VB example is a fragment from a program that tracks the progress of an opportunity through sales stages:
Function BusComp_PreWriteRecord As Integer
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 OpportunityBO = TheApplication.GetBusObject ("Opportunity")
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
If (.FirstRecord) Then
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 NewAfter
'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
Set SalesStageBC = Nothing
Set SalesStageBO = Nothing
Set StageBC = Nothing
Set OpportunityBO = Nothing
End Function
SetMultipleFieldValues Method for a Business Component
The SetMultipleFieldValues method sets new values in the fields of the current record of a business component. This method does not return any information.
Format
BusComp.SetMultipleFieldValues oPropertySet
The following table describes the arguments for the SetMultipleFieldValues method.
Table Arguments for the SetMultipleFieldValues Method
| Argument | Description |
|---|---|
oPropertySet |
Property set that identifies a collection of properties. This argument identifies the fields to set and the value to set for each field. |
The FieldName argument in the property set must match exactly the field name in Siebel Tools, including the correct case. In the following example, the FieldName is Name and the FieldValue is Acme:
oPropertySet.SetProperty "Name","Acme"
Usage
You can use the SetMultipleFieldValues method only on a field that is active.
Do not use the SetMultipleFieldValues method on a field that uses a picklist.
Used With
COM Data Control, COM Data Server, Siebel 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;
ps = null;
bc = null;
bo = null;
The following Siebel Java Data Bean example sets multiple fields:
SiebelDataBean Sieb_dataBean = null;
SiebelBusObject Sieb_busObject = null;
SiebelBusComp Sieb_busComp = null;
SiebelPropertySet ps = null;
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());
}
ps.release();
Sieb_busComp.release();
Sieb_busObject.release();
Sieb_dataBean.release();
Related Topics
For more information, see the following topics:
SetNamedSearch Method for a Business Component
The SetNamedSearch method sets the named search specification on a business component. This method does not return any information.
Format
BusComp.SetNamedSearch searchName, searchSpec
The following table describes the arguments for the SetNamedSearch method.
Table Arguments for the SetNamedSearch Method
| Argument | Description |
|---|---|
searchName |
String that identifies the name of the search specification. |
searchSpec |
String that contains the search specification. |
The searchSpec argument works in the same way as the argument you use after the equal sign in a predefined query. For more information, see SetSearchExpr Method for a Business Component and SetSearchSpec Method for a Business Component.
Usage
A named search specification is a type of search specification that Siebel CRM applies in conjunction with the existing search specification. It applies the named search specification every time it calls the ExecuteQuery method. For example, with a predefined query or with the search specification on a business component.
You can only modify a named search specification programmatically. You cannot use the administrative interface to modify a named search specification.
The ClearToQuery method does not clear the named search specification. To clear it, you must explicitly set the searchSpec argument to "". If Siebel CRM creates a new instance of a business component, then it clears the named search specification.
Using the SetNamedSearch method to define a search does not create a predefined query. You specify this search only in script. To return this search specification, you can use the GetNamedSearch method. To return the values of an attribute in a user profile, Personalization uses the GetProfileAttr method.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The examples in this topic set a named search specification for 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
SetSearchExpr Method for a Business Component
The SetSearchExpr method sets a search expression for a business component. This method does not return any information.
Format
BusComp.SetSearchExpr searchSpec
The following table describes the arguments for the SetSearchExpr method.
Table Arguments for the SetSearchExpr Method
| Argument | Description |
|---|---|
searchSpec |
String that identifies the search specification. |
Usage
You can call the SetSearchExpr method after you call the ClearToQuery method and before you call the ExecuteQuery method. It is not necessary to use the ActivateField method on a field that you specify in the SetSearchExpr method.
The maximum length of a predefined query is 2000 characters.
The searchSpec argument works in the same way as the argument you use after the equal sign in a predefined query. For example, consider the following predefined query:
'Account'.Search = "[Name] ~ LIKE ""A. C. Parker"" "
You can use the following equivalent search specification in various interface methods:
BC.SetSearchExpr "[Name] ~ LIKE ""A. C. Parker"" "
In this example, Name is a field in a business component. You must enclose it in square brackets, [ ].
To create a query that includes a sort specification, use the SetSortSpec method. You cannot use the SetSearchExpr method to set a sort specification. Do not use the SetSearchExpr method and the SetSearchSpec method together. These methods are mutually exclusive.
Any date you use with the SetSearchExpr method must use the MM/DD/YYYY format, regardless of the Regional control panel settings on the Siebel Server or the Siebel client.
Using the SetSearchExpr Method with a Keyword
If a field value contains a search keyword, then you must use two pairs of double quotes around the field value. Example keywords include NOT, AND, or OR. For example, if the Sub-Status field includes the string Not an Issue as a field value, then you must use the following Siebel VB format to avoid an SQL error:
substatus = GetFieldValue("Sub-Status")
searchst = "[Value] = """ & substatus & """""
BC.SetSearchExpr searchst
The following Siebel VB format creates an SQL error:
substatus = GetFieldValue("Sub-Status")
searchst = "[Value] = " & substatus
BC.SetSearchExpr searchst
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example in Siebel eScript demonstrates how to log the current search specification to a file:
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(ForwardBackward);
Related Topics
For more information, see the following topics:
SetSearchSpec Method for a Business Component
The SetSearchSpec method sets the search specification for a business component. This method does not return any information.
Format
BusComp.SetSearchSpec FieldName, searchSpec
The following table describes the arguments for the SetSearchSpec method.
Table Arguments for the SetSearchSpec Method
| Argument | Description |
|---|---|
FieldName |
String that identifies the name of the field where Siebel CRM sets the search specification. |
searchSpec |
String that contains the search specification. |
Usage
You must call the SetSearchSpec method before you call the ExecuteQuery method.
To avoid an unexpected compound search specification on a business component, it is recommended that you call the ClearToQuery method before you call the SetSearchSpec method. It is not necessary to use the ActivateField method on a field that you reference in the SetSearchSpec method.
Making Multiple Calls to the SetSearchSpec Method
If you instruct Siebel CRM to make multiple calls to the SetSearchSpec method for a business component, then it handles the multiple search specifications in the following ways:
If the existing search specification is on the same field as the new search specification, then Siebel CRM replaces the existing search specification with the new search specification. For example, consider the following code:
myBusComp.SetSearchSpec("Status", "<> 'Renewal'"); myBusComp.SetSearchSpec("Status", "<> 'Dropped'");This code 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 Siebel CRM creates a search specification that 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'");This code 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 Siebel CRM replaces only that part of the existing search specification that includes fields that the new search specification also includes. For example:
myBusComp.SetSearchSpec("Status", "<> 'In Progress'")This code results in the following WHERE clause:
WHERE Type <> 'Renewal' AND Status <> 'In Progress'
Siebel CRM replaces the search specification only on the Status field.
Combining Declarative and Scripted Search Specifications
If you define a search specification declaratively in Siebel Tools, and if you use the SetSearchSpec method to define another search specification in script, then Siebel CRM creates a search specification that is a logical AND of the declarative search specification and the scripted search specification. For example, consider the following scripted search specification:
myBusComp.SetSearchSpec("Status", "<> 'Cancelled'")
Consider the following declarative search specification:
[Type] <> 'Renewal' AND [Status] <> 'Sold'
When Siebel CRM creates a logical AND between these search specifications, the following WHERE clause results:
WHERE Type <> 'Renewal' AND (Status <> 'Sold' AND Status <> 'Cancelled')
Using Logical and Comparison Operators in a Search Specification
You can use logical operators and comparison operators. Consider the following example, in Siebel VB:
BC.SetSearchSpec "Status", "<> 'Closed' AND ([Owner] = LoginName () OR [Refer To] = LoginName ()) OR ([Owner] IS NULL AND [Support Group] = 'TS-AE')"
Using Special Characters in a Search Specification
The search specification can contain any of the following special characters:
" (double quote)
' (single quote)
= (equal sign)
> (greater than symbol)
< (less than symbol)
( (opening parenthesis)
) (closing parenthesis)
[ (opening square bracket)
[ (closing square bracket)
, (comma)
~ (tilde)
You must enclose each of these special characters in quotes. This rule applies to operators that are part of the search expression and to the search text.
Using Quotes and Other Characters in a Search Specification
If the search expression contains quotes or another special character, then you must enclose the entire search specification in double quotes. An apostrophe is an example of a special character.
If the search object includes a special character, then you must double that character. For example, assume your specification must search for text that contains a single double quote:
"We must
In this situation, you must do the following work:
Use two double quotes before the word We:
""We must
Enclose the string you created in the preceding step with single quotes:
'""We must'
Enclose the entire expression in double quotes:
"'""We must'"
Add the expression to the search specification:
SetSearchSpec "Comments", "'""We must'"
In another example, assume your search specification must search for the following text in the Name field:
Phillie’s Cheese Steaks
In this situation, you must use the following search specification:
SetSearchSpec "Name", "'Phillie''s Cheese Steaks'"
Using Quotes and Other Characters in a Search Specification in Siebel eScript or Browser Script
To mark a special character in Siebel eScript or Browser Script, you must use a backslash instead of a double quote. For example:
To include double quotes before the word We, you must use the following format:
SetSearchSpec("Comments", "\'\"We must\'")
To include the string Phillie’s Cheese Steaks, you must use the following format:
SetSearchSpec("Name", "\'Phillie\'\'s Cheese Steaks\'")
Using a Search Specification to Search Text in a Nontext Field
If any of the following situations are true, then you must use double quotes to enclose the text you use in a search specification:
The search expression queries a field of any type other than a text field.
The search expression includes any character that is not included in the following list:
Any upper-case letter of the alphabet. For example:
ABCDEFGHIJKLMNOPQRSTUVWXYZ
Any lower-case letter of the alphabet. For example:
abcdefghijklmnopqrstuvwxyz
Any of the following special characters:
underscore (_)
question mark (?)
back slash (\)
double quote (")
single quote (')
opening bracket ([)
closing bracket (])
Using a Search Specification to Return All Records
To return all records, use the ClearToQuery method and then the ExecuteQuery method. Do not use the SetSearchSpec method. For more information, see ClearToQuery Method for a Business Component and ExecuteQuery Method for a Business Component.
Using a Search Specification to Search for a Null Field
To search for a null field, 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", ""
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following Siebel VB code searches for a contact by name, and then navigates to a view that displays this record:
(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")
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
Set NewComp = Nothing
Set NewBusObj = Nothing
Set theCurrComp = Nothing
End Sub
For other Siebel VB examples, see FirstRecord Method for a Business Component, SetFormattedFieldValue Method for a Business Component, and BusComp_PreQuery Event.
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(ForwardBackward);
if (FirstRecord())
oAddrBC = GetMVGBusComp("Street Address");
with (oAddrBC)
{
NewRecord(NewAfter);
SetFieldValue("City", "Denver");
SetFieldValue("Street Address", "123 Main Street");
WriteRecord();
}
}
oAddrBC = null;
oAccntBC = null;
oAccntBO = null;
For another Siebel eScript example, see ClearToQuery Method for a Business Component.
SetSortSpec Method for a Business Component
The SetSortSpec method sets the sort specification for a business component. This method does not return any information.
Format
BusComp.SetSortSpec sortSpec
The following table describes the arguments for the SetSortSpec method.
Table Arguments for the SetSortSpec Method
| Argument | Description |
|---|---|
sortSpec |
String that contains the sort specification. |
The sortSpec argument uses the following format:
"fieldName1,fieldName2,...(ASCENDING)"
or
"fieldName1,fieldName2,...(DESCENDING)"
You must enclose the entire string in double quotes. To sort on various fields in different orders, you can use a comma to separate field names and order specifications.
Usage
If you use the SetSortSpec method, then you must call it after you call the ClearToQuery method and before you call the ExecuteQuery method.
The SortSpec argument works in the same way as the equal sign in a predefined query. For example, consider the following predefined query:
'Account'.Sort = "Name(ASCENDING)"
You can use the following equivalent search specification in various interface methods:
BC.SetSortSpec "Name(ASCENDING)"
Note that Name is the value in the Name property of the business component field. This example queries the Name field.
Any date you use with the SetSortSpec method must use the MM/DD/YYYY format, regardless of the Regional control panel settings of the Siebel Server or Siebel client.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The Siebel VB example in this topic sorts the Opportunity list first by Account in reverse order, and then in alphabetical order by Site. Note that the column names in the Opportunity list applet are not the same as the names in the underlying business component.
For demonstration purposes, this example sorts in ascending and descending order. In actual practice, do not sort in two directions in a single sort specification because this type of sorting can significantly degrade performance.
Function BusComp_PreQuery As Integer
With Me
.ActivateField("Account")
.ActivateField("Account Location")
.ClearToQuery
.SetSortSpec "Account(DESCENDING), Account Location(ASCENDING)"
.ExecuteQuery ForwardBackward
End With
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(ForwardBackward);
}
}
Related Topics
For more information, see the following topics:
SetUserProperty Method for a Business Component
The SetUserProperty method sets the value of a user property in a business component. A user property is similar to an instance variable of a business component. This method does not return any information.
Format
BusComp.SetUserProperty propertyName, newValue
The following table describes the arguments for the SetUserProperty method.
Table Arguments for the SetUserProperty Method
| Argument | Description |
|---|---|
propertyName |
String that identifies the name of the user property. |
newValue |
String that contains the new value. |
Usage
Usage for the SetUserProperty method is similar to the usage for the GetUserProperty method. For more information, see Usage for the GetUserProperty Method.
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
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");
}
}
SetViewMode Method for a Business Component
The SetViewMode method sets the visibility type for a business component. This method does not return any information. For more information, see GetViewMode Method for a Business Component.
Format
BusComp.SetViewMode mode
The following table describes the arguments for the SetViewMode method.
Table Arguments for the SetViewMode Method
| Argument | Description |
|---|---|
mode |
A Siebel ViewMode constant or the corresponding integer value for the constant. More information about the constants that you can use with the SetViewMode method is provided later in this topic. |
Siebel ViewMode constants correspond to applet visibility types. For more information about applet visibility types, see Siebel Security Guide.
Constants You Can Use with the SetViewMode Method
The following table describes the constants you can use with the SetViewMode method. The Owner Type column indicates the value that must be set in the Owner Type property of the BusComp view mode object of the business component. For more information, see Use Constants to Standardize Code.
Table Constants for the SetViewMode Method
| Siebel ViewMode Constant | Integer Value | Owner Type | Description |
|---|---|---|---|
SalesRepView |
0 |
Position |
This constant does the following:
|
ManagerView |
1 |
Position |
Displays records that the user and the users who report to the user can access. For example, the records that Siebel CRM displays in the My Team’s Accounts visibility filter. If the business component that the view references uses single position access control, then this constant displays records that Siebel CRM associates directly with the active position of the user and with subordinate positions. If the business component that the view references uses sales team access control, then this constant displays records according to one of the following positions:
If the user position does not include a subordinate position, then Siebel CRM does not display any records. |
PersonalView |
2 |
Position |
Displays records that the user can access, as determined by the Visibility Field property of the BusComp view mode object. For example, the records that Siebel CRM displays in the My Accounts visibility filter. |
AllView |
3 |
Not applicable |
Displays all records that includes valid owner. For example, the records that Siebel CRM displays in the All Accounts Across Organizations visibility filter. |
OrganizationView |
5 |
Position |
Displays records where a valid owner is associated with the record and the user position is associated with the organization. For example, the records that Siebel CRM displays in the All Accounts List View visibility filter. Applies access control for a single organization or for multiple organizations, as determined by the Visibility field or Visibility MVField of the BusComp view mode object of the business component. |
GroupView |
7 |
Not applicable |
This constant does one of the following:
|
CatalogView |
8 |
Catalog Category |
Displays a list of records in categories across every catalog that the user can access. Siebel CRM typically uses this visibility in a product picklist and other list of products, such as a recommended product list. |
SubOrganizationView |
9 |
Organization |
If the business component that the view references uses single organization access control, then this constant displays records that Siebel CRM associates directly with one of the following organizations:
For example, the records that Siebel CRM displays in the All Opportunities Across My Organization visibility filter. If the business component that the view references uses multiple organization access control, then this constant displays records for the primary active organization or for the primary descendent organization. |
Used With
COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The following example is in Siebel VB. For another example, see BusComp_PreDeleteRecord Event:
(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;
UndoRecord Method for a Business Component
The UndoRecord method reverses any unsaved modifications that Siebel CRM has made on a record. This includes reversing unsaved modifications to fields, and deleting an active record that is not saved to the Siebel database. This method does not return any information.
Format
BusComp.UndoRecord
No arguments are available.
Usage
You can use the UndoRecord method in the following ways:
To delete a new record. Use it after Siebel CRM calls the NewRecord method and before it saves the new record to the Siebel database.
To reverse modifications made to field values. Use it before Siebel CRM uses the WriteRecord method to save these modifications, or before the user steps off the record.
UndoRecord reverses unsaved modifications to a record. If you require a fine degree of control over the modifications that Siebel CRM reverses, then do the following:
Place the code in one of the following events:
PreNewRecord
PreSetFieldValue
PreWriteRecord
Issue a CancelOperation to cancel the modifications that the event calls.
For more information, see Caution About Using the Cancel Operation Event Handler and NewRecord Method for a Business Component.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
WriteRecord Method for a Business Component
The WriteRecord method saves to the Siebel database any modifications made to the current record. This method does not return any information.
Format
oBusComp.WriteRecord
No arguments are available.
Usage
After creating new records and setting values for fields, you can call the Write Record method to save the new record to the Siebel database.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
The Siebel VB example in this topic implements the following logic: if the user sets the Sales Stage field to 02, then insert an activity:
(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
For more examples, see GetMVGBusComp Method for a Business Component and NewRecord Method for a Business Component
Business Component Invoke Methods
This topic describes methods you can use with the InvokeMethod method. It includes the following topics:
Overview of Methods That Manipulate the File System
To manipulating the file system, you can use the following methods:
CreateFile
GetFile
PutFile
You can store a file in the local file system on the Siebel Server where your configuration runs the script. You can also return this file. You can use a UNC (Universal Naming Convention) format. For example, \\server\dir\file.txt. You can use a DOS folder. For example, c:\dir\file.txt.
The Siebel Server must be able to access the UNC path or mounted file system. If you use a Java client to run the Siebel Java Data Bean, then the Siebel Server must be able to access all files.
You can use these methods with business components that use the CSSBCFile class. These methods do not serialize the files from the client of a third-party application or place files from the client of a third-party application in the Siebel file system.
ClearLOVCache Method for a Business Component
The ClearLOVCache method clears the cache for the list of values (LOV) in the object manager, In works in a way that is similar to the Clear Cache button that Siebel CRM displays in the List of Values view of the Administration - Data screen. This method does not return any information.
The ClearLOVCache method clears only the object manager cache. It does not clear the session cache.
Format
BusComp.InvokeMethod("ClearLOVCache")
No arguments are available.
Used With
To use this method, you can use a BusComp.InvokeMethod call with the following interfaces:
Browser Script
COM Data Control
COM Data Server
Siebel Java Data Bean
Mobile Web Client Automation Server
Server Script
Examples
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");
lov_bc.NewRecord(NewAfter);
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 for a Business Component
To create a file in the Siebel file system from an external source, you can use the CreateFile method. This method returns one of the following values:
Success. The operation succeeded.
Error. The operation did not succeed.
Format
BusComp.InvokeMethod("CreateFile", SrcFilePath, KeyFieldName, KeepLink)
The following table describes the arguments for the CreateFile method.
Table Arguments for the CreateFile Method
| Argument | Description |
|---|---|
SrcFilePath |
The fully qualified path to the source file on the Siebel Server or the Siebel client. |
KeyFieldName |
The name of the field in the business component that contains the File Name. For example, AccntFileName in the Account Attachment business component. |
KeepLink |
Applies to URLs. You can use one of the following values:
The actual file is compressed in a Siebel proprietary format. Siebel CRM uploads and stores it in that format on the Siebel File System. |
Usage
Before you call the CreateFile method, call the NewRecord method to make sure Siebel CRM creates a new business component record.
Used With
To use this method, you can use a BusComp.InvokeMethod call with the following interfaces:
COM Data Control
COM Data Server
Siebel Java Data Bean
Mobile Web Client Automation Server
Server Script
Examples
The following example is in Siebel VB:
Dim RetValue as String
Dim fileBC as BusComp
'Instantiate fileBC as the appropriate attachment business component
fileBC.NewRecord NewAfter
RetValue = fileBC.InvokeMethod ("CreateFile", "c:\Demo\Image.bmp", "AccntFileName",
"Y")
fileBC.WriteRecord
The following example is in Siebel eScript:
var fileBC;
// Instantiate fileBC as the appropriate attachment business component
fileBC.NewRecord(NewAfter);
RetValue = fileBC.InvokeMethod ("CreateFile", "C:\\Demo\\Image.bmp",
"AccntFileName", "Y");
fileBC.WriteRecord();
The following example is in COM Data Control:
Dim errCode as Integer
Dim Args(2) as String
Dim RetValue as String
Dim fileBC as BusComp
'Instantiate fileBC as the appropriate attachment business component
Args(0) = "C:\Demo\Image.bmp"
Args(1) = "AccntFileName"
Args(2) = "Y"
fileBC.NewRecord NewAfter, errCode
RetValue = fileBC.InvokeMethod ("CreateFile", Args, errCode)
fileBC.WriteRecord
GenerateProposal Method for a Business Component
To create a new proposal record, the GenerateProposal method uses a template and settings from the DocServer as input. The DocServer is third-party software that specializes in searching, storing, and serving documents. It creates the proposal.
Format
To specify a custom template, use the following format:
BusComp.InvokeMethod("GenerateProposal", RecordExists, Replace, TemplateFile)
To use the default proposal template, use the following format:
BusComp.InvokeMethod("GenerateProposal", RecordExists, Replace)
The following table describes the arguments for the GenerateProposal method.
Table Arguments for the GenerateProposal Method
| Argument | Description |
|---|---|
RecordExists |
You can use one of the following values:
|
Replace |
You can use one of the following values:
|
TemplateFile |
Optional. You can use one of the following values:
|
Used With
To use this method, you can use a BusComp.InvokeMethod call with the following interfaces:
Browser Script
COM Data Control
COM Data Server
Siebel Java Data Bean
Mobile Web Client Automation Server
Server Script
GetFile Method for a Business Component
The GetFile method gets a file from the Siebel file system and places that file in the local file system on the Siebel Server or the Siebel client. This method returns one of the following values:
Operation succeeded. Returns a string that contains
Success,OutFilePath.where:
OutFilePathis the fully qualified path to the file that resides in the user temp folder on the Siebel client or on the Siebel Server.Operation failed. Returns a string that contains
Error.
Format
BusComp.InvokeMethod("GetFile", KeyFieldName)
The following table describes the arguments for the GetFile method.
Table Arguments for the GetFile Method
| Argument | Description |
|---|---|
KeyFieldName |
The name of the business component field that contains the file name. For example, AccntFileName in the Account Attachment business component. |
Usage for the GetFile Method
The record pointer must point to the record you seek. If necessary, you must query for the record ID, using the NextRecord method to advance through the returned set of records until the record pointer points to the record you seek.
Used With
To use this method, you can use a BusComp.InvokeMethod call with the following interfaces:
COM Data Control
COM Data Server
Siebel Java Data Bean
Mobile Web Client Automation Server
Server Script
Examples
The following example uses Siebel VB:
Dim RetValue as String
Dim fileBC as BusComp
'Instantiate fileBC as the appropriate attachment business component
'Query for the required attachment record
RetValue = fileBC.InvokeMethod ("GetFile", "AccntFileName")
The following example uses Siebel eScript:
var RetValue;
var fileBC;
// Instantiate fileBC as the appropriate attachment business component
// Query for the required attachment record
var RetValue = fileBC.InvokeMethod("GetFile", "AccntFileName");
The following example uses COM Data Control:
Dim errCode as Integer
Dim Args as String
Dim RetValue as String
Dim fileBC as BusComp
'Instantiate fileBC as the appropriate attachment business component
'Query for the required attachment record
Args = "AccntFileName"
RetValue = fileBC.InvokeMethod ("GetFile", Args, errCode)
PutFile Method for a Business Component
The PutFile method updates a file in the Siebel file system with a newer file. This method returns one of the following values:
Success. The operation succeeded.
Error. The operation did not succeed.
Format
BusComp.InvokeMethod("PutFile", SrcFilePath, KeyFieldName)
The following table describes the arguments for the PutFile method.
Table Arguments for the PutFile Method
| Argument | Description |
|---|---|
SrcFilePath |
The fully qualified path to the file on the Siebel Server or the Siebel client. |
KeyFieldName |
The name of the field in the business component that identifies the file name. For example, AccntFileName in the Account Attachment business component. |
Usage
Usage for the PutFile method is similar to usage for the GetFile method. For more information, see Usage for the GetFile Method.
After Siebel CRM uses the PutFile method to save a file attachment, you must make sure it calls the WriteRecord method so that the updated attachment is visible in the Siebel client. For more information, see WriteRecord Method for a Business Component.
Used With
To use this method, you can use a BusComp.InvokeMethod call with the following interfaces:
COM Data Control
COM Data Server
Siebel Java Data Bean
Mobile Web Client Automation Server
Server Script
Examples
The following example uses Siebel VB:
Dim RetValue as String
Dim fileBC as BusComp
'Instantiate fileBC to the appropriate attachment business component
'Query for the attachment record to be updated
RetValue = fileBC.InvokeMethod ("PutFile", "c:\Demo\Image.bmp", "AccntFileName")
fileBC.WriteRecord
The following example uses Siebel eScript:
var RetValue;
var fileBC;
// Instantiate fileBC to the appropriate attachment business component
// Query for the attachment record to be updated
RetValue = fileBC.InvokeMethod("PutFile", "c:\\Demo\\Image.bmp", "AccntFileName");
fileBC.WriteRecord();
The following example uses COM Data Control:
Dim errCode as Integer
Dim Args(1) as String
Dim RetValue as String
Dim fileBC as BusComp
'Instantiate fileBC to the appropriate attachment business component
'Query for the attachment record to be updated
Args(0) = "C:\Demo\Image.bmp"
Args(1) = "AccntFileName"
RetValue = fileBC.InvokeMethod ("PutFile", Args, errCode)
fileBC.WriteRecord
RefreshBusComp Method for a Business Component
The RefreshBusComp method runs the current query again for a business component and makes the record that was previously active the active record. The user can see that Siebel CRM updated the view but the same record remains highlighted in the same position in the list applet. This method does not return any information.
Format
BusComp.InvokeMethod("RefreshBusComp")
No arguments are available.
Used With
To use this method, you can use a BusComp.InvokeMethod call with the following interfaces:
Browser Script
COM Data Control
COM Data Server
Siebel Java Data Bean
Mobile Web Client Automation Server
Server Script
This method only works with a business component that uses the CSSBCBase class.
RefreshRecord Method for a Business Component
The RefreshRecord method updates the currently highlighted record, including updating business component fields in the Siebel client. It positions the cursor on the highlighted record. It does not update other records that are currently available in the Siebel client. This method does not return any information.
Format
retVal = BusComp.InvokeMethod("RefreshRecord")
No arguments are available.
Used With
To use this method, you can use a BusComp.InvokeMethod call with the following interfaces:
Browser Script
COM Data Control
Siebel Java Data Bean
Mobile Web Client Automation Server
Server Script
This method only works with a business component that uses the CSSBCBase class.
SetAdminMode Method for a Business Component
The SetAdminMode method can enable or disable visibility rules for a business component. It sets the Admin property of a view. This method does not return any information.
Format
BusComp.InvokeMethod("SetAdminMode", flag)
The following table describes the arguments for the SetAdminMode method.
Table Arguments for the SetAdminMode Method
| Argument | Description |
|---|---|
flag |
You can use one of the following values:
|
Used With
To use this method, you can use a BusComp.InvokeMethod call with the following interfaces:
COM Data Control
COM Data Server
Siebel Java Data Bean
Mobile Web Client Automation Server
Server Script
Business Component Events
This topic describes business component events. It includes the following topics:
You can use these events only on the Siebel Server, except for the PreSetFieldValue event, which you can use only on the browser.
You can call an event from a data operation on a business component. You define these events for each business component. You can call an event before or after Siebel CRM performs the predefined behavior.
Monitoring Modifications That the User Makes to a Multivalue Field
To monitor modifications the user makes to a multivalue field, you must use the multivalue group business component.
If the user uses the multivalue group applet to modify a value in a multivalue field, then Siebel CRM calls the PreSetFieldValue event and the SetFieldValue event for the field. It does not call any event on the parent business component.
If the user does not use the multivalue group applet to modify a value in a multivalue field, then Siebel CRM does not start the PreSetFieldValue event or the SetFieldValue event for the field. The only time Siebel CRM starts these events is if the user updates the field in the multivalue group applet.
BusComp_Associate Event
If the user adds a business component record to create an association, then Siebel CRM calls the BusComp_Associate event. This method does not return any information.
Format
BusComp_Associate
No arguments are available.
Usage
The usage for the BusComp_Associate event is the same as the usage for the Bus Comp_NewRecord event. For more information, see BusComp_NewRecord Event.
Used With
Server Script
BusComp_ChangeRecord Event
If a business component record becomes the current record, then Siebel CRM calls the BusComp_ChangeRecord event. This method does not return any information.
Format
BusComp_ChangeRecord
No arguments are available.
Usage
Siebel CRM runs code in the ChangeRecord event handler each time the active record changes. To allow smooth scrolling in a list applet, you must avoid lengthy operations in this event handler.
Used With
Server Script
Examples
The Siebel VB example in this topic uses subprograms in the declarations section of the general section to set up an audit trail for service requests. This example uses the ChangeRecord event handler to initialize the values from the service record so that Siebel CRM can compare them with current values:
(general)
(declarations)
Option Explicit
Dim OldClosedDate, OldCreated, OldOwner, OldOwnerGroup
Dim OldSeverity, OldSource, OldStatus
Declare Sub CreateAuditRecord
Declare Sub InitializeOldValues
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
If the user copies a business component record, and if the user makes this record the active record, then Siebel CRM calls the BusComp_CopyRecord event. This method does not return any information.
Format
BusComp_CopyRecord
No arguments are available.
Usage
If a new record is created in one of the following ways, then Siebel CRM calls the BusComp_CopyRecord method instead of the BusComp_NewRecord method:
Siebel CRM creates a new record through one of the following:
BusComp.NewRecord NewAfterCopy
BusComp.NewRecord NewBeforeCopy
A user uses a copy record feature in the Siebel Client. For example, if the user chooses the Copy Record menu item from the Edit menu, or presses CTRL+B.
Used With
Server Script
BusComp_DeleteRecord Event
If the user deletes a business component record, then Siebel CRM calls the BusComp_DeleteRecord event. The fields of the deleted record are no longer available. This method does not return any information.
Format
BusComp_DeleteRecord
No arguments are available.
Usage for the BusComp_DeleteRecord Event
Siebel CRM does not start the BusComp_PreDeleteRecord event or the BusComp_DeleteRecord event for a child record that it deletes according to the Cascade Delete property on a link. For performance reasons, Siebel CRM performs these deletes directly in the data layer. Siebel CRM calls script events from the object layer, so it does not run them.
Used With
Server Script
BusComp_InvokeMethod Event
If Siebel CRM calls the InvokeMethod method on a business component, then it also calls the BusComp_InvokeMethod event. This method does not return any information.
Format
BusComp_InvokeMethod(methodName)
The arguments you can use with this format are the same as the arguments described in WebApplet_InvokeMethod Event.
Usage
If you call a specialized method on a business component, or if you call the InvokeMethod method explicitly on a business component, then Siebel CRM calls the BusComp_InvokeMethod event. For more information, see About Specialized and Custom Methods.
Used With
Server Script
BusComp_NewRecord Event
If the user creates a business component record, and if the user makes this record the active record, then Siebel CRM calls the BusComp_NewRecord event. You can use this event to set up default values for a field. This method does not return any information.
Format
BusComp_NewRecord
No arguments are available.
Usage
If a new record is created in one of the following ways, then Siebel CRM calls the BusComp_CopyRecord method instead of the BusComp_NewRecord method:
Siebel CRM creates a new record using one of the following formats:
BusComp.NewRecord NewAfterCopy
BusComp.NewRecord NewBeforeCopy
A user uses a copy record feature in the Siebel client. For example, the user chooses the Copy Record menu item from the Edit menu, or presses CTRL+B.
Used With
Server Script
Examples
For an example, see Pick Method for a Business Component.
BusComp_PreAssociate Event
If Siebel CRM detects that the user is about to add a business component record to create an association, then it calls the BusComp_PreAssociate event before it adds the record. This method returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
Format
BusComp_PreAssociate
No arguments are available.The format is the same as for BusComp_PreNewRecord event. For more information, see BusComp_PreNewRecord Event.
Used With
Server Script
BusComp_PreCopyRecord Event
If Siebel CRM detects that the user is about to copy a business component record, then it calls the BusComp_PreCopyRecord event before it copies the record. You can use this event to perform precopy validation. This method returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
Format
BusComp_PreNewRecord
No arguments are available.
Used With
Server Script
BusComp_PreDeleteRecord Event
If Siebel CRM detects that the user is about to delete a business component record, then it calls the BusComp_PreDeleteRecord event. You can use this event to prevent the deletion or to perform any actions before Siebel CRM deletes the record.This method returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
Format
BusComp_PreDeleteRecord
No arguments are available.
Usage
Usage for the BusComp_PreDeleteRecord event is the same as usage for the BusComp_DeleteRecord event. For more information, see Usage for the BusComp_DeleteRecord Event.
Used With
Server Script
Examples
The following Siebel VB example prevents the deletion of an account that includes 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
If a user accesses a business component field, then Siebel CRM calls the BusComp_PreGetFieldValue event. This method returns the field name and field value that exists before Siebel CRM displays the field. It also returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
Format
BusComp_PreGetFieldValue(FieldName, FieldValue)
The following table describes the arguments for the BusComp_PreGetFieldValue event.
Table Arguments for the BusComp_PreGetFieldValue Event
| Argument | Description |
|---|---|
FieldName |
String that contains the name of the field that the user accessed. |
FieldValue |
String that contains the value of the field that the user accessed. |
Usage
Siebel CRM calls the BusComp_PreGetFieldValue event in the following situations:
At least one time for each user interface element that displays the value for a business component field
Every time it updates the Siebel client
As a result of other internal uses
Improving Performance when Calling the BusComp_PreGetFieldValue Method
Siebel CRM runs any script that is attached to this event very frequently. It even calls empty scripts. These calls might cause a Siebel application appear to be unresponsive.
To improve performance when calling the BusComp_PreGetFieldValue method
Remove scripts from the BusComp_PreInvokeMethod event that you do not require:
In Siebel Tools, open a script you do not require.
Delete the entire contents of the script, including the following content:
In Siebel VB, delete the Function statement and the End Function statement.
In Siebel eScript, delete the function () statement and the {} function statement.
Repeat these steps for all other scripts you do not require.
Used With
Server Script
Bus Comp_PreInvokeMethod Event
If Siebel CRM calls a specialized method on a business component, then it calls the BusComp_PreInvokeMethod event before it calls this specialized method. The BusComp_PreInvokeMethod event returns ContinueOperation or CancelOperation. For more information, see About Specialized and Custom Methods, and Caution About Using the Cancel Operation Event Handler.
Format
BusComp_PreInvokeMethod(methodName)
The arguments you can use with this format are the same as the arguments described in WebApplet_InvokeMethod Event.
Used With
Server Script
BusComp_PreNewRecord Event
If Siebel CRM detects that the user is about to create a new business component record, then it calls the BusComp_PreNewRecord event before it creates the record. You can use this event to perform preinsert validation. This method returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
Format
BusComp_PreNewRecord
No arguments are available.
Used With
Server Script
BusComp_PreQuery Event
Siebel CRM calls the BusComp_PreQuery event before it runs a query. This method returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
Format
BusComp_PreQuery
No arguments are available.
Usage
To modify the search criteria or to restrict Siebel CRM from running certain queries, you can use the BusComp_PreQuery event.
Used With
Server Script
Examples
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
Siebel CRM calls the BusComp_PreSetFieldValue event in the following situations:
After the user modifies a field value in the Siebel client and then attempts to leave the field
A call to the SetFieldValue method occurs, but before it performs any field-level validation
This event allows you to use custom validation before Siebel CRM applies predefined validation. This method returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
Format
BusComp_PreSetFieldValue(FieldName, FieldValue)
The arguments you can use with this format are the same as the arguments described in Applet_ChangeFieldValue Event.
Usage
If your script returns CancelOperation for a field, then Siebel CRM does not enter data for this field. However, Siebel CRM still starts BusComp_PreSetFieldValue for the other fields that the picklist uses to enter data. For more information, see Caution About Using the Cancel Operation Event Handler.
If a user uses a picklist to enter data for multiple fields, then it starts the BusComp_PreSetFieldValue method for each field that the user uses to enter data. For example, in an applet that the user accesses to enter data for the Last Name, First Name, and Contact ID. In this example, Siebel CRM starts the BusComp_PreSetFieldValue method three times, one time for each field.
Siebel CRM does not call the BusComp_PreSetFieldValue event on a picklist or multivalue field.
Usage With Roundtrips
Siebel CRM does the following during a roundtrip to the Siebel Server:
In Browser Script, if the Immediate Post Changes property of the business component field is set to TRUE, then it calls the BusComp_PreSetFieldValue method after the round trip to the Siebel Server completes.
In Server Script, it calls the BusComp_PreSetFieldValue method as the first event in the Siebel Server round trip.
To prevent infinite recursions, if the BusComp_PreSetFieldValue event is running, then Siebel CRM does not run it again for the same business component instance, even if Siebel CRM uses it on a different field in the business component.
Used With
Browser Script, Server Script
Examples
The following Siebel VB example uses the PreSetFieldValue event to determine if a quote discount is greater than 20 percent, and to take the appropriate action if it is. For other examples of BusComp_PreSetFieldValue, see LoginId Method for an Application, and ExecuteQuery Method for a Business Component:
Function BusComp_PreSetFieldValue (FieldName As String,
FieldValue As String) As Integer
‘code 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)
{
TheApplication().RaiseErrorText(msgtext);
}
else
{
return (ContinueOperation);
}
}
else
{
return (ContinueOperation);
}
}
BusComp_PreWriteRecord Event
Siebel CRM calls the BusComp_PreWriteRecord event before it writes a record to the Siebel database. This method returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
Format
BusComp_PreWriteRecord
No arguments are available.
Usage
For important caution information, see Caution for Using an Error Method with a Write Record Event.
You can use this event to perform any final validation before Siebel CRM performs any predefined internal record-level validation.
Siebel CRM starts the BusComp_PreWriteRecord event only if the user modifies or inserts a field value, or if the user deletes a record. If the user deletes a record, then Siebel CRM calls the BusComp_PreWriteRecord method to delete the implied join that joins any records to the initial record.
Using a Write Record Event with a Multivalue Group
If Siebel CRM associates a multivalue group record that uses a many to many relationship with the business component that calls the association, then it starts the BusComp_PreWriteRecord event and the BusComp_WriteRecord event. It starts these events even if the association does not update any fields in the multivalue group business component or in the calling business component. It runs the BusComp_PreWriteRecord event and the BusComp_WriteRecord event to acknowledge the update to the intersection table.
Used With
Server Script
Examples
The following example calls the BusComp_PreWriteRecord event:
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
Siebel CRM calls the BusComp_Query event after it completes a query but before it displays the query results. This event does not return any information.
Format
BusComp_Query
No arguments are available.
Used With
Server Script
Examples
In the following Siebel VB example, the Action business component uses a special activity type. If the user starts an account query, then this code determines if important information is available. If it is available, then Siebel CRM displays it in a message box:
Sub BusComp_Query
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
If Siebel CRM sends a value to a business component from the Siebel client or through a call to the SetFieldValue method, then it calls the BusComp_SetFieldValue event. It does not call this event for a predefaulted field or for a calculated field. This event does not return any information.
Format
BusComp_SetFieldValue(FieldName)
The arguments you can use in this format are the same as the arguments described in ActivateField Method for a Business Component.
Used With
Server Script
Examples
In the following Siebel VB example, if Siebel CRM calls the SetFieldValue event, then it calls methods on an existing business component:
Sub BusComp_SetFieldValue (FieldName As String)
Dim desc As String
Dim newDesc As String
If FieldName = "Type" Then
newDesc = [can be any valid string that contains 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
Siebel CRM starts the BusComp_WriteRecord event after it saves the record to the Siebel database. This event does not return any information.
Format
BusComp_WriteRecord
No arguments are available.
Usage
Do not use the BusComp_SetFieldValue event in a BusComp_WriteRecord event. If you must use the BusComp_SetFieldValue event, then use it in the BusComp_PreWriteRecord event. For more information, see BusComp_PreWriteRecord Event.
For information about using the BusComp_WriteRecord event with a multivalue group, see Using a Write Record Event with a Multivalue Group.
Caution for Using an Error Method with a Write Record Event
Used With
Server Script
Business Object Methods
This topic describes business object methods. It includes the following topics:
In this topic, the term oBusObj indicates a variable that contains a BusObject.
GetBusComp Method for a Business Object
The GetBusComp method returns the name of a business component instance. If an instance of the business component that the BusCompName argument specifies:
Exists, then the GetBusComp method returns the name of that instance.
Does not exist, then the interpreter starts a new business component instance, and then the GetBusComp method returns the name of this instance.
Format
oBusObj.GetBusComp (BusCompName)
The following table describes the arguments for the GetBusComp method.
Table Arguments for the GetBusComp Method
| Argument | Description |
|---|---|
BusCompName |
String that contains the name of a business component. |
The BusCompName argument is case-sensitive. It must match the case of the name that Siebel Tools displays in the Name property of the business component.
Usage
If a business component instance exists but you must create a new instance, then you can do the following:
Use the GetBusObject method to create a new business object instance.
For this new business instance, use the GetBusComp method to create a new business component.
These steps create a new business component instance that is different from the business component instance that already exists.
If you use a business object instance that already exists, then your configuration includes any other business components that reference that business object instance, even if you use the GetBusComp method.
If you no longer require the business component instance, then use one of the following keywords:
In Siebel VB, use Nothing ().
In Siebel eScript or Browser Script, use null ().
In Browser Script, the GetBusComp method can only access business component instances in the current view. In Server Script, the GetBusComp method can access every business component instance that exists in the active business object.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Server Script
Examples
The following examples are in Siebel eScript:
To access a business component in a UI context:
var ActiveBO = TheApplication().ActiveBusObject(); var ConBC = ActiveBO.GetBusComp("Contact");To access a business component in a nonUI context:
var BO = TheApplication().GetBusObject("Account"); var ConBC = BO.GetBusComp("Contact");
GetLastErrCode Method for a Business Object
The GetLastErrCode method returns the error code for the error that Siebel CRM logged most recently. This code is a short integer. 0 (zero) indicates no error.
Format
oBusObj.GetLastErrCode
No arguments are available.
Usage
For more information, see Usage for the GetLastErrCode Method.
Used With
COM Data Control, Mobile Web Client Automation Server
GetLastErrText Method for a Business Object
The GetLastErrText method returns a string that contains the text message for the error that Siebel CRM logged most recently.
Format
oBusObj.GetLastErrText
No arguments are available.
Usage
For more information, see Usage for the GetLastErrText Method.
Used With
COM Data Control, Mobile Web Client Automation Server
Name Method for a Business Object
The Name method returns a string that contains the name of a business object.
Format
oBusObj.Name
No arguments are available.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
For an example, see Name Method for a Business Component.
Release Method for a Business Object
The Release method for a business object releases a business object and the resources for this business object on the Siebel Server. This method does not return any information.
Format
oBusObj.release()
No arguments are available.
Used With
Siebel Java Data Bean
Examples
The following example is for Siebel Java Data Bean:
import com.siebel.data.*;
{
...
// create Siebel Java Data Bean
SiebelDataBean Sieb_dataBean = null;
Sieb_dataBean = new SiebelDataBean();
// log in to Siebel Java Data Bean
...
// Create Siebel Bus Object.
// get the Bus Object from SiebelDataBean
SiebelBusObject busObj = null;
busObj = Sieb_dataBean.getBusObject("Account");
...
// Use the business Object
// Release the business object resources
...
busObj.release();
}
Business Service Methods
This topic describes business service methods. It includes the following topics:
In this topic, the oService variable identifies a business service instance.
GetFirstProperty Method for a Business Service
The GetFirstProperty method returns a string that contains the name of the first property that is defined for a business service.
Format
oService.GetFirstProperty()
No arguments are available.
Usage for a Method that Gets a Business Service Property
The order that Siebel CRM uses to store properties in a property set is random. For example, the Name property is the first property that Siebel Tools displays in the Business Services list for every business service. However, the GetFirstProperty method might return any business service property, not necessarily the Name property. To correct this situation it is recommended that you add the properties in a property set to an array, and then sort that array.
To get or modify a property value, you can do the following:
Use the GetFirstProperty method or GetNextProperty method to return the name of a property.
Use the name you returned in the preceding step in one of the following ways:
To return a property value, as an argument in the GetProperty method.
To set a property value, as an argument in the SetProperty method.
For more information, see the following topics:
Used With
Browser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Example of Using Methods that Return a Business Service Property
The example in this topic returns the number of property sets that belong to a business service.
The following example is in Siebel eScript:
function countPropSets(busService)
{
var propSetName = busService.GetFirstProperty();
var count = 0;
while(propSetName != "")
{
count++;
propSetName = busService.GetNextProperty();
}
return count;
}
The following example is for Siebel Java Data Bean:
public int countPropSets(SiebelService busService)
{
int count = 0;
try
{
String propSetName = busService.getFirstProperty();
while(propSetName != "")
{
count++;
propSetName = busService.getNextProperty();
}
}
catch(SiebelException sExcept)
{
return 0;
}
return count;
}
GetNextProperty Method for a Business Service
The GetNextProperty method returns a string that contains the name of the next property of a business service. If no more properties exist, then this method returns an empty string.
Format
oService.GetNextProperty()
No arguments are available.
Usage for the GetNextProperty Method
After you call the GetFirstProperty method to return the name of the first property of a business service, you can call the GetNextProperty to return the name of the next property. This next property is the next property that is defined for a business service after the first property.
You can use the GetNextProperty consecutively to cycle through all the properties of a business service until no more properties exist, at which point Siebel CRM returns an empty string.
Usage for the GetNextProperty is similar to usage for the GetFirstProperty method. For more information, see Usage for a Method that Gets a Business Service Property.
Used With
Browser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
For examples, see Example of Using Methods that Return a Business Service Property.
GetProperty Method for a Business Service
The GetProperty method returns a string that contains the value of a property. If the property does not exist, then this method returns NULL.
Format
oService.GetProperty(propName)
The following table describes the arguments for the GetProperty method.
Table Arguments for the GetProperty Method
| Argument | Description |
|---|---|
propName |
A string that contains the name of the property that Siebel CRM returns. |
Usage
To return the value for this property you must know the name of the property. To return a property name, use the GetFirstProperty method or the GetNextProperty method. For more information, see Usage for a Method that Gets a Business Service Property.
Used With
Browser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
InvokeMethod Method for a Business Service
The InvokeMethod method calls a method on a business service. This method can be a specialized method or a custom method. For more information, see About Specialized and Custom Methods. This method does not return any information.
Siebel eScript Format
oService.InvokeMethod(methodName, InputArguments, OutputArguments)
The following table describes the arguments for the Siebel eScript format of the InvokeMethod method.
Table Arguments for the Siebel eScript Format of the InvokeMethod Method
| Argument | Description |
|---|---|
methodName |
A string that contains the name of the method that Siebel CRM must run. |
InputArguments |
A property set that identifies the arguments that the method uses as input. |
InputArguments |
A property set that identifies the arguments that the method returns as output. |
Siebel VB Format
oService.InvokeMethod methodName, InputArguments, OutputArguments
The arguments you use in this format are the same as the arguments that are described for the Siebel eScript format.
Browser Script Format
outputPropSet=Service.InvokeMethod(MethodName, inputPropSet)
The arguments you use with this format are the same as the arguments described in Applet_InvokeMethod Event.
In Browser Script, you cannot use an output property set for this format.
Usage
A predefined business service works in a way that is similar to how a call to a business component method works. You can call a specialized method on a business service that is not available directly through the object interface.
You must use this method only with Siebel VB or Siebel eScript scripts. You must use Siebel Tools to write these scripts. You can call these scripts from an external interface.
A run-time business service can include a custom method.
Although the InvokeMethod function does not return a value, the properties in the OutputArguments property set might be modified.
For more information, see Caution About Using the InvokeMethod Method.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Related Topics
For more information, see the following topics:
Name Method for a Business Service
The Name method returns a string that contains the name of a business service.
Format
oService.Name
No arguments are available.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
The following example is in Browser Script:
var svc = theApplication().GetService("Data Quality Manager"):
theApplication().SWEAlert("The active service is " + svc.Name());
PropertyExists Method for a Business Service
The PropertyExists method returns one of the following values to indicate if a property exists:
In Siebel VB, this method returns one of the following integers:
1. Indicates the property exists.
0 (zero). Indicates the property does not exist.
In other interfaces, this method returns a Boolean value.
Format
oService.PropertyExists(propName)
The following table describes the arguments for the PropertyExists method.
Table Arguments for the PropertyExists Method
| Argument | Description |
|---|---|
propName |
A string that contains the name of the property. |
Usage
Use the PropertyExists method in an If statement to determine if a specific property is set.
Used With
Browser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Release Method for a Business Service
The Release method for a business service releases a business service and the resources that this business service uses on the Siebel Server.
Format
oBusSvc.release()
No arguments are available.
Used With
Siebel Java Data Bean
Examples
The following example logs in to a Siebel Server. It then creates a business object instance, a business component instance, and a business service instance. Next, 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 Java Data Bean
m_dataBean = new SiebelDataBean();
// login to the Siebel Servers
m_dataBean.login("siebel.tcpip.none.none://gateway:port/enterprise/
object manager","userid","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 for a Business Service
The RemoveProperty method removes a property from a business service. This method does not return any information.
Format
oService.RemoveProperty(propName)
The following table describes the arguments for the RemoveProperty method.
Table Arguments for the RemoveProperty Method
| Argument | Description |
|---|---|
propName |
A string that contains the name of the property that Siebel CRM must remove. |
Usage
This method removes the property that the propName argument identifies from the business service that the oService parameter specifies. As a result, a subsequent call to the PropertyExists method for that property returns FALSE. For more information, see PropertyExists Method for a Business Service.
Used With
Browser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
SetProperty Method for a Business Service
The SetProperty method sets a value in the property of a business service. This method does not return any information.
Format
oService.SetProperty(propName, propValue)
The following table describes the arguments for the SetProperty method.
Table Arguments for the SetProperty Method
| Argument | Description |
|---|---|
propName |
A string that contains the name of the property that Siebel CRM must modify. |
propValue |
A string that contains the value that Siebel CRM sets in the property that the propName argument identifies. |
Usage
You can use the SetProperty method to set the value of a property of a business service from one of the methods of this business service or from an external object. For more information, see GetProperty Method for a Business Service.
Used With
Browser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script
Examples
For an example, see Service_PreInvokeMethod Event.
Business Service Events
This topic describes business service events. It includes the following topics:
Service_InvokeMethod Event
Siebel CRM calls the Service_InvokeMethod event after it calls the InvokeMethod method on a business service. This event does not return any information. For more information, see Service_PreInvokeMethod Event.
Server Script Format
Service_InvokeMethod(MethodName, InputArguments, OutputArguments)
The arguments you can use in this format are the same as the arguments that are described in InvokeMethod Method for a Business Service.
Browser Script Format
OutputArguments=oService.InvokeMethod(methodName, InputArguments)
The following table describes the arguments for the Browser Script format of the Service_InvokeMethod Event
Table Arguments for the Browser Script Format of the Service_InvokeMethod Event
| Argument | Description |
|---|---|
methodName |
A string that contains the name of the method that Siebel CRM must run. |
InputArguments |
A property set that identifies the arguments that the method uses as input. |
In Browser Script, you cannot use an output property set for this format.
Usage
You can use this event in the following ways:
In Server Script. It can add properties to or modify values of the properties in the property set that the OutputArguments argument identifies.
In Browser Script. It cannot modify, store, or update the values of the properties in the output property set.
If you call a business service method through Browser Script, then the business service that this method calls can use a browser or the Siebel Server. Siebel CRM determines if the business service resides in the browser. If the business service does not reside in the browser, then it sends the request to the Siebel Server.
Browser Script can call a business service on the browser or the Siebel Server. Server Script can call only a business service on the Siebel Server.
Used With
Browser Script, Server Script
Examples
To handle transactions that are not approved, the following example in Siebel eScript adds custom logic to the predefined Credit Card Transaction Service business service:
function Service_InvokeMethod (MethodName, Inputs, Outputs)
if (Outputs.GetProperty("SiebelResponseMessage") != "Approved")
{
// special handling for failed transactions here
}
Service_PreCanInvokeMethod Event
Siebel CRM calls the Service_PreCanInvokeMethod event before it calls the PreInvokeMethod event. This configuration allows you to determine if the user possesses the authority to call a business service method. This method returns CancelOperation or ContinueOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
Server Script Format
Service_PreCanInvokeMethod(MethodName, &CanInvoke)
The following table describes the arguments for the Server Script format of the Service_PreCanInvokeMethod event.
Table Arguments for the Server Script Format of the Service_PreCanInvokeMethod Event
| Argument | Description |
|---|---|
MethodName |
A string that contains the name of the method that Siebel CRM must run. |
&CanInvoke |
A string that indicates if Siebel CRM can call the business service method. You can use one of the following values:
|
Browser Script Format
Service_PreCanInvokeMethod(MethodName)
The arguments you can use with this format are the same as the arguments described in WebApplet_InvokeMethod Event.
Used With
Browser Script, Server Script
Service_PreInvokeMethod Event
Siebel CRM calls the Service_PreInvokeMethod event before it calls a specialized method on a business service. For more information, see About Specialized and Custom Methods and Service_InvokeMethod Event.
This method returns ContinueOperation or CancelOperation. For more information, see Caution About Using the Cancel Operation Event Handler.
Server Script Format
Service_PreInvokeMethod(MethodName, InputArguments, OutputArguments)
The arguments you can use in this format are the same as the arguments that are described in InvokeMethod Method for a Business Service.
Browser Script Format
Service_PreInvokeMethod(name, inputPropSet)
The arguments you can use in this format are the same as the arguments that are described in Applet_InvokeMethod Event.
Usage with Server Script
Siebel CRM uses the Server Script version of the Service_PreInvokeMethod event to perform the following work:
Performing business logic
Setting an output in the output property set
If you use a custom business service, then returning CancelOperation
Usage with Browser Script
Siebel CRM uses the Browser Script version of the Service_PreInvokeMethod event to perform the following work:
Performing a user interaction, such as asking for input data.
Setting an input property.
Canceling a user operation. For example, prompting the user to confirm a record deletion.
The Browser Script version is not intended to perform business logic. It does not return an output property set.
How Siebel CRM Handles a Predefined Business Service Method
The following image illustrates how Siebel CRM handles a predefined business service method.
With a predefined business service method, the script can do the following:
Call the Business Service Method.
In the Service_PreInvokeMethod event, process the Method and perform any necessary custom work before it runs the C++ code.
When the C++ code runs, it sets values in the outputs that the service code defines.
If the C++ code runs successfully, then the Service_InvokeMethod event can inspect and modify the output, or perform other tasks depending on the successful completion of the C++ code. At this point, the calling function takes control of the script flow.
How Siebel CRM Handles a Custom Business Service Method
The following image illustrates how Siebel CRM handles a custom business service method.
With a custom business service method, the script can do the following:
Call the Business Service Method.
In the Service_PreInvokeMethod event, process the method and take any necessary custom actions.
The script must return CancelOperation. This operation configures Siebel CRM to cancel the remaining operations that it associates with the event. If Siebel CRM does not cancel the remaining operations, then the flow continues to the C++ code.
This C++ code cannot handle the custom method, so it issues an error that is similar to the following error message:
Unknown method name
Siebel CRM cancels the call to the method, so it does not run the Service_InvokeMethod event.
For more information, see Caution About Using the Cancel Operation Event Handler.
Used With
Browser Script, Server Script
Examples
The following Siebel VB example sets properties in the custom Shipping Engine business service:
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
End If
Service_PreInvokeMethod = iReturn
End Function
Control Methods
This topic describes control methods. It includes the following topics:
In this topic, the controlVar variable indicates the name of the control that causes Siebel CRM to call the method. For example, Button1_Click.
A control method does not work with an ActiveX control.
Applet Method for a Control
The Applet method returns a string that contains the name of the applet that contains the control.
Format
controlVar.Applet
No arguments are available.
Usage
Getting the name of the applet that contains the control allows you to configure Siebel CRM to do operations on the applet, not only on the control.
Used With
Browser Script
BusComp Method for a Control
The BusComp method returns a string that contains the name of the business component that an applet references. The control resides in this applet.
Format
controlVar.BusComp
No arguments are available.
Used With
Browser Script
Examples
For an example, see Name Method for a Business Component.
GetProperty Method for a Control
The GetProperty method returns a string that contains the value of a property. If the property does not exist, then this method returns NULL.
Format
controlVar.GetProperty(propName)
No arguments are available.
Usage
You can use the GetProperty method with the following controls:
CheckBox
ComboBox
TextBox
TextArea
Label
You can use the GetProperty method to get values for the following properties:
Background Color
Enabled
FontType
FontColor
FontSize
FontStyle
Height
Width
Read Only
Visible
For more information about these properties, see Properties You Can Set For a Label.
To return more than one property, you must use a separate statement for each property.
Used With
Browser Script
Examples
The following example uses the GetProperty method to return values for the FontSize, Background Color, Width, and Height properties:
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 for a Control
The GetValue method returns the value that a control displays for the data type of the field that the control references. The type of value depends on the specific control. This method returns the value in a string.
The GetValue method cannot return a literal value that a user provides as input to a control. This method returns the value that Siebel CRM stores for the user entry, according to the data type of the field that the control references.
Format
controlVar.GetValue
No arguments are available.
Usage
For more information, see Usage for the GetValue Method and the SetValue Method.
Used With
Browser Script
Examples
For an example, see Examples for the GetValue Method and the SetValue Method.
Name Method for a Control
The Name method for a control returns a string that contains the name of a control.
Format
controlVar.Name
No arguments are available.
Used With
Browser Script
Examples
For an example, see Name Method for a Business Component.
SetLabelProperty Method for a Control
The SetLabelProperty method sets the properties of a label. This method does not return any information.
Format
controlVar.SetLabelProperty(propName, propValue)
The following table describes the arguments for the SetLabelProperty method.
Table Arguments for the SetLabelProperty Method
| Argument | Description |
|---|---|
propName |
The name of the property that Siebel CRM must set. The values that you can enter are described later in this topic. |
propValue |
The value to set for the property. The values that you can enter are described later in this topic. |
Usage
If you must set more than one property, then you must use a separate statement for each property.
Enabling the SetLabelProperty Method
Siebel CRM does not enable the SetLabelProperty method by default. You must enable it in Siebel Tools before you use it in a script.
To enable the SetLabelProperty method
Open Siebel Tools.
Display the Control User Prop object type:
Choose the View menu, and then the Options menu item.
Click the Object Explorer tab.
Scroll down through the Object Explorer Hierarchy window until you locate the Applet tree.
Expand the Applet tree, expand the Control tree, and then make sure the Control User Prop object type includes a check mark.
Click OK.
In the Object Explorer, click Applet.
In the Applets list, locate the applet that includes the control you must modify.
In the Object Explorer, expand the Applet tree, and then click Control.
In the Controls list, locate the control you must modify.
In the Object Explorer, expand the Control tree, and then click Control User Prop.
In the Control User Props list, add a new control user property using values from the following table.
Property Value Name
useLabelID
Value
TRUE
Properties You Can Set For a Label
The following table lists the properties you can set for a label.
Table Properties You Can Set For a Label
| Property | Value | Description |
|---|---|---|
BgColor |
string |
Determines the background color for a label. For example:
|
FontColor |
string |
Determines the font color for a label. For example, green is #00ff00. |
FontType |
string |
Determines the font type for a label. For example, Times Roman. |
FontSize |
string |
Determines the font size for a label. For example, 12 pt. |
FontStyle |
string |
Determines the font style for a label. For example, italic. |
FontWeight |
string |
Determines the font weight for a label. You can use the following values:
The default value is normal. |
Height |
string |
Determines height for a label, in pixels. For example, 5. |
Visible |
visible or hidden |
Determines if the label is visible. The default value is the value in the Siebel runtime repository. |
Width |
string |
Determines the width for a label, in pixels. For example, 80. |
Used With
Browser Script
Examples
The following code uses the SetLabelProperty method:
function Applet_PreInvokeMethod (name, inputPropSet){
switch (name) {
// Example of changing the font size of the Location label
case ("fontsize"):
{
var ctl = this.FindControl("Location");
var fSize = prompt("Specify the required label font size (numeric value
only).");
ctl.SetLabelProperty("FontSize", fSize);
return ("CancelOperation");
}
// Example of changing the background color of the Location label
case ("bgcolor"):
{
var ctl = this.FindControl("Location");
var bgColor = prompt("Specify th ebackground color of the label. Enter a valid
six hexadecimal digit RGB value preceded by #");
ctl.SetLabelProperty("BgColor", bgColor);
return ("CancelOperation");
}
// Example of changing the font type of the Location label
case ("fonttype"):
{
var ctl = this.FindControl("Location");
var fontType =prompt("Specify the font type for the label.");
ctl.SetLabelProperty("FontType", fontType);
return ("CancelOperation");
}
// Example of changing the font color of the Location label
case ("fontcolor"):
{
var ctl = this.FindControl("Location");
var fontColor = prompt("Specify the font color of the label. Enter a valid six
hexadecimal digit RGB value preceded by #");
ctl.SetLabelProperty("FontColor", fontColor);
return ("CancelOperation");
}
break;
}
}
SetProperty Method for a Control
The SetProperty method sets the properties of a control. This method does not return any information.
Format
controlVar.SetProperty(propName, propValue)
The following table describes the arguments for the SetProperty method.
Table Arguments for the SetProperty Method
| Argument | Description |
|---|---|
propName |
The name of the property that Siebel CRM must set. The values you can enter are described later in this topic. |
propValue |
The value that Siebel CRM must set for the property. The values that you can enter are described later in this topic. |
Usage
You can use the SetProperty method with the following controls:
CheckBox
ComboBox
TextBox
TextArea
If you must set more than one property, then you must use a separate statement to set each property.
Properties You Can Set for a Control
The following table describes the properties you can set for a control.
Table Properties You Can Set for a Control
| Property | Value | Description |
|---|---|---|
Enabled |
TRUE or FALSE |
Determines if the control is active. The default value is the value in the Siebel runtime repository. |
Shown |
TRUE or FALSE |
Determines if Siebel CRM displays the control. The default value is the value in the Siebel runtime repository. |
ReadOnly |
TRUE or FALSE |
Determines if the control is read-only. The default value is the value in the Siebel runtime repository. |
BgColor |
To modify these control properties, you can use these same properties you use to modify a label. For a description of the values you can enter, see Properties You Can Set For a Label. |
|
FontColor |
||
FontType |
||
FontSize |
||
FontStyle |
||
FontWeight |
||
Height |
||
Visible |
||
Width |
||
Used With
Browser Script
Using the SetProperty Method to Control Font Weight
To use the SetProperty method to control font weight, you must use the FontWeight property. For example:
control.SetProperty("FontWeight","600")
You cannot use the FontStyle argument to control font weight. For example, the following code fails:
control.SetProperty("FontStyle", "Bold")
Examples
The following code uses the SetProperty method:
objCheckBox.SetProperty("FontColor", "#00ff00");
objCheckBox.SetProperty("FontStyle", "italic");
objCheckBox.SetProperty("FontType", "Verdana");
objCheckBox.SetProperty("FontSize", "14 pt");
objCheckBox.SetProperty("BgColor", "#00f000");
objCheckBox.SetProperty("Width", "100");
objCheckBox.SetProperty("Height", "100");
SetValue Method for a Control
The SetValue method sets the contents for a control. This method does not return any information.
Format
controlVar.SetValue (controlValue)
The following table describes the arguments for the SetValue method.
Table Arguments for the SetValue Method
| Argument | Description |
|---|---|
controlValue |
String that contains the value that Siebel CRM must set for the control. |
Usage for the GetValue Method and the SetValue Method
Note the following usage for the SetValue method:
This method does not validate the format of the data. Data validation occurs when the user steps off the field or the record, or explicitly saves the record.
This method can set the value for a read-only control, but Siebel CRM does not save this information when the user saves the record.
The user can modify the contents of a control before Siebel CRM saves control information to the business component field.
Note the following usage for the GetValue method and the SetValue method:
These methods only work on form applets.
These methods work only for a control that references a business component field.
You cannot use these methods with a label.
Used With
Browser Script
Examples for the GetValue Method and the SetValue Method
The following code uses the GetValue method and the SetValue method:
function Applet_PreInvokeMethod (name, inputPropSet)
{
switch (name) {
// Example of changing the value of the Abstract control to uppercase
case ("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
case ("SR Billable"):
{
var ctlName = "Billable Flag";
var ctl = this.FindControl(ctlName);
var ctlVal = ctl.GetValue();
if (ctlVal == "Y")
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
case ("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 saves the record
ctl= null;
return("CancelOperation");
}
break;
}
}
Property Set Methods
This topic describes property set methods. It includes the following topics:
In this topic, the oPropSet variable indicates the variable that contains a property set.
AddChild Method for a Property Set
The AddChild method adds a child property set to a property set. This method returns an integer that indicates the index of the child property set.
Format
oPropSet.AddChild(childPropSet)
AddChild Method for a Property Set describes the arguments for the AddChild method.
Table Arguments for the AddChild Method
| Argument | Description |
|---|---|
childObject |
A property set that Siebel CRM must make as a child to the property set that the oPropSet variable identifies. |
Usage
You can use a property set to create a tree data structure. You can add any number of arbitrarily structured child properties to a property set. You can use a child property set to structure a property set in a manner that is similar to the structure that the data model uses. For example, a parent account property set can include child property sets for opportunities, contacts, activities, and so forth. In this example, you could create an independent property set named Opportunity, where accounts, contacts, and activities can be children.
If Siebel CRM creates an instance of a property set through script, and then adds it to a parent property set, and if the parent property set is subsequently released, then Siebel CRM does not release this child instance. The reference to the child instance exists independently.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
The following fragment of Siebel eScript code adds child property sets to a parent property set:
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
For more information, see the following topics:
Copy Method for a Property Set
The Copy method returns a copy of a property set.
Format
oPropSet.Copy()
No arguments are available.
Usage
The Copy method creates a copy of a property set, including any properties and child property sets. Siebel CRM typically passes a property set through a reference, so making a copy allows you to manipulate a property set without affecting the original property set.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
The following Siebel VB example uses a copy of a property set to store the original values of the properties, and displays the original and Pig-Latin forms of the properties:
(general)
(declarations)
Option Explicit
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
Set message = Nothing
Set Outputs = Nothing
Set Inputs = Nothing
End Sub
GetByteValue Method for a Property Set
The GetByteValue method returns the following information:
If a byte value is set, then this method returns a byte array.
If a string value is set, then this method returns a null value.
For more information, see SetByteValue Method for a Property Set.
Format
oPropSet.getByteValue()
No arguments are available.
Used With
Siebel Java Data Bean
Examples
The following example uses a binary value as input and provides a binary output. The angle brackets (< >) indicate a variable:
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 return the value..and pop it in a String..for example
String out2 = new String (output.getByteValue());
System.out.println(out2);
GetChild Method for a Property Set
The GetChild method returns the index number of a child property set.
Format
oPropSet.GetChild(index)
The following table describes the arguments for the GetChild method.
Table Arguments for the Arguments for the GetChild Method
| Argument | Description |
|---|---|
index |
An integer that identifies the index number of the child property set that Siebel CRM must return. |
How Siebel CRM Handles Indexing for Child Property Sets
Note how Siebel CRM handles indexing for a child property set you add, insert, or remove:
If Siebel CRM creates a child property set, then it creates an index number for this child property set, starting at 0 (zero). It increments this index for each child property set it adds to a given parent property set.
If you use the AddChild Property method, then Siebel CRM uses the next available index number for the child property set it adds.
If you use the InsertChildAt method, then Siebel CRM inserts the new child property set at a specified index. It also increases the index by 1 for the property set that the new child displaces, and for all child property sets that occur after the displaced property set.
If you use the RemoveChild method, then Siebel CRM removes the child property set you specify, and then decreases the index by 1 for all property sets that follow the removed child.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
If you use the Web Client Automation Server, then the child object that Siebel CRM returns is a copy of the object. Siebel CRM updates any modifications that occur to the object that it returns, but it does not update the originating object.
Examples
The following 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
For more information, see the following topics:
GetChildCount Method for a Property Set
The GetChildCount method returns the number of child property sets that exist for a parent property set.
Format
oPropSet.GetChildCount()
No arguments are available.
Usage
The GetChildCount method returns the number of child property sets for the property set that the oPropSet variable identifies. The index number for child property sets start at 0, so a child count of 3 indicates that there are child property sets at indexes 0, 1, and 2.
The GetChildCount method returns only the number of direct descendants. If a child property set includes children, then Siebel CRM does not include these grandchildren in the count that it provides in the return value.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
For an example, see GetChild Method for a Property Set.
GetFirstProperty Method for a Property Set
The GetFirstProperty method for a property set returns a string that contains the name of the first property in a property set.
Format
oPropSet.GetFirstProperty()
No arguments are available.
Usage
The usage for the GetFirstProperty method for a property set is similar to the usage for the GetFirstProperty method for a business service. For more information, see Usage for a Method that Gets a Business Service Property.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
The following example uses the GetFirstProperty method to get the first property, and then uses the GetNextProperty method to return all subsequent properties. If the GetNextProperty method returns a null value, then Siebel CRM terminates the loop:
function Service_PreInvokeMethod (MethodName, Inputs, Outputs)
{
var propName = "";
var propVal = "";
propName = Inputs.GetFirstProperty();
// stay in loop if the property name is not an empty string
while (propName != "") {
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
For more information, see the following topics:
GetLastErrCode Method for a Property Set
The GetLastErrCode method returns the error code for the error that Siebel CRM logged most recently. This code is a short integer. 0 (zero) indicates no error.
Format
oPropSet.GetLastErrCode
No arguments are available.
Usage
For more information, see Usage for the GetLastErrCode Method.
Used With
Mobile Web Client Automation Server, Web Client Automation Server
GetLastErrText Method for a Property Set
The GetLastErrText method returns a string that contains the text message for the error that Siebel CRM logged most recently.
Format
oPropSet.GetLastErrText
No arguments are available.
Usage
For more information, see Usage for the GetLastErrText Method.
Used With
Mobile Web Client Automation Server, Web Client Automation Server
GetNextProperty Method for a Property Set
The GetNextProperty method returns a string that contains the name of the next property of a property set. If no more properties exist, then this method returns an empty string.
Format
oPropSet.GetNextProperty()
No arguments are available.
Usage
Usage for the GetNextProperty method for a property set is similar to the usage for the GetNextProperty method for a business service. For more information, see Usage for the GetNextProperty Method.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
For an example, see GetFirstProperty Method for a Property Set.
Related Topics
For more information, see the following topics:
GetProperty Method for a Property Set
The GetProperty method returns a string that contains the value of a property. If the property does not exist, then this method returns NULL.
Format
oPropSet.GetProperty(propName)
The arguments you can use with this format are the same as the arguments described in GetProperty Method for a Business Service.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
The following fragment of Siebel eScript code receives a set of input properties used with the Shipping Engine business service described in Service_PreInvokeMethod Event:
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
For more information, see the following topics:
GetPropertyCount Method for a Property Set
The GetPropertyCount method returns the number of properties that exist in the current level in the hierarchy. It does not return all properties in the entire property set hierarchy.
Format
oPropSet.GetPropertyCount
No arguments are available.
Used With
Browser Script, COM Data Control, COM Data Server, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
GetType Method for a Property Set
The GetType method returns a string that contains the value of the type attribute of a property set.
Format
oPropSet.GetType
No arguments are available.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Related Topics
For more information, see the following topics:
GetValue Method for a Property Set
The GetValue method returns a string that contains the value of the value attribute of a property set.
Format
oPropSet.GetValue
No arguments are available.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Related Topics
For more information, see the following topics:
InsertChildAt Method for a Property Set
The InsertChildAt method inserts a child property set in a parent property set at a specific location. This method does not return any information. For more information, see AddChild Method for a Property Set.
Format
oPropSet.InsertChildAt childObject, index
The following table describes the arguments for the InsertChildAt method.
Table Arguments for the InsertChildAt Method
| Argument | Description |
|---|---|
childObject |
The property set that Siebel CRM must make a child. It makes this property set a child of the property set that the oPropSet variable identifies. |
index |
An integer that identifies the position where Siebel CRM must insert the property set. The childObject argument identifies this property set. |
Usage
For more information, see How Siebel CRM Handles Indexing for Child Property Sets.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
PropertyExists Method for a Property Set
The description of the PropertyExists method for a property set is the same as the description of the PropertyExists method for a business service. For more information, see PropertyExists Method for a Business Service.
Format
oPropSet.PropertyExists(propName)
The arguments you can use with this format are the same as the arguments described in PropertyExists Method for a Business Service.
Usage
The GetProperty method returns an empty string for every nonexistent property, so you can use the PropertyExists method in an If statement to determine if a specific property is set.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
For an example, see GetFirstProperty Method for a Property Set.
RemoveChild Method for a Property Set
The RemoveChild method removes a child property set from a parent property set. This method does not return any information.
Format
oPropSet.RemoveChild index
The following table describes the arguments for the RemoveChild method.
Table Arguments for the RemoveChild Method
| Argument | Description |
|---|---|
index |
An integer that identifies the index number of the child property set that Siebel CRM must remove. |
Usage
For information about how Siebel CRM handles indexing for child property sets, see How Siebel CRM Handles Indexing for Child Property Sets.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
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
For more information, see the following topics:
RemoveProperty Method for a Property Set
The RemoveProperty method removes a property from a property set. This method does not return any information.
Format
oPropSet.RemoveProperty propName
The arguments you can use with this format are the same as the arguments described in RemoveProperty Method for a Business Service.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Reset Method for a Property Set
The Reset method removes all properties and children from a property set. This method does not return any information.
Format
oPropSet.Reset()
No arguments are available.
Usage
The Reset method allows you to reuse a property set.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
SetByteValue Method for a Property Set
The SetByteValue method sets the value of a property set. This method does not return any information.
Format
oPropSet.setByteValue(value)
The following table describes the arguments for the SetByteValue method.
Table Arguments for the SetByteValue Method
| Argument | Description |
|---|---|
value |
The byte array that contains the value that Siebel CRM must set. |
Used With
Siebel Java Data Bean
Examples
The following example uses a binary value as input and then provides a binary output. For more information, see GetByteValue Method for a Property Set:
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 return the value and put it in a String
String out2 = new String (output.getByteValue());
System.out.println(out2);
SetProperty Method for a Property Set
The SetProperty method sets a value in the property of a property set. This method does not return any information. For more information, see GetProperty Method for a Property Set.
Format
oPropSet.SetProperty propName, propValue
The arguments you can use with this format are the same as the arguments described in SetProperty Method for a Business Service.
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Examples
This Siebel VB fragment uses the Shipping Engine business service:
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
For more information, see Service_PreInvokeMethod Event.
SetType Method for a Property Set
The SetType method sets the value for the type attribute of a property set. This method does not return any information.
Format
oPropSet.SetType type
The following table describes the arguments for the SetType method.
Table Arguments for the SetType Method
| Argument | Description |
|---|---|
type |
A string that contains data that Siebel CRM must store in the type attribute. |
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Related Topics
For more information, see the following topics:
SetValue Method for a Property Set
The SetValue method sets the value for the value attribute of a property set. This method does not return any information.
Format
oPropSet.SetValue value
The following table describes the arguments for the SetValue method.
Table Arguments for the Arguments for the SetValue Method
| Argument | Description |
|---|---|
value |
A string that contains data that Siebel CRM must store in the value attribute. |
Used With
Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server
Related Topics
For more information, see the following topics:
Miscellaneous Methods
This topic describes other methods. It includes the following topics:
GetErrorCode Method
The GetErrorCode method returns a string that contains a numeric error code. For more information, see GetErrorMessage Method.
Format
public int getErrorCode()
No arguments are available.
Used With
Siebel Java Data Bean
Examples
The following example for the Siebel Java Data Bean returns the first record in the Account business component. If an error occurs, then the script displays the error code and error message:
try
{
//Instantiate the Siebel Java 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);
}
...
GetErrorMessage Method
The GetErrorMessage method returns a string that contains an error message. For more information, see GetErrorCode Method.
Format
public string getErrorMessage()
No arguments are available.
Used With
Siebel Java Data Bean
TheApplication Method
The theApplication method is a global method that returns a string that contains the name of an application object. This object is the root of objects in the Siebel Application Object hierarchy.
Browser Script Format
the Application()
Siebel VB Format
TheApplication
Siebel eScript Format
TheApplication()
No arguments are available.
Usage
You can use the theApplication method to determine the object reference of the Siebel application. You can then use this information to find other objects or to call a method on the application object. For example, if you use Siebel eScript to determine if you are logged in to a server database or local database, then you can use the following code:
TheApplication().InvokeMethod("GetDataSource")
Used With
Browser Script, Server Script
Examples
The following Siebel VB example returns 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