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

SWE Arguments


Table 16 lists some commonly used SWE arguments.

Table 16.  SWE Arguments
URL Argument
Short
Format
Description
Usage
Examples
SWECount
C
Dynamically generates an index number for each hyperlink for the purpose of bookmarking each request.
SWEC=n, where n is a positive integer number. <ARG NAME="SWEC">n</ARG>
SWEC=1, or <ARG NAME="SWEC">1</ARG>
SWEDataOnly
 
Discards all UI content (including anchors) if set to TRUE.
SWEDataOnly={TRUE | FALSE}<ARG NAME="SWEDataOnly">TRUE|FALSE</ARG>
SWEDataOnly=TRUE<ARG NAME="SWEDataOnly">TRUE</ARG>
SWEExclude
 
Uses the comma-separated UI element names specified as the value of the parameter to exclude UI elements from appearing in the output document.
SWEExclude="list of names". Names can be MENU, SCREENBAR, TOOLBAR, THREADBAR, PAGEITEM, VIEWBAR.<ARG NAME="SWEExcludet">list of names</ARG>
SWEExclude="MENU,SCREENBAR"<ARG NAME="SWEExclude"> MENU,SCREENBAR </ARG>
SWEField
F
Specifies the name of the applet field.
SWEField=<field name><ARG NAME="SWEField">field name</ARG>
SWEField=Revenue<ARG NAME="SWEField">Revenue</ARG>
SWEFullRefresh
 
Forces a full refresh of the Siebel Web Client. Used by the High Interactivity client to send a SWE command to load the High Interactivity client completely. Typically used for session interleaving from a non-Siebel session to the Siebel High Interactivity client application.
SWEFullRefresh={TRUE | FALSE}<ARG NAME="SWEFullRefresh">TRUE|FALSE</ARG>
SWEFullRefresh=TRUE<ARG NAME="SWEFullRefresh">TRUE</ARG>
SWEGetApplet
 
This parameter is used to filter the outbound XML document so only the applet named as the value of the parameter will be allowed in the output. All other document content will be discarded.
SWEGetApplet=<name of the applet><ARG NAME="SWEGetApplet">name of the applet</ARG>
SWEGetApplet=Account+List+Applet<ARG NAME="SWEGetApplet">Account List Applet</ARG>
SWEGetPDQ
 
Discards all XML content and returns only PDQ list when set to TRUE.
SWEGetPDQ={TRUE | FALSE}<ARG NAME="SWEGetPDQ">TRUE|FALSE</ARG>
 
SWEKeepContext
Kx
Keeps the current business object if going to a view that uses the same business object, if set to TRUE.
SWEKeepContext={TRUE | FALSE}<ARG NAME="SWEKeepContext">TRUE|FALSE</ARG>
SWEKeepContext=TRUE<ARG NAME="SWEKeepContext">TRUE</ARG>
SWENeedContext
Nct
Skips restoring the state of the view, applet, busobj, and buscomp when going back to a previously viewed page, if set to FALSE.
Default is TRUE for a view or applet and FALSE for a Web page.
SWENeedContext={TRUE | FALSE}<ARG NAME="SWENeedContext">TRUE|FALSE</ARG>
SWENeedContext=TRUE<ARG NAME="SWENeedContext">TRUE</ARG>
SWENoAnchor
 
Discards all anchors if set to TRUE.
SWENOAnchor={ TRUE | FALSE }<ARG NAME="SWENoAnchor">TRUE|FALSE</ARG>
SWENoAnchor=TRUE<ARG NAME="SWENoAnchor">TRUE</ARG>
SWEReloadFrames
RF
Forces the reloading of all HTML frames when set to TRUE.
SWERF={TRUE|FALSE}, or <ARG NAME="SWERF">TRUE | FALSE</ARG>
SWERF=TRUE, or <ARG NAME="SWERF">TRUE</ARG>
SWEReqRowId
Rqr
Needs to position to the row specified in the argument SWERowI, if set to TRUE.
SWEReqRowId={ TRUE | FALSE }<ARG NAME="SWEReqRowId">TRUE|FALSE</ARG>
SWEReqRowId=TRUE<ARG NAME="SWEReqRowId">TRUE</ARG>
SWERows
Rs
Specifies the number of rows to be used as an attribute of an HTML frameset.
SWERs=n, where n is a positive integer number. Or <ARG NAME="SWERs">n</ARG>
SWERs=1, or <ARG NAME="SWERs">1</ARG>
SWERowId
R
The rowId of the record to position to.
SWERowId=<rowid><ARG NAME="SWERowId">
rowid</ARG>
SWERowId=12-XI46FG<ARG NAME="SWERowId">12-XI46FG</ARG>
SWERowIds
Rs
A string specifying the rowId of the parent buscomps.
SWERowIds=<string of rowids><ARG NAME="SWERowId">
string of rowids</ARG>
SWERowIds=SWERowId0%3d12-61W25L<ARG NAME="SWERowId">SWERowId=12-61W25L</ARG>
SWESetMarkup
 
Temporarily sets the markup language to use in the output document.
SWESetMarkup=<name of the markup language><ARG NAME="SWESetMarkup">markup language</ARG>
SWESetMarkup=HTML<ARG NAME="SWESetMarkup">HTML</ARG>
SWESetNoTempl
 
Disables the use of templates during the generation of the outbound document.
SWESetNoTempl={TRUE | FALSE}<ARG NAME="SWESetNoTempl">TRUE|FALSE</ARG>
SWESetNoTempl=TRUE<ARG NAME="SWESetNoTempl">TRUE</ARG>
SWESetRowCnt
 
Temporarily sets the workset size or row number of list applets in the view.
SWESetRowCnt=<number of list rows><ARG NAME="SWESetRowCnt">number of list rows</ARG>
SWESetRowCnt=50<ARG NAME="SWESetRowCnt">number of list rows</ARG>
SWEXslStyleSheet
 
Specifies the name of the XSLT stylesheet to use to perform the XSLT on the XML output document.
SWEXslStyleSheet=<stylesheet name>. The stylesheet needs to be in the application's webtempl directory.<ARG NAME="SWEXslStyleSheet">name of the XSLT stylesheet</ARG>
SWEXslStyleSheet=ui.xsl<ARG NAME="SWEXslStyleSheet">ui.xsl</ARG>

 Siebel Portal Framework Guide
 Published: 09 September 2004