1. Configuring Siebel Open UI Guide
  2. Configuring Siebel Open UI to Consume Siebel Portlets

Configuring Siebel Open UI to Consume Siebel Portlets

Siebel portlets can be integrated inside a portal application using iFrame or any other mechanism supported by the portal application. Siebel accepts both GET and POST requests.

To make a Siebel Server available as part of a portal, you can add the server URL to an iFrame that resides on the main Web page. In this sample code, the HTTP GET method is used:

<HTML>   
  <BODY>   
    <IFRAME src = "http://server_address/siebel/app/application/
lang?SWECmd=SWECmd=GotoView&IsPortlet =1&other_arguments"> </IFRAME>   
  </BODY>   
</HTML>

where:

  • server_address specifies the address of the Siebel Server.

  • application specifies the Siebel application.

  • SWECmd is a required argument that specifies how to display the Siebel application when the user accesses this URL.

  • isPortlet is a required argument that informs the Siebel Server that this application runs in a portlet. The server requires this argument so that it can do the processing it requires to support a portlet.

  • other_arguments specify how to display the Siebel application. For example, the login requirements to display, the applets to display, how to size applets, and so on.

For example, consider the following iFRAME src:

http://server_name.example.com/siebel/app/callcenter/enu? 
SWECmd=GetApplet&SWEApplet=Quote+List+Applet&IsPortlet 
=1&SWESM=Edit+List"style="height: 50%;width: 100%;&KeepAlive=1&PtId=my_theme"

The following table describes the parts of this iFRAME src that specifies the Siebel URL.

URL Argument Description

http://server_name.example.com

Access the Siebel Server that resides at server_name.example.com.

/callcenter/enu

Run the CallCenter application.

SWECmd=GetApplet

Provide commands to the Siebel Web Engine.

SWEApplet=Quote+List+Applet

Display the Quote List Applet.

IsPortlet =1

Run the CallCenter application as a portlet.

SWESM=Edit+List

Use the Edit List Mode

KeepAlive=1

Keep Siebel portlet sessions active even if the session is idle longer than SessionTimeout. Siebel CRM is predefined to expire a Siebel session that is not in use for a period of time according to the value that the SessionTimeout server parameter specifies. In the absence of this parameter, the session timing out will lead to Siebel Open UI displaying a login dialog box in the portlet. This behavior might not be desirable in a Siebel portlet. It is recommended that you set this argument to keep the session active.

For more information about the KeepAlive parameter, see Configuring the Portlet Session to Stay Alive.

&PtId=my_theme"

You can style a portlet application in such a way that the look and feel of the exposed application match that of the portal. The iFrame itself can be styled using a Cascading Style Sheet.

For more information, see Configuring the Use of Cascading Style Sheets Instead of iFrame Attributes.

In addition, the Siebel application can be styled according to a theme. A theme can be defined in the Siebel manifest, and the PtId argument can be used to reference the theme. The theme defined will be applied to the exposed application.

SWECmd=ExecuteLogin &SWEUserName=user_name

&SWEPassword=my_password

Provide user name and password authentication arguments. ExecuteLogin is allowed only through HTTP POST. Passing user IDs and password in an HTTP request is not recommended due to security reasons.

For more information, see About Siebel Portlet Authentication and Security Requirements.

Siebel Open UI supports HTTP POST and exposes the Siebel portlet for HTTP POST requests. The Siebel portal can send the following URL with the listed form fields:

http://server_name.example.com/siebel/app/callcenter/enu?
SWECmd=ExecuteLogin
SWEUserName=user_name
SWEPassword=my_password
SWEAC=SWECmd=GetApplet
SWEApplet=Quote+List+Applet
IsPortlet =1
KeepAlive=1
PtId=my_theme"