SAP Widget Foundation User's Guide

User's Guide
SAP Widgets
Enterprise Foundation
Copyright 2007 SAP AG. All rights reserved
Page 1 of 18
User's Guide
SAP Widget Foundation
Table of Contents
SAP Widget Foundation ........................................................................................................................ 4
What Is SAP Widget Foundation? ........................................................................................................ 4
System Requirements .......................................................................................................................... 4
Installing SAP Widget Foundation ........................................................................................................ 4
Installing SAP Widget Foundation as a Standalone Application........................................................... 5
Starting SAP Widget Foundation .......................................................................................................... 6
Configuring SAP Widget Foundation .................................................................................................... 7
Adding and Configuring an Identity....................................................................................................... 7
Adding an Identity............................................................................................................................................... 8
Configuring an Identity ....................................................................................................................................... 8
Adding and Configuring Service Providers ........................................................................................... 9

Adding a Service Provider Instance ................................................................................................................... 9
Configuring a Service Provider Instance.......................................................................................................... 10
Changing SAP JCO Service Provider Single Sign-On Authentication Type.................................................... 12
Service Agents.................................................................................................................................... 12
Importing SAP Widget Foundation Configuration Parameters ........................................................... 13
Exporting SAP Widget Foundation Configuration Parameters ........................................................... 13
Uninstalling SAP Widget Foundation.................................................................................................. 13
Uninstalling SAP Widget Foundation as a Standalone Application .................................................... 14
Troubleshooting ................................................................................................................................... 15
Appendix ............................................................................................................................................... 17
Configuration Status Indicators........................................................................................................... 17
SAP Widget Foundation Menu Items.................................................................................................. 17
Disclaimer ............................................................................................................................................. 18
2008 SAP AG. All rights reserved
Page 2 of 18
User's Guide
History of revisions
Revision
date
Version
Description
Jan 18,
0.11.x
The Adding and Configuring an Identity section is added. Small updates in Adding
and Configuring Service Providers section.
0.11.1038
Updating the Installing SAP Widget Foundation as a Standalone Application and

Troubleshooting sections.
0.12.1142
Updating System Requirements section. Minor document changes.
2008
Jan 22,
2008
Mar 11,
2008
Page 3 of 18
User's Guide

This section introduces the SAP Widget Foundation and describes how to install and configure it.
The following topics are included in this section:
What Is SAP Widget Foundation?

System Requirements
Installing SAP Widget Foundation
Installing SAP Widget Foundation as a Standalone Application
Starting SAP Widget Foundation
Configuring SAP Widget Foundation
Adding and Configuring Service Providers
Uninstalling SAP Widget Foundation
What Is SAP Widget Foundation?

SAP Widget Foundation is an application that provides Representational State Transfer (REST)
XML and JSON interfaces to the SAP system and allows creating mashups using SAP and non-SAP
services. A mashup is a service that combines content from various back end systems. SAP
Widget Foundation connects to SAP using SAP Java Connector and Web services and supports
single sign-on (SSO) using SECUDE PSE Management software, Kerberos, or user password
authentication.
For more information on REST, see http://en.wikipedia.org/wiki/REST, and for Web services, see
http://en.wikipedia.org/wiki/Web_service.
System Requirements
The following software is required for using SAP Widget Foundation:
Windows XP/Vista
Java 1.6 or higher
SECUDE PSE Management
SECUDE PSE Management must be installed if SECUDE SSO authentication is used.
Yahoo! Widget Engine 4.5.1 or higher
Yahoo! Widget Engine 4.5.1 or higher must be installed if Yahoo! widgets are used.
Installing SAP Widget Foundation

SAP Widget Foundation is installed using Java Web Start. Java Web Start is a framework that
allows starting application software for the Java Platform directly from the Internet using a web
browser. For more information on Java Web Start, see http://en.wikipedia.org/wiki/Java_web_start.
To install SAP Widget Foundation, proceed as follows:
Page 4 of 18
User's Guide
1. In a web browser, enter the following URL that is available only in SAP internal network:
http://nvpal168.pal.sap.corp:1080/wfws/foundationWS.jnlp
The Warning Security window appears.
Figure 1: Running SAP Widget Foundation

2. Select Always trust content from this publisher.
3. Click Run.
The
icon appears in the system tray indicating that the SAP Widget Foundation is installed.
For more information on configuration status indicators, see Configuration Status Indicators. For
more information on the SAP Widget Foundation menu items, see SAP Widget Foundation Menu
Items.
Installing SAP Widget Foundation as a Standalone

Application
Automatic SAP Widget Foundation update and the Gallery_D service provider are not supported in
the standalone SAP Widget Foundation version.
To install SAP Widget Foundation as a standalone application, proceed as follows:
1. Run the SAPWidgetFoundation.jar file.
The Install SAP Widget Foundation window appears.
Page 5 of 18
User's Guide
Figure 2: Initializing SAP Widget Foundation installation
If *.jar files are not associated with Java and the window does not appear, type the following
string in the command line:
java -jar <path_to_SAPWidgetFoundation.jar>
2. Click Next and select the I agree with license check box.
3. Click Next and do one of the following:
To use the default installation folder, review the default location and click Next.
To specify an installation folder, select the installation destination folder for SAP Widget
Foundation using the Browse button and click Next.
4. Click Finish.
The Installation result window appears:
Figure 3: SAP Widget Foundation installation confirmation

5. Click OK.
SAP Widget Foundation is installed and can be started as described in Starting SAP Widget
Foundation.
Starting SAP Widget Foundation

After installation, SAP Widget Foundation is launched automatically on widgets startup. For
manually starting SAP Widget Foundation, Start > Programs > SAP Widget Foundation > SAP
Widget Foundation must be selected.
Page 6 of 18
User's Guide
Configuring SAP Widget Foundation

To configure the SAP Widget Foundation, proceed as follows:
1. In the system tray, right click the
icon and select Configuration.
The SAP Widget Enterprise Foundation Configuration appears.
Figure 4: Viewing the SAP Widget Enterprise Foundation Configuration
The Version information section displays versions of installed software and allows updating or
installing missing components
2. To check for widget updates, in the General settings section, click Check for Updates Now.
3. To enable launching SAP Widget Foundation on computer startup, in the General settings
section, select the Launch SAP Widget Foundation on Startup check box.
4. To save the changes to the configuration, click Save.
Adding and Configuring an Identity

The My SAP Identity is the preconfigured default identity of the RFC service. By default, My SAP
Identity uses SECUDE SSO for authentication. The Widget GALLERY Identity is the preconfigured
default identity used for accessing the widget gallery.
Page 7 of 18
User's Guide
Adding an Identity
To add and configure an identity, proceed as follows:
1. Click Create new identity.
2. In the Enter unique instance name field, enter the identity name and click OK.
The identity is created.
Configuring an Identity
The following table describes available identity authentication types:
SAP Widget Foundation identity types authentication types
Identity authentication
type
Description
User Name and Password
Used for username and password authentication.
Secude Single Sign-On
Default configuration for Single Sign-On to systems inside the SAP internal
network. Uses C:\Program Files\SECUDE\SECUDE for R3\secude.dll as a
path to the secude.dll file and partner name. The partner name notation is as
follows:
p:CN=<System ID>, O=SAP-AG, C=DE, where <System ID> is SAP system ID. If
the secude.dll file location differs from C:\Program Files\SECUDE\SECUDE for
R3\secude.dll or has a different partner name, Generic Security Services
Application Program Interface (GSS-API) Sign On identity type must be used.
Kerberos Single Sign-On
Single Sign-On option used for authentication to SAP system with Kerberos.
GSS-API Enabled SignOn
Universal GSS with enabled Single Sign-On option with option to select a *.dll
file implementing GSS and specifying a partner name.
To configure an identity, proceed as follows:

1. Click the appropriate identity.
2. Configure identities of the User Name and Password type as described in the following table:
SAP Widget Foundation User Name and Password type identity properties
Property
Description
Managed Instance
If selected, the instance properties are taken from SAP Widget Gallery on every
SAP Widget Foundation start up.
Username
SAP system user name.
Password
SAP system user password.
Name
Identity name defined when creating the identity.
Label
Identity label.
Description
Identity description.
3. Configure identities of the Secude Single Sign-On type as described in the following table:
Page 8 of 18
User's Guide
SAP Widget Foundation Single Sign-On type identity properties

Property
Description
Managed Instance
Name
Label
Identity label.
Description
4. Configure identities of the Kerberos Single Sign-On type as described in the following table:
SAP Widget Foundation Kerberos Single Sign-On type identity properties
Property
Description
Managed Instance
Partner name
Partner name displayed when a SAP user logs in SAP GUI, under Systems >
Change Item, in the SNC Name field. Alternatively, the partner name can be
presented in the following format:
P:<KerberosID>@<Domain>
Name
Label
Identity label.
Description
5. Configure identities of the GSS-API Enabled Sign-On type as described in the following table:
SAP Widget Foundation GSS-API Enabled Sign-On type identity properties
Property
Description
Managed Instance
Partner name
Partner name displayed when a SAP user logs in SAP GUI, under Systems >
Change Item, in the SNC Name field. Alternatively, the partner name can be
presented in the following format:
P:<KerberosID>@<Domain>
GSS-API library path
Path of the *.dll file path implementing GSS-API.
Name
Label
Identity label.
Description
6. Click Save.
Adding and Configuring Service Providers

This section describes how to add a Service Provider instance and configure it.
Adding a Service Provider Instance

To add a Service Provider instance, proceed as follows:
Page 9 of 18
User's Guide
1. In the Manage Service Providers Types node, select the appropriate Service Provider
instance type and click Create Instance.

The following table describes SAP Widget Foundation service provider types:
SAP Widget Foundation service provider types
Service provider
Description
GALLERY_D
Provides connection to the widget gallery.
JCO
Provides SAP RFC access using SAP Java Connector (SAP JCO).
WS_SERVICES
Provides SAP RFC access using Web services.
2. In the Enter unique instance name field, enter the instance name and click OK.
The Service Provider instance is created.
Configuring a Service Provider Instance

To configure a Service Provider instance, proceed as follows:
1. Click the appropriate Service Provider instance.
2. Configure the JCO type Service Provider instances as described in the following table:
JCO Service Provider instance properties
Property
Description
Service Provider ID
Service Provider type ID.
Instance Name
Service Provider instance name defined when creating the instance.
Instance Label
Service Provider instance label defined when creating the instance.
Instance Description
Service Provider instance description defined when creating the instance.
Managed Instance
Check Status
Option for verifying SAP JCO connection to SAP by testing calling the
ME_GET_CURRENT_USER_ID function. If the function call succeeds, the Connection
test succeed message is displayed.

Client
Client number displayed when a SAP user logs in SAP GUI, under System >
Status > Client.
Language
Language displayed when a SAP user logs in SAP GUI, under System > Status >
Language.
Page 10 of 18
User's Guide
JCO Service Provider instance properties

Property
Description
Use message server
Indicates whether SAP message server must be used for connection. If the value
is set to Yes, the following properties must be defined:
Property
Description
Message server
SAP message server host name.
Server group
SAP server group name. This field is case

sensitive.
System ID
SAP system ID.
If the value is set to No, the following properties must be defined:

Property
Description
AS host
SAP application server host displayed under

Systems > Change Item > Application
Server in SAP logon used to store connection
information.
System number
SAP system number, SAP system instance ID,

displayed under Systems > Change Item >
System Number in the SAP logon application
used to store connection information
System ID
SAP system ID.
Identity instance
Identity of a JCO type Service Provider.
SAP JCO provider supports all authentication types, but does not support using multiple SSO
authentication types at the same time. For more information on authentication types, see
Configuring an Identity.
3. Configure GALLERY_D type Service Provider instances as described in the following table:
GALLERY_D type Service Provider instance properties
Property
Description
Service Provider ID
Service Provider type ID.
Instance Name
Instance Label
Instance
Description
Managed Instance
If selected, the instance properties are taken from SAP Widget Gallery on every SAP
Widget Foundation start up.
Check Status
Option for verifying if SAP Widget Gallery is available.
Download widget
WEB service
Gallery web service description URL.
4. Configure WS_SERVICES type Service Provider instances as described in the following table:
Page 11 of 18
User's Guide
WS_SERVICES type Service Provider instance properties

Property
Description
Service Provider ID
Service Provider instance type ID.
Instance Name
Instance Label
Instance Description
Managed Instance
If selected, the instance properties are taken from SAP Widget Gallery on
every SAP Widget Foundation start up.
Check status
Option for verifying SAP Web Service Provider connection to SAP by testing
by calling the ME_GET_CURRENT_USER_ID function. If the function call
succeeds, the Connection test succeed message is displayed.
Note:
SAP Web Services Provider uses universal BAPI SOAP service on

<host>:<port>/sap/bc/soap/rfc to verify the connection.
Connection protocol
Connection protocol HTTP or HTTPS for secure connection.
Web service host
Host of Web Application Server.
Web service port
Port of Web Application Server.
Language
Language displayed when a SAP user logs in SAP GUI, under System >
Status > Language.
Client
Client number displayed when a SAP user logs in SAP GUI, under System
> Status > Client.
Identity instance
Identity of a service provider of the WS_SERVICES type.
Web services support all authentication types, except Kerberos Single Sign-On.
Note: In cases with advanced GSS-API, the service provider works if the GSS-API is of the Secude
Single Sign-On type, which is the secude.dll file.
5. Click Save.
Changing SAP JCO Service Provider Single Sign-On

Authentication Type
To change SAP JCO Service Provider Single Sign-On authentication type, proceed as follows:
1. For all SAP JCO Service Providers, use identity instances with the same Single Sign-On
authentication type.
2. Save the changes.
3. Restart SAP Widget Foundation.
The SAP JCO Service Provider authentication type is changed.
Service Agents
A Service is a Java or XQuery language program that handles HTTP requests from widgets,
executes business logic, and produces results in XML or JSON formats. The JavaScript Object
Notation (JSON) format is a lightweight computer data interchange format. For more information on
Page 12 of 18
User's Guide
format, see http://en.wikipedia.org/wiki/JSON. A Service Agent is a ZIP file with packed

Services that can be deployed within SAP Widget Foundation.
JSON
Most widgets are using the SAP RFC Service Agent that allows calling any RFC function in a SAP
system or using SAP JCO or web services.
Importing SAP Widget Foundation Configuration

Parameters
To import SAP Widget Foundation configuration parameters, proceed as follows:
1. Under the Advanced Settings node, in the Configuration section, click Browse.
2. Select the appropriate configuration file and click Open.
3. Click Load.
The configuration is imported.
Exporting SAP Widget Foundation Configuration

Parameters
To import SAP Widget Foundation configuration parameters, proceed as follows:
1. Under the Advanced Settings node, in the Configuration section, click Export.
The File Download Security Warning window appears.

2. Click Save and select the appropriate location.
3. Click Save.
The configuration is exported.
Uninstalling SAP Widget Foundation

To uninstall SAP Widget Foundation, proceed as follows:
1. Select Start > Settings > Control Panel.
The Control Panel window appears.

2. In the Control Panel window, double click the Add or Remove Programs node.
The Add or Remove Programs window appears.

3. In the Add or Remove Programs window, select SAP Widget Foundation and click Remove.
4. Click Finish.
5. In the C:\Documents and Settings\<username>\SAPFoundation folder, delete all files except the
configuration_v2.obj
file, which contains SAP Widget Foundation configuration settings.
Page 13 of 18
User's Guide
Uninstalling SAP Widget Foundation as a Standalone

Application
To uninstall standalone SAP Widget Foundation, proceed as follows:
1. Delete folder where SAP Widget Foundation was installed
2. Delete shortcut folder Start > Programs > SAP Widget Foundation
Page 14 of 18
User's Guide
Troubleshooting
Troubleshooting
The following table contains troubleshooting information for SAP Widget Foundation:
SAP Widget Foundation troubleshooting information
Problem
Resolution
Cannot launch the
To resolve this problem, verify Java 6 is installed. If not, download

and install Java 6 from http://java.com.
SAPWidgetFoundation.jar file
SAP JCO connection test is not

passed.
To resolve this problem, proceed as follows:

1. Verify whether the ME_GET_CURRENT_USER_ID function is
available and enabled on SAP system that SAP Widget
Foundation uses
2. If available, execute the ME_GET_CURRENT_USER_ID function using
SAP Widget Foundation using the following URL
http://localhost:7531/SapMiddleTier/REST/ewcs/service/rfct/form.
3. In the RFC Name field, enter ME_GET_CURRENT_USER_ID.
4. In the Service provider list box, select a service provider
instance for verification.
5. Click Query RFC.
SAP WS_SERVICES connection

test is not passed.
To resolve this problem, verify whether the ME_GET_CURRENT_USER_ID

function is available on the SAP server by opening the following URL:
http://<host_name>:<port_number>/sap/bc/soap/wsdl11?services=M
E_GET_CURRENT_USER_ID&sap-client=<client_number>
Problem occurs when using a widget
If a problem occurs when using a widget, do the following:

1. Press Ctrl+Shift and right click the Yahoo! Widget Engine icon in
the system tray.
2. Select Debug Mode.
3. Restart the widget.
4. Perform the operation that caused the error.
5. Copy the Konfabulator window content and send to
Widgetsupport@sap.com.
Gallery service connection test fails.

1. Verify whether the URL value in the Gallery Service Provider
configuration, in the Download widget WEB service field is
accessible in the Internet browser.
2. If the URL is not available, check the browser proxy settings.
During the start up, SAP Widget

Foundation displays the following
message: Cannot load resources.

1. Verify whether the SAP Widget Foundation JNLP file is available
at the following location:
http://nvpal168.pal.sap.corp:1080/wfws/foundationWS.jnlp.
2. If available, select Start > Settings > Control Panel > Java.
The Java Control Panel window appears.
3. Click Network Settings and configure the proxy server settings
as required.
Problems with widget or SAP Widget

Foundation
Send the log file C:\Documents and

Settings\<username>\SapFoundation\ applicationserver.log
to Widgetsupport@sap.com.
Page 15 of 18
User's Guide
Troubleshooting
SAP Widget Foundation troubleshooting information

Problem
Resolution
Using SAP Web Services Service

provider SAP Widget Foundation
returns the following message:
Function cannot be found.
Search for the RFC functions through the web service browser, use
the following URL:
http://<host_name>:<port_number>/sap/bc/bsp/sap/WebServiceBrow
ser/search.html?sap-client=<client_number>
If not available, enable function RFC access.
When connecting to SAP system

using message server and status
check displays the following
message:
Verify the sapms<system_id> <port_number>/tcp entry exisists in

the C:\windows\system32\drivers\etc\services file. If not, copy
the file from the conventionally configured SAP computer.
Cannot resolve user name:

Reason: Cannot connect to SAP
host. Hostname may be incorrect.
*.jar files are associated with
another program, not with Java.
Start the SAP Widget Foundation installation from the command line
using the following string:
java -jar <path_to_SAPWidgetFoundation.jar>
To resolve other issues related to SAP Widget Foundation, SAP widgets, SAP Widget Development
Kit, or SAP Widget Development Tools, contact widgetsupport@sap.com.
Page 16 of 18
User's Guide
Appendix
Appendix
This section describes SAP Widget Foundation menu properties and the status indicators. The
following topics are included:
Configuration Status Indicators

SAP Widget Foundation Menu Items
Configuration Status Indicators

Configuration status icons indicate the connection status for SAP Widget Foundation and Service
Providers.
The following table describes the configuration status indicators:
Configuration status indicators
Indicator
Description
Indicates none of the Service Providers instances are connected.
Indicates at least one Service Providers instance is connected to the back end application and
at least one instance is not connected.
Indicates that all Service Provider instances are connected to the back end applications.
SAP Widget Foundation Menu Items

To open SAP Widget Foundation menu, right click the SAP Widget Foundation icon in the system
tray. The following table describes SAP Widget Foundation menu items:
SAP Widget Foundation menu items
Menu item
Description
Configuration
Opens SAP Widget Foundation configuration web page. For more information on how to
configure SAP Widget Foundation, see Configuring SAP Widget Foundation.
About SAP Widget

Foundation
Opens the SAP Widget Foundation About window with copyright, build, and release
information.
Quit
Quits the SAP Widget Foundation.
Page 17 of 18
User's Guide
Disclaimer
Disclaimer
Release 0.12.0, build 1142, last revision date 2008-03-11.
THE SERVICE AND THE MATERIALS ARE PROVIDED BY SAP ON AN "AS IS" BASIS, AND SAP
EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE, WITH RESPECT TO THE SERVICE OR ANY MATERIALS AND
PRODUCTS. IN NO EVENT SHALL SAP BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES OF ANY KIND WHATSOEVER WITH
RESPECT TO THE SERVICE, THE MATERIALS, AND THE PRODUCTS.
Page 18 of 18

SAP Widget Foundation User&#39;s Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SAP Widget Foundation User&#39;s Guide

Uploaded by

Copyright:

Available Formats

User's Guide

Copyright 2007 SAP AG. All rights reserved

SAP Widget Foundation

Adding and Configuring Service Providers ........................................................................................... 9

2008 SAP AG. All rights reserved

SAP Widget Foundation

Updating the Installing SAP Widget Foundation as a Standalone Application and

Updating System Requirements section. Minor document changes.

2008 SAP AG. All rights reserved

SAP Widget Foundation

SAP Widget Foundation

What Is SAP Widget Foundation?

What Is SAP Widget Foundation?

Installing SAP Widget Foundation

2008 SAP AG. All rights reserved

SAP Widget Foundation

The Warning Security window appears.

Figure 1: Running SAP Widget Foundation

Installing SAP Widget Foundation as a Standalone

The Install SAP Widget Foundation window appears.

2008 SAP AG. All rights reserved

SAP Widget Foundation

Figure 2: Initializing SAP Widget Foundation installation

Figure 3: SAP Widget Foundation installation confirmation

Starting SAP Widget Foundation

2008 SAP AG. All rights reserved

SAP Widget Foundation

Configuring SAP Widget Foundation

icon and select Configuration.

The SAP Widget Enterprise Foundation Configuration appears.

Figure 4: Viewing the SAP Widget Enterprise Foundation Configuration

Adding and Configuring an Identity

2008 SAP AG. All rights reserved

SAP Widget Foundation

The identity is created.

User Name and Password

Used for username and password authentication.

Secude Single Sign-On

Kerberos Single Sign-On

GSS-API Enabled SignOn

To configure an identity, proceed as follows:

SAP system user name.

SAP system user password.

Identity name defined when creating the identity.

2008 SAP AG. All rights reserved

SAP Widget Foundation

SAP Widget Foundation Single Sign-On type identity properties

Identity name defined when creating the identity.

Identity name defined when creating the identity.

GSS-API library path

Path of the *.dll file path implementing GSS-API.

Identity name defined when creating the identity.

Adding and Configuring Service Providers

Adding a Service Provider Instance

2008 SAP AG. All rights reserved

SAP Widget Foundation

instance type and click Create Instance.

Provides connection to the widget gallery.

Provides SAP RFC access using Web services.

The Service Provider instance is created.

Configuring a Service Provider Instance

Service Provider type ID.

Service Provider instance name defined when creating the instance.

Service Provider instance label defined when creating the instance.

SAP Widget Foundation User's Guide

SAP Widget Foundation User's Guide