Siebel Portal Framework Guide > Delivering Content to External Web Applications > SWE API >

SWE Commands


Table 25 provides a list of commonly used SWE commands.

NOTE:  A subset of these SWE commands are available in Siebel Open UI. These commands are listed in Table 26.

Table 25. SWE Commands
Supported Values
Short Format
Description
Required Args (with Description)
Optional Args (with Description)

CanInvokeMethod

For a list of commonly used methods, see Table 27.

C

Checks whether a method can be invoked on an applet, a business service, a business component, or the SWE application.

Called only when the Object Manager is in high interactivity mode.

Use the optional SWEService, SWEBusComp, and SWEApplet arguments to specify the Siebel object on which the method is invoked. If none of these are specified, then SWE checks the CanInvokeMethod state of the method on the SWE application object, which currently supports a limited set of InvokeMethod, such as Logoff, SortOrder, SaveQuery, and SaveQueryAs.

SWEMethod - name of the method.

SWEService - name of the business service to check whether the method can be invoked.

SWEBusComp - name of the business component to check whether the method can be invoked.

SWEApplet - name of the applet to check whether the method can be invoked.

ExecuteLogin

Xlg

Executes login for a user.

SWEUserName - user name.

SWEPassword - password.

None

GotoPage

Gp

Goes to a Siebel Web page (this is the Web page object defined in Siebel Tools).

SWEPage - name of the Web page.

None

GotoPageTab

Gt

Goes to a Siebel screen. Shows the default view for the screen.

SWEScreen - name of the screen.

None

GotoView

Gv

Goes to a Siebel view.

If the SWEPostnApplet and SWEPostnRowId arguments are specified, then it executes a search for the specified row ID in the specified applet.

NOTE:  If the queried applet is part of a toggle cycle, then set SWEPostnApplet to the default (top) applet in the toggle cycle or the application displays an error, View: %1 does not contain applet: %2.
For more information about applet toggles, see Configuring Siebel Business Applications.

If SWEQMApplet and SWEQMMethod arguments are specified, then it invokes the method after going to the view.

SWEView - name of the view.

SWEKeepContext - if TRUE, keeps the current business object context, when requesting to a view based on the same business object.

SWEPostnApplet - name of the applet on which to execute the search.

SWEPostnRowId - row ID to search for.

SWEQMApplet - name of the QueueMethod applet where the method (as specified in SWEQMMethod) is invoked after going to the view.

SWEQMMethod - name of the QueueMethod method to be invoked. You can invoke only one method.

SWEQMArgs - arguments of the QueueMethod method.

InvokeMethod

For a list of commonly used methods, see Table 27.

Inv

Invokes a method on an applet, a business service, a business component, or the SWE application.

Use the optional SWEService, SWEBusComp, and SWEApplet arguments to specify the Siebel object on which the method is invoked. If none of these are specified, then SWE invokes on the SWE application object, which currently supports a limited set of InvokeMethod such as Logoff, SortOrder, SaveQuery, and SaveQueryAs.

SWEMethod - name of the method.

SWEService - name of the business service to invoke the method.

SWEBusComp - name of the business component to invoke the method.

SWEApplet - name of the applet to invoke the method.

SWEView - name of the view to invoke the method

LoadService

None

Loads a business service on the server side.

SWEService - name of the business service to load.

None

Login

Lg

Loads the login view or login page. SWE first looks at the Acknowledgment Web View property of the application object in the repository for the login view to show. If not specified, then the default is the "Acknowledgment Web Page" property to show the login page.

None

None

Logoff

Bye

Executes the database logoff, then shows the logoff view or page. SWE first looks at the Logoff Acknowledgment Web Page property of the application object in the repository for the login page to show. If none is specified, then SWE shows the login view or login page, depending on how you log in.

None

None

ReloadCT

None

Reloads personalization info. SWE loads the initial personalization on startup, and when the personalization rules are changed, SWE does not update the info automatically since there is cost in performance, so SWE provides this command to reload the info.

None

None

Siebel Portal Framework Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.