Using Siebel Tools > Using Siebel Script Editors > Using the ST eScript Engine >

Using Running Tool Tip

Running Tool Tip is a help feature in the Siebel Script Editor that you can use to write a script. If you enter a method name in the Running Tool Tip window, then it displays the method arguments that you can use with this method. If you enable Script Assist, then Siebel Tools enables Running Tool Tip, by default. For more information, see About Script Assist.

To use Running Tool Tip

1. Open the Siebel Script Editor.

   For more information, see Opening the Siebel Script Editor.

2. In the Script Editor window, enter a method name followed by an open parenthesis.

   Siebel Tools displays the Running Tool Tip window. This window displays the method name and the method arguments. It uses italicized text to suggest an argument. Siebel Tools hides this window after you enter all the required method arguments.

Figure 4 includes the Running Tool Tip window.

Figure 4. Running Tool Tip Window in the Siebel Script Editor

How Running Tool Tip Differs from Tool Tips in Script Assist

If you enter a function name followed by a left parenthesis in the Script Editor, then Script Assist or Running Tool Tip displays depending on the type of function you enter.

Running Tool Tip Window

If you enter a simple call expression, then Siebel Tools displays the Running Tool Tip window. A call expression allows you to send anything to the function according to the type of argument. For example, if you use the following code to enter a data object function, then Siebel CRM can send a value that you choose to this function:

Date.SetFullYear

For example, assume you enter the following code:

var oDate = new Date();
oDate.SetFullYear(

In this situation, Siebel Tools displays the following code in the Running Tool Tip window:

oDate.SetFullYear(year, month, date)

Script Assist Window

If you enter a collection function, then Siebel Tools displays the Script Assist window. This window includes a list of methods and properties that you can choose for an object. A collection function is a type of function that includes a finite set of values. You can send values to a collection function. For example, if you enter the following code, then Siebel Tools displays fields that are defined only for this business component:

BusComp.GetFieldValue

The following code is an example:

var bo = TheApplication().GetBusObject(

For more information about using functions and expressions in Siebel eScript, see Siebel eScript Language Reference.