For example:

var myControl = SiebelApp.S_App.GetAppletControlInstance (
"MyDropDown",
constants.get("SWE_CTRL_COMBOBOX"),
"I want this to appear on the screen",
"50",
"20");

GetConstructorFromKey Method

The GetConstructorFromKey method returns the constructor that Siebel Open UI registers in the client against the rendering key that it passes to the method. It returns this constructor in a string that Siebel Open UI resolves according to the name space. It uses the following syntax:

GetConstructorFromKey (key)

where:

• key is a string that contains the Name of the rendering key. For more information, see About the Rendering Key.

For example:

var myConstructor = SiebelApp.S_App.GetConstructorFromKey( "CarouselPModel" );
if (myConstructor){
// Say myConstructor is "SibelAppFacade.CarouselPM"
var facadeObj = window[myConstructor.split(".")[0]];
var constructorObj = facadeObj[myConstructor.split(".")[1]];
var carouselPMObject = new constructorObj(this);
...

You can use GetConstructorFromKey to create an instance of the constructor to meet your customization requirements

RegisterConstructorAgainstKey Method

The RegisterConstructorAgainstKey method registers a constructor string that Siebel Open UI resolves according to the name space that it uses against a rendering key. It uses the following syntax:

RegisterConstructorAgainstKey (key, constructor)

where:

• key is a string that identifies the name of the rendering key. For more information, see About the Rendering Key.
• constructor is a string that identifies the name of the constructor that Siebel Open UI uses when it encounters the key.

For example:

var CarouselConstructor = "SiebelAppFacade.CarouselPModel";
SiebelApp.S_App.RegisterConstructorAgainstKey( "CarouselPM", CarouselPMConstructor );

GetDirection Method

The GetDirection method returns one of the following values:

• RTL. Siebel Open UI is configured so the user reads text from right-to-left.
• Null. Siebel Open UI is not configured so the user reads text from right-to-left.

GetName Method

The GetName method returns the name of Siebel business application. For example, Siebel Call Center. It returns this value as a string. It uses the following syntax:

GetName()

It includes no parameters.

For example:

activeView.ExecuteFrame (activeApplet.GetName(), [{field: this.Get( "SearchField" ), value: this.Get( "SearchValue" )}])

GetPageURL Method

The GetPageURL method returns the URL that the Siebel business application uses. It returns this value without a query string. For example, it can return the following value:

http://computerName.corp.siebel.com/start.swe

It uses the following syntax:

GetPageURL()

The GetPageURL method includes no parameters.

For example:

finalurl = SiebelApp.S_App.GetPageURL() + strURL.split("start.swe")[1];

GetProfileAttr Method

The GetProfileAttr method returns the value of a user profile attribute.

GetProfileAttr (attributeName)

where:

• attributeName is a string that includes the name of an attribute.

SetProfileAttr Method

The SetProfileAttr method assigns a value to a user profile attribute.

SetProfileAttr (attributeName, attributeValue)

where:

• attributeName is a string that includes the name an attribute.
• attributeValue is a string that includes the value Siebel Open UI sets. If attributeValue is empty, then Siebel Open UI sets the attribute value to null.

GetService Method

The GetService method creates a business service proxy that calls a business service method. It creates an instance of a business service object that allows the interface to call a method on this business service.It returns the name of the business service object.

It uses use the following syntax:

SiebelApp.S_App.GetService( "name") );

where:

• name is a string that identifies the name of the business service that Siebel Open UI calls when it creates the proxy instance.

Example

Assume you must configure Siebel Open UI to call a business service from custom code that resides on the client, and that this code does not bind an applet control that resides in the repository to a business service. You can use the GetService method to instantiate the service proxy that Siebel Open UI uses to call any method on the business service.

Assume you must call the following business service:

Task UI Service (SWE)

The following code instantiates the proxy instance for this business service:

var service = SiebelApp.S_App.GetService( "Task UI Service (SWE)" ) );

You can configure Siebel Open UI to call any method on this business service after this instance is available. For example, the following code calls the GoToInbox method on the Task UI Service (SWE) business service:

if( service ){ outPS = service.InvokeMethod( "GoToInbox", inPS,true ); }

For more information about InvokeMethod, see Business Service Class and InvokeMethod Method.

RemoveService Method

The RemoveService method removes a service from the client. It uses the following syntax:

RemoveService (service)

where:

• service identifies the name of the service that Siebel Open UI removes.

For example, the following code removes the service that the GetService method references:

var service = SiebelApp.S_App.GetService( "Task UI Service (SWE)" ) );
// Use service
...
//Remove service
if (service){

If you use RemoveService to remove a service that does not exist, then Siebel Open UI might not behave as predicted.

GotoView Method

The GotoView method navigates the user to a view in the client. It uses the following syntax:

SiebelApp.S_App.GotoView(view, viewId, strURL, strTarget);

where:

• view is an object that contains the name of the view. Other parameters are optional.
• viewId is an object that contains the Id of the view.
• strURL is an object that contains an optional query string that Siebel Open UI passes as part of the GotoView method. This string must use the HTTP query string format that Siebel CRM requires. For example:

  "SWEParam1=valueForParam1&SWEParam2=valueForParam2"

• strTarget is an object that contains the string target.

For example, assume the view object contains a value of Account List View. The following code navigates the user to this view:

SiebelApp.S_App.GotoView(view, viewId, strURL, strTarget);

Siebel Open UI does the following work when it runs the GotoView method:

1. Changes the cursor state to busy.
2. Runs any required validation steps. if a validation fails in the client, then it returns false and exits the GotoView method. Implicit Commit is an example of a validaiton.
3. Adds additional default parameters.
4. Sends a request to the Siebel Server.
5. Navigates the user to the view that viewName specifies.

IsExtendedKeyBoard Method

The IsExtendedKeyBoard method returns one of the following values:

• true. Siebel Open UI is configured to use extended keyboard shortcuts.
• false. Siebel Open UI is not configured to use extended keyboard shortcuts.

It includes no parameters.

IsMobileApplication Method

The IsMobileApplication method determines if Mobile is enabled for the Siebel application that is currently running in the client. It returns a string that includes one of the following values:

• true. Mobile is enabled.
• false. Mobile is not enabled.

It uses the following syntax:

IsMobileApplication()

It includes no parameters.

For example, the following code determines if Mobile is enabled, and then does something if IsMobileApplication does not return a value of true:

if ( SiebelApp.S_App.IsMobileApplication() !== "true" )

InvokeMethod Method

The InvokeMethod method calls a method. It returns a value from the method that it calls. It uses the following syntax:

SiebelApp.S_App.InvokeMethod( "methodName", psObject, lp );

where:

• methodName identifies the name of the method that Siebel Open UI calls.
• psObject is an object that contains the property set object that Siebel Open UI passes to the method that InvokeMethod calls, if required.
• lp is an object that contains information about how to run AJAX.

The following example changes the next applet to become the active applet of the view:

SiebelApp.S_App.InvokeMethod( "NextApplet", psObject, lp );

LogOff Method

The LogOff method calls the Siebel Server and returns the Login page to the user.

LookupStringCache Method

The LookupStringCache method gets a string from the client string cache. It uses the following syntax:

LookupStringCache (index)

where:

• index is a number that identifies the location of a string in the client string cache.

For example:

// Assume appletControl to be the reference of an applet control.
var justification = appletControl.GetJustification(); //Returns text justification in index.
var stringJustification = SiebelApp.S_App.LookupStringCache (justification);
alert (justification); // Will alert "Left" or "Right"

NewProperty Set Method

The NewPropertySet method creates a new property set object. It returns the object reference for this new property set. It uses the following syntax:

NewPropertySet ()

It includes no parameters.

For example, the following code in the alarm.js file:

var returnPropSet = App ().NewPropertySet();

SetDiscardUserState Method

The SetDiscardUserState method sets a property in the client that instructs Siebel Open UI to not evaluate the state before it navigates to another view. It uses the following syntax:

SetDiscardUserState (bDiscard)

where :

• bDiscard contains one of the following Boolean values:
  • true. Ignore the state before doing navigation. Siebel Open UI applies this logic for all potential states, such as a commit is pending, Siebel Open UI is currently opening a dialog box, and so on. Siebel Open UI runs any GotoView call it receives. It loses the client state.
  • false. Do not ignore the state before doing navigation. Do the client validation.

For example:

// A business condition is met that requires Siebel Open UI to automatically navigate the user.
SiebelApp.S_App.DiscardUserState (true);
// Don't care about user state - we need the navigation to occur.
SiebelApp.S_App.GotoView ("MyView".. );
// Reset
SiebelApp.S_App.DiscardUserState (false);