11Web Client Automation Server Quick Reference

Web Client Automation Server Quick Reference

This chapter describes summary information for the Web Client Automation Server. It includes the following topics:

• Siebel HTML Application Methods for the Web Client Automation Server

• Siebel Service Methods for the Web Client Automation Server

• Property Set Methods for the Web Client Automation Server

Siebel HTML Application Methods for the Web Client Automation Server

The following table describes a summary of Siebel HTML application methods you can use with the Web Client Automation Server. It does not include object interface methods that Siebel CRM does not call directly from an application instance. For information about methods that Siebel CRM calls with the InvokeMethod method on the application, see LoadObjects Method for an Application.

Table Summary of Siebel HTML Application Methods for the Web Client Automation Server

Method	Description	Format
GetLastErrCode Method for an Application	Returns the error code for the error that Siebel CRM logged most recently.	Dim siebelApp As SiebelHTMLApplication Dim iErr as Long iErr = siebelApp.GetLastErrCode
GetLastErrText Method for an Application	Returns the text message for the error that Siebel CRM logged most recently.	Dim siebelApp As SiebelHTMLApplication Dim sText as String sText = siebelApp.GetLastErrText
GetService Method for an Application	Locates a business service. If this business service is not already running, then Siebel CRM starts it.	Dim siebelApp As SiebelHTMLApplication Dim svc As SiebelService Set svc = siebelApp.GetService(ServiceName as String)
Name Method for an Application	Returns the name of the Siebel application.	Dim siebelApp As SiebelHTMLApplication Dim name as String name = siebelApp.Name
NewPropertySet Method for an Application	Creates a new property set.	Dim siebelApp As SiebelHTMLApplication Dim propSet as SiebelPropertySet Set propSet = siebelApp.NewPropertySet

Siebel Service Methods for the Web Client Automation Server

The following table describes a summary of Siebel service methods you can use with the Web Client Automation Server.

Table Summary of Siebel Service Methods for the Web Client Automation Server

Method	Description	Format
GetNextProperty Method for a Business Service	Returns the name of the next property of a business service.	Dim svc As SiebelService Dim iErr as Long iErr = svc.GetLastErrCode
InvokeMethod Method for a Business Service	Calls a method.	Dim svc As SiebelService svc.InvokeMethod(MethodName as String, inputPropSet as SiebelPropertySet, outputPropSet as SiebelPropertySet)
Name Method for a Business Service	Returns the name of a business service.	Dim svc As SiebelService Dim name as String name = svc.Name

Property Set Methods for the Web Client Automation Server

The following table describes a summary of the property set methods you can use with the Web Client Automation Server.

Table Summary of Property Set Methods for the Web Client Automation Server

Method	Description	Format
AddChild Method for a Property Set	Adds child property sets to a property set.	Dim oPropSet as SiebelPropertySet oPropSet.AddChild(childObject as SiebelPropertySet)
Copy Method for a Property Set	Returns a copy of a property set.	Dim oPropSet1 as SiebelPropertySet Dim oPropSet2 as SiebelPropertySet Set oPropSet2 = oPropSet1.Copy
GetChild Method for a Property Set	Returns a child property set of a property set.	Dim oPropSet as SiebelPropertySet Dim oChildPropSet as SiebelPropertySet Set oChildPropSet = 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 SiebelPropertySet Dim iCount as Long iCount = oPropSet.GetChildCount
GetFirstProperty Method for a Property Set	Returns the name of the first property in a property set.	Dim oPropSet as SiebelPropertySet Dim sPropName as String sPropName = oPropSet.GetFirstProperty
GetLastErrCode Method for a Property Set	Returns the error code for the error that Siebel CRM logged most recently.	Dim oPropSet as SiebelPropertySet Dim iErr as Long iErr = oPropSet.GetLastErrCode
GetLastErrText Method for a Property Set	Returns the text message for the error that Siebel CRM logged most recently.	Dim oPropSet as SiebelPropertySet Dim sText as String sText = oPropSet.GetLastErrText
GetNextProperty Method for a Property Set	Returns the name of the next property in a property set.	Dim oPropSet as SiebelPropertySet Dim sPropName as String sPropName = oPropSet.GetNextProperty
GetProperty Method for a Property Set	Returns the value of a property.	Dim oPropSet as SiebelPropertySet Dim sValue as String sValue = 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 SiebelPropertySet Dim iCount as Long iCount = oPropSet.GetPropertyCount
GetType Method for a Property Set	Returns the value of the type attribute of a property set.	Dim oPropSet as SiebelPropertySet Dim type as String type = oPropSet.GetType
GetValue Method for a Property Set	Returns the value of the value attribute of a property set.	Dim oPropSet as SiebelPropertySet Dim sValue as String sValue = 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 SiebelPropertySet oPropSet.InsertChildAt(childObject as SiebelPropertySet, index as Long)
PropertyExists Method for a Property Set	Returns a Boolean value that indicates if the property that the argument identifies exists.	Dim oPropSet as SiebelPropertySet Dim bool as Boolean bool = oPropSet.PropertyExists(propName as String)
RemoveChild Method for a Property Set	Removes a child property set from a parent property set.	Dim oPropSet as SiebelPropertySet oPropSet.RemoveChild(index as Long)
RemoveProperty Method for a Property Set	Removes a property from a property set.	Dim oPropSet as SiebelPropertySet 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 SiebelPropertySet oPropSet.Reset
SetProperty Method for a Property Set	Sets a value in the property of a property set.	Dim oPropSet as SiebelPropertySet oPropSet.SetProperty(propName as String, propValue as String)
SetType Method for a Property Set	Sets the value for the type attribute of a property set.	Dim oPropSet as SiebelPropertySet oPropSet.SetType(value as String)
SetValue Method for a Property Set	Sets the value for the value attribute of a property set.	Dim oPropSet as SiebelPropertySet oPropSet.SetValue(value as String)