Bookshelf Home | Contents | Index | Search | PDF

Siebel Tools Reference > Configuring the Customer Dashboard > Using Siebel VB Script and eScript >

Customer Dashboard Commands

---

Since the customer dashboard is a business service, in your script you will need to use the GetService ("Persistent Customer Dashboard") command. Using the code behind a button you may either push information to the dashboard or pull information from the dashboard.

There are two commands to pull information from the dashboard including getting the record id for the current record populated in the dashboard or obtaining individual field values for fields populated in the dashboard. Details for these commands are described in the following sections.

GetCurrentContactId

This command returns the record ID for the current record populated in the dashboard. For example, if the record is from the Contact business component, then it returns the ContactId; if the record is from the Account business component, then it returns the AccountId.

No input argument should be specified.

The output argument is always "ContactId".

NOTE:  The "ContactId" is a variable used by the dashboard but this refers to the record ID for whichever business component is populated in the dashboard.

For example:

bs.InvokeMethod("GetCurrentContactId",inpargs,outargs); var fvalue = outargs.GetProperty("Contact Id");

GetDashboardFieldValue

This command returns the current field value for the record populated in the dashboard. The input argument is the name-value pair for the dashboard field. The output argument is "Field Value".

For example:

inpargs.SetProperty("Field Name","Field 4"); bs.InvokeMethod("GetDashboardFieldValue",inpargs,outargs); var fvalue = outargs.GetProperty("Field Value");

Update Dashboard

This command is used to populate the dashboard with a new record.

Source Name: Base View
Buscomp Name: Contact
RowId: E301

For example:

inpargs.SetProperty("Source Name","Base View", "Buscomp Name", "Contact", "RowId", "E301"); bs.InvokeMethod("Update Dashboard",inpargs,outargs);No output argument

NOTE:  In Siebel 7 version 7.0.3 and 7.0.4 there are two spaces between "Buscomp" and "Name" in the second parameter. In subsequent versions, there is one space.

Bookshelf Home | Contents | Index | Search | PDF