learn how to configure an update site for providing installation packages of abap development tools

SAP NetWeaver 7.31 SP04 - 14 and 7.40 SP02 - 09Document Version: 2.36 - 2014-11-24

Configuring an Update Site for Providing Installation Packages of ABAP Development ToolsInstallation Instructions for Administrators

Table of Contents1 About this Configuration Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 Document History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

3 Business Scenario. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4 Related Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

5 Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

6 Step-by-Step Procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86.1 Downloading the Installation Package and Copying It to the Target Folder. . . . . . . . . . . . . . . . . . . . . 8

6.1.1 Downloading the Eclipse Installation Packages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86.1.2 Downloading the ABAP Development Tools Installation Packages. . . . . . . . . . . . . . . . . . . .9

6.2 Creating the Update Site Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106.2.1 compositeContent.xml. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106.2.2 compositeArtifacts.xml. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106.2.3 Adding Additional Update Sites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

6.3 Testing the Update Site Locally. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116.4 Copying the Content from the Update Site Folder to the Target Folder. . . . . . . . . . . . . . . . . . . . . . . 136.5 Configuring the Base Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136.6 Creating the Update Site as an HTML Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166.7 Rolling out the Update Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

2 © 2014 SAP SE or an SAP affiliate company. All rights reserved.Configuring an Update Site for Providing Installation Packages of ABAP Development Tools

Table of Contents

1 About this Configuration GuideABAP Development Tools for SAP NetWeaver (in short: ABAP Development Tools or ADT) is the ABAP IDE (Integrated Development Environment) built on top of the Eclipse platform. Its main objective is to support developers in today’s increasingly complex development environments by offering state-of the art ABAP development tools.

Scope of documentation

This document is an addition to the ADT Installation Guide and provides detailed information about how to set up an update site in order to distribute SAP´s Eclipse-based installation packages within a company.

NoteThe examples and procedures given in this document assume that you will create the base installation on a Windows 7 (64bit) operating system. For Mac and Linux, you can provide the corresponding installation packages in a similar way.

Target Audience

ABAP system and IT administrators who are responsible for the configuration of the ABAP systems, network, or intranet of your company.

More on ABAP Core Scenario

NoteIn order to enable you to develop ABAP source code, your ABAP system administrator needs to configure an ABAP system. For this, a Configuration Guide is provided on the SAP Commnunity Network: http://scn.sap.com/docs/DOC-47656

NoteVisit also the ABAP in Eclipse space in the SAP Community Network for more information and to interact with other developers.

Configuring an Update Site for Providing Installation Packages of ABAP Development ToolsAbout this Configuration Guide © 2014 SAP SE or an SAP affiliate company. All rights reserved. 3

http://help.sap.com/disclaimer?site=http://scn.sap.com/docs/DOC-47656

http://help.sap.com/disclaimer?site=http://scn.sap.com/docs/DOC-47656

http://help.sap.com/disclaimer?site=http://scn.sap.com/community/abap/eclipse

http://help.sap.com/disclaimer?site=http://scn.sap.com

2 Document HistoryDocument Version Description

V2.36 First official release of this guide


Document History

3 Business ScenarioYou can create an update site to provide and distribute SAP´s latest Eclipse-based installation packages (such as ABAP Development Tools, SAP HANA Studio, SAP UI5) to the ABAP developers of your company. Using this site, they can directly download and install a complete Eclipse installation, including SAP´s installation packages, or update an existing Eclipse installation.

The advantages of such an in-house update site are as follows:

● You can advertise these Eclipse-based software updates and their installation packages on a single HTML page.

● You can simplify the installation process for your users.● You can control and define the update cycle on your own. This gives you more time to test installation

packages in advance, for example.

Configuring an Update Site for Providing Installation Packages of ABAP Development ToolsBusiness Scenario © 2014 SAP SE or an SAP affiliate company. All rights reserved. 5

4 Related DocumentsEach release of ABAP Development Tools for SAP NetWeaver is announced through a corresponding SAP note.

A link to the SAP Software Download Center on the SAP Service Marketplace for downloading the installation packages and the installation guide are provided herewith. See here for further information on how to install ABAP Development Tools.


Related Documents

http://help.sap.com/disclaimer?site=https://support.sap.com/

5 PrerequisitesThis document is intended for system administrators who know:

● How the internal setup of the client and system landscape beyond the ABAP Backend is configured.● How to copy and publish content to a Web or file-sharing server.

Configuring an Update Site for Providing Installation Packages of ABAP Development ToolsPrerequisites © 2014 SAP SE or an SAP affiliate company. All rights reserved. 7

6 Step-by-Step ProcedureContext

The following installation procedure comprises steps that are required for creating an update site:

● Downloading the Installation Package and Copying It to the Target Folder [page 8]● Creating the Update Site Data [page 10]● Testing the Update Site Locally [page 11]● Copying the Content from the Update Site Folder to the Target Folder [page 13]● Configuring the Base Installation [page 13]● Creating the Update Site as an HTML Page [page 16]● Rolling out the Update Site [page 16]

6.1 Downloading the Installation Package and Copying It to the Target Folder

Context

The installation package, you want to distribute, consists of two parts:

1. The Eclipse installation itself2. The Eclipse-based installation packages of ABAP Development Tools (ADT) that you want to add to the

Eclipse installation.

In order to get the corresponding installation packages, you need to download them in the first step.

6.1.1 Downloading the Eclipse Installation Packages

Procedure

1. Download the Eclipse installation package corresponding to your operating system from eclipse.org .2. Unzip or open the Eclipse installation package.

Results

In the selected target folder, the Eclipse folder that contains all files of the downloaded Eclipse installation is created.


Step-by-Step Procedure

http://help.sap.com/disclaimer?site=http://www.eclipse.org/downloads/

6.1.2 Downloading the ABAP Development Tools Installation Packages

Procedure

1. Download the appropriate Eclipse-based installation packages of ADT from the SAP Software Download Center on the SAP Service Marketplace .

NoteA new version of ABAP Development Tools has been announced through an SAP note that provides an installation guide. In this document you will find detailed information regarding for which Eclipse version the ADT installation package is supported.

2. In your file system, create a new update site folder (for example, 'update site').3. Create a new subfolder (for example, 'ADT').4. In the subfolder, unzip or open the installation package.

Figure 1: Subfolder structure after extraction5. Copy and paste the compositeContent.xml and compositeArtifacts.xml files to your 'update site' folder.

Figure 2: Subfolder structure after pasting the XML files into your update site folder

NoteDo not rename these files. If you do, the update site will not work correctly.

Results

In the installation package, the following folders and files are added:

● Features and plugins folders

Configuring an Update Site for Providing Installation Packages of ABAP Development ToolsStep-by-Step Procedure © 2014 SAP SE or an SAP affiliate company. All rights reserved. 9

http://help.sap.com/disclaimer?site=https://support.sap.com/

http://help.sap.com/nw74

● Artifacts and content jar files● index.html (not needed for the update site to work)

Now you have collected the files for testing the local connection to the update.

6.2 Creating the Update Site Data

You want to provide installation packages for ABAP Development Tools (folder 'ADT') SAP. For this you need one artifact and one content XML file that define for each installation package the file location in the child tag.

6.2.1 compositeContent.xml

The compositeContent.xml file defines the metadata of the update site.

<?xml version='1.0' encoding='UTF-8'?><?compositeMetadataRepository version='1.0.0'?><repository name='Eclipse Update Site'...type='org.eclipse.equinox.internal.p2.metadata.repository.CompositeMetadataRepository' version='1.0.0'> <properties size='1'> <property name='p2.timestamp' value='1243822502499'/> </properties> <children size='2'> <child location='ADT'/> </children></repository>

6.2.2 compositeArtifacts.xml

The compositeArtifacts.xml defines the content and file location of the update site:

<?xml version='1.0' encoding='UTF-8'?><?compositeArtifactRepository version='1.0.0'?><repository name='Eclipse Update Site'...type='org.eclipse.equinox.internal.p2.artifact.repository.CompositeArtifactRepository' version='1.0.0'> <properties size='1'> <property name='p2.timestamp' value='1243822502440'/> </properties> <children size='2'> <child location='ADT'/> </children></repository>



6.2.3 Adding Additional Update Sites

If you want to add other update sites, for example SAP UI5, you can do this through additional child location entries in both XML files as follows: <child location='UI5'/>

6.3 Testing the Update Site Locally

You can test whether your local update site finds the update files.

Procedure

1. Open a standard Eclipse installation.

2. In the Menu bar, choose Help Install new Software .3. In the Work with field, enter the path of the update site.

Start your entry with 'file:' Example: file: C:\Users\Tester\Desktop\update-site4. Press Enter to confirm.


Results

In the Install wizard, the ABAP Development Tools for SAP NetWeaver updates are provided:

Figure 3: Example of an installation wizard for selecting ADT updates



6.4 Copying the Content from the Update Site Folder to the Target Folder

You need to copy your content from the local drive to the file share or web server where you provide the installation content. Hence, the users (for example, ABAP developers) can download the updates and add them directly in their standard Eclipse client.

Context

TipIn addition, you can test the connection if the installation packages are available from the new URL as you have tested it from the local drive.

If the URL cannot be resolved in the Install Wizard in Eclipse, check the proxy settings you can find in Preferences General Network Connections . Here you have to enter your company-specific values.

Results

The update site, in the case of a Web server, is accessible through an http URL. In the case of a file share, the content is accessible through a file URL. In either case, remember the URL because you will need it in the chapter Configuring the Base Installation [page 13].

6.5 Configuring the Base Installation

A user can add the Eclipse-based SAP software packages to an existing standard Eclipse installation that they may already have on their machines. Or you, as administrator, can provide an installation package that contains an Eclipse installation as well as the Eclipse-based SAP installation packages.

Context

The latter option above ensures that you can control the distributed Eclipse version in your company. Another advantage is that you can simplify the installation process for your users.


NoteThis creation process needs to be repeated on every platform for which you want to provide installation packages, that is, you create a Windows installation on a Windows machine, a Linux package, on Linux, and so on.

Procedure

1. Download an Eclipse installation package, for example, the ‘Eclipse Standard’ package, from the download section of Eclipse.org .

NoteDownload the Eclipse version corresponding to the operating system used.

2. Install Eclipse on your local drive.3. Run Eclipse.

NoteWhen you start Eclipse, a workspace path is required. Make sure you create the workspace path outside of the installation folder. Otherwise your user data might be added to the installation package.

4. In case you need special proxy settings (see the chapter Copying the Content from the Update Site Folder to the Target Folder [page 13]), add them in Preferences General Network Connections .

5. Install the required Eclipse features from the Help Install New Software menu.

NoteTo install all the prerequisites for ABAP Development Tools, see further information in the chapter

Installation Installation of ABAP Development Tools Installing the ABAP Development Tools package of the current ABAP Development Tools for SAP NetWeaver installation guide.

6. In the same Install New Software dialog, enter the URL from the chapter Copying the Content from the Update Site Folder to the Target Folder [page 13]

NoteThis URL needs to be kept stable. Otherwise your users' connection to the update site will be lost.

7. From the Windows Preferences menu, open the Preferences dialog.8. Enter 'install' and search for the Automatic Updates. Here you select the Automatically find new

updates and notify option.



http://help.sap.com/disclaimer?site=http://www.eclipse.org

Figure 4: Automatic Updates option in order to hint to the user that a new update is available9. In the installation folder, create a ZIP file from the Eclipse installation.

NoteIf you are working on a Linux or Mac system, you should create a tar or tar.gz file that preserves file permissions.

10. Copy the ZIP file onto your file share or web folder.

Results

You have created a fully configured Eclipse installation that contains the added SAP Eclipse-based packages. After creating and uploading the ZIP file you can now link the ZIP file to your update site.

NoteIf you want to further automate this process of creating a base installation, you can use - for example - the Eclipse 'P2 Director' tool. This avoids the platform restrictions mentioned above, which means you can automatically create Windows, Linux, and Mac installations all on one Windows machine. The usage of this tool is beyond the scope of this document and legal liability of SAP.


6.6 Creating the Update Site as an HTML Page

You have to create a website (index.html) that provides the links to the installation packages. Ensure that the links therein refer to the corresponding installation files.

Results

Now, users can download the fully configured base installation or update an existing Eclipse installation via the Installation dialog from your internal update site.

6.7 Rolling out the Update Site

Finally, you have to inform the users about the availability of the update site.

Context

Users can then use the update site in one of the following ways:

● Downloading the complete installation package: This is the preferred option and it allows automatic updates. Here, the URL of the update site is preconfigured in Eclipse.

● Using the update site URL on the basis of an existing Eclipse installation: In the Eclipse case, users can install ABAP Development Tools through Help Install New Software , as described above. From then on they can update the installed tools using Help Check for Updates , or turn on automatic updates, as described above.



Important Disclaimers and Legal Information

Coding SamplesAny software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP intentionally or by SAP's gross negligence.

AccessibilityThe information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be a binding guideline on how to ensure accessibility of software products. SAP in particular disclaims any liability in relation to this document. This disclaimer, however, does not apply in cases of wilful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of SAP.

Gender-Neutral LanguageAs far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.

Internet HyperlinksThe SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for transparency (see: http://help.sap.com/disclaimer).

Configuring an Update Site for Providing Installation Packages of ABAP Development ToolsImportant Disclaimers and Legal Information © 2014 SAP SE or an SAP affiliate company. All rights reserved. 17

http://help.sap.com/disclaimer/

www.sap.com/contactsap

© 2014 SAP SE 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 SE or an SAP affiliate company. The information contained herein may be changed without prior notice.Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary.These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company 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 SE (or an SAP affiliate company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies.Please see http://www.sap.com/corporate-en/legal/copyright/index.epx for additional trademark information and notices.

http://www.sap.com/contactsap

http://www.sap.com/corporate-en/legal/copyright/index.epx

http://www.sap.com/corporate-en/legal/copyright/index.epx