Bookshelf Home | Contents | Index | PDF     

Siebel SmartScript Administration Guide > Extending Scripts with Siebel VB and Siebel eScript > Other Preprogrammed SmartScript Methods >

GetParameter

GetParameter retrieves a value that has been assigned to a specified user parameter, a CTI switch parameter or a system parameter.

Syntax

GetParameter(ParameterName)

Argument
Description

ParameterName

The name of a system parameter, as a string
Returns

The value of the specified parameter, as a string.

Usage

GetParameter can be used to retrieve a value assigned to a user parameter. The parameter name in this case must be prefixed with User. Usually a value is stored by using the SetUserParameter function.

GetParameter can be used to retrieve the current setting of a Siebel CTI switch parameter. The parameter name in this case must be prefixed with CTI. CTI switch parameters are set when SmartScript is invoked through Siebel Communications Server. For more information, see Siebel Communications Server Administration Guide.

This parameter can be used to retrieve the value of a system parameter. Table 10 lists the system parameters.

Table 10. System Parameters
System Parameter Name
Usage Definition

CampaignId

Set when SmartScript is invoked through Siebel Communications Server.

CampConId

Set when SmartScript is invoked through Siebel Communications Server.

ContactId

Set when SmartScript is invoked through Siebel Communications Server.

ScriptId

Script row ID.

ScriptName

Script name.

ScriptLabel

Script's translation (label).

Language Code/Language

Language in which the script is running.

Currency Code/Currency

Default currency.

System.RecordFound

Set to TRUE if there are records returned from the search spec defined on the question; set to FALSE otherwise.
Siebel VB Example

Dim ContactId as String
ContactId = GetParameter("ContactId")
SetUserParameter "ContactId", ContactId

GetParameter("CTI.ANI")

See Also

SetUserParameter.

    
Siebel SmartScript Administration Guide