Siebel Object Interfaces Reference > Siebel eScript Quick Reference > Object Interfaces Reference >

Application Methods for Siebel eScript


Table 128 describes a summary of application methods you can use with Siebel eScript. 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 128. Summary of Application Methods for Siebel eScript
Method
Description
Format

ActiveBusObject Method for an Application

Returns the name of the business object that the active view references.

var busObject;
busObject = TheApplication().ActiveBusObject();

ActiveViewName Method for an Application

Returns the name of the active view.

var sView;
sView = TheApplication().ActiveViewName();

CurrencyCode Method for an Application

Returns the currency code that is associated with the division of the user position.

var sCur;
sCur = TheApplication().CurrencyCode();

GetBusObject Method for an Application

Creates a new instance of a business object.

var myBusObject;
myBusObject = TheApplication().GetBusObject( BusObjectName);

Name Method for an Application

Returns the name of the Siebel application.

var name;
name = TheApplication().Name();

GetService Method for an Application

Locates a business service. If this business service is not already running, then Siebel CRM starts it.

var Service;
Service = TheApplication().GetService
(serviceName);

GetSharedGlobal Method for an Application

Returns the shared global variables.

var sName;
sName = TheApplication().GetSharedGlobal
(varName);

GotoView Method for an Application

Activates a view.

TheApplication().GotoView( viewName[, BusinessObject]);

InvokeMethod Method for an Application

Calls a method.

TheApplication().InvokeMethod( methodName, methodArg1, methodArg2,..., methodArgn);

LoginId Method for an Application

Returns the login ID of the user who started the Siebel application.

var sID;
sID = TheApplication().LoginId();

LoginName Method for an Application

Returns the login name of the user who started Oracle's Siebel application.

var sUser;
sUser = TheApplication().LoginName();

NewPropertySet Method for an Application

Creates a new property set.

var oPropSet;
oPropSet = TheApplication().NewPropertySet();

PositionId Method for an Application

Returns the position ID of the user position.

var sRow;
sRow = TheApplication().PositionId();

PositionName Method for an Application

Returns the name of the current user position.

var sPosition;
sPosition = TheApplication().PositionName();

RaiseError Method for an Application

Sends a scripting error message to the browser. To determine the error text, Siebel CRM uses a key to look up the current language.

var keyVal;
var arg1 ...;
TheApplication().RaiseError(keyVal, arg1, ...);

RaiseErrorText Method for an Application

Sends a scripting error message to the browser.

var message;
TheApplication().RaiseErrorText
(message);

SetPositionId Method for an Application

Sets the active position to a position ID.

var success;
success = TheApplication().SetPositionId
(posId);

SetPositionName Method for an Application

Sets the active position to a position name.

var success;
success = TheApplication().SetPositionName
(posName);

SetProfileAttr Method for an Application

Personalization uses this method to set a value for an attribute in a user profile.

TheApplication().SetProfileAttr
(name, value);

SetSharedGlobal Method for an Application

Sets a shared global variable.

TheApplication().SetSharedGlobal
(varName, value);

Trace Method for an Application

Appends a message to the trace file.

TheApplication().Trace(message);

TraceOff Method for an Application

Turns off tracing.

TheApplication().TraceOff();

TraceOn Method for an Application

Turns on tracing.

TheApplication().TraceOn(filename, type, selection);

Siebel Object Interfaces Reference Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.