17
Installation Guide UI development toolkit for HTML5 on SAP HANA XS PUBLIC Document Version: 1.3 2013-01-17

SAPUI5_Hana_InstGuide_V1-3

Embed Size (px)

DESCRIPTION

SAP UI5 Hana Installation Guide

Citation preview

  • Installation Guide

    UI development toolkit for HTML5 on SAP HANA XS

    PUBLIC

    Document Version: 1.3 2013-01-17

  • Table of Contents

    1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

    2 About this Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

    3 Before you Start. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

    4 SAP Notes for the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

    5 Related Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

    6 Installation Prerequisites for SAPUI5 Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86.1 Software Component Download for SAPUI5 Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

    7 Installation Prerequisites for SAPUI5 Runtime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107.1 Software Component Download for SAPUI5 Runtime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

    8 Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118.1 Installing SAPUI5 Runtime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118.2 Installing SAPUI5 Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

    9 Upgrading SAPUI5 Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

    10 Additional Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

    11 Uninstalling SAPUI5 Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

    12 Versioning of SAPUI5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

    13 Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

    2I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved.

    Installation Guide for SAPUI5 on SAP HANA XSTable of Contents

  • 1 Introduction

    The UI development toolkit for HTML5 (SAPUI5) is a library and a framework, which is designed to enable developers to easily create and extend state-of-the-art user interfaces. SAPUI5 is based on HTML5 and bases on the the jQuery library. It supports CSS3, which allows you to adapt themes to your company's branding in an effective manner. SAPUI5 is Open AJAX-compliant and can be used together with other standard JavaScript libraries. The client-side rendering library provides a rich set of controls. You can extend the existing controls, or develop new custom controls.The UI development tools are part of SAPUI5. They are a set of eclipse-based tools and editors, which support you in developing applications and controls. Wizards help you to create application projects and views according to the model view controller concept. It also provides additional features, such as the JavaScript code completion and the In-place application preview. The SAPUI5 ABAP team provider functionality supports you in developing on an ABAP backend system.A Web application, which has been developed in the SAPUI5 framework can run on the following platforms: SAP NetWeaver ABAP Server SAP NetWeaver Java Server SAP NetWeaver Cloud Open Source Java Application Server Static Open Source Web ServerFor more information about the required deployment steps, see the corresponding platform documentation in the SAP Service Marketplace at service.sap.com/instguides.

    Caution: SAPUI5 can be used on different platforms. For SAPUI5, the license and maintenance conditions of the respective platform apply, on which SAPUI5 is used. For example, if you use SAPUI5 tools on SAP NetWeaver Cloud, the license and maintenance conditions of SAP NetWeaver Cloud apply.

    Installation Guide for SAPUI5 on SAP HANA XSIntroduction

    I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved. 3

  • 2 About this Document

    This document guides administrators through the required steps to install, configure, and maintain the UI development toolkit for HTML 5 (SAPUI5).The Installation Guide comprises the following main sections: Before you Start: This section provides links to SAP Notes and other information that is relevant for the

    installation of SAPUI5. Support and Maintenance Strategy: This section provides information about the support and maintenance

    strategy for SAPUI5. Preparation: This section provides information about the installation prerequisites and the required software

    components for SAPUI5 tools and SAPUI5 runtime. Installation: This section provides information about the steps required to install SAPUI5 tools and SAPUI5

    runtime. Additional Information: This section provides information about how to uninstall SAPUI5 tools, the versioning

    of SAPUI5, and links to additional information.For security related issues, refer to the Security Guide.

    4I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved.

    Installation Guide for SAPUI5 on SAP HANA XSAbout this Document

  • 3 Before you Start

    The following sections provide information about: SAP Notes for the Installation Related Information

    Installation Guide for SAPUI5 on SAP HANA XSBefore you Start

    I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved. 5

  • 4 SAP Notes for the Installation

    You must read the following SAP Notes before you start the installation:

    SAP Note number Description1747308 Collection of information about SAPUI5

    Make sure that you habe the up-to-date version of each SAP note, which you can find in the SAP Service Marketplace at http://service.sap.com/notes.

    6I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved.

    Installation Guide for SAPUI5 on SAP HANA XSSAP Notes for the Installation

  • 5 Related Information

    For more information about topics not covered in this guide, see the following content: SAP NetWeaver Library at http://help.sap.com SAP NetWeaver Platform Product Availability Matrix at http://help.sap.com/pam

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

    Installation Guide for SAPUI5 on SAP HANA XSRelated Information

    I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved. 7

  • 6 Installation Prerequisites for SAPUI5 Tools

    To install and run SAPUI5 tools, the following software has to be installed: Java Runtume environment: JRE 1.6, 32/64-Bit (same as Eclipse) 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 SAP HANA StudioBefore you can start the installation of SAPUI5 tools, the SAP HANA Studio has to be installed according to the SAP HANA installation information on the SAP Help Portal under help.sap.com/hana_appliance Installation and Upgrade Information .Make sure that the following features are installed:

    Name Technical IDEclipse Faceted Project Framework org.eclipse.wst.common.fprojEclipse Faceted Project Framework JDT Enablement org.eclipse.jst.common.fproj.enablement.jdtEclipse Java EE Developer Tools org.eclipse.jst.enterpride_ui.featureEclipse Java Web Developer Tools org.eclipse.jst.web_ui.featureWST Common Core org.eclipse.wst.common_core.featureJetty Core: Servlets and webapps org.eclipse.jetty.core

    Note: Make sure that the following features are installed in version 3.4.0: Eclipse Faceted Project Framework Eclipse Faceted Project Famework JDT Enablement Eclipse Java EE Developer Tools Eclipse Java Web Developer Tools WST Common CoreNote: It may be necessary to deselect the Group Items by Category and Show only latest versions of available software checkboxes when installing the above features from the Eclipse Release Train Update.

    6.1 Software Component Download for SAPUI5 ToolsBefore you start the installation of UI development toolkit for HTML5 (SAPUI5), download the software components for SAPUI5 tools as follows:

    8I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved.

    Installation Guide for SAPUI5 on SAP HANA XSInstallation Prerequisites for SAPUI5 Tools

  • 1. Open the SAP Software Download Center on SAP Service Marketplace (http://service.sap.com/swdc).2. Search for SAPUI5 TOOLS IDE PLUGIN 1.00.3. Add the package to the download basket.4. Download the corresponding archive file (zip) to a local directory.

    Installation Guide for SAPUI5 on SAP HANA XSInstallation Prerequisites for SAPUI5 Tools

    I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved. 9

  • 7 Installation Prerequisites for SAPUI5 Runtime

    One of the following platforms is required for the installation of SAPUI5 runtime: SAP NetWeaver 7.00, 7.01, 7.02, or 7.31 SAP NetWeaver Cloud SAP NetWeaver Java

    7.1 Software Component Download for SAPUI5 RuntimeSAPUI5 runtime is available as delivery unit and part of the SAP HANA installer.

    10I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved.

    Installation Guide for SAPUI5 on SAP HANA XSInstallation Prerequisites for SAPUI5 Runtime

  • 8 Installation

    The following sections describe the installation steps that are required to install UI development toolkit for HTML5:1. Installing UI5 runtime2. Installing UI5 tools

    8.1 Installing SAPUI5 RuntimeSAPUI5 runtime is installed as part of the SAP HANA installer, see .

    8.2 Installing SAPUI5 ToolsTo install the SAPUI5 tools package, proceed as follows:1. Launch your SAP HANA Studio 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 certifcates from Eclipse.org and SAP with OK.8. To apply the changes of the installation procedure, restartthe SAP HANA Studio Eclipse workbench.9. To check whether the installations has been successful, proceed as follows: For SAPUI5 application

    development open the SAP HANA Studio Eclipse IDE and choose File New Other ... SAPUI5 Application Development Application Project . If the installation has been successful, the New Application Project wizard opens.

    Installation Guide for SAPUI5 on SAP HANA XSInstallation

    I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved. 11

  • 9 Upgrading SAPUI5 Tools

    To upgrade SAPUI5 tools, download the new versino of the SAPUI5 tools package from SAP Service Marketplace. For information about the prerequisites for installing and upgrading SAPUI5 tools, see Installation Prerequisites for SAPUI5 Tools [page 8].Proceed as follows:1. Launch your SAP HANA Studio 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 bedore 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 Updates .b. 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 license 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.

    12I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved.

    Installation Guide for SAPUI5 on SAP HANA XSUpgrading SAPUI5 Tools

  • 10 Additional Information

    The following sections provide additional information about the following topics: Uninstalling SAPUI5 Tools [page 14] Versioning of SAPUI5 [page 15] Documentation

    Installation Guide for SAPUI5 on SAP HANA XSAdditional Information

    I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved. 13

  • 11 Uninstalling SAPUI5 Tools

    To 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.

    14I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved.

    Installation Guide for SAPUI5 on SAP HANA XSUninstalling SAPUI5 Tools

  • 12 Versioning of SAPUI5

    With 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.

    Installation Guide for SAPUI5 on SAP HANA XSVersioning of SAPUI5

    I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved. 15

  • 13 Documentation

    The following documentation is available for UI development toolkit for HTML5:To access the SAPUI5 DemoKit use this URL, replacing with the XS Engine host name and with the XS Engine port number:http://:/sap/ui5/demokit/#docs/guide/Documentation.html

    16I N T E R N A L U S E O N L Y 2012 SAP AG. All rights reserved.

    Installation Guide for SAPUI5 on SAP HANA XSDocumentation

  • www.sap.com/contactsap

    2012 SAP AG. 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.Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation.IBM, DB2, DB2 Universal Database, System ads, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation.Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries.Oracle is a registered trademark of Oracle Corporation.UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc.HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology.Java is a registered trademark of Sun Microsystems, Inc.JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape.SAP, R/3, xApps, xApp, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, 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 in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.These materials are subject to change without notice. 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.

    TitlePage_SAPUI5_InstallHanaInstallation_Guide_for_SAPUI5_on_SAP_HANA_XS_V1-3Table of Contents1 Introduction2 About this Document3 Before you Start4 SAP Notes for the Installation5 Related Information6 Installation Prerequisites for SAPUI5 Tools6.1 Software Component Download for SAPUI5 Tools

    7 Installation Prerequisites for SAPUI5 Runtime7.1 Software Component Download for SAPUI5 Runtime

    8 Installation8.1 Installing SAPUI5 Runtime8.2 Installing SAPUI5 Tools

    9 Upgrading SAPUI5 Tools10 Additional Information11 Uninstalling SAPUI5 Tools12 Versioning of SAPUI513 Documentation