7Siebel VB Quick Reference

Siebel VB Quick Reference

This chapter describes summary information for Siebel VB. It includes the following topics:

• Applet Methods for Siebel VB

• Web Applet Events for Siebel VB

• Application Methods for Siebel VB

• Application Events for Siebel VB

• Business Component Methods for Siebel VB

• Business Component Events for Siebel VB

• Business Object Methods for Siebel VB

• Business Service Methods for Siebel VB

• Business Service Events for Siebel VB

• Property Set Methods for Siebel VB

• Miscellaneous Methods for Siebel VB

Applet Methods for Siebel VB

The following table describes a summary of the applet methods you can use with Siebel VB.

Table Summary of Applet Methods for Siebel VB

Method	Description	Format
BusComp Method for an Applet	Returns the name of the business component that an applet references.	Dim oApplet as Applet Dim oBusComp as BusComp Set oBusComp = oApplet.BusComp
BusObject Method for an Applet	Returns the name of the business object for the business component that the applet references.	Dim oApplet as Applet Dim oBusObject as BusObject Set oBusObject = oApplet.BusObject
InvokeMethod Method for an Applet	Calls a specialized method.	Dim oApplet as Applet oApplet.InvokeMethod methodName as String, methArg1, methArg2, methArgN as String or StringArray
Name Method for an Applet	Returns the name of an applet.	Dim oApplet as Applet Dim sApplet as String sApplet = oApplet.Name

Web Applet Events for Siebel VB

The following table describes a summary of web applet events you can use with Siebel VB.

Table Summary of Web Applet Events for Siebel VB

Event	Description	Format
WebApplet_InvokeMethod Event	Called after Siebel CRM runs a specialized method on the Web applet.	WebApplet_InvokeMethod(MethodName as String)
WebApplet_PreCanInvokeMethod Event	Called before Siebel CRM calls the PreInvokeMethod event, allowing you to determine if the user possesses the authority to call the applet method.	WebApplet_PreCanInvokeMethod (MethodName as String, CanInvoke as String)
WebApplet_PreInvokeMethod Event	Called before Siebel CRM calls a specialized method for the Web applet or before it calls a custom method through oWebApplet.Invoke Method.	WebApplet_PreInvokeMethod (MethodName as String) As Integer
WebApplet_Load Event	Called immediately after Siebel CRM loads an applet.	WebApplet_Load

Application Methods for Siebel VB

The following table describes a summary of the application methods you can use with Siebel VB. It does not include object interface methods that are not called directly from an application object instance. For information about methods that are called with the InvokeMethod method on the application object, see LoadObjects Method for an Application.

Table Summary of Application Methods for Siebel VB

Method	Description	Format
ActiveBusObject Method for an Application	Returns the name of the business object of the active view.	Dim oApplication as Application Dim oBusObject as BusObject Set oBusObject = oApplication.ActiveBusObject
ActiveViewName Method for an Application	Returns the name of the active view.	Dim oApplication as Application Dim sView as String sView = oApplication.ActiveViewName
CurrencyCode Method for an Application	Returns the currency code that is associated with the division of the user position	Dim oApplication as Application Dim sCur as String sCur = oApplication.CurrencyCode
GetBusObject Method for an Application	Creates a new instance of a business object.	Dim oApplication as Application Dim oBusObject as BusObject set oBusObject = oApplication.GetBusObject (busobject as String)
GetProfileAttr Method for an Application	Returns the name of an attribute in a user profile.	Dim oApplication as Application Dim sAttr as String SAttr = oApplication.GetProfileAttr(name as String)
GetService Method for an Application	Locates a business service. If this business service is not already running, then Siebel CRM starts it.	Dim oApplication as Application Dim oService as Service set oService = oApplication.GetService(serviceName as String)
GetSharedGlobal Method for an Application	Returns the shared global variables.	Dim oApplication as Application Dim sName as String sName = Application.GetSharedGlobal(varName as String)
GotoView Method for an Application	Does the following: Deactivates any business object, business component, applet, or control that is active. Activates a view. 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	Dim oApplication as Application oApplication.GotoView viewName as String[, BusinessObjectName as BusObject]
InvokeMethod Method for an Application	Calls a method.	Dim oApplication as Application oApplication.InvokeMethod(methodName asString, methArg1, methArg2, methArgN as String or StringArray)
LoginId Method for an Application	Returns the login ID of the user who started the Siebel application.	Dim oApplication as Application Dim sID as String iID = oApplication.LoginId
LoginName Method for an Application	Returns the login name of the user who started the Siebel application.	Dim oApplication as Application Dim sUser as String sUser = oApplication.LoginName
NewPropertySet Method for an Application	Creates a new property set.	Dim oApplication as Application Dim oPropSet as PropertySet oPropSet = oApplication.NewPropertySet
PositionId Method for an Application	Returns the name of the current user position.	Dim oApplication as Application Dim sRow as String sRow = oApplication.PositionId
PositionName Method for an Application	Returns the name of the current user position.	Dim oApplication as Application Dim sPosition as String sPosition = oApplication.PositionName
RaiseError Method for an Application	Sends a scripting error message to the browser. To determine the error text, Siebel CRM uses a key to look up the current language.	Dim oApplication as Application oApplication.RaiseErrorkeyValue as String, param1 as String, ...
RaiseErrorText Method for an Application	Sends a scripting error message to the browser.	Dim oApplication as Application oApplication.RaiseErrorText message as String
SetPositionId Method for an Application	Sets the active position to a Position Id.	Dim oApplication as Application oApplication.SetPositionId posId as string
SetPositionName Method for an Application	Sets the active position to a position name.	Dim oApplication as Application oApplication.SetPositionName posName as string
SetProfileAttr Method for an Application	Sets a value for an attribute in a user profile.	Dim oApplication as Application oApplication.SetProfileAttr name as String, value as String
SetSharedGlobal Method for an Application	Sets a shared global variable.	Dim oApplication as Application oApplication.SetSharedGlobal varName as String, value as String
Trace Method for an Application	Appends a message to the trace file.	Dim oApplication as Application oApplication.Trace message as String
TraceOff Method for an Application	Turns off tracing.	Dim oApplication as Application oApplication.TraceOff
TraceOn Method for an Application	Turns on tracing.	Dim oApplication as Application oApplication.TraceOn filename as String, type as String, selection as String

Application Events for Siebel VB

The following table describes a summary of the application events you can use with Siebel VB.

Table Summary of Application Events for Siebel VB

Event	Description	Format
Application_Close Event	Allows scripts to perform cleanup, before the Siebel application closes.	Application_Close
Application_Navigate Event	Called after the user navigates to a view.	Application_Navigate
Application_InvokeMethod Event	Called after a specialized method is called.	Application_InvokeMethod (MethodName as String)
Application_PreInvokeMethod Event	Called before an applet menu or the InvokeMethod method calls a specialized method.	Application_PreInvokeMethod (MethodName as String) As Integer
Application_PreNavigate Event	Called before the Siebel application displays the view where the user navigates.	Application_PreNavigate (DestViewName As String, DestBusObjName As String)
Application_Start Event	Called when the Siebel client starts and again when it displays the client interface for the first time.	Application_Start(commandLine as String)

Business Component Methods for Siebel VB

The following table describes a summary of the business component methods you can use with Siebel VB. It does not include object interface methods that are not called directly from a business component. For information about methods that you can call with the InvokeMethod method on the business component, see Business Component Invoke Methods.

Table Summary of Business Component Methods for Siebel VB

Method	Description	Format
ActivateField Method for a Business Component	Activates a field.	Dim oBusComp as BusComp oBusComp.ActivateField fieldName as String
ActivateMultipleFields Method for a Business Component	Activates multiple fields.	Dim oBusComp as BusComp oBusComp.ActivateMultipleFields oPropSet as PropertySet
Associate Method for a Business Component	Creates a new many-to-many relationship for the parent object through an association business component.	Dim oBusComp as BusComp oBusComp.Associate whereIndicator as Integer
BusObject Method for a Business Component	Returns the name of the business object that the business component references.	Dim oBusComp as BusComp Dim oBusObject as BusObject Set oBusObject = oBusComp.BusObject
ClearToQuery Method for a Business Component	Clears the current query but does not clear sort specifications on the business component.	Dim oBusComp as BusComp oBusComp.ClearToQuery
DeactivateFields Method for a Business Component	Deactivates the fields that are currently active from the SQL query statement of a business component.	Dim oBusComp as BusComp oBusComp.DeactivateFields
DeleteRecord Method for a Business Component	Removes the current record from a business component.	Dim oBusComp as BusComp oBusComp.DeleteRecord
ExecuteQuery Method for a Business Component	Returns a set of business component records.	Dim oBusComp as BusComp oBusComp.ExecuteQuery cursorMode as Integer
ExecuteQuery2 Method for a Business Component	Returns a set of business component records. Allows you to control the number of records Siebel CRM returns.	Dim oBusComp as BusComp oBusComp.ExecuteQuery2 cursorMode as Integer, ignoreMaxCursorSize as Integer
FirstRecord Method for a Business Component	Moves the record pointer to the first record in a business component, making that record the current record.	Dim oBusComp as BusComp Dim iIsRecord as Integer iIsRecord = oBusComp.FirstRecord
FirstSelected Method for a Business Component	Makes the first record of the multiple selection in a business component active.	Dim oBusComp as BusComp Dim iIsMultipleSection as Integer iIsMultipleSelection = oBusComp.FirstSelected
GetAssocBusComp Method for a Business Component	Returns the name of the association business component.	Dim oBusComp as BusComp Dim AssocBusComp as BusComp Set AssocBusComp = oBusComp.GetAssocBusComp
GetFieldValue Method for a Business Component	Returns the value of a field from the current record of a business component.	Dim oBusComp as BusComp Dim sValue as String sValue = oBusComp.GetFieldValue(FieldName as String)
GetFormattedFieldValue Method for a Business Component	A field value that is in the same format that the Siebel client uses.	Dim oBusComp as BusComp Dim sValue as String sValue = oBusComp.GetFormattedFieldValue(FieldName as String)
GetMultipleFieldValues Method for a Business Component	Returns values for the fields specified in a property set.	Dim oBusComp as BusComp oBusComp.GetMultipleFieldValues oFields as PropertySet, oValues as PropertySet
GetMVGBusComp Method for a Business Component	Returns the multivalue group business component associated a business component field.	Dim oBusComp as BusComp Dim MvgBusComp as BusComp set MvgBusComp = oBusComp.GetMVGBusComp(FieldName as String)
GetNamedSearch Method for a Business Component	Returns the name of a search specification.	Dim oBusComp as BusComp Dim sValue as String sValue = oBusComp.GetNamedSearch(SearchName as String)
GetPicklistBusComp Method for a Business Component	Returns the name of the pick business component that is associated with a field in the current business component.	Dim oBusComp as BusComp Dim pickBusComp as BusComp Set pickBusComp = oBusComp.GetPicklistBusComp(FieldName as String)
GetSearchExpr Method for a Business Component	Returns the current search expression that is defined for a business component.	Dim oBusComp as BusComp Dim sExpr as String sExpr = oBusComp.GetSearchExpr
GetSearchSpec Method for a Business Component	Returns the search specification for a field.	Dim oBusComp as BusComp Dim sSpec as String sSpec = oBusComp.GetSearchSpec(FieldName as String)
GetSortSpec Method for a Business Component	Returns the sort specification for a business component.	Dim sSortSpec as String sSortSpec = GetSortSpec
GetUserProperty Method for a Business Component	Returns the value of a user property.	Dim oBusComp as BusComp Dim sValue as String sValue = oBusComp.GetUserProperty(propertyName as String)
GetViewMode Method for a Business Component	Returns the current visibility mode for a business component.	Dim oBusComp as BusComp Dim iMode as Integer iMode = oBusComp.GetViewMode
InvokeMethod Method for a Business Component	Calls a method.	Dim oBusComp as BusComp oBusComp.InvokeMethod(methodName as String, methArg1, methArg2, methArgN as String or StringArray)
LastRecord Method for a Business Component	Moves the record pointer to the last record in a business component.	Dim oBusComp as BusComp Dim iReturn as Integer iReturn = oBusComp.LastRecord
Name Method for a Business Component	Returns the name of a business component.	Dim oBusComp as BusComp Dim sName as String sName = oBusComp.Name
NewRecord Method for a Business Component	Adds a new record to a business component.	Dim oBusComp as BusComp oBusComp.NewRecord whereIndicator as Integer
NextRecord Method for a Business Component	Moves the record pointer to the next record in a business component, making that record the current record.	Dim oBusComp as BusComp Dim iReturn as Integer iReturn = oBusComp.NextRecord
NextSelected Method for a Business Component	Makes the next record of the current multiple selection the active record.	Dim oBusComp as BusComp Dim iReturn as Integer iReturn = oBusComp.NextSelected
ParentBusComp Method for a Business Component	Returns the name of the parent business component.	Dim oBusComp as BusComp Dim parentBusComp as BusComp Set parentBusComp = oBusComp.ParentBusComp
Pick Method for a Business Component	Places the currently chosen record in a pick business component into the appropriate fields of the parent business component.	Dim oBusComp as BusComp oBusComp.Pick
PreviousRecord Method for a Business Component	Moves the record pointer to the previous record in a business component.	Dim oBusComp as BusComp Dim iReturn as Integer iReturn = oBusComp.PreviousRecord
RefineQuery Method for a Business Component	Refines a query.	Dim oBusComp as BusComp oBusComp.RefineQuery
SetFieldValue Method for a Business Component	Sets a new value for a field in the current record of a business component.	Dim oBusComp as BusComp oBusComp.SetFieldValue FieldName as String, FieldValue as String
SetFormattedFieldValue Method for a Business Component	Sets the new value to a field for the current record of a business component.	Dim oBusComp as BusComp oBusComp.SetFormattedFieldValue FieldName as String, FieldValue as String
SetMultipleFieldValues Method for a Business Component	Sets new values in the fields of the current record of a business component.	Dim oBusComp as BusComp oBusComp.SetMultipleFieldValues oPropSet as PropertySet
SetNamedSearch Method for a Business Component	Sets the named search specification on a business component.	Dim oBusComp as BusComp oBusComp.SetNamedSearch searchName as String, searchSpec as String
SetSearchExpr Method for a Business Component	Sets a search expression for a business component rather than for each field.	Dim oBusComp as BusComp oBusComp.SetSearchExpr searchSpec as String
SetSearchSpec Method for a Business Component	Sets the search specification for a field.	Dim oBusComp as BusCompoBusComp.SetSearchSpec fieldName as String, searchSpec as String
SetSortSpec Method for a Business Component	Sets the sort specification for a business component.	Dim oBusComp as BusComp oBusComp.SetSortSpec sortSpec as String
SetUserProperty Method for a Business Component	Sets the value of a user property in a business component.	Dim oBusComp as BusComp oBusComp.SetUserProperty propertyName as String, newValue as String
SetViewMode Method for a Business Component	Sets the visibility type for a business component.	Dim oBusComp as BusComp oBusComp.SetViewMode viewMode as Integer
UndoRecord Method for a Business Component	Reverses any unsaved modifications that Siebel CRM has made on a record.	Dim oBusComp as BusComp oBusComp.UndoRecord
WriteRecord Method for a Business Component	Saves to the Siebel database any modifications made to the current record.	Dim oBusComp as BusComp oBusComp.WriteRecord

Business Component Events for Siebel VB

The following table describes a summary of the business component events you can use with Siebel VB.

Table Summary of Business Component Events for Siebel VB

Event	Description	Format
BusComp_Associate Event	Called if the user adds a business component record to create an association.	BusComp_Associate
BusComp_ChangeRecord Event	Called if a business component record becomes the current record.	BusComp_ChangeRecord
BusComp_CopyRecord Event	Called if the user copies a business component record, and if the user makes this record the active record.	BusComp_CopyRecord
BusComp_DeleteRecord Event	Called if the user deletes a business component record.	BusComp_DeleteRecord
BusComp_InvokeMethod Event	Called if Siebel CRM calls the InvokeMethod method on a business component.	BusComp_InvokeMethod(methodName as String)
BusComp_NewRecord Event	Called if the user creates a business component record, and if the user makes this record the active record. You can use this event to set up default values for a field.	BusComp_NewRecord
BusComp_PreAssociate Event	Called if Siebel CRM detects that the user is about to add a business component record to create an association.	BusComp_PreAssociate
BusComp_PreCopyRecord Event	Called if Siebel CRM detects that the user is about to copy a business component record. You can use this event to perform precopy validation.	BusComp_PreCopyRecord
BusComp_PreDeleteRecord Event	Called if Siebel CRM detects that the user is about to delete a business component record. You can use this event to prevent the deletion or to perform any actions before Siebel CRM deletes the record.	BusComp_PreDeleteRecord
BusComp_PreGetFieldValue Event	Called if a user accesses a business component field.	BusComp_PreGetFieldValue(FieldName as String, FieldValue as String)
Bus Comp_PreInvokeMethod Event	Called if Siebel CRM calls a specialized method on a business component. Siebel CRM calls it before it calls this specialized method.	BusComp_PreInvokeMethod(methodName as String)
BusComp_PreNewRecord Event	Called if Siebel CRM detects that the user is about to create a new business component record. You can use this event to perform preinsert validation.	BusComp_PreNewRecord
BusComp_PreQuery Event	Siebel CRM calls the BusComp_PreQuery event before it runs a query. You can use this event to modify the search criteria or to restrict Siebel CRM from running certain queries.	BusComp_PreQuery
BusComp_PreSetFieldValue Event	Siebel CRM calls this event after the user modifies a field value or after a call to the SetFieldValue method occurs. This event allows you to use custom validation before Siebel CRM applies predefined validation.	BusComp_PreSetFieldValue(FieldName as String, FieldValue as String)
BusComp_PreWriteRecord Event	Called before Siebel CRM writes a record to the Siebel database.	BusComp_PreWriteRecord
BusComp_Query Event	Called after Siebel CRM completes a query but before it displays the query results.	BusComp_Query
BusComp_SetFieldValue Event	Called if Siebel CRM sends a value to a business component from the Siebel client or through a call to the SetFieldValue method.	BusComp_SetFieldValue(fieldName as String)
BusComp_WriteRecord Event	Called after Siebel CRM saves the record to the Siebel database.	BusComp_WriteRecord

Business Object Methods for Siebel VB

The following table describes a summary of business object methods you can use with Siebel VB.

Table Summary of Business Object Methods for Siebel VB

Method	Description	Format
GetBusComp Method for a Business Object	Returns the name of a business component instance.	Dim oBusObject as BusObject Dim oBusComp as BusComp set oBusComp = BusObject.GetBusComp(BusCompName as String)
Name Method for a Business Object	Returns the name of a business object.	Dim oBusObject as BusObject Dim sName as String sName = oBusObject.Name

Business Service Methods for Siebel VB

The following table describes a summary of the business service methods you can use with Siebel VB.

Table Summary of Business Service Methods for Siebel VB

Method	Description	Format
GetFirstProperty Method for a Business Service	Returns the name of the first property that is defined for a business service.	Dim oService as Service Dim sName as String sName = oService.GetFirstProperty
GetNextProperty Method for a Business Service	Returns the name of the next property of a business service.	Dim oService as Service Dim sName as String sName = oService.GetNextProperty
GetProperty Method for a Business Service	Returns the value of a property.	Dim oService as Service Dim sValue as String sValue = oService.GetProperty(propName as String)
InvokeMethod Method for a Business Service	Calls a method on a business service.	Dim oService as Service oService.InvokeMethod(methodName as String, InputArguments as PropertySet, OutputArguments as PropertySet)
Name Method for a Business Service	Returns the name of a business service.	Dim oService as Service Dim sName as String sName = oService.Name
PropertyExists Method for a Business Service	Returns a Boolean value that indicates if the property that the argument identifies exists.	Dim oService as Service Dim iReturn as Boolean iReturn = oService.PropertyExists(propName as String)
RemoveProperty Method for a Business Service	Removes a property from a business service.	Dim oService as Service oService.RemoveProperty propName as String
SetProperty Method for a Business Service	Sets a value for a property of a business service.	Dim oService as Service oService.SetProperty propName as String, propValue as String

Business Service Events for Siebel VB

The following table describes a summary of business service events you can use with Siebel VB.

Table Summary of Business Service Events for Siebel VB

Method	Description	Format
Service_InvokeMethod Event	Siebel CRM calls this event after it calls the InvokeMethod method.	Service_InvokeMethod(methodName as String)
Service_PreCanInvokeMethod Event	Siebel CRM calls this event before it calls the PreInvokeMethod event. This configuration allows you to determine if the user possesses the authority to call the business service method.	Service_PreCanInvokeMethod(methodName as String, CanInvoke As String)
Service_PreInvokeMethod Event	Siebel CRM calls this event before it calls a specialized method on a business service.	Service_PreInvokeMethod(methodName as String, Inputs as PropertySet, Outputs as PropertySet)

Property Set Methods for Siebel VB

The following table describes a summary of the property set methods you can use with Siebel VB.

Table Summary of Property Set Methods for Siebel VB

Method	Description	Format
AddChild Method for a Property Set	Adds a child property set to a property set.	Dim oPropSet as PropertySet oPropSet.AddChild childObject as PropertySet
Copy Method for a Property Set	Returns a copy of a property set.	Dim oPropSet1 as PropertySet Dim oPropSet2 as PropertySet set oPropSet2 = oPropSet1.Copy
GetChild Method for a Property Set	Returns a child property set of a property set.	Dim oPropSet as PropertySet Dim childPropSet as SiebelPropertySet set childPropSet = oPropSet.GetChild(index as Long)
GetChildCount Method for a Property Set	Returns the number of child property sets that exist for a parent property set.	Dim oPropSet as PropertySet Dim iCount as Integer iCount = oPropSet.GetChildCount
GetFirstProperty Method for a Property Set	Returns the name of the first property in a property set.	Dim oPropSet as PropertySet Dim sPropName as String sPropName = oPropSet.GetFirstProperty
GetNextProperty Method for a Property Set	Returns the name of the next property in a property set.	Dim oPropSet as PropertySet Dim sPropName as String sPropName = oPropSet.GetNextProperty
GetProperty Method for a Property Set	Returns the value of a property.	Dim oPropSet as PropertySet Dim sPropVal as String sPropVal = oPropSet.GetProperty(propName as String)
GetPropertyCount Method for a Property Set	Returns the number of properties that exist in the current level in the hierarchy.	Dim oPropSet as PropertySet Dim count as Long count = oPropSet.GetPropertyCount
GetType Method for a Property Set	Returns the value of the type attribute of a property set.	Dim oPropSet as PropertySet Dim sTypeVal as String sTypeVal = oPropSet.GetType
GetValue Method for a Property Set	Returns the value stored in the value attribute of a property set.	Dim oPropSet as PropertySet Dim sValVal as String sValVal = oPropSet.GetValue
InsertChildAt Method for a Property Set	Inserts a child property set in a parent property set at a specific location.	Dim oPropSet as PropertySet oPropSet.InsertChildAt childObject as SiebelPropertySet, index as Integer
PropertyExists Method for a Property Set	Returns a Boolean value that indicates if the property that the argument identifies exists.	Dim oPropSet as PropertySet oPropSet.PropertyExists(propName as String)
RemoveChild Method for a Property Set	Removes a child property set from a parent property set.	Dim oPropSet as PropertySet oPropSet.RemoveChild index as Integer
RemoveProperty Method for a Property Set	Removes a property from a property set.	Dim oPropSet as PropertySet oPropSet.RemoveProperty propName as String
Reset Method for a Property Set	Removes every property and child property set from a property set.	Dim oPropSet as PropertySet oPropSet.Reset
SetProperty Method for a Property Set	Sets a value in the property of a property set.	Dim oPropSet as PropertySet oPropSet.SetProperty propName as String, propValue as String
SetType Method for a Property Set	Sets a data value for the type attribute of a property set.	Dim oPropSet as PropertySet oPropSet.SetType value as String
SetValue Method for a Property Set	Sets a data value for the value attribute of a property set.	Dim oPropSet as PropertySet oPropSet.SetValue value as String

Miscellaneous Methods for Siebel VB

The following table describes a summary of miscellaneous methods you can use with Siebel VB.

Table Summary of Miscellaneous Methods for Siebel VB

Method	Description	Format
TheApplication Method	Returns the name of an application object.	TheApplication