Master Guide for User Interface Add-On - NWBC

CUSTOMERSAP NetWeaverDocument Version: - 2014-01-27

Master Guide for User Interface Add-On

Table of Contents1 Master Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31.1 Related Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31.2 Software Units. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.3 Software Component Matrix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81.4 System Landscape. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131.5 Overall Implementation Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

2 Installing SAPUI5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192.1 Support and Maintenance Strategy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192.2 SAPUI5 Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

2.2.1 SAPUI5 Tools Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222.2.2 Upgrading SAPUI5 Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252.2.3 Uninstalling SAPUI5 Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

2.3 SAPUI5 Runtime Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .252.4 Versioning of SAPUI5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .262.5 Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

2C U S T O M E R 2014 SAP AG or an SAP affiliate company. All rights reserved.

Master Guide for User Interface Add-OnTable of Contents

1 Master GuideUse

About This DocumentThis Master Guide is the central starting point for the technical implementation of user interface add-on for SAP NetWeaver . It contains cross-scenario implementation information as well as scenario-specific information.Use the Master Guide to get an overview of UI add-on for SAP NetWeaver , its software units, and its scenarios from a technical perspective. The Master Guide is a planning tool that helps you to design your system landscape. It refers you to the required detailed documentation, mainly: Installation guides for single software units SAP Notes Configuration documentation SAP Library documentationConstraintsThe business scenarios that are presented here are examples of how you can use SAP software in your company. The business scenarios are only intended as models and do not necessarily run as described here in your customer-specific system landscape. Be sure to check your requirements and systems to determine whether these scenarios can be used productively at your site. Furthermore, we recommend that you test these scenarios thoroughly in your test systems to ensure they are complete and free of errors before going live.This Master Guide primarily discusses the overall technical implementation of UI add-on for SAP NetWeaver , rather than its subordinate components. This means that additional software dependencies might exist that are not mentioned explicitly in this document. You can find more information on component-specific software dependencies in the corresponding installation guides.

1.1 Related Information

Use

For more information about topics not covered in this guide, see the following content:

Title Location

SAP NetWeaver Library http://help.sap.com/netweaver SAP NetWeaver Platform

SAP NetWeaver Gateway documentation http://help.sap.com/netweaver SAP NetWeaver Gateway

SAP Web Dispatcher documentation http://help.sap.com/nw_platform

Master Guide for User Interface Add-OnMaster Guide

C U S T O M E R 2014 SAP AG or an SAP affiliate company. All rights reserved. 3

Title Location

Select a release. Under Application Help, open Function-Oriented View and choose Application Server Application Server Infrastructure SAP Web Dispatcher .

SAP Visual Business documentation SAP Visual Business 2.1: http://help.sap.com/visualbusiness21UI add-on for SAP NetWeaver includes the SAP Visual Business 2.1 back end and the HTML5 version of the SAP Visual Business client as SAPUI5 Library.

Product Availability Matrix http://service.sap.com/pam

Important SAP NotesMake sure that you have the up-to-date version of each SAP Note, which you can find on SAP Service Marketplace at http://service.sap.com/notes .

SAP Note Number Title Description

SAP Note 1759682 UI Add-On for SAP NetWeaver: Central NoteThis central SAP note refers to other SAP notes that contain important information about the user interface add-on for SAP NetWeaver.

SAP Note 1760422 HTML5 applications using WebServices via Gateway as a hubContains important information regarding the setup of the system landscape.

SAP Note 1666368 Installing UI Add-ons 1.0 for SAP NetWeaverDescribes the installation of the ABAP components of user interface add-on for SAP NetWeaver .

SAP Note 1666369 Support Packages for UI Add-ons 1.0 for SAP NetWeaverContains information about add-on support packages for UI add-on for SAP NetWeaver .

SAP Note 1666367 Release Strategy for UI Add-ons 1.0 for SAP NetWeaverContains information about the release strategy for UI add-on for SAP NetWeaver. Read this note if you plan to install or upgrade UI add-on for SAP NetWeaver .

SAP Note 1582870 ABAP XSS Escaping Support It is important that you apply this SAP Note to protect your system against cross-site scripting attacks.



1.2 Software UnitsUse

Software ComponentsUser interface add-on for SAP NetWeaver includes the following software components:

Type Software Component Description Available in UI add-on for SAP NetWeaver Release

ABAP UI_INFRA UI theme designer (requires UISAPUI5)

SAP NetWeaver 7.0

UI2_FND Foundation components for OData servicesThese include the server runtime for UI services.

SAP NetWeaver 7.0

UI2_700 Provides an OData service for accessing report launchpad links

SAP NetWeaver 7.0

UI2_701 Component for future extensions

SAP NetWeaver 7.0 EHP1

UI2_702 Component for future extensions


UI2_731 Provides OData page building services for the configuration, customizing and personalization scopes

SAP NetWeaver 7.3 EHP1SAP NetWeaver 7.0 EHP3

UI2_SRVC Component for future extensions

SAP NetWeaver 7.0

UISAPUI5 SAP NetWeaver 7.0UI5_731 SAP NetWeaver 7.3 EHP1


Frontend NWBC NW BUSINESS CLIENT 4.0

SAP NetWeaver Business Client 4.0 for Desktop

Java SAPUI5_TOOLS



Type Software Component Description Available in UI add-on for SAP NetWeaver Release

SAPUI5_TEAM_PROVIDER Allows you to deploy applications built with the Eclipse-based tools to an ABAP environment

SAP NetWeaver 7.0 EHP3SAP NetWeaver 7.3 EHP1

Dependencies between Software ComponentsThe following figure shows the dependencies between software components:

UI2_700, UI2_701, UI2_702 and UI2_731 require software component UI2_FND. In addition, the higher UI2_7xx components require the lower UI2_7xx components.UI2_FND requires IW_BEP and UI2_INFRA.UI5_731, UI2_SRVC and UISAPUI5 require UI2_INFRA.All software components mentioned above require SAP_BASIS and SAP_ABA.Product InstancesIn the different versions of UI add-on for SAP NetWeaver , the software components described above are bundled in the following product instances:



Type Product Instance

Software Components in UI add-on for SAP NetWeaver 7.00




ABAP Integration Services: All

Integration Services: ProviderandIntegration Services: Libs




Integration Services: Provider

UI2_FND

UI2_700

UI_INFRA

IW_BEP

UI2_FND

UI2_700

UI2_701

UI_INFRA

IW_BEP

UI2_FND

UI2_700

UI2_701

UI2_702

UI_INFRA

IW_BEP

UI2_FND

UI2_700

UI2_701

UI2_702

UI2_731

UI_INFRA

IW_BEP

Integration Services: Libs

HTML5 DevToolkit: Client LibsUI2_SRVC


HTML5 DevToolkit: Client LibsUI2_SRV


HTML5 DevToolkit: Client Libs

UISAPUI5

UI_INFRA

UISAPUI5

UI_INFRA

UISAPUI5

UI_INFRA

UISAPUI5

UI_INFRA

HTML5 DevToolkit: All

n.a n.a n.a HTML5 DevToolkit: Client LibsUI5_731

Frontend Frontend NWBC NW BUSINESS CLIENT 4.0

NWBC NW BUSINESS CLIENT 4.0



Java HTML5 DevToolkit: Plugins

SAPUI5_TOOLS SAPUI5_TOOLS SAPUI5_TOOLS SAPUI5_TOOLS

SAPUI5_TEAM_PROVIDER



1.3 Software Component MatrixUse

The following table shows which scenarios are supported in the different versions of user interface add-on for SAP NetWeaver :

Scenario Product VersionsX = supported (X) = supported partly - = not supported

UI add-on for SAP NetWeaver 7.00



UI add-on for SAP NetWeaver 7.03/7.31

NWBC 4.0 desktop client installation

X X X X

Developing applications with the UI development toolkit for HTML5 (see the note below)

(X) (X) (X) X

Running applications built with the UI development toolkit for HTML5, where all UI resources are deployed in the SAPUI5 ABAP repository on the same system as the corresponding ABAP application logic

X X X X

Running applications built with the UI development toolkit for HTML5, where all UI resources are deployed in the SAPUI5 ABAP repository on a central system, for

X X X X



Scenario Product VersionsX = supported (X) = supported partly - = not supported




UI add-on for SAP NetWeaver 7.03/7.31

example a remote Gateway Server

Enabling an ABAP system to provide UI-related data via SAP NetWeaver Gateway OData services, for example accessing launchpad links for navigation

X X X X

Enabling an ABAP system to provide UI-related data via SAP NetWeaver Gateway OData services and to run applications based on the UI development toolkit for HTML5

X X X X

Create and deploy custom themes with the UI theme designer

(X) X X X

Integrating the social collaboration platform SAP Jam across SAP technologies including ABAP and SAPUI5

- = - = (X) X



NoteIn order to deploy SAPUI5 applications built with the Eclipse-based Tools to an ABAP environment, there are 2 options depending on the SAP NetWeaver release: SAP NetWeaver 7.03/7.31: Direct integration via the SAP Repository Team Provider allows easy and fast

deployment. For more information, see the User Interface Add-on for SAP NetWeaver Developer Guide . SAP NetWeaver 7.00, 7.01, 7.02 and 7.03/7.31 < SPS04: In these releases, it is not possible to directly

deploy or upload applications from the local Eclipse installation to the ABAP server. Deployment must take place manually. For more information, see the User Interface Add-on for SAP NetWeaver Developer Guide .

The following table shows which product instances are required for the different scenarios:

Scenario Product InstancesX = mandatory (X) = optional - = not part of scenario

Integration Services: All





Frontend HTML5 DevToolkit: Plugins

NWBC 4.0 desktop client installation

- - - - - X -

Developing and testing applications with the UI development toolkit for HTML5 on SAP NetWeaver 7.03 or higher

(X) (X) X - X

Running applications built with the UI development toolkit for HTML5,

(X) (X) X - -










where all UI resources are deployed in the SAPUI5 ABAP repository on the same system as the corresponding ABAP application logic

Running applications built with the UI development toolkit for HTML5, where all UI resources are deployed in the SAPUI5 ABAP repository on a central system, for example a remote Gateway Server

(X) (X) X - -










Enabling an ABAP system to provide UI-related data via SAP NetWeaver Gateway OData services, for example accessing launchpad links for navigation

(X) X - -

Enabling an ABAP system to provide UI-related data via SAP NetWeaver Gateway OData services and to run applications based on the UI development toolkit for HTML5

X - -

Create and deploy

(X) (X) X - -










custom themes with the UI theme designerIntegrating the social collaboration platform SAP Jam across SAP technologies including ABAP and SAPUI5

X X X X - = - = - =

1.4 System LandscapeUse

Background: Same Origin PolicyWhen setting up your system landscape, it is important to have the same origin policy of modern Web browsers in mind.You install the add-on in one or more ABAP systems. If you are using the back-end services provided by user interface add-on for SAP NetWeaver , you also need an SAP NetWeaver Gateway system, which provides business data using the OData Channel. In this case, a client needs to communicate with the following agents: A resource handler that provides HTML/JavaScript data A data handler that provides business data using the OData ChannelFor security reasons, modern Web browsers do not allow JavaScript to perform cross-origin calls. A cross-origin call is a call where either the protocol, host name, or port is different from the origin of the HTML page.



Thus, in the system landscape all client requests - OData and UI requests - have to be handled by one server using the same protocol, host, and port.System LandscapeThe following graphic shows two possibilities for designing your system landscape:

The abbreviations in the graphic above have the following meaning:

Abbreviation Description

AJAX Asynchronous JavaScript and XML

HTML HyperText Markup Language

JS JavaScript

RFC Remote Function Call

UI User interface

XHR XMLHttpRequest

Single ABAP SystemIf you want to access data from one ABAP system only, you can install SAP NetWeaver Gateway on the same server as your ABAP system. This ensures that user interface data and business data come from the same origin.Multiple ABAP Systems



If you want to access data from multiple ABAP systems, you need to install and configure a reverse proxy. SAP Web Dispatcher is an example of a reverse proxy. The examples in this documentation assume that SAP Web Dispatcher is used as a proxy.

RecommendationIf you want to run applications that have been built with the UI development toolkit for HTML5 and require access to OData services provided by UI add-on for SAP NetWeaver , SAP currently recommends that you install and operate a local SAP NetWeaver Gateway on the same system as UI add-on for SAP NetWeaver .It is also possible to configure a remote SAP NetWeaver Gateway system on a separate server, but you have to carefully consider specific requirements for browser-based scenarios.

1.5 Overall Implementation Sequence

Use

The following table describes the overall installation sequence for user interface add-on for SAP NetWeaver . This table contains all available software units. However, to implement a specific scenario, you only need a subset of available software units. Some are only required for special processes. For information about which software is required to implement a specific scenario, see Software Component Matrix.Before you start the implementation, take a decision regarding your system landscape. For more information, see System Landscape.

Process

Step Action Remarks

1 Download the software package The software packages are available on SAP Service Marketplace at http://service.sap.com/swdc .

2 Install the ABAP add-on on your back-end system

For more information about the installation, see SAP Note 1666368

.Among other things, the installer installs the IW_BEP component that is required for communication with the SAP NetWeaver Gateway server.



Step Action Remarks

3 Install the SAP NetWeaver Gateway server

SAP recommends to install and operate a local SAP NetWeaver Gateway server on the same system as UI add-on for SAP NetWeaver .The minimum requirement for user interface add-on 1.0 for SAP NetWeaver is SAP NetWeaver Gateway 2.0 Support Package 4.For more information, see http://help.sap.com/netweaver SAP NetWeaver Gateway Installation Guide .

4 Configure OData Channel Before you perform this step, the add-on (including the IW_BEP component) must be installed on the respective back-end system.In the SAP NetWeaver Gateway system, you configure the connection to one or more back-end systems. This includes defining an RFC destination, setting up a trust relationship and creating a system alias.For more information, see the sections OData Channel and Connection Settings: SAP NetWeaver Gateway to SAP Systems in the SAP NetWeaver Gateway Configuration Guide at

http://help.sap.com/netweaverSAP NetWeaver Gateway

Confiugration Guide .

5 Install and configure a reverse proxy This step is only required if the SAP NetWeaver Gateway server runs on a different server than your ABAP back-end system. For more information, see System Landscape.In an example configuration SAP uses SAP Web Dispatcher as reverse proxy. However, you can use any other reverse proxy you



Step Action Remarks

wish, or possibly use a reverse proxy that you already have installed.For more information on installing SAP Web Dispatcher see Importing the SAP Web Dispatcher in the SAP Web Dispatcher documentation.For more information on the operation of SAP Web Dispatcher see Operating the SAP Web Dispatcher in the SAP Web Dispatcher documentation.

6 Activate OData services For more information, see http://help.sap.com/netweaver

Application Help User Interface Add-On for SAP NetWeaver Administration Guide Activating OData Services .

7 Install the Development Toolkit for HTML5 (SAPUI5)

8 Activate the UI5_ICF_HANDLER

9 Install the SAP NetWeaver Business Client

On the system that you connect to, the NWBC runtime must be installed.For more information, see http://help.sap.com/netweaver

Application Help SAP NetWeaver Business ClientInstallation .

NoteWhen setting up an RFC destination between the SAP Gateway system and a back-end system, set up a trust relationship between the systems. For more information, see the RFC documentation on SAP Help Portal at http://help.sap.com/netweaver SAP NetWeaver Platform Application Help SAP NetWeaver Library: Function-Oriented View Application Server Application Server Infrastructure Connectivity Components of SAP Communication Technology Classic SAP Technologies (ABAP) RFC RFC AdministrationMaintaining Remote Destinations Maintaining Trust Relationships between SAP Systems .In the configuration of the RFC destination, it is important that you do not specify a generic user name and password, but configure the system to use the user name of the user who is currently logged on. For more



information, see http://help.sap.com/netweaver SAP NetWeaver Gateway Configuration Guide OData Channel Configuration Connection Settings on the SAP NetWeaver Gateway Hub System Connection Settings: SAP NetWeaver Gateway to SAP Systems Creating a Type 3 RFC Destination on SAP NetWeaver Gateway Host .



2 Installing SAPUI5Provides information on the installation of SAPUI5The following sections guide administrators through the required steps to install, configure, and maintain the UI development toolkit for HTML5 (SAPUI5).

NoteYou can install SAPUI5 on different platforms. The license and maintenance conditions of the respective platforms apply also for SAPUI5. If you use SAPUI5 tools on SAP HANA Cloud Platform, for example, the licence and maintenance conditions of the SAP HANA Cloud Platform apply.

Important SAP Notes for the Installation

Before you start the installation process, read the following SAP notes. Make sure that you have the up-to-date version of each SAP note. You can find them on SAP Service Marketplace at http://service.sap.com/notes .

Note Number Title Description

1666368 Installing UI add-ons for SAP NetWeaver Describes the installation of the ABAP components of UI add-on for SAP NetWeaver

1666369 SPs for UI add-ons for SAP NetWeaver Contains information about add-on support packages for UI add-on for SAP NetWeaver

1686090 Translation Object for SAPUI5 (ABAP) To use the translation feature with the SAPUI5 ABAP team provider in the UI add-on in a SAP NetWeaver 7.03/7.31 system, implement this SAP note in the translation system to enable the translation of text elements.

1747308 SAPUI5 Collection of information about SAPUI5

https://service.sap.com/sap/support/notes/

ABAP XSS Escaping Support We highly recommend that you implement this note to support ABAP XSS escaping.

2.1 Support and Maintenance StrategyServer

The UI development toolkit for HTML5 (SAPUI5) is comprised of a server and a client component for both the SAPUI5 tools and runtime. The support and maintenance strategy of both parts differs from the general SAP

Master Guide for User Interface Add-OnInstalling SAPUI5


NetWeaver support and maintenance strategy, see SAP Maintenance Strategy . The SAPUI5 components are downward-compatible software components and follow the same strategy as the SAP GUI. They can be replaced by a higher software component version during the lifetime of the software product version they are built into without adaptations or changes to other software component versions within the relevant software product version. Therefore, the SAPUI5 software component versions are usually not maintained for the entire maintenance period of the software product version they are built into. Instead, they have to be replaced by a higher software component version.Downward-compatible means, for example, for SAP NetWeaver ABAP that starting with SAP NetWeaver UI extensions add-on SP01, the most current client version of SAPUI5 runtime and tools will always be compatible with all future SAP NetWeaver support packages. We recommend, therefore, that customers apply the most recent client updates of SAPUI5 tools and runtime on a regular basis. As the SAPUI5 tools client has many dependencies, this may require additional updates.

Client

SAPUI5 tools are build into Eclipse, but are not shipped as a bundle with Eclipse, but separately as an Eclipse p2 repository. Eclipse is supported for different individual platforms. The support of individual platforms also depends on the support of the operating systems by the manufacturers. SAP cannot provide support for a platform or for an operating system which is no longer supported by its vendor or manufacturer. In the same sense, SAP cannot provide support for an Eclipse version or any other Open Source software version, which is no longer supported by the Eclipse Foundation or the Open Source community.

Support Platform Matrix

SAPUI5 tools is only supported for a subset of the individual platform and operating system versions that are also supported by Eclipse. The list of different individual operating system versions, Java Runtime versions, Eclipse versions, and Browser versions that are supported by SAPUI5 tools is provided in the SAPUI5 tools Support Platform Matrix (SPM). SAP does not support to run SAPUI5 tools on operating system versions, Java Runtime versions, Eclipse versions, and Browser versions that are not listed in the SAPUI5 tools SPM.The following table gives an overview of the supported platforms and operating systems:Operating System Windows XP, Vista 7 (32- or 64-Bit)Java Runtime JRE 1.6, 32/64-BitBrowser Internet Explorer 9.0 or higherABAP Tools for SAP NetWeaver When using the SAPUI5 ABAP Team Provider, the Support

Platform Matrix of ABAP Development Tools for SAP NetWeaver applies

Eclipse platform Eclipse Indigo 3.7 or Juno 3.8 or Juno 4.2

The SAPUI5 runtime supports the browsers that are listed in the Product Availability Matrix for the UI add-on for SAP NetWeaver.



Special Terms for Operating Systems

SAP recommends that you always use a current Support Package (SP) for the relevant operating system as listed on the SAPUI5 tools SPM. An operating system, which is no longer supported by the operating system's manufacturer should no longer be used in conjunction with SAPUI5 tools. If an issue occurs only on an unsupported operating system, SAP will not analyse nor solve the issue, but instead reply by recommending an update of the operating system. Additionally, SAP does not test SAPUI5 tools on such operating systems anymore.

Special Terms for Java Runtime versions

SAP recommends that you always use a current Java Runtime version as listed on the SAPUI5 tools SPM. A Java Runtime version, which is no longer supported by the Java Runtime version manufacturer should no longer be used in conjunction with SAPUI5 tools. If an issue occurs only on an unsupported Java Runtime version SAP will not analyse nor solve the issue, but instead reply by recommending an upgrade of the Java Runtime version. Additionally, SAP does not test SAPUI5 tools on such Java Runtime versions anymore.

Special Terms for Eclipse versions

SAP recommends that you always use a current Eclipse version as listed on the SAPUI5 tools SPM. An Eclipse version, which is no longer supported by the Eclipse foundation should no longer be used in conjunction with SAPUI5 tools. If an issue occurs only on an unsupported Eclipse version SAP will not analyse nor solve the issue, but instead reply by recommending an upgrade of the Eclipse version. Additionally, SAP does not test UI5 tools on such Eclipse versions anymore.

Special Terms for Browser versions

SAP recommends that you always use a current Browser version as listed on the SAPUI5 tools SPM. A Browser version which is no longer supported by the Browser manufacturer should no longer be used in conjunction with UI5 tools. If an issue occurs only on an unsupported Browser version SAP will not analyse nor solve the issue, but instead reply by recommending an upgrade of the Browser version. Additionally, SAP does not test SAPUI5 tools on such Browser versions anymore.

Language Support

If the SAPUI5 ABAP TeamProvider is used, the SAPUI5 tools are released in English language only.



SAP Shipment Channel and License Agreement

The use of SAPUI5 is subject to the terms and conditions of your license agreement with SAP which is directly related to the SAP shipment channel where SAPUI5 has been initially been downloaded and installed from. SAP does not support to update SAPUI5 with software from a different SAP shipment channel than the initial installation of SAPUI5 has been done. Example: An update of an older SAPUI5 installation which has originally been downloaded and installed from the SAP Service Marketplace with a newer SAPUI5version which is provided on the SAP Developer Center is not recommended and not supported by SAP.

Disclaimer

Some components of this product are based on Java. Any code change in these components may cause unpredictable and severe malfunctions and is therefore expressly prohibited, as is any decompilation of these components.Any Java Source Code delivered with this product is only to be used by SAP's Support Services and may not be modified or altered in any way.

2.2 SAPUI5 Tools

2.2.1 SAPUI5 Tools InstallationInstallation prerequisites and installation process for SAPUI5 toolsThe following sections provide the required information for the installation, upgrade, and uninstallation of SAPUI5 tools.Before you start the installation, make sure that you have the required software versions installed and that you have downloaded the respective Software components.

Required Software for Installing and Running SAPUI5 Tools

To install and run SAPUI5 tools, the following software has to be installed: Java Runtime environment: JRE 1.6, 32/64-Bit (same as Eclipse)

If you install the SAPUI5 ABAP team provider together with ABAP development tools for SAP NetWeaver in a version below 1.0 Patch 07, you need to use the 32 Bit versions.

SAPUI5 ABAP team provider to connect to an ABAP backend system on SAP NetWeaver 7.31If you want to use the SAPUI5 ABAP team provider to connect to an ABAP backend system, the following additional prerequisites are required: User interface add-on for SAP NetWeaver 1.0 support package 02



AiE Communication FrameworkThe AIE Communication Framework is part of the ABAP development tools for SAP NetWeaver. Install the complete ABAP development tools according to the installation procedure in the Installation Guide for the ABAP Development Tools, see SAP Note 1718399.

Operating system: Windows Vista, Windows 7 (32- or 64-Bit) Browser: Not relevant, except for Internet Explorer 9.0 or higher for embedded application preview Eclipse Platform for SAPUI5 tools:

SAPUI5 tools run on the following Eclipse versions: Indigo 3.7, Juno 3.8 / 4.2 and Kepler 4.3. There are two options for the Eclipse platform: Either an 'Eclipse IDE for Java EE Developers' bundle or an 'Eclipse Classic 4.2' bundle. Depending on the bundle you choose, you may be required to install additional features according to this list:

Name Technical IDE Min. version Contained in Eclipse JEE Bundle

Contained in Eclipse Classic Bundle

Eclipse Platform org.eclipse.platform 3.5.0 Yes YesEclipse Faceted Project Framework

org.eclipse.wst.common.fproj

3.1.0 Yes No

Eclipse Faceted Project Framework JDT Enablement

org.eclipse.jst.common.fproj.enablement.jdt

3.1.0 Yes No

Eclipse Java Development Tools

org.eclipse.jdt 3.5.0 Yes Yes

Eclipse Java EE Developer Tools

org.eclipse.jst.enterprise_ui.feature

3.1.0 Yes No

Eclipse Java Web Developer Tools / JST Web UI

org.eclipse.jst.web_ui.feature

3.1.0 Yes No

EMF - Eclipse Modeling Framework Runtime and Tools

org.eclipse.emf 2.0.0 Yes No

Graphical Editing Framework GEF

org.eclipse.gef 3.5.0 Yes No

JavaScript Development Tools

org.eclipse.wst.jsdt.feature

1.1.0 Yes No

WST Common Core org.eclipse.wst.common_core.feature

3.1.0 Yes No

WST Server Adapters org.eclipse.wst.server_adapters

3.2.300 Yes No

NoteMake sure that you have write permssion for the directory you use for the Eclipse installation, or start Eclipse as Administrator.



NoteFor the SAPUI5 application preview, you require the Jetty feature. This needs to be installed explicitely as of Juno release.

NoteIf your Eclipse installation contains the feature org.eclipse.wst.jsdt.feature in version 1.3.1, we recommend to update to a current version. Invoking the JavaScript code completion in version 1.3.1 may cause a system crash of Eclipse.

Required Software Components for SAPUI5 Tools

For the installation of SAPUI5 tools, download the following components from the SAP Software Download Center on SAP Service Marketplace at http://service.sap.com/swdc : SAPUI5 TOOLS IDE PLUGIN 1.00 SAPUI5 TEAM PROV IDE 1.00

Installation Process for SAPUI5 Tools

To install SAPUI5 tools, proceed as follows:1. Launch your Eclipse workbench.2. Open the installation wizard by choosing Help Install New Software .3. In the Work with field of the installation wizard, specify the target directory of the package.

To add the new installation directory, choose Add and then choose Archive to specify the location. Enter a name for your local software site.

4. Select all UI development toolkit for HTML5 features and choose Next.5. Review the feature groups to be installed and choose Next.6. Accept the terms of the license agreement and choose Finish to initiate the installation of selected feature

groups.7. In the Certificates dialog confirm the certificates from Eclipse.org and SAP with OK.8. To apply the changes of the installation procedure, restart the Eclipse workbench.9. To check, whether the installation has been succesful, proceed as follows:

For SAPUI5 application development open the Eclipse IDE and choose File New Other ... SAPUI5 Application Development Application Project . If the installation has been succesful, the New Application Project wizard opens.For the SAPUI5 ABAP repository team provider open the Eclipse IDE and choose File New Other ...SAPUI5 Application Development Application Project . Select the new project and choose Context Menu

Team Share Project... . If the installation has been succesful, SAPUI5 ABAP Repository appears in the list



2.2.2 Upgrading SAPUI5 ToolsTo upgrade SAPUI5 tools, download the new version of the SAPUI5 tools package from SAP Service Marketplace.

NoteIf you have installed SAPUI5 tools and SAPUI5 ABAP team provider, make sure that they are both updated at the same time. This is ensured if you follow the procedure described below.

Proceed as follows:1. Launch your Eclipse workbench.2. If you have downloaded the new version with a different name and/or stored at a different location instead of

exchanging the old version with the new version, you have to update the list of available software sites in Eclipse to refer to the new location before you can start the update. Proceed as follows:a. Choose Window Preferences .b. Choose Install/Update Available Software Sites .c. Select the entries that you have added for the installation or the last update and adjust them for the new

version.d. Confirm your changes.

3. Continue with the update as follows:a. To open the Updates wizard, choose Help Check for Updatesb. In the Available Updates list, select all UI development toolkit for HTML5 features and choose Next.c. Review the feature groups to be installed and choose Next.d. Accept the terms of the licence agreement and choose Finish to start the installation of the selected

feature groups.e. In the Certificates dialog, confirm the certificates of Eclipse.org and SAP.

2.2.3 Uninstalling SAPUI5 ToolsTo uninstall all frontend components required for UI5 tools, proceed as follows:1. Launch your Eclipse workbench.2. Choose Help About .3. Choose Installation Details.4. Select the SAPUI5 node and choose Uninstall.

The Uninstall Details page displays a list of feature groups that will be uninstalled.5. To start the uninstall function, choose Finish.

2.3 SAPUI5 Runtime InstallationInstallation prerequisites and installation process for SAPUI5 runtime



The following sections provide the required information for the installation of SAPUI5 runtime.Before you start the installation, make sure that you have the required software versions installed and that you have downloaded the respective Software components.

Required Software for Installing and Running SAPUI5 Runtime

To install SAPUI5 runtime, one of the following platforms is required: SAP NetWeaver 7.00. 7.01, 7.02, or 7.31 SAP HANA Cloud SAP NetWeaver Java

Required Software Components for SAPUI5 Runtime

Before you start the installationof SAPUI5 runtime, download the respective software components from the SAP Software Download Center on SAP Service Marketplace at http://service.sap.com/swdc .

Installation Process

The UI add-on is installed on an existing SAP NetWeaver release and can be used on the SAP NetWeaver release versions 7.00, 7.01, 7.02, and 7.31To install SAPUI5 runtime on SAP NetWeaver ABAP, proceed as follows:

1. Import the UI add-on from service.sap.com by using transaction SAINT. For more information about the installation and the prerequisites for the UI add-on, see SAP note 1666368 on service.sap.com/notes .

2. To check whether the installation of UI add-on and SAPUI5 has been successful, open your web browser with the following URL: http://:/sap/public/bc/ui5_ui5/index.html. Replace and with the respective host name and port number of your SAPNetWeaver application server. You can get this information via the ICM Monitor (transaction code SMICM) by choosing Goto Services .If the installation was succesful, the browser dislays the index page with the versions of the installed libraries and the SAPUI5 script tag that needs to be used in an HTML page to upload SAPUI5 in your browser.

2.4 Versioning of SAPUI5With SAPUI5 1.6 there is a close coupling of SAPUI5 core/runtime and SAPUI5 tools: It is required that within a running system both have the same version, that is, have the same major and minor version. For example, SAPUI5 core/runtime 1.6.1 works together with SAPUI5 tools 1.6.2, but not with SAPUI tools 1.8. For a future release it is



planned to have a more lose coupling here with regards to the minor and micro version. Please note that with SAPUI5 1.6 we can only support customers, which follow this rule in their system landscapes.

2.5 DocumentationThe following documentation is available for UI development toolkit for HTML5: ABAP Server:

To access the SAPUI5 DemoKit use this URL, replacing with your host name and with your port number:http://:/sap/public/bc/ui5_ui5/demokit/#docs/guide/Documentation.html

SAP Java Server:To access the UI5 DemoKit use the respective URL, replacing with your host name and with your port number.

SAP HANA Cloud:https://sapui5.netweaver.ondemand.com/sdk/

NoteThis is the current version of the SAPUI5 DemoKit on the SAP HANA Cloud. It might not be the version of your local installation.



www.sap.com/contactsap

2014 SAP AG or an SAP affiliate company. All rights reserved.No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice.Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. National product specifications may vary.These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries.Please see http://www.sap.com/corporate-en/legal/copyright/index.epx for additional trademark information and notices.

Master Guide for User Interface Add-OnTable of Contents1 Master Guide1.1 Related Information1.2 Software Units1.3 Software Component Matrix1.4 System Landscape1.5 Overall Implementation Sequence

2 Installing SAPUI52.1 Support and Maintenance Strategy2.2 SAPUI5 Tools2.2.1 SAPUI5 Tools Installation2.2.2 Upgrading SAPUI5 Tools2.2.3 Uninstalling SAPUI5 Tools

2.3 SAPUI5 Runtime Installation2.4 Versioning of SAPUI52.5 Documentation

Copyright and Trademarks

Master Guide for User Interface Add-On - NWBC

Documents

Transcript of Master Guide for User Interface Add-On - NWBC