Bookshelf v7.5: Application

Table 80. Application Methods Syntax Summary
Method	Description	Syntax
ActiveBusObject	Returns the business object for the business component for the active applet.	var busObject; busObject = TheApplication().ActiveBusObject();
ActiveViewName	Returns the name of the active view.	var sView; sView = TheApplication().ActiveViewName();
CurrencyCode	Returns the three-letter operating currency code.	var sCur; sCur = TheApplication().CurrencyCode();
GetBusObject	Instantiates and returns a new instance of the business object specified in the argument.	var myBusObject; myBusObject = TheApplication().GetBusObject(BusObject);
Name	Returns the value of an attribute in a user profile.	var sAttr; sAttr = TheApplication().GetProfileAttr(name);
GetService	Instantiates and returns a new instance of the service specified in the argument.	var Service; Service = TheApplication().GetService(serviceName);
GetSharedGlobal	Gets the shared user-defined global variables.	var sName; sName = TheApplication().GetSharedGlobal(varName);
GotoView	Activates the named view and its business object.	TheApplication().GotoView(viewName,[ BusinessObjectName]);
InvokeMethod	Calls the named specialized method.	var sReturn; sReturn = TheApplication().InvokeMethod(methodName, methodArg1, methodArg2,..., methodArgn);
LoginId	Returns the login ID of the user who started the Siebel application.	var sID; sID = TheApplication().LoginId();
LoginName	Returns the login name of the user who started the Siebel application.	var sUser; sUser = TheApplication().LoginName();
NewPropertySet	Constructs and returns a new property set object.	var oPropSet; oPropSet = TheApplication().NewPropertySet();
PositionId	Returns the position ID that describes the user's current position.	var sRow; sRow = TheApplication().PositionId();
PositionName	Returns the position name of the user's current position.	var sPosition; sPosition = TheApplication().PositionName();
RaiseError	Raises a scripting error message to the browser. The error code is a canonical number.	var keyVal; var param1; TheApplication().RaiseError(keyVal, param1, ...)
RaiseErrorText	Raises a scripting error message to the browser. The error text is the specified literal string.	var message; TheApplication().RaiseErrorText(message);
SetPositionId	Sets the active position to the position ID specified in the argument.	TheApplication().SetPositionId(posId);
SetPositionName	Sets the active position to the position name specified in the argument. Returns a Boolean value indicating whether or not method succeeded.	TheApplication().SetPositionName(posName);
SetProfileAttr	Used in personalization to assign values to attributes in a user profile.	TheApplication().SetProfileAttr(name, value);
SetSharedGlobal	Sets a shared user-defined global variable.	TheApplication().SetSharedGlobal(varName, value);
Trace	Appends a message to the trace file.	TheApplication().Trace(message);
TraceOff	Turns off the tracing started by TraceOn.	TheApplication().TraceOff();
TraceOn	Turns tracing on.	TheApplication().TraceOn(filename, type, selection);

Table 81. Application Events Syntax Summary
Event	Description	Syntax
Application_Close	Called before the application exits.	Application_Close();
Application_InvokeMethod	Called after a specialized method is invoked.	Application_InvokeMethod(methodName);
Application_Navigate	Called after the client has navigated to a view.	Application_Navigate()
Application_PreInvokeMethod	Called before a specialized method is invoked.	Application_PreInvokeMethod(methodName);
Application_PreNavigate	Called before the client has navigated from one view to the next.	Application_PreNavigate (DestViewName, DestBusObjName)
Application_Start	Called when the client starts.	Application_Start(commandLine);