Bookshelf Home | Contents | Index | Search | PDF

Siebel Object Interfaces Reference > Interfaces Reference > Business Component Methods >

ActivateField

---

ActivateField allows queries to retrieve data for the argument-specified field.

Syntax

BusComp.ActivateField(FieldName)

Argument	Description
FieldName	String variable or literal containing the name of the field to activate

Returns

Not applicable

Usage

FieldName must be enclosed in double quotes and must be spelled exactly as the field name appears in Siebel Tools, using the same case. You must activate fields using ActivateField prior to executing a query for the business component.

NOTE:  If you are writing an event handler on a business component, you must make sure that the field has already been activated by specifying the ForceActive user property on the control.

By default, fields are inactive except when:

They are displayed on the applet and the business component is the instance on which the applet is based.
They are System fields (which include Id, Created, Created By, Updated, and Updated By).
Their ForceActive property is set to TRUE.
The method ActivateField has been invoked with the FieldName.
They have the Link Specification property set to TRUE.

After a business component has been executed, if additional fields are activated, the business component must be requeried before field values can be accessed. Failure to requery the business component results in a value of 0 being returned. The ActivateField method destroys the context of a query when it is used after the ExecuteQuery method.

Used With

Server Script, Mobile/Dedicated Web Client Automation Server, COM Data Control, COM Data Server, Java Data Bean, CORBA Object Manager

Example

Here is a Siebel VB example. For an equivalent Siebel eScript example, read ClearToQuery.

Dim oEmpBusComp As BusComp
Dim sLoginName As String

Set oEmpBusObj = TheApplication.ActiveBusObject
Set oEmpBusComp = TheApplication.ActiveBusComp

oEmpBusComp.ActivateField("Login Name")
oEmpBusComp.SetViewMode AllView
oEmpBusComp.ClearToQuery
oEmpBusComp.SetSearchSpec "Login Name", sLoginName
oEmpBusComp.ExecuteQuery

Set oEmpBusComp = Nothing

See Also

DeactivateFields

Bookshelf Home | Contents | Index | Search | PDF