aak tool version 4.0

Add-On Assembly Kit

Documentation

Version 4.00

For add-ons based on • SAP Basis 4.6C

• SAP Web Application Server 6.10

• SAP Web Application Server 6.20

• SAP NetWeaver 2004

• SAP NetWeaver 2004s

Document version: 1.00, June 1, 2006

SAP AG Dietmar-Hopp-Allee 16 69190 Walldorf Germany T +49/18 05/34 34 24 F +49/18 05/34 34 20 www.sap.com

© Copyright 2006 SAP AG. All rights reserved. HTML, XML, XHTML and W3Care trademarks or registered

trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology.

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.

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.

Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. MaxDB is a trademark of MySQL AB, Sweden. Microsoft, Windows, Outlook, PowerPoint, and SQL Server are registered trademarks of Microsoft Corporation.

SAP, R/3, mySAP, mySAP.com, SAP NetWeaver, xApps, xApp, 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 information purposes only. National product specifications may vary.

IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, Informix, i5/OS, POWER, POWER5, OpenPower and PowerPC are trademarks or registered trademarks of IBM Corporation. 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.

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.

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 of Citrix Systems, Inc.

Typographic Conventions Icons

Type Style Description

Example Text Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options.

Cross-references to other documentation

Example text Emphasized words or phrases in body text, graphic titles, and table titles

EXAMPLE TEXT Technical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE.

Example text Output on the screen. This includes file and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools.

Example text Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation.

<Example text>

Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system.

EXAMPLE TEXT Keys on the keyboard, for example, F2 or ENTER.

Icon Meaning

Caution

Example

Note

Recommendation

Syntax

Add-On Assembly Kit

4 01.06.06

Contents Add-On Assembly Kit .......................................................................6

1 About this Document..........................................................................8 1.1 Naming Conventions ........................................................................... 10 1.2 New Features in Version 4.00.............................................................. 11

2 Background Information: Add-Ons.................................................15 3 Software Component Layers ...........................................................17 4 Procedure: Add-On Assembly Kit ...................................................21 5 Determining the Delivery Strategy ..................................................22

5.1 Modifications and Their Consequences............................................. 23 6 Determining Namespaces ................................................................25

6.1 Rules for Namespaces......................................................................... 26 6.2 Reserving Namespaces ....................................................................... 27 6.3 Add-On Software Component ............................................................. 28 6.4 Add-On Release Name......................................................................... 28 6.5 Naming Conventions for Delivery Requests...................................... 30

7 Creating the System Landscape and the Systems........................32 7.1 System Landscape for Developing Add-Ons..................................... 32

7.1.1 Creating the Development Landscape for the First Add-On Release ........................33 7.1.2 Creating Development Landscapes for Other SAP Releases....................................33

7.2 System Landscape for Maintaining Add-Ons .................................... 37 7.2.1 Creating Systems for Add-On Maintenance ...............................................................38

7.3 Developing Multiple Add-Ons in a Single System Landscape ......... 39 7.4 Client Layout and Transport Routes .................................................. 41 7.5 Installing Add-On Assembly Kit.......................................................... 43 7.6 Making Settings for the Development and Consolidation System .. 44

7.6.1 Entering the Namespace and Defining the Namespace Role ....................................44 7.6.2 Creating or Updating the Add-On Software Component and the Add-On Release Name....................................................................................................................................45 7.6.3 Setting the System Change Option ............................................................................46 7.6.4 Setting Parameters for the Transport Control Program tp..........................................47 7.6.5 Setting the Parameters LANGUAGE and LSM ..........................................................48

7.7 Making Settings for the Maintenance Systems ................................. 49 7.8 Upgrading the Development and Maintenance Landscape.............. 49 7.9 Test Systems ........................................................................................ 50

8 Developing the Add-On ....................................................................51 8.1 Creating and Assigning Packages (Transaction SE80) .................... 51 8.2 Rules for Developing Add-Ons ........................................................... 51

8.2.1 Rules for Developing Add-Ons in Multiple SAP Releases..........................................53 8.3 Rules for Developing a Modifying Add-On......................................... 54

Add-On Assembly Kit

01.06.06 5

8.4 Additions to the Enhancement Procedure and Modifications Topic............................................................................................................ 55 8.5 Documentation and Translation.......................................................... 57

9 Delivery of the Add-On Software.....................................................59 9.1 Package Types ..................................................................................... 60 9.2 Final Assembly System ....................................................................... 63 9.3 Creating a Delivery............................................................................... 64

9.3.1 Object List Checks......................................................................................................67 9.4 Creating an Add-On Installation Package .......................................... 70 9.5 Making a Delivery Available ................................................................ 70

9.5.1 Template: Installation Instructions ..............................................................................71 9.6 Delivering Languages that are Translated Later ............................... 73

10 Maintenance and Upgrade .............................................................78 10.1 Rules for Add-On Maintenance ......................................................... 78 10.2 Creating Maintenance Packages....................................................... 79

10.2.1 Creating an Add-On Support Package .....................................................................79 10.2.2 Creating a Conflict Resolution Transport..................................................................80

10.3 Creating an Add-On Upgrade Package (Upgrading the Add-On Software)..................................................................................................... 82 10.4 Add-On Behavior During an SAP System Upgrade......................... 83 10.5 Ending Maintenance .......................................................................... 86

11 Additional Information....................................................................87 11.1 Overview: Installation Tools.............................................................. 87 11.2 Conflicts.............................................................................................. 88

11.2.1 Background Information: Conflict Check ..................................................................88 11.2.2 Conflicts When Installing/Upgrading an Add-On ......................................................89 11.2.3 Conflicts When Importing Support Packages ...........................................................92

11.3 CD for the Add-On Delivery............................................................... 93 11.4 Troubleshooting ................................................................................. 95 11.5 Paths to Documentation in SAP Help Portal.................................... 96 11.6 Terminology...................................................................................... 101

1 About this Document

Add-On Assembly Kit Purpose You can use Add-On Assembly Kit to develop industry, country or enterprise-specific enhancements to the SAP standard, as well as customer and partner projects, while using the options offered by add-on technology. Add-On Assembly Kit provides you with a set of tools that you can use during the entire lifecycle of your add-on.

With its extensive documentation, Add-On Assembly Kit helps you to ensure the quality of your development during the planning phase, and provides you with tools for delivery assembly and installation. You can also use Add-On Assembly Kit to further update and maintain your software.

Features Documentation Add-On Assembly Kit documentation describes the following steps for the add-on delivery: ...

1. Determining the delivery strategy

Here, you need to answer questions, such as:

○ Which SAP release is your development based on?

○ Does your development make any modifications to the SAP standard?

○ What does your maintenance and upgrade strategy look like?

By answering these questions you can quickly establish a framework for the delivery of your add-on.

2. Determining namespaces

By working in a namespace that is protected by SAP, you are making sure that your development does not conflict with developments of other vendors or SAP after delivery. This is the first step in providing quality assurance for your add-on.

3. Setting up the system landscape

The way you create the system landscape for your add-on development depends on the delivery strategy you have chosen. In this step, you also install the Add-On Assembly Kit tools in your system landscape.

4. Developing the add-on

In this step, you perform the actual software development in the systems that have been set up for it. The documentation contains a list of rules suggesting how you can avoid errors during development.

5. Delivering the add-on

The tools included in Add-On Assembly Kit assist you when assembling the delivery and packing software into installable packages.

6. Maintenance and upgrade

You can also use Add-On Assembly Kit when maintaining and upgrading your add-on. You can use the tools in Add-On Assembly Kit to create installable packages, to remove errors in your add-on, to update your add-on or to make it work in a higher SAP release.

6 01.06.06


Tools Software Delivery Composer (transaction SSDC) collects all the parts of your development that are delivery-relevant, checks if they are consistent and correct, and assembles them for delivery.

Software Delivery Assembler (transaction SSDA) packs the delivery into a package format that can be imported. You can also use Software Delivery Assembler to define import conditions that set the prerequisites for importing the packages correctly.

You use SAP installation tools to import these packages. The appendix contains an overview of the installation tools [Page 87].

01.06.06 7


1 About this Document Validity This document provides an overview of the process for creating an add-on using Add-On Assembly Kit:

Add-On Assembly Kit 4.00 is available for SAP components that are based on the following SAP Basis / SAP Web AS / SAP NetWeaver releases:

● SAP Basis 4.6C

● SAP Web Application Server 6.10

● SAP Web Application Server 6.20

● SAP NetWeaver 2004 (SAP Web Application Server 6.40)

● SAP NetWeaver 2004s (SAP NetWeaver AS 7.00)

Note that you can only use Add-On Assembly Kit for ABAP developments.

Target Groups This documentation has been created with the following target groups in mind:

● Producers of add-ons who create add-ons for their own company or for customers.

● System administrators who build the systems for add-on development and maintenance.

● Software developers who are involved in add-on development.

● Producers who create the add-on packages using the tools in Add-On Assembly Kit.

Prerequisites To work with Add-On Assembly Kit, you need to be acquainted with the following topics:

● Installing SAP systems

For more information, see SAP Service Marketplace, under service.sap.com/installation.

● Copying systems

For more information, see SAP Service Marketplace, under service.sap.com/systemcopy.

● System landscape (Change and Transport System)

For details, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Logistics → Change and Transport System.

● Basic knowledge of ABAP programming

For more information, see SAP Help Portal, under help.sap.com →

8 01.06.06


○ Documentation → SAP NetWeaver 2004s → German → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Programming and Runtime Environment (BC-ABA)

○ Documentation → SAP NetWeaver 2004s → German → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench (BC-DWB)

● ABAP software maintenance

For details, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Maintenance.

● Documentation and translation tools

For details, see SAP Help Portal under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → Documentation and Translation Tools.

Overview of SAP Notes The following SAP Notes can be helpful when working with Add-On Assembly Kit. They are referred to at various points in this documentation.

● General SAP Notes about Add-On Assembly Kit:

Note Number Description

329731 Add-On Assembly Kit – Documentation Additions

921103 Installation/Upgrade Add-On Assembly Kit 4.00

567695 Password Required to Import Add-On Packages

● Notes on Software Delivery Composer:


215176 Software Delivery Composer: General Information

943780 AAK 4.00: Corrections Regarding Software Delivery Composer

215178 Software Delivery Composer: Object List Checks

870407 SDC: Object types that cannot be delivered

● Notes on Software Delivery Assembler:


943901 AAK 4.00: Corrections Regarding Software Delivery Assembler

● Other SAP Notes:


104010 Restrictions on Developments in Namespaces

105132 Reserving Namespaces as of Basis Release 4.0

16466 Customer Name Range for SAP Objects

01.06.06 9


195442 Language Import and Support Packages

212876 New Archiving Tool SAPCAR

Integration This document describes the processes that you need to work through when creating add-ons with Add-On Assembly Kit.

For details about the tools in Add-On Assembly Kit, see the online documentation for the tool in question. You can view this by choosing the help function on the toolbar.

1.1 Naming Conventions Paths to Documentation in SAP Help Portal.

If the present documentation contains links to documentation in SAP Help Portal help.sap.com, the specified paths apply for release SAP NetWeaver 2004s.

help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Logistics → Change and Transport System.

For lower releases, see the list of paths to documentation in each release [Page 96] in the appendix.

If the documentation is installed in your system, you can also call it by choosing Help → Application Help. This calls up the relevant documentation directly.

Development Class and Package

In SAP Web Application Server 6.10, development classes were renamed as packages and now contain additional functions. For further information about the package concept, see help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench → ABAP Workbench: Tools → Package Builder.

In this documentation, only the term package is used. For SAP Basis 4.6C, you have to replace the term package with development class.

Add-On Support Package (AOP) and Component Support Package (CSP)

As of SAP NetWeaver ’04, Add-On Support Packages (package type AOP up to SAP Web AS 6.20) are registered as Component Support Packages (package type CSP). This does not have any technical consequences.

To keep things simple, this documentation refers to both packages as Add-On Support Packages.

10 01.06.06


1.2 New Features in Version 4.00 General Version 4.00 of Add-On Assembly Kit is the first version to support SAP NetWeaver 2004s (SAP NW AS 7.00).

Software Delivery Composer ● The functions Create/Change/Display Delivery and Delivery for Delivery Request →

Register are no longer next to each other on the Software Delivery Composer start screen; instead they are on top of each other. There is a direct link to the latest note on Software Delivery Composer.

● During creation of the delivery, it is no longer possible to freely select the delivery component. Instead, the system determines the delivery component from the prefix in the delivery name.

● During request selection, in the function for selecting change requests, three new options have been added under With Any Selection. These are Transport Target, Owner and Short Description.

● You can choose the export languages for the delivery request. Previously, the settings were copied over from the Transport Management System.

● Object List Checks

○ The following new object list checks have been added:

■ Extended DDIC check

A check to ensure that only consistent dictionary objects are delivered, for example only active dictionary objects.

■ Required objects

For Installation/Upgrade type deliveries, the system checks that all definitions of packages/development classes and namespace definitions are included in the delivery for which there are objects in the delivery request.

For all delivery types, a check is made to see whether packages/development classes and namespace definitions are included in the delivery, for which there are no objects in the delivery request. For all namespaces in the delivery request, a check is made to see whether a valid repair license exists.

○ The following object list checks have been modified:

■ Table entries: Generic transport

The check now only lists table content according to the following generic categories: All contents of table, language-dependent table content, client-specific table content, or client-specific and language-dependent table content. Previously, all table content was listed for which a wildcard (*) was used at the end of the table entry.

■ Table entries: Delivery relevance/delivery behavior The error severity display and the corresponding message texts have been modified.

01.06.06 11


■ (Non-Permitted) Modifications and Deliverability

The check now also finds inconsistent number range objects, and includes that start with ‘L’ (for which no function group exists).

■ Description of the software component (LANG VERS) required

This check has been adapted to take account of the export language selection. The check indicates missing software component descriptions for languages that have been selected as export languages.

■ Table entries in the customer area (protected by TRESC)

The check now only lists key entries or logical objects for which there are also entries in the system. The error severity has also been modified. Instead of errors, the check now displays warnings.

■ Forbidden objects

The check now includes a number of new forbidden objects. For a list of these forbidden object types, see SAP Note 870407.

■ Delivery of software components (R3TR VERS) forbidden

This check is no longer a free-standing check, as it has been incorporated into the Forbidden Objects check.

○ Additional changes to the object list check framework:

■ All checks now have a status display that includes the end date and end time of the most recent check.

■ The display options for the results overview have been removed from the Selection of Checks dialog box. These can now be displayed in the results overview of the object list checks, by choosing Settings → Displayed Categories/Options.The result list for the object checks can now be saved for subsequent processing.

■ Check results can now be set to Completed.

■ Whenever a check is performed, the system now displays all previous activities in connection with this check in the result overview.

■ Object list checks can now be performed in the background.

■ In Installation/Upgrade deliveries, the component piece list and the exchange component piece list can also now be checked. Previously, this was only possible for the change piece list.

● When creating the Installation/Upgrade delivery type for add-ons based on SAP Web AS 6.20 and higher, you can now – in addition to the change piece list and the component piece list – create an exchange component piece list for the add-on exchange upgrade (add-on release change during SAP system upgrade). You then register the exchange component piece list in Software Delivery Assembler as either an AOU with the extended attribute CREATE_FULLTASK = T or as an Add-On Exchange Package (AOX), depending on the SAP release.

The introduction of the exchange component piece list means that, as of SAP Web AS 6.20, you can now create two upgrade packages for your add-on release: a package for the add-on delta upgrade (updates your add-on at the same time without a simultaneous SAP system upgrade) and a package for the add-on exchange upgrade.

● Various input helps in Software Delivery Composer have been modified.

12 01.06.06


● With Installation/Upgrade deliveries, subobjects in your software component are now converted into whole objects in the change piece list too. This helps to ensure consistency, as the delivery of subobjects can lead to problems during an add-on delta upgrade. Previously, this was only done in the component piece list.

● The short description of the delivery requests has been revised.

Software Delivery Assembler ● Extended attribute EQUIVALENT has been added.

If your add-on is developed and maintained in several SAP releases in parallel, you can use this attribute to set the relationship between Support Packages and CRTs from various releases. By doing this, you can ensure that a correction in a Support Package is also available in the higher release following an SAP system upgrade. For more information about using this attribute, see the online documentation for Software Delivery Assembler.

● Extended attribute MULTISTEP_INSTALL has been added.

If you set this attribute, the import queue can contain a prerequisite add-on installation package or add-on upgrade package from the same component, or an add-on upgrade package from a different component. Normally, only one add-on installation package or add-on upgrade package is allowed per queue.

You can use this attribute if you are only creating add-on upgrade packages for an add-on installation package. This helps you to ensure that a customer who wants to implement a higher release of your add-on is able to import the necessary packages in a queue at the same time.

In certain circumstances, it might also be necessary for an add-on upgrade package to be imported in a queue at the same time as an add-on upgrade package from another software component, in order to prevent conflicts. You can also use attribute MULTISTEP_INSTALL in this case.

● In Add-On Assembly Kit 3.51, Support Package type Component Support Package (CSP) has been introduced (available for Support Packages as of SAP NetWeaver ´04). This is used for collections of error corrections to the add-on. It replaces Support Package type Add-On Support Package (AOP) that was valid up to and including SAP Web AS 6.20. This does not entail any technical changes.

● In SAP NetWeaver 2004s, upgrade package type Add-On Exchange Package (AOX) was introduced. This package type is used for the add-on exchange upgrade and is created from the exchange component piece list. It replaces the package type Add-On Upgrade Package (AOU) with extended attribute CREATE_FULLTASK = T that was valid in SAP Web AS 6.20 and 6.40.

● The system now creates a log of all activities performed for each package. The log also contains error messages and is also available for deleted packages.

Documentation ● All updated functions and new functions in Add-On Assembly Kit 4.00 have been

documented.

● Information for SAP NetWeaver 2004s, such as updated paths to further documentation, has been added.

● The new section Conflicts describes conflicts that may arise with modifying add-ons when add-on packages and Support Packages are imported.

01.06.06 13


● The new section Creating the Development Landscape for Other SAP Releases

describes how to set up an additional development landscape if your add-on supports several SAP releases.

● The new section Rules for Developing Add-Ons in Multiple SAP Releases contains rules and recommendations for simultaneous development in several SAP releases.

● The section Add-On Release Name now contains recommendations for determining the add-on release name.

● The section Namespaces has been modified.

● The section Add-On Behavior During an SAP System Upgrade has been modified.

14 01.06.06

2 Background Information: Add-Ons

2 Background Information: Add-Ons An add-on consists of a sequence of transport requests that are assembled into a single delivery package. During the import, the add-on is registered as a supplementary software component in the system.

Add-ons are developed in separate systems on the basis of a particular SAP release. The functions of the add-on are based on the functions of SAP main/application components.

An add-on can contain the following objects:

● Newly developed add-on objects

● Add-on-specific Customizing

● Modified objects belonging to SAP main/application component, if you have to adjust certain functions to match the requirements of the add-on (SAP application components only).

Add-ons are not allowed to modify SAP Kernel objects or SAP Basis objects, and are not dependent on a specific database or operating system.

Add-ons are installed in the SAP system by SAP Add-On Installation Tool. The add-on installation is dependent on the SAP release and possibly also on the Support Package level of the installed components on which your add-on development is based. This also applies for add-on upgrades.

Add-On Package Types With Add-On Assembly Kit, you can create the following package types [Page 60]:

● Add-On Installation Package (AOI)

● Add-On Upgrade Package (AOU)

● Add-On Support Package (AOP up to SAP Web AS 6.20 or CSP from SAP NetWeaver ´04)

● Add-On Exchange Package (AOX) from SAP NetWeaver 2004s

● Conflict Resolution Transport (CRT)

Advantages of Delivering Software as Add-Ons You can deliver software that is supplementary to the SAP standard in different ways, namely:

● In the form of transport requests

● As add-ons

Compared to the alternative of delivering software with transport requests, add-ons offer the following advantages:

● Information about installation prerequisites

● Information about the installation sequence

● Conflicts with other software components can be resolved

● Conflicts with customer modifications can be resolved

● The installation or upgrade process is guaranteed

01.06.06 15

2 Background Information: Add-Ons

● Anonymization of the objects

● Visibility of the delivered software status

16 01.06.06

3 Software Component Layers

3 Software Component Layers Software Component Layers in SAP Web AS 6.10 and Lower In releases up to and including SAP Web AS 6.10, software components in SAP systems belong to one of two layers.

● Layer for the main components (SAP_BASIS, SAP_ABA, SAP_HR, and so on)

● Layer for the add-ons (plug-ins, industry solutions, development projects, customer and partner add-ons and so on).

As a result, all types of add-ons are processed in the same way. It is not possible to define dependencies within the add-on layer or to define add-ons as prerequisites for other add-ons.

Software Component Layers in SAP Web AS 6.10 and Lower

Add-Ons

Main Components

A

‘ ‘

BasisBasis

ABA, APPL, HR, CRM, BW , ...ABA, APPL, HR, CRM, BW , ...

Industry Solutions, Industry Solutions, PlugPlug -- Ins, Development Projects,Ins, Development Projects,Customer and Partner AddCustomer and Partner Add -- OnsOns

......

CVERS

Software Component Hierarchy in SAP Web AS 6.20 and Higher To create better options for processing add-ons, SAP has implemented an extended software component hierarchy for SAP R/3 Enterprise (based on SAP Web AS 6.20). This hierarchy consists of two layers of mandatory (fixed) software components and four layers of optional software components. Mandatory software components can be included in an SAP system only by a system installation or a system upgrade. Optional software components can be installed at a later stage.

The software component hierarchy only allows references of add-ons from a higher layer to a lower layer (from layer C to layer I, for example).

Add-ons created with Add-On Assembly Kit always belong to layer C.

01.06.06 17


Software Component Hierarchy Layers in SAP Web AS 6.20

Industry Solutions, Countr y Versions,...

Customer and Partner Add-Ons

Enterprise Extension Set

Plug-In Components

Application Components

Web AS Components

C

I

N

P

R

SSAP_BASISSAP_BASISSAP_ABASAP_ABA

Enterprise ExtensionsEnterprise Extensions

EAEA -- APPLAPPL EAEA -- FINSERVFINSERVEA-HR......

SAP_APPLSAP_APPL SAP_HRSAP_HR SAP_BWSAP_BW BBPBBPCRMCRM ...

PIPI WPWP --PIPI ...

......

IBUsIBUs ......

Development ProjectsDevelopment Projects

The software component hierarchy distinguishes the following layers:

Mandatory Software Components (Main Components) ● Web AS Components (Layer ‘S‘)

The components in the SAP Web Application Server (SAP_BASIS and SAP_ABA) belong to this layer.

● Application Components (Layer ‘R’)

This includes all software components of an SAP system that are not installed at a later stage and that are not part of the SAP Web AS belong to this layer (SAP_APPL, SAP_HR, SAP_APO, and SAP_BW, for example). These components enter a system or are removed from it only through an upgrade.

Optional Software Components (Add-On Components) ● Plug-In Components (Layer ‘P’)

Plug-in components are add-ons that provide functions that are used by a large number of other components and that are not application-specific. An example is the PI plug-in.

● Enterprise Extensions (Layer ‘N‘)

Add-ons that extend the core functions of an SAP system belong to this layer. The main aim is to deliver new functions for application components in a shorter cycle than is possible for complete system releases.

● Industry Solutions and Country Versions (Layer ‘I‘)

Add-ons that are used to adjust the application components, installed plug-ins, and enterprise add-ons to the requirements of specific industries or countries belong to this layer. These add-ons can also contain additional functions that are needed by only a small number of customers.

18 01.06.06


● Development Projects (Layer ‘C‘)

This layer comprises all add-ons that cannot be assigned to other layers, such as customer and partner add-ons.

Software Component Hierarchy in SAP NetWeaver ´04 and Higher The software component hierarchy introduced in SAP Web AS 6.20 had six layers. It has been further extended or modified for SAP NetWeaver ´04. The Basis Plug-In component (PI_BASIS) is now part of SAP NetWeaver and is therefore located in a separate layer on which the application components sit. SAP_BW is also now part of SAP NetWeaver. The layer for industry solutions and country versions has also now been extended into a number of interrelated layers. This optimizes the mapping of dependencies between Industry Business Solutions or country versions.

Layers in the software component hierarchy for SAP NetWeaver

E

Industry Solutions ,Country Vers ions …

Applicatio n Co mpo nents

C

I

N

P

R

SAP_Basis

SAP_APPL SAP_HR...

Applicatio n Plu g-In C omp onentsPI ...

SAP NetWeaver Basis Co mp onentsSAP_ABA

SAP NetWeaver Add-On ComponentsSAP_BW ...

SAP NetWeaver Plug- In Co mpo nentsPI_BASIS ...

S

X

W

Applicatio n ExtensionsApplicatio n Extensions

EA-APPL...

...

Shared Ob jects for App lication Extensions...O

GH

F

Customer and Partner Add-OnsDevelopment Pro jects ...

...

...

...

... Layer 1Layer 2

Layer 3Layer 4Layer 5

EA-HR

... Application Platform Components (SAP NW 2004s & higher)V SAP_AP

SAP_BASIS

The software component hierarchy distinguishes the following layers:

SAP NetWeaver Software Components ● NetWeaver Basis Components (Layer ‘S‘)

The components SAP_BASIS and SAP_ABA belong to this layer.

01.06.06 19


● NetWeaver Plug-In Components (Layer ‘X’)

The Basis Plug-In components in SAP NetWeaver belong to this layer. A typical example is PI_BASIS.

● NetWeaver Add-On Components (Layer ‘W’)

Other add-on components in SAP NetWeaver belong to this layer. A typical example is SAP_BW.

● NetWeaver Application Components (Layer ’V’)

(Valid in SAP NetWeaver 2004s and higher)

The components in the NetWeaver application platform, such as SAP_AP, belong to this layer.

Other Software Components Based on SAP NetWeaver ● Application Components (Layer ‘R’)

This layer includes all software components that are not part of the SAP NetWeaver platform and contain the core functionality of the SAP ECC system, such as SAP_APPL and SAP_HR. These components cannot be installed in a system subsequently, and can only be updated by means of an SAP system upgrade.

● Application Plug-In Components (Layer ‘P’)

This includes add-ons that deliver functionalities that are used by multiple components and are not specific for any single application. An example is the PI plug-in.

● Application Extensions (Layer ‘N‘)

Add-ons that contain or extend the core functions of an SAP system belong to this layer.

● Industry Solutions and Country Versions (Layers ’E’‚ ’F’‚ ’G’‚ ’H’ and ‘I‘)

This includes add-ons that contain additional functionalities or are used to adapt application components or any installed plug-ins and application extensions to the needs of specific industries or countries. These add-ons are assigned to one of the five layers so that they can be set on top of each other.

● Development Projects (Layer ‘C‘)

This layer comprises all add-ons that cannot be assigned to other layers, such as customer and partner add-ons. Add-ons created with Add-On Assembly Kit always belong to layer C.

20 01.06.06

4 Procedure: Add-On Assembly Kit

4 Procedure: Add-On Assembly Kit The following graphic provides an overview of the procedure for creating an add-on using Add-On Assembly Kit:

Add-On Creation

Determine Delivery Strategy

Determine Namespaces

Create System Landscape

Carry Out Development

Compose Delivery(Software Delivery Composer)

Create Delivery Package(Software Delivery Assembler)

Deliver Add-On

Update and Maintain Add-On/Upgrade or Keep Add-On During

Upgrade to New SAP Release

...

1. Determining the Delivery Strategy [Page 22]

2. Determining the Namespaces [Page 25] (for development objects and add-on software component)

3. Creating the System Landscape and the Systems [Page 32]

4. Developing the Add-On [Page 51]

5. Delivering the Add-On Software [Page 59]

6. Maintenance and Upgrade [Page 78]

01.06.06 21

5 Determining the Delivery Strategy

5 Determining the Delivery Strategy Before creating the system landscape, you need to make certain decisions in order to define your delivery strategy:

● Which SAP standard release do you want to develop the add-on in?

Choose the SAP release in which you want to develop the add-on. Information on the operating system and database is not relevant here, since the add-on must be developed independently of databases and platforms.

● How are other SAP releases supported?

We recommend that you always create non-release specific add-ons. This means that you must develop your code so that it can run in all supported SAP releases without being modified. You should be careful not to use any syntax that will not be supported in later releases. Although you need a development landscape for each supported SAP release, you can transport your development into the other releases without difficulty.

● Are modifications to the SAP Standard necessary?

If your add-on modifies objects in the SAP System and delivers these modifications, it is a modifying add-on. Modifications have consequences during the various phases of the add-on's lifecycle. For information about the consequences of modifications, see Modifications and their Consequences [Page 23] and Conflicts [Page 88].

We recommend that you always create add-ons without modifications.

● What is your maintenance strategy for the customer delivery?

If you are developing a modifying add-on, you are dependent on the maintenance cycle of the modifying component. You need to react to all SAP Support Packages that have conflicts with the add-on.

Non-modifying add-ons are independent of the SAP maintenance cycle. You can create Support Packages as and when required. If you do this, however, you need to define a delivery cycle for your Support Packages in advance.

● What is your upgrade strategy?

You need to define an upgrade strategy for your add-on before you start developing it.

You need to define how often you want to update your add-on, and how your add-on responds to an SAP system upgrade. Note that your add-on is always dependent on the SAP release cycle, since it must always react to each new release.

Even if you do not want to update your add-on in an SAP system upgrade, you must make sure that the add-on is retained, and that it can run in the new release. To guarantee this, you must test your add-on for each new SAP release. If you do not support a particular SAP release, your add-on customers will not be able to upgrade to this release.

For more information, see Add-On Behavior During an SAP System Upgrade [Page 83] and Ending Maintenance [Page 86].

● Are there any dependencies with other add-ons?

If your add-ons are based on existing add-ons, you need to define dependencies beforehand. This is the case, for example, if you are developing an add-on that has

22 01.06.06


another add-on as a prerequisite. In this case, you need to describe this prerequisite relationship.

● Does your add-on include Customizing settings?

Add-On Assembly Kit supports the delivery of Customizing settings only in BC Sets. This means that you need to define a development/delivery strategy for your Customizing settings alongside your add-on delivery strategy.

● Which languages do you want to deliver your add-on in?

You need to define the languages that you want to make the add-on available in. If you require more than one language, you also need to organize the translation.

5.1 Modifications and Their Consequences Before starting to develop an add-on, you have to check whether your add-on makes modifications to the SAP standard necessary.

For add-ons that were created using Add-On Assembly Kit, modifications to an application component in layer R (SAP Web AS 6.10 or lower) are possible from a technical point of view. However, we strongly recommend that you do not create a modifying add-on, since modifications change the behavior of the entire system. When performing modifications to an object, you must always make sure that other SAP components can still use this object. Modifications therefore create a lot of extra work. They also affect the following areas:

● Add-on development landscape and maintenance landscape

If you have to make modifications, this can affect both the add-on development landscape and the maintenance landscape.

If you are developing non-modifying add-ons, you can develop multiple add-ons in one system, provided that certain prerequisites are met. This is not possible for modifying add-ons. You can only develop one add-on for each development system. (See Developing Multiple Add-Ons in a Single System Landscape [Page 39]).

● Importability

If your customers are using your add-on, they might not be able to import SAP Support Packages into the add-on system, since SAP Support Packages could overwrite the add-on modifications. You usually have to create CRTs.

Neither can you guarantee that customers can install your add-on. If another add-on that modifies the same objects is already installed in the system, it will not be possible to install your add-on. By the same token, it might be impossible to install other add-ons that modify an object if your add-on modifies the same object and is already installed. For more details about this, see Conflicts with Add-On Components from the Same Layer in Conflicts when Installing/Upgrading an Add-On [Page 89].

● Maintenance

Modifications to SAP standard development objects create a relationship between the add-on development and the SAP standard. This means that you cannot maintain and upgrade the add-on development and the SAP Standard independently of one another.

You need to compare any changes that are transported into the add-on development system as Support Packages with the add-on modifications, and make adjustments as necessary. You have to create Conflict Resolution Transports (CRTs). This is true for each Support Package that SAP creates for the component that has been modified by

01.06.06 23


your add-on, and for each Support Package that has conflicts with the modifications you have made. This procedure is error-prone. This also makes your add-on dependent on the SAP maintenance cycle, since you have to repeat this procedure until the end of the maintenance cycle of the corresponding SAP release.

Additional Information In many cases, you can avoid using modifications by using enhancement procedures instead, such as Business Add-Ins (BAdIs) or appends. For developments that are based on SAP NW 2004s, the Enhancement Framework can be used. Check these options thoroughly before making any modifications. See Additions to the Enhancement Procedure and Modifications Topic [Page 55].

If modifications are unavoidable, there are certain rules [Page 54] that you need to follow.

For more details, see the information in the Conflicts [Page 88] topic.

24 01.06.06

6 Determining Namespaces

6 Determining Namespaces Use Traditionally, there have been two name ranges in the SAP System. These are the SAP name range for development work at SAP, and the customer name range for customer development work.

However, naming conflicts can arise when add-on producers deliver their add-ons.

A company develops enhancements to standard SAP applications and delivers them to third parties, who may then make their own developments. If the add-on producer and the recipients of the add-on both work in the customer name range, multiple objects might end up having the same name. This leads to naming conflicts, which you must avoid.

A solution to this problem is to make your developments in a separate namespace, reserved exclusively for SAP customers or SAP partners. One of the benefits of developing objects in reserved namespaces is that a license key in the namespace table checks the usage of these objects. This prevents invalid usage of the objects. You can request namespaces in SAP Service Marketplace.

By developing objects in a reserved namespace, you can ensure that all objects in the add-on are given the relevant prefix, which prevents them from conflicting with other development objects that have the same name.

To develop and deliver an add-on, you require the following namespaces:

● Namespace for the development objects

Guarantees that the development objects have unique names.

● Namespace for the add-on software component

Guarantees that the add-on software component is unique.

The name of the add-on software component is formed from the namespace reserved for the add-on software component. The names of the delivery requests (and the resulting packages) are in turn formed from the add-on software component.

The namespace for the add-on software component can be identical with the namespace for the development objects. If, for example, you develop just one add-one and have already reserved a namespace for the development objects, you can also use this namespace for the add-on software component. Note that the name of the add-on software component is visible in the system and is also reflected in the names of the importable add-on packages. You should therefore check which name you want to deliver your packages under.

Before starting developing, you also need to determine the add-on release name, as you always develop an add-on in a certain release.

Additional Information Rules for Namespaces [Page 26]

Reserving Namespaces [Page 27]

Add-On Software Component [Page 28]

Add-On Release Name [Page 28]

01.06.06 25


Naming Conventions for Delivery Requests [Page 30]

6.1 Rules for Namespaces When defining namespaces, be sure to observe the following rules:

General Rules ● Define your namespace between two forward slashes. Your namespace can have

between three and eight characters.

We recommend that you choose a namespace with at least four characters, since three-character namespaces are assigned internally at SAP.

/ABCD/

● Do not use a namespace that has already been reserved for SAP developments:

○ /*SAP*/

○ /IS*/

○ /C<two characters>/

○ /HR<two characters>/

○ /P<two characters>/

● Use capital letters.

Additional Information for Namespaces for the Add-On Software Component To ensure that the add-on software component [Page 28] is unique, its name is derived automatically from the namespace reserved for it. When a delivery is created, the namespace prefix in the delivery name is taken over as the add-on software component.

If the namespace for the add-on software component is /ABCD/, then your add-on software component must be ABCD.

As the name of the add-on software component is visible in the system and is also reflected in the name of the package, you should consider reserving a specific namespace - by which your add-on will then be known - for the add-on software component

Alternatively, you can use the namespace for development objects for the add-on software component. If you have reserved multiple namespaces, you can specify that the name of your add-on software component will be derived from any one of these namespaces.

If you have reserved the namespaces /ABCD1/, /ABCD2/ and /ABCD3/, your add-on software component could be called ABCD2.

26 01.06.06


6.2 Reserving Namespaces Use You need to reserve the following namespaces for your add-on:

● Namespace for the development objects

● Namespace for the add-on software component if this is not identical with the namespace for the development objects.

You can reserve namespaces in SAP Service Marketplace, under service.sap.com/namespaces. The namespaces will be reserved within a few days. You can then release these namespaces for use by entering them in the SAP System. You will receive the license key for your namespace when you register the namespace for your installation number.

Prerequisites To reserve namespaces, you need an ABAP Workbench license authorizing you to make your own developments.

Procedure You can find details of the functions mentioned here in SAP Service Marketplace, under service.sap.com/namespaces.

Reserving a Namespace ...

Choose Create Namespace Request.

When defining the namespace, see the Rules for Namespaces [Page 26] that apply for Add-On Assembly Kit.

To see the current status of the namespace request, choose Status of Namespace Requests.

Generating the Key for the Namespace Choose Generate Key for Namespace. ...

Note that SAP must have already confirmed reservation of the namespace, and that you must have specified this installation number when you reserved the namespace. If you did not specify the installation number when reserving the namespace, you can declare these as permitted installations for the namespace now, by choosing Change Namespace Request → External Assignment. Once you have done this, you can also call the namespace keys for these installation numbers.

To create the delivery [Page 64], you need the development license for the installation number in the consolidation system.

For a detailed description of the processes in these functions (and the relevant authorizations) see the documentation available in SAP Service Marketplace, under service.sap.com/namespaces or in SAP Note 105132.

Remember that after making the reservation, you need to enter the namespace and define the namespace role [Page 44].

01.06.06 27


6.3 Add-On Software Component A software component bundles a set of packages (development classes) that can only be delivered to customers together. All packages are distributed disjunctively among software components. This means that the objects in a package can only be delivered to customers with a software component. You assign objects to a software component by assigning the package to which the objects belong. In general, there are several releases for each software component.

You need the add-on software component in the following situations:

● For assigning packages to the software component

● For creating the delivery and delivery requests with Software Delivery Composer

● For generating importable packages with Software Delivery Assembler

● For importing packages with Support Package Manager or SAP Add-On Installation Tool

To ensure that the add-on software component is unique, its name is derived automatically from the namespace reserved for it. When a delivery is created, the namespace prefix of the delivery name is taken over as the add-on software component.

6.4 Add-On Release Name In general, there are several releases for each software component. The add-on release name structures the add-on development.

Note the following when deciding on the name of your add-on release:

● Use only numbers, uppercase letters and underscores. Do not use periods or any other special characters.

● The name of the release should contain between three and ten characters.

● The name of the release must be in alphanumerically ascending order for ASCII and EBCDIC codes.

Use a format that allows an ascending order and that provides the right results when you compare the release name.

100_46C < 100_620 < 200_620 < 300_700

As the name of the add-on release is reflected in the version name in the delivery request [Page 30] and is restricted to three characters there, you should choose your add-on release name in such a way that a unique version name can be derived from it in the delivery request.

Examples By defining the name of the add-on release according to the examples here, you can make sure that a unique version name can be derived from the release name in the delivery request. For your add-on, choose the case that suits your delivery strategy.

28 01.06.06


● Your add-on release supports multiple SAP releases.

If your add-on supports multiple SAP releases at the same time, for example add-on release 100 supports SAP Web AS 6.20 and 6.40, you can use the following syntax for the add-on release name: <Digit>00_<underlying SAP release>

The first digit can be of your choosing. The second and third should be 0, while position four is an underscore. The subsequent digits reflect the underlying SAP release.

As the version name for the delivery request, you take the first number from the add-on release name and the first two characters in the underlying SAP release.

SAP release name Add-on release name

Version name in the delivery request

46C 100_46C 146

470 100_470 147

500 100_500 150

620 200_620 262

640 200_640 264

640 300_640 364

700 300_700 370

● You create one new add-on release every year.

If you publish exactly one add-on release every year, you can use the following syntax for the add-on release name: <Digit>00_<Year in which the package was created>

The first digit can be of your choosing. The second and third should be 0, while position four is an underscore. The subsequent digits reflect the year in which the package was created.

As the version name for the delivery request, you take the first number from the add-on release name and the two unique characters from the year in which the add-on release was created.

Add-on release name


100_2004 104

200_2004 204

200_2005 205

300_2006 306

● Your add-on release supports exactly one SAP releases.

If a release for your add-on always supports exactly one SAP release, for example add-on release 100 supports SAP Web AS 6.20, add-on release 200 supports SAP

01.06.06 29


Web AS 6.40 and add-on release 300 supports SAP NW AS 7.00, you can use the following syntax for the add-on release name: <Digit><Digit>0

The first two digits are of your choosing, while the third is 0. No other positions are used.

The version name of the delivery request corresponds to the name of the add-on release.

Add-on release name


100 100

110 110

200 200

300 300

450 450

Note that an add-on release must always be developed on a higher SAP release. Ensure that the release name is alphanumerically ascending, as it will not be possible to perform an add-on exchange upgrade if it is not.

Note that before you start developing, you must Enter the Add-On Software Component and the Add-On Release Name [Page 45].

6.5 Naming Conventions for Delivery Requests Delivery requests derive their names from the add-on software component and the add-on release name. This guarantees that the delivery requests and add-on packages are unique.

The name of the delivery requests must correspond to the following syntax:

SAPK-<Version ID><++>IN<Namespace>

Name Component Description

SAPK- Introductory type string

<Version Name> Three-character Add-on/software component release

When creating the delivery requests, Software Delivery Composer proposes the first three characters of the add-on release name as the name of the add-on release, for example100.

You can overwrite this if you want. For examples of how to define the version name, see Add-On-Release Name [Page 28].

<++> Two characters: Supported characters: 0-9 and A-Z

30 01.06.06


We recommend that you choose these two characters in such a way as to identify the delivery request, such as: ...

● CH: Change Piece List

● CO: Component Piece List

● EX: Exchange Component Piece List

For Support Packages and CRTs that form part of a series, the two characters must be in lexicographically ascending order. These should correspond to the Support Package level, such as 01, 02, 03,…, 99, A1, A2, …, B1, B2,…, Z9.

IN Separator

<Namespace> Namespace name that corresponds to the name of the add-on software component, such as ABCD. The namespace is taken automatically from the namespace prefix in the delivery name.

If /ABCD/ has been reserved as a namespace, the component piece list for add-on ABCD 100_640 will be called SAPK-164COINABCD. If /ABCD/ has been reserved as a namespace, Support Package 03 for add-on ABCD 200_700 will be called SAPK-27003INABCD.

01.06.06 31

7 Creating the System Landscape and the Systems

7 Creating the System Landscape and the Systems For basic information about the structure of a landscape, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Logistics → Change and Transport System.

● Transport Management System

● Change and Transport System - Overview

Make sure in your system landscape that the upgrade and maintenance strategy in your development system corresponds with the delivery strategy [Page 22].

You need two systems for the development version and each maintenance version, whereby the consolidation system also acts as the final assembly system and as the translation system.

Add another temporary test system for the final assembly test. In each case, this test system is updated using system copies to the version in which a delivery is about to be tested.

Since we recommend that you use the consolidation system as the final assembly system in all system landscapes, make sure that the consolidation system does not contain any cross-client test data. Otherwise, your delivery contains this test data. You can of course use client-specific test data in the test client.

7.1 System Landscape for Developing Add-Ons To develop your add-on, you need two systems for each add-on release and each supported SAP release:

● a development system (for developing software and documentation, and Customizing)

● a consolidation system (for translation and delivery. You must not make any repairs or perform any Customizing in this system)

Create a consolidation route from the development system to the consolidation system and schedule regular consolidation transports.

Development System

ConsolidationSystemConsolidation Route

Support Packages New SAP Releases

Packages for installing the add-on / upgrading to the newestversion

Support Packages New SAP Releases

32 01.06.06


The consolidation system is also the final assembly system.

You also need a temporary extra test system. For more information about this, see Test Systems [Page 50].

If you test add-on functions or Customizing changes directly in the consolidation system instead of in the test system, you run the risk of including test data in the delivery if you log on to the wrong client.

7.1.1 Creating the Development Landscape for the First Add-On Release Prerequisites You have determined your system landscape for the add-on development and now want to create the systems for the first add-on release.

Procedure You can create systems for add-on developments in the following ways:

● By installing an SAP system

● By copying an SAP system that has already been installed

When you create an SAP system, it must have exactly the same state that you require for your delivery strategy [Page 22] (in particular, the same release and Support Package levels) in both cases. When creating the system landscape, pay attention to the client layout [Page 41].

Result You have created the systems. You can now install the Add-On Assembly Kit in your system landscape [Page 43]. To configure this to work with the Add-On Assembly Kit, see Making Settings for the Development and Consolidation System [Page 44].

7.1.2 Creating Development Landscapes for Other SAP Releases Use If you want your add-on to support multiple SAP releases at the same time, you need a separate development landscape for each SAP release that is supported.

Depending on whether your add-on contains modifications, you can create the systems for add-on development for another SAP release as follows:

01.06.06 33


Creating a Development Landscape for a Non-Modifying Add-On: . ...

1. Create the systems in the new SAP release by installing an SAP system or copying an SAP system that is already installed.

Install Add-On Assembly Kit [Page 43] in the systems and make the relevant system settings [Page 44].

2. If you want to deliver your add-on in more than one language, set up the translation environment in the new consolidation system in the same ways as the translation environment in the existing consolidation system. For further information, see SAP Help Portal under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → Documentation and Translation Tools → Setting Up and Coordinating Translation (BC-DOC-TTL).

3. You now need to create a transport request in the delivery client of the consolidation system in the first development landscape. You need to include the component piece list from the previous release in this transport request. To do this, select the request type Transport of Copies.

4. Export the transport of copies in the translated languages from the consolidation system in the first development landscape.

5. Import the transport of copies into the Customizing client of the new development system and into the delivery client of the new consolidation system.

6. Register the transport of copies as a component piece list of the previous release. You will need this later when creating the exchange component piece list.

To do this, call Software Delivery Composer in the delivery client of the new consolidation system. On the initial screen, choose Delivery for Delivery Request → Register.

7. Ask your developers to check in the new development system which of the imported add-on objects have to be adapted or deleted in the new SAP release. After making the adjustments, transport all add-on objects (including the deleted ones) to the new consolidation system using a consolidation transport. This transport forms the basis of the new SAP release that you want to support.

The non-modifying add-on ABCD, Release 100, was developed in SAP Web AS 6.40 (ABCD 100_640). You now want the same add-on, Release 100, to support SAP NetWeaver AS 7.00 (ABCD 100_700) too. The graphic below illustrates the structure of the new development landscape:

34 01.06.06


Structure of the new development landscape for non-modifying add-on ABCD 100_700

Development System

ABCD 100_640

ConsolidationSystem

ABCD 100_640

Consolidation TransportDevelopment

System ABCD 100_700

ConsolidationSystem

ABCD 100_700

Transport of Copies Transport

of Copies

Packages for Installing / Upgrading ABCD 100_640

Packages for Installing / Upgrading ABCD 100_700

Creating a Development Landscape for a Modifying Add-On: ... ...

1. Create the new development system as a copy of the first consolidation system.

2. Choose one of the following options for the client layout:

○ In the new development system, use the old test client as the new development client and the old delivery client as the new Customizing client.

○ If you want to base your development on the delivered Customizing from the previous release, you have the alternative of creating the new development client as a copy of the new Customizing client.

3. After making the copy in the new development system, perform an SAP system upgrade to the new SAP release that you want to support. If necessary, adjust the modified objects (transactions SPDD and SPAU): During the upgrade, you also need to update Add-On Assembly Kit. Then check the settings [Page 44] in the development system. For example, you need to update the add-on release name.

4. Create the new consolidation system as the installation of a new SAP system or as a copy of a SAP system that is already installed. Install Add-On Assembly Kit [Page 43] in the new system and make the relevant settings [Page 44].

5. If you want to deliver your add-on in more than one language, set up the translation environment in the new consolidation system in the same ways as the translation environment in the existing consolidation system. For further information, see SAP Help Portal under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → Documentation and Translation Tools → Setting Up and Coordinating Translation (BC-DOC-TTL).

6. You now need to create a transport request in the Customizing client of the new development system. You need to include the component piece list from the previous release in this transport request. To do this, select the request type Transport of Copies.

01.06.06 35


7. Export the transport of copies in the translated languages from the first development

landscape. Make sure that you set LSM parameter to ALL and that the LANGUAGE parameter contains all translated languages from the first development landscape. The standard setting for the LSM parameter is MASTER. (See: Setting the Parameters Language and LSM [Page 48])

8. Import the transport of copies into the delivery client in the new consolidation system.

9. Register the transport of copies as a component piece list of the previous release. You will need this later when creating the exchange component piece list.

To do this, call Software Delivery Composer in the delivery client of the new consolidation system. On the initial screen, choose Delivery to Delivery Request → Register.

10. Ask your developers to check in the new development system which of the add-on objects have to be adapted or deleted in the new SAP release. The add-on objects are contained in the component piece list of the previous release. After making the adjustments, transport all add-on objects (including the deleted ones) to the new consolidation system using a consolidation transport. This transport forms the basis of the new SAP release that you want to support.

The modifying add-on EFGH, Release 100, was developed in SAP Web AS 6.40 (EFGH 100_640). You now want to carry on developing the add-on as Release 200 in SAP NetWeaver AS 7.00 (EFGH 200_700). The graphic below illustrates the structure of the new development landscape: Structure of the new development landscape for modifying add-on EFGH 200_700

Development System

EFGH 100_640

ConsolidationSystem

EFGH 100_640

Upgrade toNW AS 7.00

Copy of Consolidation

System EFGH 100_640

System Copy

Transport of CopiesDevelopment

System EFGH 200_700

ConsolidationSystem

EFGH 200_700

Modification Adjustment

Packages for Installing / Upgrading EFGH 100_640

Packages for Installing / Upgrading EFGH 200_700

Consolidation Transport

36 01.06.06


You can also use this procedure for non-modifying add-ons. We do not recommend this, however, as upgrades normally involve extra time and cost.

When creating an SAP system, note that it must always have exactly the same status as the one your need for your delivery strategy [Page 22] (in particular, the same release and Support Package levels). When creating the system landscape, pay attention to the client layout [Page 41].

Result You have created the systems for add-on development in another SAP release.

If you want your add-on to support more SAP releases, repeat this procedure for each SAP release that you want to support.

7.2 System Landscape for Maintaining Add-Ons The maintenance of add-ons involves the following tasks: ...

1. Removing errors from the add-on (by creating Add-On Support Packages)

2. If an add-on makes modifications to the SAP standard, you need to perform the modification adjustment for SAP Support Packages (by creating Conflict Resolution Transports) if the corrections in the Support Packages overwrite your modifications.

3. Creating deliveries for the specified packages.

You require two systems for each delivered add-on release that you want to maintain. In a two-system landscape, you can make regular corrections in the maintenance system, and reproduce any errors reported by customers in the consolidation system. To do this, you need a test client in which cross-client changes are not permitted.

If you have modifying add-ons, you can perform the necessary modification adjustment in the maintenance system to create CRTs. A two-system landscape also enables you to compare objects without versioning. Since you cannot predict what effects SAP Support Packages will have on your add-on’s modifications, and how much work you need to put into creating CRTs, the second system is available as a buffer.

Two-System Maintenance Landscape Create a consolidation route from the maintenance system to the consolidation system for the corrections and schedule regular consolidation transports.

MaintenanceSysten

ConsolidationSystem

for CorrectionsConsolidation Route

Add-On Support Packages, Conflict Resolution Transports

01.06.06 37


The consolidation system is used as the translation and final assembly system.

Make the same settings for the maintenance system as for the development system (see also Making Settings for the Maintenance Systems [Page 49]), and the same settings for the consolidation system for corrections as for the consolidation system for development.

7.2.1 Creating Systems for Add-On Maintenance Prerequisites You have determined the system landscape for maintaining the add-on release that needs to be maintained and now want to create the systems for add-on maintenance.

Procedure To create the systems for add-on maintenance, proceed as follows:

● By copying the consolidation system of the development landscape for the add-on release to be maintained

We recommend this method as the standard procedure.

● By transporting copies of the objects in the add-on release to be maintained

Copying Your Consolidation System ...

1. Make sure that all deliveries in the system to be copied have the status Confirmed.

2. For the maintenance system and for the consolidation system for corrections, create copies of the consolidation system that you used when you created the add-on release to be maintained.

For more information about system copies, see SAP Service Marketplace at service.sap.com/systemcopy.

3. Choose one of the following options for the client layout:

○ After you have copied the system, use the test client as the correction client, and use the delivery client as the Customizing client in the maintenance system. The client layout of the consolidation system for corrections remains the same after you have copied the system. (See also Client Layout [Page 41]).

○ If you want to base your maintenance activities on the Customizing version that is delivered, you have the alternative of creating the correction client as a copy of the Customizing/delivery client.

To do this, create the correction client in the maintenance system as a client copy of the delivery client (of the consolidation system that has been copied). The previous delivery client then takes on the function of the Customizing client. In the same way, create the test client in the consolidation system for corrections as a client copy of the delivery client so that later tests can be based on the delivery version of Customizing.

38 01.06.06


Transport of Copies ...

1. Install two SAP systems with the release and Support Package level that the consolidation system had when the add-on release you are maintaining was exported.

2. Use the unchanged export level to create a transport request in the delivery client (see Client Layout [Page 41]) of the consolidation system, including the component piece list of the add-on release that you want to maintain. To do this, select the request type Transport of Copies.

3. Before you release the transport, make sure that the tp parameter r3transoptions is set to smodi=yes in the Transport Management System. This ensures that information about the modification is also transported.

4. Release the transport.

5. In the maintenance system, create the Customizing client as a client copy of client 000. In the consolidation system for corrections, create the delivery client in the same way.

Under Client Layout [Page 41], read the information that applies to your maintenance systems.

6. Import the transport of copies into the Customizing client of the maintenance system and into the delivery client of the corresponding consolidation system for corrections.

7. To create more clients, choose one of the following options:

○ In the maintenance system, create the correction client as a client copy of client 000. In the consolidation system for corrections, create the test client as a client copy of client 000 too.

○ If you want to base your maintenance activities on the Customizing version that is delivered, you have the alternative of creating the correction client as a copy of the Customizing/delivery client.

To do this, in the maintenance system, create the correction client as a client copy of the Customizing client. In the consolidation system for corrections, create the test client as a client copy of the delivery client so that later tests can be based on the delivery version of Customizing.

8. Make the settings in the maintenance systems [Page 49].

9. In the delivery client of the consolidation system for corrections, you now need to register the transport copy as a component piece list of the add-on release to be maintained. This is required for the object list check New Objects (Entries) in Support Package/CRT and for the conflict check for creating Conflict Resolution Transports.

To do this, call Software Delivery Composer in the delivery client of the consolidation system for corrections. On the initial screen, choose Delivery for Delivery Request → Register.

7.3 Developing Multiple Add-Ons in a Single System Landscape To keep costs down, it may be advantageous to develop multiple add-ons in a single system landscape. If you do this, you do not need as many systems. This saves on hardware costs. It

01.06.06 39


also reduces the level of administration and the associated costs. However, the amount of quality assurance increases.

There are other important restrictions that you have to consider if you intend to develop multiple add-ons that run in a single system landscape.

Restrictions ● Disjointedness

If you want to deliver add-ons independently of one another, you must develop them disjointed.

However, no technical support is provided to guarantee the disjointedness of objects from multiple add-ons that have been developed in a single system. There is a risk of the add-ons referencing each other, thus making them dependent on one another. This would prevent your customers from being able to import these add-ons individually. The add-ons cannot run independently.

A data element from add-on 2 is using a domain from add-on 1.

Since the system does not check disjointedness during development, certain errors might not be identified until the import test. Other errors may be identified even later, at add-on runtime (that is, during functional tests or even after reaching the customer). This is the case, for example, if add-on 1 calls a function module or program belonging to (the non-existent) add-on 2.

In SAP Web AS 6.10, a package concept has been introduced in order to structure and delimit add-on development. For further information about the package concept, see help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench → ABAP Workbench: Tools → Package Builder.

● Development with no modifications

The add-ons are not allowed to modify other software components.

The reasons listed under Disjointedness also apply to developments with no modifications. If an add-on modifies another software component, the initial status is no longer the same for other add-ons. There is then a risk of not being able to execute the add-ons independently or that one add-on can be executed but not the other.

Developing multiple modifying add-ons in one system is not possible, since you have to test the technical installation of each add-on in a separate system to ensure that the add-ons are indeed independent of one another, and that one add-on does not reference the other. Furthermore, external influences such as separate delivery cycles, may prevent two modifying add-ons from being developed in one system at the same time. This is the case if add-on 1 requests an SAP Support Package to be imported because a CRT is required for this Support Package, but add-on 2 does not allow the import because it is still in the development phase.

● Coordination requirements when importing Support Packages / performing an upgrade

Restrictions also apply when importing Support Packages into your system or performing an upgrade. For each system, you can only import Support Packages or perform an upgrade centrally. This creates a strong dependency regarding the release cycle and Support Package cycle of the add-on.

40 01.06.06


Due to these various hindrances, we do not recommend that you create multiple add-ons in one system. This is particularly true for add-ons that are independent of one another. However, if an add-on is based on another add-on, it may make sense to develop and maintain these add-ons in the same system. Here, when registering the add-on, you can specify that one add-on is a prerequisite for the other.

Notes for Developing Multiple Add-Ons in a Single System If you still want to develop multiple independent add-ons in one system, bear in mind the following considerations:

● Work consistently in the prefix namespace. This helps you to ensure that an add-on does not reference any objects from another add-on. This is only useful for guidance purposes, however, and does not offer completely reliable protection.

● From SAP Web AS 6.10, use the package concept for encapsulation. For further information, see help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench → ABAP Workbench: Tools → Package Builder.

● When creating the delivery, perform the Extended Syntax Check for the delivery piece list in the Transport Organizer (transaction SE01). Perform this check in the final assembly system and in the test system. This check determines whether the add-on is correct from a technical point of view.

● For each add-on, set up a separate test system and perform an import test and functional tests.

7.4 Client Layout and Transport Routes General Information About Clients and Transport Routes For basic information about clients and transport routes, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Logistics → Change and Transport System.

● Change and Transport System - Overview

● Transport Management System (BC-CTS-TMS)

Unless otherwise specified, create new clients as a copy of client 000.

01.06.06 41


Recommended Client Layout and Transport Routes for the Development and Maintenance Landscapes Client Layout Make the following settings (call transaction SM30 and display table T000):

System Changes and transports for client-specific objects

Changes to cross-client objects

Development system or maintenance system

Development client or correction client (client X00)

Changes without automatic recording

Changes to the Repository and cross-client Customizing allowed

Customizing client (client X05) Automatic recording of changes

No changes to Repository objects

Consolidation system or consolidation system for corrections

Test client (client X00) Changes without automatic recording, no transports allowed

No changes to Repository objects and client-specific Customizing objects

Delivery client (client X05) No changes allowed No changes to Repository objects and client-specific Customizing objects

Transport Routes Make the following settings in the Transport Management System (TMS) to transport your changes:

Source client = target client

If you want to test the delivery Customizing in the test client, activate the extended transport control so that transport requests in the Customizing client (X05) also appear in the test client (X00). For details about extended transport control, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Logistics → Change and Transport System → Transport Management System → Configuring TMS → Configuring the Transport Routes → Special Features of Extended Transport Control.

42 01.06.06


The following graphic shows you how to create transport routes:

X00 Development / Correction,Test Customizing

X05 Delivery Customizing

X00 Test Client withTest Customizing

X05 Delivery Client withDelivery CustomizingTranslation

X05

X00

...

X05

X00

...

Development System/Maintenance System

Consolidation System/Consolidation System for Corrections

Delivery

Development System/Maintenance System

Consolidation System/Consolidation System for Corrections

Transports

To control the export of language-specific data, read Setting the Parameters LANGUAGE and LSM [Page 48].

For additional settings, see Setting Parameters for the Transport Control Program tp [Page 47].

7.5 Installing Add-On Assembly Kit Use SAP delivers Add-On Assembly Kit as a separate add-on (AOFTOOLS). You therefore need to install it in your system landscape using Add-On Installation Tool.

Procedure ...

1. Before installing Add-On Assembly Kit Version 4.00, read SAP Note 921103.

2. Install Add-On Assembly Kit into your development and consolidation system according to the instructions in SAP Note 921103.

Pay particular attention to the preparatory steps and post-installation steps described in the Note.

You need to have Add-On Assembly Kit in the development system, so that you can determine the add-on software component and the add-on release. You need to have Add-On Assembly Kit in the consolidation system as well, so that you can create the delivery.

01.06.06 43


Result You have installed Add-On Assembly Kit. You can now make settings in the systems.

7.6 Making Settings for the Development and Consolidation System You have to make the following settings:

● Entering the Namespace and Defining the Namespace Role []

● Creating or Updating the Add-On Software Component and Add-On Release Name [Page 45]

● Setting the System Change Option [Page 46]

● Setting the Parameters for the Transport Control Program tp [Page 47]

● Setting the Parameters LANGUAGE and LSM [Page 48]

7.6.1 Entering the Namespace and Defining the Namespace Role Use To create and maintain add-ons, you need to work in defined namespaces. After reserving your namespaces, you therefore have to enter them in a table and define the namespace role in the systems.

Prerequisites You have administrator authorization in the Change and Transport System (CTS). This is included in the standard authorization S_CTS_ADMIN.

You have reserved one or more namespaces for the development objects and - if relevant - have reserved a namespace for the add-on software component. For details, see Reserving Namespaces [Page 27].

Procedure To enter your reserved namespaces in the development system and the consolidation system, proceed as follows: ...

1. Call Software Delivery Composer.

2. On the entry screen, choose Environment → Create/Update Namespace.

3. On the screen Change View "Repository in Namespaces": Overview, choose the New Entries function. The system displays the screen for editing the namespaces.

4. Enter the reserved namespaces and define the namespace role for each namespace.

By doing this, you determine how to deal with objects in the namespace. That is, whether it is possible to make corrections or just repairs.

44 01.06.06


Set the namespace role as follows:

○ In the development system and in the maintenance system, set it to P (producer). This means that objects can be created and that corrections can be made to the objects.

To do this, you need to enter the development license for the system installation number.

You can obtain the development license for the system installation number in SAP Service Marketplace. (For more information, see Reserving Namespaces [Page 27].

○ In the consolidation systems (including the test systems), set it to C (recipient). This means that only repairs can be made to the objects.

To do this, you need to enter the valid repair license for the namespace.

You can obtain the repair license for the namespace in SAP Service Marketplace. (For more information, see Reserving Namespaces [Page 27].

To create/update the software component and to create the delivery, you also need the valid development license for the namespace that you reserved for the add-on software component. (See: Creating a Delivery [Page 64]) To define the development license in the consolidation system, you can temporarily set the namespace role for the add-on software component namespace to P and enter the valid development license. Then set the namespace role back to C. The development license is now stored in the system. You can create/update the software component, and create the delivery, without having to enter the development license again.

7.6.2 Creating or Updating the Add-On Software Component and the Add-On Release Name Use As a basis for the development of each new add-on release, you need to create or update the add-on software component and add-on release name in the development system. When creating packages for your development, you have to assign them to the software component.

The add-on software component also represents a prerequisite for creating a delivery. The add-on software component and the add-on release name therefore need to be created and up to date in the consolidation system (final assembly system).

Prerequisites You have determined the add-on software component and the add-on release name. For information about this, see Determining the Namespaces [Page 25].

You have installed Add-On Assembly Kit in the development system. For more information, see Installing Add-On Assembly Kit [Page 43].

01.06.06 45


Procedure ... ...

1. To create your add-on software component in the development system, call Software Delivery Composer and choose Environment → Create/Update Add-On Software Component.

2. In the Software Component field, enter the add-on software component that you determined above.

3. If you have not already entered the development license for the namespace, enter it now.

4. Enter the new add-on release together with a description.

The system then automatically enters the necessary data in the corresponding tables.

A dialog box is displayed, prompting you to enter the transport request.

5. Create a new transport request or choose an existing one.

The request contains a transport entry for your add-on software component.

6. Release the transport request and import it into the consolidation system. You need to do this so that the add-on software component, add-on release name and the related description are available in the consolidation system.

While performing the translation [Page 57], make sure that the description of the add-on software component has been translated into all the languages to be delivered. The software component description must always be available in English, even if the add-on does not exist in English, since English is the standard language at SAP. When the delivery is assembled, Software Delivery Composer checks whether the translated entries are included in the delivery, and whether the English entry exists.

If Add-On Assembly Kit is not installed in your development system, you can create the add-on software component and the add-on release name in the consolidation system. Now release the transport request that contains this data and transport it back to the development system. You need to do this so that the add-on software component and the add-on release name are also registered in the development system.

7.6.3 Setting the System Change Option Use The system change option determines whether Repository objects and cross-client Customizing objects are modifiable or not.

For basic information about setting system modifiability, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Logistics → Change and Transport System → Transport Organizer → Requirements for Working with the Transport Organizer → Setting the System Change Option.

46 01.06.06


Prerequisites You have administration authorization in the Change and Transport System (CTS). This is contained in the delivered standard authorization S_CTS_ADMIN.

You have entered your namespace(s) for the development objects [Page 44].

Procedure

Both the namespace for the development objects and the software component are used to control the system change option.

After releasing the namespace(s) for the development objects, you need to set the system change option in the development and maintenance system: ...

1. Call transaction SE03.

2. Choose Administration → System Change Option.

3. To be able to change objects in the namespace of the development objects, you need to set both the global setting and the namespace to Modifiable.

4. You also need to set the add-on software component that is assigned to the objects to Modifiable, so that you can change objects.

5. Also check the system change option for all other software components. To make sure that you do not inadvertently modify software components, set all software components – except for your own add-on component – to Not Modifiable. If you make modifications to another software component, you also have to set this component to Modifiable. To avoid unwanted modifications, restrict the change option as much as possible overall.

6. If you want to set additional restrictions for the system change option in the maintenance system, you can define special roles and authorizations for your developers. This allows you to specify that developers cannot modify Dictionary objects or user interfaces, for example. For further information about roles and authorizations, see help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Security → Identity Management → Users and Roles (BC-SEC-USR) or – if you are currently in the role maintenance transaction (PFCG), choose Help → Application Help.

7.6.4 Setting Parameters for the Transport Control Program tp Use To create and maintain add-ons, you must set parameters for the transport control program tp in your systems.

For information about these parameters and how to set them, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Logistics → Change and Transport System →.

01.06.06 47


● Transport Tools

● Transport Management System → Configuring TMS → Configuring the Transport Domain → Maintaining and Monitoring the Transport Domain → Changing the Configuration of an SAP System → Changing the Transport Control Program Parameters

Procedure For the add-on development, set the parameters for tp in the Transport Management System (TMS) as follows:

Parameter Value in development system or maintenance system

Value in the consolidation system or consolidation system for corrections

ABAP/NTFMODE b b

NEW_SAPNAMES true true

T_IMPORT no no

K_IMPORT no yes

VERS_AT_IMP yes no

If you want to view only the profile parameters that have been automatically generated for the transport control program tp, select the Transport Tools tab in the TMS. For information about how to change these parameters, see the paths in SAP Help Portal mentioned above. To display all the parameters, choose Goto → TP Parameters.

7.6.5 Setting the Parameters LANGUAGE and LSM

Use To create and maintain add-ons, you need to set both of these parameters in your systems.

You can use the parameters LANGUAGE and LSM (language_selection_mode) to control the export of language-specific data.

From the development system, you must export data in the master language only. You can export data from the consolidation system in all supported languages.

Procedure Make the following settings in the transport control program tp in the Transport Management System: ...

1. In the parameter LANGUAGE, select Global and enter the required languages.

2. Set the parameter LSM as follows:

In the development system

48 01.06.06


For parameter LSM, enter MASTER.

This value ensures that language-specific data is exported in the master language.

In the consolidation system

For parameter LSM, enter ALL.

This value ensures that all the languages that you entered in the parameter LANGUAGE are exported.

This ensures that all table entries are exported in accordance with the parameter LANGUAGE, without the need to include any missing languages in the language-specific tables.

Alternatively, you can set the export languages while creating the delivery in Software Delivery Composer. To do this, choose Delivery Component → Specify Export Languages. The settings that you made in the Transport Management System will then be overwritten.

7.7 Making Settings for the Maintenance Systems The details included in the section Making Settings for the Development and Consolidation System [Page 44] also apply for the settings in the systems in the Maintenance Landscape [Page 37].

You must make the same settings for the maintenance system as for the development system, and the same settings for the consolidation system for corrections as for the consolidation system for development.

7.8 Upgrading the Development and Maintenance Landscape When upgrading a system landscape in which you are performing the add-on development or maintenance work, all objects that you have created yourself are retained. These are all those objects that have an object directory entry whose original system is not SAP.

If you have made modifications to SAP objects (objects with an object directory entry whose original system is SAP), these are overwritten by the SAP standard during upgrade. After the upgrade, however, you can reproduce your modifications during modification adjustment.

01.06.06 49


7.9 Test Systems During add-on development and maintenance, you need to perform the following tests:

● Final Assembly Test (obligatory)

Here, you test the import of the completed packages.

If corrections are necessary, you need to make them in the development or maintenance system, and then import them into the consolidation system and test system. Now test the import of the new package again.

We recommend that you make backups of the various system versions that you import for testing into the final assembly system.

● Acceptance Test (optional – recommended for extensive development work)

At the end of the development phase, corrections are copied continuously to a test system that contains test data. The aim of this is to continuously test add-on functions and Customizing changes at the end of the development phase.

If you test add-on functions or Customizing changes in the consolidation system, you run the risk of including cross-client test data in the delivery.

We recommend that you use an acceptance test system. This system is located behind the consolidation or final assembly system in the system landscape, and unlike these systems contains cross-client test data. You could, for example, set up this test system as a recipient system behind the consolidation system. Make settings, for example to the transport profile, in the same way as in the consolidation system.

Ideally, you should have two systems for these tests. Depending on the time schedule and your development process, you can also perform these tests at different times in one system.

You must have a (temporary) test system for the final assembly test. You update this system to the version in which you want to test a delivery by using previously created system copies.

50 01.06.06

8 Developing the Add-On

8 Developing the Add-On For basic information about ABAP development, see the SAP Help Portal under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench.

As of SAP NetWeaver ´04, you can find further information about ABAP development in the SAP NetWeaver Developer´s Guide in the SAP Developers Network, under sdn.sap.com/irj/sdn/devguide.

Perform the development in the development system for cross-client objects in the development client, and for client-specific objects, perform it in the Customizing client.

When creating new objects, make sure that you set the original language correctly. We recommend that you always log on in the development language, since the default value for the original language of an object is the same as the logon language. Otherwise, problems can arise during translation or for customers who deal with deliveries in foreign languages.

You need to transport the objects to the consolidation system as soon as a development stage has been completed.

Perform the translation in the delivery client in the consolidation system.

Depending on the delivery strategy, import the current Support Packages into your development system. This means that the development system must have the same version of SAP Support Packages that is required for the customer system.

8.1 Creating and Assigning Packages (Transaction SE80) To develop your add-ons, you have to create packages. Assign each package of the add-on to the relevant software component and to a transport layer. Prerequisite for assigning packages is that you have set up a software component in the development and consolidation systems for each add-on release, as well as a transport layer for the consolidation transports.

8.2 Rules for Developing Add-Ons It is important to observe the following rules when developing your add-on:

● Cross-platform development

Your add-on developments must comply with the SAP platform strategy. ABAP developments must support all application servers on UNIX, Windows, and IBM eServer iSeries. You may only make exceptions if absolutely necessary for technical reasons.

01.06.06 51


Note the following technical issues:

○ If you use call system in ABAP programs, this leads to platform-specific applications. Alternatively, use transaction SM69 to define platform-specific commands.

○ Depending on the platform, an application runs under the ASCII code page or under the EBCDIC code page. This means that logical comparisons such as f1 BETWEEN f2 AND f3 provide different results, depending on the platform.

○ When you access the file system of the application server, take the relevant code page into consideration.

○ If you want to use CPIC communication to start external programs, you have to convert the code page. If you use RFC communication, conversion occurs automatically.

● Cross-Database Development

ABAP developments must support all database systems released by SAP. This means that you must not dispatch commands with exec sql (native SQL) from ABAP programs.

● Develop the add-on as a closed, functional unit with precisely defined interfaces to the SAP software.

● Do not make any modifications to SAP software.

Instead, use enhancement techniques [Page 55]. If you cannot avoid making modifications, see the Rules for Developing a Modified Add-On [Page 54].

● You should only develop one add-on for each system landscape.

If you develop more than one add-on in a system, read the notes in the section Developing Multiple Add-Ons in a System Landscape [Page 39].

● Cross-client objects: Use BC Sets and IMG Enhancements.

For more information, see SAP Help Portal at help.sap.com →

BC Sets Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Customizing → Business Configuration Sets (BC-CUS)

IMG Enhancements

Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Customizing → Customizing → Implementation Guide (IMG) → Using the IMG → Enhancing IMGs

● Tables

Contents of SAP Tables

If you want to deliver entries in SAP tables, use BC Sets.

If you want to deliver table entries directly (without using BC Sets), then this represents a modification for which you cannot make adjustments. The entries can be overwritten in your system and in your customer’s system by SAP Support Packages or upgrades at any time, without a warning being displayed.

52 01.06.06


You are not allowed to use the AAK to deliver entries in the customer name range of an SAP table, since these entries may overwrite the contents of your customer’s system.

New Tables

If you want to create a new table, make sure that you assign the correct delivery class to the table. The delivery class controls the transport behavior of tables. Only tables of delivery class E, G or C support BC Sets. Also note that other restrictions apply when using BC Sets (for example, the length of the table name may be restricted).

For further information about delivery classes for tables, choose the info button on the ABAP Dictionary initial screen (transaction SE11) or refer to the relevant documentation in SAP Help Portal, at help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench (BC-DWB) → BC-ABAP Dictionary → Tables → Creating Tables → Delivery Class.

● During development, note the information contained in the section Object List Checks [Page 67].

● If your add-on supports multiple SAP releases, you should also observe the Rules for Developing Add-Ons in Multiple SAP Releases [].

● Since you do your developing in a prefix namespace, bear in mind the restrictions that apply for this type of development. These are described in SAP Note 104010.

8.2.1 Rules for Developing Add-Ons in Multiple SAP Releases It is important to observe the following rules if you are developing your add-on in multiple releases.

● Originality/New Objects

If you need your add-on objects in multiple SAP releases, you should always create the new objects in the lowest supported SAP release. This gives you the following benefits:

○ The upward compatibility of the objects is generally guaranteed. This means, for example, that the ABAP syntax normally remains valid in the higher release, and the objects types are normally known in the higher release too.

○ Transporting copies from a lower SAP release to a higher one is usually possible from a technical point of view.

○ Having the objects in the same system as the original system helps you to keep an overview of all add-on objects.

As far as possible, you should therefore always create the new objects in the development system in the first development landscape. If you need the objects in another development system, you can transport copies to the development system in the new landscape. Note that you might need to make adjustments to the objects in the higher release.

If you do not need an object in the first development system, you can create it in the next higher development system in the new development landscape.

01.06.06 53


Make sure that objects always only have one original system and that they only exist as copies of this original in any other systems.

● Transporting Copies of Add-On Objects

When transporting copies between development systems in various releases, you should always transport them from a lower SAP release to a higher one. The reasons for this are explained under Originality/New Objects.

● Modifications

If you need modifications in the higher SAP release, you have to perform these manually. You should not transport copies with modified objects, as you cannot assume that the status of the modified objects in the higher SAP release corresponds to that in the lower release.

● Non-Release Specific Development

To keep down the costs and effort required for developing your add-on in multiple release tracks, your development should be non-release specific wherever possible. For details, see Determining the Delivery Strategy [Page 22].

8.3 Rules for Developing a Modifying Add-On If modifications to SAP standard objects are necessary, make as few as possible and keep them as small as you can. Also note the following rules:

● You are not allowed to modify any objects belonging to the software components SAP_BASIS or SAP_ABA. Modifications to other add-ons are also forbidden.

Modifications made to ABAP Dictionary objects from SAP_BASIS may be lost during the upgrade. After the upgrade, these objects return to their original (unchanged) form. The system does not support the modification adjustment of objects from SAP_BASIS.

● The modifications that you make to your add-on must concern just one SAP main/application component only (SAP_HR or SAP_APPL, for example).

● Use the Modification Assistant. For further information, see help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench (BC-DWB) → Changing the SAP Standard (BC) → Modification Assistant.

● Note the further restrictions listed in the table below:

Modification Development (Add-On Installation Package, Add-On Upgrade Package, Add-On Exchange Package)

Maintenance (Add-On Support Package, Conflict Resolution Transport)

New modification objects Not recommended Not permitted

New function modules in SAP function groups

Not permitted Not permitted

Modifications to user interface of SAP Not permitted Not permitted

54 01.06.06


Standard

Dictionary changes that modify database tables (such as adding fields, Includes)


Modifications to objects – in external software components – of which you cannot make a version (for example, table entries in SAP tables or logical transport objects); it is impossible to adjust these modifications using a Conflict Resolution Transport


Deletion or renaming of SAP Standard objects


Modifications to SAP Standard Customizing


Domain modifications Not permitted Not permitted

Customer Exits Not permitted Not permitted

Use of Customizing Includes and system Includes


Check your modifications regularly in the Modification Browser (transaction SE95).

8.4 Additions to the Enhancement Procedure and Modifications Topic Enhancement procedures represent an opportunity to enhance SAP software without having to perform modifications. If you need to make modifications, use the Modification Assistant.

For further information, see the SAP training course BC425 and SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench (BC-DWB) → Changing the SAP Standard.

For developments that are based on SAP NW 2004s and higher, the Enhancement Framework can be used. For further information, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench (BC-DWB) → Enhancement Framework.

Note that the topics described below pick out individual objects, but in no way claim to be complete.

01.06.06 55


Enhancement Procedure

Business Add-Ins

You should use Business Add-Ins (BAdIs) for your enhancements. These are parts of a source defined be SAP, where you can add code without modifying the original object. You can work with the proposed logic, or copy an implementation that has been made available.

For further information about Business Add-Ins, see the definition maintenance for Business Add-Ins in your SAP system (transaction SE18), under Help → Application Help or SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench (BC-DWB) → Changing the SAP Standard → Classic BAdIs.

Notes for Dealing with Unavoidable Modifications to SAP Standard Objects Dictionary Objects With Dictionary objects, extending tables is of particular interest in the development of add-ons.

Extending Tables

You must never extend SAP standard tables by directly adding new add-on-specific fields, since these modifications can be overwritten in the add-on system by table object updates (Support Packages or upgrades), SAP software components, or other add-on components.

You should use the append structure as an enhancement option for SAP standard tables. This method allows you to extend tables without modifying them and means that they are not overwritten when the table object is transported out of the SAP standard system again. Note that this type of enhancement cannot be used for pool or cluster tables.

For further information about the append structure for tables, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench (BC-DWB) → BC - ABAP Dictionary → Tables → Append Structures.

Programs You must use the Modification Assistant to make changes to programs. Activate the Modification Assistant in your development system.

For further information about Modification Assistant, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench (BC-DWB) → Changing the SAP Standard → Modification Assistant.

Function Modules

We do not recommend that you integrate a statement block directly in the SAP program. Instead, call a function module that contains the encapsulated enhancements.

If a new function module is developed in an add-on development system, create it in its own add-on function group. This ensures that you do not overwrite the newly created function module during an update. You may only have to include the call of the newly created function module in the source code.

56 01.06.06


If you want to include source code in an existing SAP Standard function group so that you can use its global memory, use a form routine instead of a function module. This avoids inconsistencies with the assignment of numbers for the Include of the function modules. Do not create new function modules in SAP function groups.

Customer Exits

Customer exits (also called function module exits) are created by SAP using transaction SMOD and activated at the customer site using transaction CMOD.

Customer exits are reserved exclusively for customers and cannot be used directly for add-on enhancements without restricting enhancement options for customers.

Form Routines

Where possible, avoid PERFORM calls and use function modules instead. The only exception is when you create a form routine instead of a function module in an SAP Standard function group so that you can have access to the global memory of the function group.

Variables

If you have to create a new variable within an SAP program, define this variable locally.

Messages

You must use add-on-specific message IDs for new messages within an SAP program.

You are not allowed to create messages in existing SAP namespaces.

8.5 Documentation and Translation Documentation Software development also entails writing documentation. Documentation helps to make working with the add-on easier for users. You can write documentation directly in the development system (online documentation).

For basic information about creating documentation in the SAP system, see SAP Help Portal under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → Documentation and Translation Tools.

Translation If you want to deliver your add-on in more than one language, you have to translate all the language-specific objects of the add-on. As well as the documentation, this includes other objects, such as interface texts.

To work with the translation environment, you first have to prepare your system for translation. Translation usually takes place in the consolidation system for development or the consolidation system for corrections. If you have a system landscape that is quite big, then you can also set up a separate translation system.

For basic information about translation, see SAP Help Portal under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → Documentation and Translation Tools.

01.06.06 57


Note the following with regard to translation:

● For each new release, make sure that the description of the software component is translated into all the languages that you want to deliver. To do this, choose the following function from the translation initial screen (transaction SE63):

○ Releases up to SAP Web AS 6.20, Basis Support Package 24: ...

i. Choose Translation → Short Texts → Table Entries.

ii. In the Table Name field, enter CVERS_REF. This is the name of the table in which the software component description is stored.

iii. In the Object Name field, enter the name of your add-on software component.

iv. Choose Edit.

v. Translate the description of the software component.

○ Releases later than SAP Web AS 6.20, Basis Support Package 25: ...

i. Choose Translation → R/3 Enterprise → Short Texts.

ii. In the object type selection, select the type < TABL > Tables.

iii. In the Object Name field, enter CVERS_REF. This is the name of the table in which the software component description is stored.

iv. Choose Edit.

v. When the system has found the correct object type for you to begin editing, choose Edit again.

vi. In the Software Component field, enter the name of your add-on software component, or select it using input help.

vii. Translate the description of the software component.

● Before delivering the add-on, make sure that all language-specific objects in the add-on have been translated.

To export the translated languages correctly, you have to set the parameters LANGUAGE and LSM [Page 48] correctly. The translated languages are then immediately included in the add-on delivery.

If you need an additional language for an add-on subsequent to delivery, proceed as described in the section Delivering Languages that are Translated Later [Page 73].

58 01.06.06

9 Delivery of the Add-On Software

9 Delivery of the Add-On Software After completion of development of a new add-on release, corrections for a new add-on Support Package level or migration to a new SAP Release, you need to create the corresponding delivery packages.

The following package types are available:

● First delivery of the add-on: Add-On Installation Package

● New add-on Support Package level: Add-On Support Package

● Adjustment with SAP Support Packages: Conflict Resolution Transport

● Add-on software delta upgrade: Add-On Upgrade Package

● Add-on software exchange upgrade (inclusion in the SAP system upgrade): Either an Add-On Exchange Package (for releases from SAP NetWeaver 2004s onwards) or an Add-On Upgrade Package (in SAP Web AS 6.20 and SAP NetWeaver ´04)

The delivery creation process contains a number of steps: ...

1. Assembling the delivery

To begin with, determine the delivery type in Software Delivery Composer. Then create the associated delivery requests for delivery, and make entries in them. Software Delivery Composer performs checks that consolidate the content of the delivery requests.

The following delivery types and requests are available:

○ Delivery type Add-on Installation/Upgrade.

The following delivery requests are available for this:

■ Change Piece List

■ Component Piece List

■ Exchange Component Piece List

○ Delivery type Support Package

Delivery request Support Package is available for this.

○ Delivery type Conflict Resolution Transport

Delivery request Conflict Resolution Transport is available for this.

2. Creating the delivery package

You do this using Software Delivery Assembler. Software Delivery Assembler converts each delivery request into an importable package. The table shows which package types the various delivery requests can be converted into.

Delivery Request Package Type

Change Piece List Add-On Upgrade Package for Add-On Delta Upgrades (AOU)

Component Piece List Add-On Installation Package (AOI)

Exchange Component Piece List Depending on the SAP Release, either Add-On Upgrade Package (AOU) or Add-On Exchange Package (AOX) for Add-On Exchange Upgrades

01.06.06 59


Support Package Depending on the SAP Release, either Add-On Support Package Type AOP or CSP

Conflict Resolution Transport Conflict Resolution Transport (CRT)

3. Making the delivery package available

You can provide your customer with the package using the following methods:

○ Compressed on the Internet

○ By following a defined directory layout on a CD (see CD for the Add-On Delivery [Page 93])

9.1 Package Types The following package types can be delivered:

● Add-On Installation Package (AOI)

An Add-On Installation Package (AOI) is used for the first delivery of an add-on. Add-On Installation Packages are imported using SAP Add-On Installation Tool.

Add-On Installation Package

AOISAP System

Add-OnSAP Add-On Installation Tool

SAP System

60 01.06.06


● Add-On Upgrade Package (AOU) for Add-On Delta Upgrades

An Add-On Upgrade Package for Add-On Delta Upgrades is used to update the add-on if the SAP release is unchanged. Add-On Upgrade Packages are imported using SAP Add-On Installation Tool.

Add-On Upgrade Package for Add-On Delta Upgrades

Add-On

AOU

AOUSAP Add-On Installation Tool

Add-On +

SAP System

SAP System

● Add-On Support Package (AOP) or Component Support Package (CSP)

An Add-On Support Package or Component Support Package is used to change the Add-On Support Package level. Depending on the underlying SAP release, the package type is either AOP (for Add-On Support Packages up to and including SAP Web AS 6.20) or CSP (for Component Support Packages from NetWeaver 2004/SAP Web AS 6.40 onwards). In this documentation, both package types are referred to as Add-On Support Packages. Add-On Support Packages are imported using Support Package Manager.

Add-On Support Package

AOP/CSP

Support Package Man ager Add-On

SAPSystem

01.06.06 61


● Conflict Resolution Transport (CRT)

A Conflict Resolution Transport is used to restore modifications to a modified add-on that have been overwritten by SAP Support Packages. A Conflict Resolution Transport can also contain corrections to the add-on. Conflict Resolution Transports are imported using Support Package Manager.

SAP System

Conflict Resolution Transport

Support Packages

#CRT

Add- On

Support PackageMan ager

SupportPackag eManager

SAP System

Add- On

● Add-On Upgrade Package (AOU) for Add-On Exchange Upgrades

An Add-On Upgrade Package for add-on exchange upgrades is used to update the add-on if the SAP system is upgraded at the same time. Add-On Upgrade Packages must contain the extended attribute CREATE_FULLTASK = T and be included in the upgrade during the SAP system upgrade using the SAP upgrade tool R3up.

You can create Add-On Upgrade Packages for Add-On Exchange Upgrades that are based on SAP Web AS 6.20 and SAP NetWeaver ´04.

Add-On Upgrade Package for Exchange Upgrades

Add-On

AOU with CRE ATE_FULL

TASK = T

AOU = Add-OnR3up

SAP System in the Source Rel ease SAP System in the Target Rel ease

SAP Syst em

SAP Syst em

62 01.06.06


● Add-On Exchange Package (AOX)

An Add-On Exchange Package for add-on exchange upgrades is used to update the add-on if the SAP system is upgraded at the same time. Add-On Exchange Packages are included in the upgrade during the SAP system upgrade using the SAP upgrade tool SAPup. You can create Add-On Exchange Packages for Add-Ons that are based on SAP NetWeaver 2004s and higher.

Add-On Exchange Package

Add-On

AOX

AOX = Add-OnSAPup

SAP System in the Source R elease SAP System in the Target R elease

SAP System

SAP System

9.2 Final Assembly System As described in Creating the System Landscape and the Systems [Page 32], you can use the consolidation system as the final assembly system. This means that the details included in Making Settings for the Development and Consolidation System [Page 44] also apply to the settings for the final assembly system.

Note that the settings for the consolidation system also apply to the final assembly system in the maintenance track.

See also:

Creating the System Landscape and the Systems [Page 32]

Making Settings for the Development and Consolidation System [Page 44]

Making Settings for the Maintenance Systems [Page 49]

01.06.06 63


9.3 Creating a Delivery Use When you have completed the development, maintenance or update, you can create the delivery using the tools in Add-On Assembly Kit.

The process for creating a delivery depends on the type of delivery and the package type to be created. The procedure described here is the general delivery creation process. For information about the specific procedures for different delivery types and package types, see the sections that deal with the various package types (Creating an Add-On Installation Package, for example) or the online documentation offered in the help function in the tool in question.

Composing the Delivery with Software Delivery Composer

Before using Software Delivery Composer, see SAP Note 215176. This Note is updated regularly.

...

1. In Software Delivery Composer, determine the type of delivery (Add-On Installation, Add-On Upgrade, Add-On Support Package, or Conflict Resolution Transport) and other administrative data.

The namespace prefix of the delivery name is taken over automatically as the Add-On software component.

To identify yourself as owner of the namespace for the delivery, you have to enter the respective development license, if required. This ensures that deliveries can only be created by the namespace owner.

2. Create the list of all changed objects for the delivery (the change list). Fill the change list using the various selection criteria for change requests or for objects. To do this, select the delivery requests and then include them.

3. Check the languages that the delivery request is exported in, or select them. To do this, choose Delivery Component → Specify Export Languages.

4. Perform the object list checks [Page 67]using Software Delivery Composer. Make any necessary corrections to the change list.

5. When the contents of the change list have been determined, release the change list in Software Delivery Composer.

6. Depending on the delivery type, you need to create further delivery requests (such as the component and exchange component piece list). Perform the object list checks for these as well. Once you have established that the content is consistent, release the delivery requests.

7. Release the associated delivery component.

Creating a Delivery Package with Software Delivery Assembler ...

1. To register the delivery request, call Software Delivery Assembler. To do this, choose Delivery Request -> Register (by SDA, Local) from the toolbar in Software Delivery Composer.

64 01.06.06


Software Delivery Assembler calls the tab page for the relevant package type. The system copies package attributes and import conditions from Software Delivery Composer.

2. Check the attributes and import conditions generated by the system. Add to these, or delete any entries that are not relevant. Keep the following points in mind:

○ In Software Delivery Assembler, specify the conditions that you want the import tool to check in the target system. These include release and Support Package levels of software components or prerequisite software components. Bear in mind all existing dependencies.

Also note the requirements that are specific to your delivery type. For further information, see the chapters for the relevant each package type (Creating an Add-On Installation Package [Page 70], Creating an Add-On Support Package [Page 79], Creating a Conflict Resolution Transport [Page 80], Creating an Add-On Upgrade Package [Page 82], Add-On Behavior During an SAP System Upgrade [Page 83]) or the online documentation for Software Delivery Assembler.

○ If you add the extended attribute SEE_PNOTE, when the package is being imported, the import tool prompts you for a password that is usually mentioned in an SAP Note. The customers can choose to display this SAP Note. Since you are not usually able to create SAP Notes, SAP Note 567695 has been created for this purpose. This Note informs the customers that they can find out the password by contacting their add-on producers. You should inform your customers of this password, for example by mentioning it in the Installation Instructions for your add-on.

You can generate the password in Software Delivery Assembler, by choosing Extras → Generate Password.

We recommend that you always use this attribute. In this way, you can provide your customers with further details about the package.

○ If you require a particular version of Support Package Manager/Add-On Installation Tool to import your package, you can use the extended attribute NEED_SPAM_LEVEL to define that the version in question must be used.

We recommend that you always choose the latest version of the SPAM/SAINT update.

3. Register the delivery request.

You now receive a package that can be imported. This package has the status Locked. It is available in the transport subdirectory EPS/out.

Testing the Delivery Test the delivery package. ...

1. Make the package available for a test system.

To do this, switch to the transport subdirectory EPS/out in the final assembly system,. Copy the delivery package in the test system into the transport subdirectory EPS/in.

2. If you want to test the package import with the SAP Add-On Installation Tool or Support Package Manager, upload the package in the test system.

01.06.06 65


To do this, choose Support Package → Load Packages → From Application Server in the test system in Support Package Manager.

The package is in the test system and available for import.

If you want to test the inclusion of the package in the SAP system upgrade, this step is not necessary, as the SAP upgrade tools R3up and SAPup load the package independently from the transport directory.

3. Import the package in your test system.

To do this, use the relevant installation tool.

4. Test the functions of the package.

Removing Errors in the Delivery The following options are available for removing errors in the delivery: ...

1. If the attributes or import conditions assigned for the package are identified as incorrect or incomplete during testing, you can correct them in Software Delivery Assembler and register the package again.

Proceed as follows:

a. In Software Delivery Assembler, enter the name of the package on the tab page for your package type.

b. When selecting the registration options, choose Change Attributes.

c. Correct any attributes and import conditions that are incorrect.

d. Register the package again.

e. Test the delivery package.

2. If the test shows that the delivery request contains errors or is incomplete, you can reset the release status of the delivery component in Software Delivery Composer. This also resets the release of the delivery requests. You can now make corrections to the delivery request.

Proceed as follows: ...

a. Reset the delivery component in Software Delivery Composer.

b. Correct the delivery request and check it.

c. Release the delivery request again.

d. Release the delivery component again.

e. Use Software Delivery Assembler to register the delivery request again.

To do this, enter the name of the package on the tab page for your package type in Software Delivery Assembler and choose Exchange Data File in the registration options.

f. Test the delivery.

Finishing Creation of the Delivery ...

When the tests have run successfully, you can finish creating the delivery.

1. Confirm the delivery in Software Delivery Composer.

You cannot make any more changes to the delivery in Software Delivery Composer.

66 01.06.06


2. Release the package in Software Delivery Assembler.

By doing this, you are documenting that the package has a defined status. You cannot make any more changes to the package, nor to its attributes or import conditions.

9.3.1 Object List Checks When you create the delivery request, carefully check the object list to avoid any installation and maintenance problems occurring later.

You cannot automatically include all objects in these requests in the delivery.

Software Delivery Composer (SDC) helps you to perform the object list checks.

For more information about the various object list checks, click the question mark for the check in question in the check result display in Software Delivery Composer. Note 215178 explains how you can define your own additional checks.

Checks in Software Delivery Composer ● Forbidden objects

Some object types or objects are not permitted and must not be delivered (customer objects, for example).

Customer objects are reserved for your customers. You are not usually allowed to deliver these, since your customer may already be productively using entries that would be overwritten by a delivery. For more information, see SAP Note 16466.

Entries of type R3TR VERS (definition of software components) must not be delivered, as these entries are made by the import tools.

For a list of these forbidden object types and objects, see SAP Note 870407.

● Extended DDIC Check

All dictionary objects in the delivery must be consistent. Inconsistent dictionary objects can have all kinds of negative effects, from generation errors to data loss.

● Existence of the objects and table entries to be delivered

If objects require object directory entries, these entries must exist. The objects must also be in a recognized, delivery-relevant package (development class).

This check also checks for deleted objects. Deleted objects do not usually need to be delivered in an add-on installation.

● Table Entries: Generic Transport

You must not deliver any table entries (TABU) or logical objects with simple generic keys (*). This would delete the entire area covered by the generic key in the customer system and replace them with exported entries.

The check determines the following table entries, which trigger the transport of entire table ranges:

○ *: All contents of table

○ <language key>*: Language-dependent table content

01.06.06 67


○ <client>*: Client-specific table content

○ <client><language key>*: Client-specific and language-dependent table content

● Required objects

For Installation/Upgrade type deliveries, the system checks that all definitions of packages/development classes and namespace definitions are included in the delivery for which there are objects in the delivery request.

For all delivery types, a check is made to see whether packages/development classes and namespace definitions are included in the delivery, for which there are no objects in the delivery request. For all namespaces in the delivery request, a check is made to see whether a valid repair license exists.

Your add-on customers can only make changes to objects in your namespace if a valid repair license has also been entered in the system. If you have entered the repair license in your final assembly system, it will be included in the delivery as well. Otherwise, you have to inform your add-on customers of the repair license, so that they can then enter it in their system.

● Table Entries: Delivery Relevance/Delivery Behavior

You must not deliver entries from class A tables. Check whether that the other delivery-relevant table entries and logical objects behave in the expected way when you import them (according to the delivery class for tables). Software Delivery Composer lists all the table entries and logical objects to be checked, together with their import behavior.

Import behavior during the installation and upgrade differs according to whether the tables are client-specific or cross-client.

● (Non-Permitted) Modifications and Deliverability

Avoid making modifications to objects from a software component other than your own. Software Delivery Composer displays any objects that belong to a software component other than your own.

Modifications to ABAP Dictionary objects that are used in transparent tables can result in conversions. Check this, since the conversions could lead to increased runtimes during upgrades and installations.

Remember that you must not modify objects in other software components if you cannot create a version of these objects. You cannot modify more than one software component either.

You must not to deliver objects that have been flagged by their owner as ’not to be delivered’ (for example, by assigning them to a package of software component LOCAL or HOME).

No repository objects from the customer namespace must be included in the delivery.

Generated objects must not be delivered.

The object types of the objects must be valid in the target release.

68 01.06.06


● Table entries in the customer area (protected by TRESC)

Table entries and logical objects must not be located in name ranges reserved for customers (according to table TRESC).

Additional checks in Software Delivery Composer for deliveries of type installation/upgrade

● Description of the software component (LANG VERS) required

The delivery request must contain a description of the add-on software component in all languages that are to be delivered, including English even if English will not actually be delivered.

Additional check in Software Delivery Composer for deliveries of type Support Package and Conflict Resolution Transport

● New Objects (Entries) in Support Package/CRT

Avoid delivering new objects in Add-On Support Packages and Conflict Resolution Transports (CRTs).

Software Delivery Composer checks whether these objects are to be delivered.

Software Delivery Composer can only perform this check if the component piece list for the add-on release has been registered to it in your SAP system. If you have created this in a different system, you can register it in Software Delivery Composer in the current system. To do this, go to the Software Delivery Composer initial screen and choose Delivery for Delivery Request → Register.

Since you create a CRT for one main/application component only, the CRT may contain only objects from its own add-on software component or from the assigned main/application component. Software Delivery Composer checks whether the delivery request contains objects from other software components.

Manual Check The objects must be consistent. All subobjects (program code, and so on) must exist, for example. If this is not the case, errors will occur when you import the package, if not before.

You can perform this check in the Transport Organizer before releasing the delivery request. ...

1. Call Transport Organizer (transaction SE01).

2. On the Display tab page, enter the name of the delivery request and choose Display.

3. Choose Request/Task → Overall Check → Objects (Syntax Check)

Perform this check in both the final assembly system and the test system.

Additional checks when releasing delivery requests for deliveries of type Installation/Upgrade Delivery requests for deliveries of type Installation/Upgrade can only contain complete objects belonging to your add-on (in the software component that triggers the delivery). Any subobjects (LIMUs) in your add-on must therefore be replaced with the corresponding complete objects.

01.06.06 69


When the change piece list, component piece list and exchange component piece list are released, Software Delivery Composer automatically replaces the subobjects in your add-on with complete objects.

Note that this does not apply to modified SAP standard objects.

9.4 Creating an Add-On Installation Package Use If you want to deliver the software developments for your add-on to customers for the first time, you need to create an Add-On Installation Package (AOI).

You can also create an Add-On Installation Package if you want to update a “small” add-on. To do this, you need to create an Add-On Installation Package containing all add-on objects, and assign the extended attribute REINSTALL_ALLOWED = T to the package in Software Delivery Assembler. The new Add-On Installation Package can then overwrite the existing add-on with a lower release. This makes sense in the case of small add-ons, as an additional upgrade package is not required. However, customers who have changed the objects in the add-on need to adjust their modifications when re-installing. For larger add-ons, you should create upgrade packages for the Add-On Delta Upgrade [Page 82], as these contain only the modified and new objects from the add-on.

Procedure ...

1. Make the software developments in the development system.

2. Import the developments into the consolidation/final assembly system.

3. Create the delivery using the tools in AAK (see Creating a Delivery [Page 64]).

When you create an Add-On Installation Package to update your add-on, assign the extended attribute REINSTALL_ALLOWED = T to the package in Software Delivery Assembler during registration.

9.5 Making a Delivery Available To deliver the add-on package, you have the following options:

● Delivered on CD

● Delivered in compressed form on the Internet

The following information and data must be included in the delivery:

● Add-on software

● Required documentation (including installation instructions)

When creating a CD, bear in mind the following points:

● CD structure

● Assembling/disassembling the files

70 01.06.06


For more information about the CD structure and assembling and disassembling files, see CD for the Add-On Delivery [Page 93].

9.5.1 Template: Installation Instructions In addition to the usual product documentation, your add-on delivery must also include installation instructions. This is important, since this is where you store all the information that your add-on customer needs to be able to install the packages.

The installation instructions must contain the following information:

● Prerequisites

● Preparation

● Installation

● Post-installation

The following text shows the most important information that installation instructions must contain. You can use this text as a template for your add-on delivery.

You can also use this template to create instructions for other add-on packages (Add-On Upgrade Package, CRT and so on).

Installing <Add-On><Release> Contents

Prerequisites for installing <add-on><release>

Preparations for installing <add-on><release>

Performing the installation of <add-on><release>

Post-installation of <add-on><release>

Password for installing <add-on><release>

Language support

Prerequisites for installing <add-on><release>

● Current versions of kernel, tp and R3trans

Make sure that your system contains the current versions of kernel, tp and R3trans.

● Current SPAM / SAINT Update

Make sure that you have imported the most recent SPAM / SAINT Update into your system. Compare the short text of the last SPAM / SAINT Update you imported with that of the SPAM / SAINT Update in the SAP Service Marketplace. If the version of the SPAM / SAINT Update in the SAP Service Marketplace is more recent, import it.

● Before starting the installation, read the following SAP Notes and documentation:

<Note title> <Note number>

● Check whether the following prerequisites are met in your system:

○ Prerequisite software components (see table CVERS):

01.06.06 71


SAP_BW 700

or EA-APPL 600

or EA-APPL 200

PI_BASIS 2005_1_700

or PI_BASIS 2005_1_640

○ Prerequisite Support Packages:

SAP_BASIS 700 Support Package 06

SAP_ABA 700 Support Package 06

● Additional information about the installation

Space required in the transport directory

approx. X MB

CD Label Add-On Installation <Label number>

Net runtime approx. X hours

Preparation for installing <add-on><release> ...

1. Import the required user language(s) for all components that have already been installed. This language import must be performed prior to the upgrade or installation of <add-on><release>.

2. Mount the Add-On Installation CD.

3. Load the packages into your system.

For more information about this, see the online documentation for Add-On Installation Tool. To do this, choose the help function in the application toolbar and navigate to Online Docu → Loading Installation Packages.

Performing the installation of <add-on><release> ...

1. Log on to your SAP system as client 000 and as a user that has SAP_ALL authorization. Do not use the user SAP* or DDIC.

2. Start the installation or upgrade using Add-On Installation Tool (transaction SAINT):

For more information about this, see the online documentation for Add-On Installation Tool. To do this, choose the help function on the toolbar.

Post-installation of <add-on><release>

Password for installing <add-on><release>

<If you have generated a password for the installation, you can specify it here.>

Language support

As well as the <original language>, <add-on> <add-on release> also supports the following languages: <Language1>, <Language2>.

72 01.06.06


If you want to perform the installation in one of these languages, the standard languages of the current SAP release must be installed. Perform the add-on language import as described in the language transport documentation. The language packages for <add-on> <add-on release> can be found in the directory <Language> on the <Installation / Languages CD>.

9.6 Delivering Languages that are Translated Later Use As a rule, your first add-on delivery must contain all required languages. For this you will have had to perform the translation [Page 57] completely. If you have correctly set the Parameters for Exporting Language-Specific Data [Page 48], then the add-on package is available in all languages.

It may be the case, however, that you have to deliver a language for your add-on at a later time. This may occur, for example, if you use your add-on in your company, and then your company merges with a foreign company whose national language the add-on has not yet been translated into. Although the functions in the add-on are available to the new company, this company requires the add-on texts in another language.

If you are selling your add-on to other companies, it is also possible that foreign companies may be interested in your add-on being available in a different language.

For the language that is to be translated, you can deliver an add-on language package at a later time, which contains just the translation.

Prerequisites ● You have already delivered the current release of your add-on without the new target

language. You may also have already created Support Packages for your add-on.

● The SAP components on which your add-on is based, support the required target language. Check the availability of the languages for the corresponding SAP components in the SAP Service Marketplace under service.sap.com/languages.

● You have installed the required target language for the SAP components of your entire system in the consolidation system for corrections.

Language packages are located on separate language CDs that are delivered with the installation or upgrade. The language packages are imported using the Language Import Tool (transaction SMLT).

For information about language imports, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Logistics → Change and Transport System → Language Transport.

Activities ...

1. Preparing the consolidation system for corrections for the add-on translation into the new target language

For further information, see SAP Help Portal under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability →

01.06.06 73


ABAP Technology → Documentation and Translation Tools → Setting Up and Coordinating Translation (BC-DOC-TTL).

You must make sure that all language-specific objects in your add-on are translated. To do this, use the current complete piece list for the add-on as a basis for calculating the objects that require translating. The complete piece list for the add-on consists of the component piece list of the add-on and the piece lists of all Support Packages and Conflict Resolution Transports that have been created up to this point. You can assemble the complete piece list for the add-on in Transport Organizer, for example.

If you encounter problems when preparing the systems for translation, open a problem message and assign it to the component BC-DOC-TTL.

2. Translating the objects determined above into the new target language

For further information, see SAP Help Portal under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → Documentation and Translation Tools → Setting Up and Coordinating Translation (BC-DOC-TTL) → Tools for Translators (BC-DOC-TTL).

3. Creating an add-on language package for the new target language

You create the language package using the Language Export Tool (transaction SMLT_EX).

For information about language exports, see SAP Help Portal, under help.sap.com → Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Logistics → Change and Transport System → Language Transport.

When using the Language Export Tool to create the language package, note the following points:

General

○ For the object selection, enter the complete piece list for the add-on as a transport request.

○ Select all object types.

○ Note the special features for the objects Terminology, Glossary, Public Holiday Calendar and Balance Sheet Structures. For information about this, see the following sections of the Language Guide:

Release 4.6C: Special language-specific objects

Release 6.X and higher: Objects with Special Handling

○ Use only one transport request for the language package. Do not distribute the language package on different transport requests.

Release 4.6C

○ Do not use the Language Export Wizard (Wizard button).

○ In the output options, specify a valid virtual system for the export as Target System/Group.

74 01.06.06


○ For SAP partners who have configured their system as an SAP system, the following applies:

After selecting the objects, use expert mode in the Language Export Tool. Choose Extras → Expert mode. Copy the default options for the delivery export.

■ Activate the option Specify those components explicitly, whose existence you want to check when the languages are imported, and specify the software component on which the language package is based. By doing this you are making sure that the language package can only be imported if the software component is installed in the system.

■ Select the option Upgrade piece list, any name. To guarantee the uniqueness of your language delivery, enter a name for the transport request in the same way as for the other add-on delivery requests created in Software Delivery Composer:

SAPK-<3 character add-on release name><any 2 characters>IN<namespace>

Release 6.10

○ Do not use the Language Export Wizard (Wizard button).

○ For SAP partners who have configured their system as an SAP system, the following applies:

In the Language Export Tool, choose Extras → Settings before selecting the objects.

■ Under Naming Schema for Transport Requests, choose the option Upgrade Piece List, Any Name. To guarantee the uniqueness of your language delivery, enter a name for the transport request in the same way as for the other add-on delivery requests created in Software Delivery Composer:


■ Under Naming Schema for Language Package, enter a name of your choice for the language package.

Start the export, and copy the default options.

■ On the tab page Special Parameters, select the option Delivery Transport (Upgrade Piece List).

■ Activate Specify Components for Import Check Explicitly, and specify the software component on which the language package is based. By doing this you are making sure that the language package can only be imported if the software component is installed in the system.

Release 6.20 and higher

○ Use the Wizard for Creating Add-Ons. (prerequisite for Release 6.20: SAP Basis Support Package 29)

Choose the Wizard button. If the Add-On Assembly Kit is installed in the system, the following prompt is displayed: Use Wizard to create add-on? Confirm this prompt.

01.06.06 75


Do not use the general language export wizard. This appears in the following cases: - In Release 6.20 to Support Package 28: Wizard button. - In Release 6.20, Support Package 29 and higher: Wizard button:

Respond to the prompt Use Wizard to create add-on? by choosing No.

○ To guarantee the uniqueness of your language delivery, enter a name for the transport request under Export parameters in the field Transport Request, in the same way as for the other add-on delivery requests created in Software Delivery Composer:


4. After the export has been created, the language package is available in the transport subdirectory EPS/out/ in the consolidation system.

/usr/sap/trans/EPS/out

If you have not assigned a separate name for the language package, it assumes one of the following names:

Release 4.6C: <SID><Installation number>_<7-character sequential number>.PAT

Release 6.10: <2-character ISO language key><Name of the transport request>.PAT

Release 6.20 and higher: <SID><Installation number>_<7-character sequential number>.PAT

The transport request is included in the language package. If you have not assigned a separate name for the transport request, the system automatically generates a name for it.

5. Testing the add-on language package

To test the language package, copy it from the transport subdirectory EPS/out in the consolidation system for corrections into the transport subdirectory EPS/in in the test system.

For the language package, if you have not specified the software component on which it is based, make sure prior to import that this software component is installed in the system.

Before importing the language package, make sure that the test system has the same Support Package level as the consolidation system in which you created the language package. If you import the Add-On Support Packages after importing the language package, part of the imported language may be overwritten. This results in a language data inconsistency in the test system, for which a great deal of effort is needed to correct it. For further information, see the SAP Note 195442.

Import the language package into the test system using the Language Import Tool (transaction SMLT).

Check that the add-on is completely available in the new target language.

6. Migrating the language package into Software Delivery Assembler (applies for language packages of SAP Web AS 6.10 or later)

76 01.06.06


Migrate the language package into Software Delivery Assembler in the system in which you registered your other packages. This guarantees unified storage for all the packages that you have created.

The Language Import Tool does not analyze attributes that you can assign in Software Delivery Assembler (such as entering a particular Support Package level). For this reason, you do not have to assign these attributes.

7. Delivering the add-on language package

If the tests were successful, you can make the language package available for delivery [Page 70].

If the language package is based on a particular Add-On Support Package level, inform your customers that they first have to import all Add-On Support Packages that were created up to the point when the language package was created. Only after doing this can they import the language package using the Language Import Tool (transaction SMLT).

8. Post-processing actions

Since you now have to maintain the add-on in the new target language from this point as well, add the new target language in the LANGUAGE Parameter [Page 48] in your consolidation system for corrections. From now on, translate into all languages in the consolidation system for corrections.

By doing this you ensure that any Support Packages that you create after this point will also contain the newly translated target language.

If you are delivering your add-on in the required target language, in the Installation Instructions, you must draw attention to the fact that your customers must note the following import sequence: - Install the add-on package and all Support Packages that were created

up to the point when the language package was created. - Import the language package. - Import any other Support Packages that already contain the new target

language.

01.06.06 77

10 Maintenance and Upgrade

10 Maintenance and Upgrade Following the initial delivery of an add-on, the following tasks have to be performed:

● You need to correct any errors for the add-on. To do this, you create Add-On Support Packages.

● If you have made modifications to the SAP Standard for the add-on development, and they were reset by the import of an SAP Support Package, you need to recover these modifications. To do this, you create Conflict Resolution Transports.

● If you make any additional developments to the add-on, deliver them in the form of an upgrade. To do this, you create Add-On Upgrade Packages.

● An equally important task is supporting the add-on during SAP system upgrades, since you normally also have to update an installed add-on during the upgrade, so that it will be able to function in the higher SAP release.

To upgrade an add-on during an SAP upgrade (add-on exchange upgrade), you have to create one of the following packages, depending on the relevant SAP release:

○ SAP NetWeaver 2004s and higher: Add-On Exchange Package

○ SAP Web AS 6.20 and SAP NetWeaver ´04: Add-On Upgrade Package with extended attribute CREATE_FULLTASK = T

The package is included in the SAP system upgrade at the correct position.

If the add-on has been developed compatibly and can run in multiple releases without any need for modification or adjustment, you can keep your add-on without updating it during SAP system upgrades. To do this, you need to provide your customer with a special password that will allow them to use this add-on in the higher release. You can request this password from SAP.

10.1 Rules for Add-On Maintenance The following rules apply for the maintenance of your add-on:

● Do not create any new objects.

However, if you have to create new objects, you need to create them first in the development system for the lowest required add-on release in your development landscape. Then transport the objects to the development and maintenance systems in the other landscape. This ensures that the objects created in maintenance also exist in higher releases, thus preventing your add-on from being “downgraded”.

...

● Do not make any new modifications.

● Make changes to source code only. Do not make any changes to interfaces or to dictionary objects.

If you change the interface, training manuals and the like might need to be updated. Changes to dictionary objects may even lead to data loss.

● See the details under Object List Checks [Page 67].

● If your add-on contains modifications to another software component, see the Rules for Developing a Modifying Add-On [Page 54].

78 01.06.06


10.2 Creating Maintenance Packages Add-on maintenance is divided into two main areas:

● Correction of errors in the add-on delivery

Creating Add-On Support Packages

● Additionally, for modifying add-ons:

Creating Conflict Resolution Transports (CRTs)

You need to perform the modification adjustment for each SAP Support Package in the modified software component, if your modifications have been overwritten by SAP Support Packages. You have to deliver the adjusted objects in a Conflict Resolution Transport (CRT).

10.2.1 Creating an Add-On Support Package Use If you correct any errors in the add-ons that you have delivered, you need to create Add-On Support Packages (AOPs or CSPs) containing these corrections.

Certain restrictions apply concerning which changes you are allowed to make. For more information, see Rules for Add-On Maintenance [Page 78].

Procedure To create an Add-On Support Package, proceed as follows: ...

1. Make your corrections in the maintenance system.

2. Import the corrections into the consolidation/final assembly system for corrections.

3. Create the delivery with the tools in AAK (see Creating the Delivery [Page 64]).

Create the delivery in the delivery client of the consolidation system for corrections.

If you are creating Support Packages in parallel in various releases, you need to use the EQUIVALENT attribute when registering the Support Package in Software Delivery Assembler. This attribute creates a relationship between Support Packages/CRTs from various add-on releases. This helps you to ensure that corrections from the Add-On Support Packages are maintained in the higher releases during an SAP system upgrade. For more information about the EQUIVALENT attribute, see the online documentation for Software Delivery Assembler, under Tab Page: Extended Attributes.

01.06.06 79


10.2.2 Creating a Conflict Resolution Transport Use

You do not need Conflict Resolution Transports (CRTs) for developments without modifications.

A CRT resolves conflicts between add-ons and SAP Support Packages. You must first determine the conflicts between the SAP Support Packages and all the add-on deliveries for one add-on release.

When you create a CRT, the term SAP Support Package represents a Support Package for the main/application component that the add-on modifies.

For add-ons that are based on SAP Web AS 6.20, Software Delivery Composer supports the conflict calculation and CRT creation for Support Packages of layer R (application components) and an add-on from layer C (see Software Component Layers [Page 17]).

When you create CRTs, there are restrictions concerning which changes you are allowed to make. For more information, see Rules for Maintaining Add-Ons [Page 78].

Procedure To begin with, work through the steps described in Actions in the Maintenance System and then perform the actions required in the consolidation system for corrections. ...

Actions in the Maintenance System ... ...

1. Request the required Support Packages in SAP Service Marketplace at service.sap.com/patches.

2. Import the Support Packages into the maintenance system using Support Package Manager.

3. Adjust your modifications in Support Package Manager (transactions SPDD and SPAU):

a. Resolve any direct conflicts.

b. Adjust any dependent objects if necessary.

c. Adjust the copied objects if necessary.

d. For any preliminary corrections that are in the SAP Support Package, choose Return to Original.

4. If necessary, you can also still make corrections to the add-on software.

5. Check whether all the objects in transaction SPAU have been processed. Then release the following requests:

a. All modification adjustment requests

b. All transport requests that contain corrections to the add-on software, if they exist

80 01.06.06


Actions in the Consolidation System for Corrections ... ...

1. Import the SAP Support Packages that have already been imported into the maintenance system into the consolidation system for corrections (in short: consolidation system) using Support Package Manager.

2. Use Support Package Manager to import these Support Packages into the consolidation system and, if necessary, call transaction SPDD again (to adjust Dictionary objects).

3. Import the released transport requests (from the last step above) into the consolidation system.

○ If any imports or corrections contain errors, make the necessary changes in the maintenance system and transport them into the consolidation system.

4. Determine the conflicts between the SAP Support Packages that you have imported and all the add-on deliveries for one add-on release.

○ To do this, compare the add-on for each add-on release (that is, Add-On Installation Packages, Add-On Upgrade Packages, Add-On Support Packages, and Conflict Resolution Transports) with the object lists of the SAP Support Packages that you have just imported.

○ The intersection of the add-on and the SAP Support Packages contains all the modified objects that have been overwritten, and the objects that you had previously reset to original.

○ To adjust a customer system to the new add-on maintenance level, you need to re-deliver the objects that you reset to original and that are once again contained in the SAP Support Packages.

○ Use Software Delivery Composer to find the conflicts. On the initial screen of Software Delivery Composer, choose Utilities → Display/Determine Conflicts. If this check does not detect any conflicts, you do not need to create a CRT.

Software Delivery Composer checks for conflicts in

■ Repository objects

■ Logical transport objects

Software Delivery Composer does not check for conflicts between table entries.

5. If a CRT is required, create the delivery using the tools in AAK (see Creating a Delivery [Page 64]).

Create the change list of the CRT, taking into account the transport requests that you imported into the consolidation system:

a. Transport requests with a modification adjustment

b. Transport requests that contain corrections to the add-on software (if they exist)

When you create a delivery of type CRT using Software Delivery Composer, you have to select the main/application component that contains conflicts. Software Delivery Composer then automatically includes the objects causing the conflicts in the CRT change list.

Once you have included all the delivery-relevant requests in the change list, release the CRT.

If you are creating CRTs in parallel in various Releases, you need to use the EQUIVALENT attribute when registering the CRT in Software Delivery Assembler. This

01.06.06 81


attribute creates a relationship between Support Packages/CRTs from various add-on releases. This helps you to ensure that corrections from the CRTs are maintained in the higher releases during an SAP system upgrade. For more information about the EQUIVALENT attribute, see the online documentation for Software Delivery Assembler, under Tab Page: Extended Attributes.

10.3 Creating an Add-On Upgrade Package (Upgrading the Add-On Software) Use If you make any developments in addition to just error corrections in the add-on you deliver, you need to create an Add-On Upgrade Package (AOU). An Add-On Upgrade Package is used during an add-on delta upgrade (release change in the add-on without a simultaneous SAP release change). You import Add-On Upgrade Packages with SAP Add-On Installation Tool.

If you want to deliver new objects, we recommend that you always create an Add-On Upgrade Package and not an Add-On Support Package.

For add-ons based on SAP Web AS 6.20 and SAP NetWeaver ´04, you also have to create an Add-On Upgrade Package (AOU) in order to update the add-on during an SAP system upgrade. This procedure is described in detail in Updating an Add-On During an SAP System Upgrade [Page 83].

Procedure To create an Add-On Upgrade Package, proceed as follows: ...

1. Make any additional developments in the development system for the relevant add-on release.

2. Import the additional developments into the consolidation/final assembly system.

3. Create the delivery using the tools in AAK (see Creating a Delivery [Page 64]).

If you only create an Add-On Upgrade Package to update your add-on, without creating an Add-On Installation Package at the same time, you can use the extended attribute MULTISTEP_INSTALL = T when registering the Add-On Upgrade Package in Software Delivery Assembler. If this attribute is set, the add-on upgrade package can be imported in a queue together with a predecessor add-on installation package or predecessor upgrade package from the same component. Normally, only an Add-On Installation Package or an Add-On Upgrade Package is allowed in a queue.

82 01.06.06


10.4 Add-On Behavior During an SAP System Upgrade Use

This section describes the behavior of installed add-ons during an SAP system upgrade. For information about SAP system upgrades for your add-on developments and maintenance landscape, see Upgrading the Development and Maintenance Landscape [Page 49].

Whenever SAP brings out a new release, you need to decide how your add-on will react to it.

You have the following options:

● You can update your add-on during the upgrade.

In this case, you can use Add-On Assembly Kit to define either an Add-On Exchange Package (AOX) or an Add-On Upgrade Package (AOU) (the type of package depends on the release) with extended attribute CREATE_FULLTASK = T. This attribute adds the package to the upgrade in the correct position.

We recommend this option as the standard procedure.

● If your add-on runs in the new SAP release without any adjustment, you can keep your add-on during the upgrade without updating it.

In this case, you need to give your customer a password for the SAP system upgrade. You need to request this password from SAP.

You cannot use this options for modifying add-ons.

Note that you cannot delete your add-on during an upgrade. For more information, see Ending Maintenance [Page 86].

Updating an Add-On During an SAP System Upgrade If your upgrade strategy determines that the add-on is to be updated during the upgrade, you have the following options, depending on the SAP Web AS/SAP NW release in question:

● SAP NetWeaver 2004s: Create an Add-On Exchange Package (AOX)

● SAP Web AS 6.20 and SAP NetWeaver ´04: Create an Add-On Upgrade Package (AOU) with enhanced attribute CREATE_FULLTASK = T

To create these packages, proceed as follows: ...

1. Make any additional developments in the development system for the new SAP release.

2. Import the additional developments into the consolidation/final assembly system. Create the delivery using the AAK tools (see Creating a Delivery [Page 64]).

Keep the following points in mind:

a. In Software Delivery Composer, use the delivery type Installation/Upgrade to create a delivery request of type exchange component piece list.

01.06.06 83


This exchange component piece list contains the complete add-on. When the exchange component piece list is created, the associated component piece list is automatically selected and added to the same add-on release. Select the component piece lists of all add-on releases supported as upgrade start releases.

b. Register the exchange component piece list in Software Delivery Assembler. If you choose Delivery Request → Register (by SDA, Locally) in Software Delivery Composer, Software Delivery Assembler automatically calls the relevant tab page:

■ SAP NetWeaver 2004s: Tab page AOX:

To create an Add-On Exchange Package

■ SAP Web AS 6.20 and SAP NetWeaver ´04: Tab page AOU:

To create an Add-On Upgrade Package

During this activity, extended attribute CREATE_FULLTASK is automatically set to T. This ensures that the AOU is accepted as an upgrade package during the upgrade.

When defining the import conditions in Software Delivery Assembler, bear the following points in mind:

■ Make sure that you characterize the release and Support Package level of the software components in the target system sufficiently. You can, for example, specify as a prerequisite the software components that are referenced by your add-on with a particular Support Package level, or other add-ons that are referenced by your add-on.

■ Enter the add-on release of your add-on in the start release as a prerequisite in order to specify the add-on start release for the upgrade. For your add-on start release, however, you cannot specify any of your Support Packages or CRTs as prerequisites.

If your add-on also supports other add-on start releases, you can add other start releases by choosing Alternative Import Conditions.

However, you cannot use the import conditions to force installation of a new add-on during the upgrade.

3. Perform the upgrade to the new release in the test system where you have installed your add-on start release.

Before you reach the UPLOAD_REQUEST phase in the PREPARE program, place the EPS file of the created Add-On Exchange Package/Add-On Upgrade Package in the transport directory EPS/in. The EPS file is the file with the .pat extension.

If you have previously packed the delivery package to an SAR archive, as described in CD for the Add-On Delivery, and placed the packed SAR archive in directory /usr/sap/trans, the EPS file will automatically be placed in directory EPS/ when the SAP archive is unpacked. For information about packing and unpacking, see CD for the Add-On Delivery [Page 93].

During the upgrade, your add-on appears in the IS_SELECT phase with the status UNDECIDED. Select your add-on and choose OK to confirm. Now choose the option

84 01.06.06


Upgrade with SAINT package for your add-on. The Add-On Exchange Package/Add-On Upgrade Package is included in the upgrade at the right position.

If the SAP upgrade tool does not recognize your add-on, it might be because the EPS file is not in transport directory EPS/in, or that the import conditions for the add-on package have not been met.

4. After the upgrade, make sure that your add-on can run in the higher release.

5. Provide your customers with the Add-On Exchange Package/Add-On Upgrade Package and describe the procedure in the PREPARE phases UPLOAD_REQUEST and IS_SELECT. (See: Making the Delivery Available [Page 70]

Your customers can now use the Add-On Exchange Package/Add-On Upgrade Package to upgrade to the new release. The add-on is updated during the upgrade and can run in the new release.

Your customers can read more about this topic in the Upgrade Guide for the relevant release, in the section Making Entries for the Extension Module.

Keeping an Add-On (with Password) During an SAP System Upgrade ...

In exceptional circumstances, you can keep you add-on without updating it during the upgrade. To do this, you first need to make sure that your add-on can run in the new release without any adjustments being made. You then need to request a password from SAP. Your customers have to enter this password during the upgrade in order to keep their add-on.

Proceed as follows:

1. Request the password that you need in order to maintain the add-on during the upgrade from SAP. To do this, create a customer message and assign it to component XX-PROJ-AAK. Enter the name of your add-on software component (ABCD, for example) in the message, together with the target release of the SAP_BASIS component underlying the add-on (SAP_BASIS 700, for example).

2. Perform the upgrade in a test system where you have installed your add-on.

During the upgrade, your add-on appears in the IS_SELECT phase with the status UNDECIDED. Select your add-on and choose OK to confirm. Now choose the option Keep (with vendor key), and enter the password.

3. Make sure that your add-on can run in the new SAP release.

4. Give your customer this password and describe the procedure in the PREPARE phase IS_SELECT.

Your customers can now upgrade to the new SAP release without the need for an upgrade package. The add-on is kept during the upgrade and can run in the new SAP release.

01.06.06 85


10.5 Ending Maintenance You cannot delete add-ons. Add-On Assembly Kit does not support any methods for deleting add-ons from a system.

This has the following effects:

● You must ensure that the add-on works in every Support Package for the SAP release that the add-on is based on.

● You also have to react to every SAP upgrade. You can either update the add-on simultaneously or, in exceptional circumstances, keep the add-on without making any adjustments. For more information, see Add-On Behavior During an SAP System Upgrade [Page 83].

During the upgrade, do not select the Delete option during the PREPARE phase. This option can lead to inconsistencies in the target release, as there is no way of ensuring that your add-on has been completely deleted. If you want to prevent the Delete option from being selectable, you can inform SAP of this. To do this, create a customer message and assign it to component XX-PROJ-AAK. As the title for your message, enter “Prevent ’Delete’ Option in IS_SELECT Phase”. Enter the name of your add-on software component (ABCD, for example) in the message. For upgrades to SAP NW 2004s and higher, the Delete option can no longer be selected. For upgrades to SAP NW ’04 or SAP Web AS 6.20, an error message is displayed if the Delete option is displayed. If you create the customer message in good time before the upgrade, the SAP upgrade tool will contain details of your add-on. If you do not create the customer message until after the SAP upgrade tool has been delivered, details of your add-on will be delivered with corrections to the SAP upgrade tool. In this case, import the corrections to the SAP upgrade tool before the upgrade. You need to inform your customers that they need to import the latest corrections too. The following SAP Notes have been created for this purpose:

SAP Release SAP Note Number

SAP Web AS 6.20 522711: Repairs for Upgrades to Basis 6.20

SAP NetWeaver AS 6.40 663258:Corrections for R3up Version 6.40

SAP NetWeaver AS 7.00 821032: Corrections for SAPup Release 7.00

86 01.06.06

11 Additional Information

11 Additional Information This section provides information about the following topics:

Overview: Installation Tools []

Conflicts [Page 88]

CD for the Add-On Delivery [Page 93]

Troubleshooting [Page 95]

Paths to Documentation in SAP Help Portal [Page 96]

Terminology [Page 101]

11.1 Overview: Installation Tools The installation tools for add-on packages are:

Tool Description

SAP Add-On Installation Tool (Transaction SAINT)

Installs and upgrades add-ons directly from the SAP system

Support Package Manager (Transaction SPAM)

Imports Support Packages (such as Add-On Support Packages, Conflict Resolution Transports)

R3up/SAPup Controls the SAP system upgrade based on ABAP. To update the add-on during an SAP system upgrade, Add-On Upgrade Packages and Add-On Exchange Packages can be added to the SAP system upgrade.

R3up is used for SAP system upgrades for NetWeaver 2004 and lower.

SAPup is used for SAP system upgrades for NetWeaver 2004s and higher.

Detailed online documentation is provided for each tool in SAP Add-On Installation Tool and Support Package Manager. For details about system upgrades with R3up and SAPup, see the Upgrade Guides in SAP Service Marketplace, under service.sap.com/instguides.

01.06.06 87


11.2 Conflicts If your add-on contains modifications, that is, it delivers changes to a different software component to your own, you may encounter conflicts when installing it.

Conflicts can occur in the following cases:

● During installation: When installing/upgrading an add-on with the Add-On Installation Tool

● During maintenance: When importing Support Packages with Support Package Manager

When packages are imported, Add-On Installation Tool and Support Package Manager check for conflicts with existing add-ons or Support Packages. Conflicts only occur with modifying add-ons. If, for example, an add-on modifies an object that is then delivered again with a SAP Support Package, the person who created the add-on has to resolve this conflict. Otherwise, the Support Package cannot be imported. If you have created an add-on that contains modifications, you have to react to any conflicts in order to ensure that your add-on can still run. Conflict resolution means a lot of extra effort, and is sometimes not possible.

For further information, see:

● Background Information: Conflict Check []

● Conflicts When Installing/Upgrading an Add-On [Page 89]

● Conflicts When Importing Support Packages [Page 92]

11.2.1 Background Information: Conflict Check Up to and Including SAP Web AS 6.10 Add-ons that are based on SAP Web AS 6.10 and lower can reference (call) and modify objects from the underlying main components. Add-On Assembly Kit supports the conflict check and the creation of Conflict Resolution Transports for conflicts between the add-on and Support Packages for the main component.

SAP Web AS 6.20 and higher Since the introduction of the software component hierarchy in SAP Web AS 6.20, add-ons that are created with Add-On Assembly Kit are situated in layer ’C’. Add-ons in layer ’C’ can reference objects from components in lower layers. Modifications are therefore only possible to objects from software components in layer ’R’. Add-On Assembly Kit supports the conflict check and the creation of Conflict Resolution Transports only for conflicts between the add-on and Support Packages from layer ‘R’.

88 01.06.06


References and Modifications in the Software Component Hierarchy

E

C

I

N

P

R ...

SAP NetWeaver Basis ComponentsS

X

W

Enhancements ...

...

O

GH

F

Development Projects ...

...

...

...

Application Platform ComponentsV

Industry Solutions, Country Versions

Shared Objects for Enhancement s

Application Components

SAP NetWeaver Add-On Components

SAP NetWeaver Plug-In Components

Application Plug-In Components

Referencepossible

Modificationpossible

Layer 3

Layer 1Layer 2

Layer 4Layer 5

11.2.2 Conflicts When Installing/Upgrading an Add-On When an add-on is installed or upgraded, Add-On Installation Tool checks for the following conflicts:

Conflicts with Add-On Components in Lower Layers Add-On Installation Tool checks for conflicts with add-on components in lower layers.

Example: Add-on 1 in layer ’I’ and add-on 2 in layer ’C’ modify the same object in component SAP_APPL (in layer ’R’). Add-on 1 has already been installed. During installation of add-on 2, Add-On Installation Tool detects a conflict and aborts the installation process.

If you want add-on 1 and add-on 2 to be installed in one system at the same time, and you created add-on 2 yourself, you now need to resolve the conflict. To do this, you need to define add-on 1 as a prerequisite for add-on 2. Add-on 1 must therefore be installed as a condition for installing add-on 2. In this case, no conflict check is performed for the prerequisite component. To ensure that add-on 1 can still run, however, you need to make sure that add-on 2 contains the modification from add-on 1. This means that add-on 1 also needs to be installed in your system landscape, so that you can test the functionality of both add-ons.

01.06.06 89


You specify the prerequisite relationship using the import conditions in Software Delivery Assembler. When registering the package, select the Import Conditions tab page under Add-On Component and enter the release for add-on 1, and then select the option T (= True).

SAP_APPL

SAP_BASIS / SAP Web AS/ SAP NetWeaver

#Layer ‘C‘

Layer ‘R‘

1 2

Layer ‘I ‘ Add-On 1

x

Add-On 2

SAP_APPL


Add-On 1

Add-On 2 Add-on 1 is a prerequisite foradd-on 2

x

Conflict Solution

xx

Conflicts with Add-On Components from the Same Layer Add-On Installation Tool checks for conflicts with add-on components in the same layer.

Example: Add-on 1 and add-on 2 in layer ’C’ both modify the same object in component SAP_APPL (in layer ’R’). Add-on 1 has already been installed. During installation of add-on 2, Add-On Installation Tool detects a conflict and aborts the installation process.

In this case, there is no way of resolving the conflict. It is not possible for both add-ons to be installed in one system.

SAP_APPL

SAP_BASIS/ SAP W eb AS/ SAP NetW eaver

#Layer ‘C‘

Layer ‘R‘

xAdd-On 2Add-On 1

The conflict cannot be resolved

90 01.06.06


Conflicts with Support Packages in Lower Layers Add-On Installation Tool checks for conflicts with Support Packages from software components in lower layers that exceed the import conditions, that is, with installed Support Packages whose level is higher than the prerequisite Support Package level in the import conditions. Add-On Installation Tool does not check for conflicts with Support Packages that are prerequisite in the import conditions.

Example: An add-on in layer ’C’ modifies objects in component SAP_APPL (in layer ’R’). Four SAP_APPL Support Packages are prerequisites for the add-on. In one system, seven SAP_APPL Support Packages have already been imported. Support Packages 5 and 6 contain corrections to some of the objects modified by the add-on. When the add-on is installed in this system, Add-On Installation Tool detects conflicts with Support Packages 5 and 6. It then prompts the user to add a Conflict Resolution Transport to the queue.

If you created the add-on, you are responsible for resolving the conflict. You do this by creating Conflict Resolution Transport for Support Packages 5 and 6, or by creating a collective CRT for both of them. The procedure is described under Creating a Conflict Resolution Transport [Page 80].

Add-On

SAP_APPL

SAP_BASIS/ SAP Web AS/ SAP NetWeaver

#Layer ‘C‘

Layer ‘R‘

SP1SP5

SP2

SP3SP4

SP6SP7

#Add-On

SAP_APPL


SP1

SP2

SP3SP4

SP7

CRT CRT

1 Conflict 2 Solution

Conflicts with Add-On Components in Higher Layers During add-on installation, Add-On Installation Tool checks for conflicts with add-on components in higher layers.

Example: Add-on 1 in layer ’I’ and add-on 2 in layer ’C’ modify the same object in component SAP_APPL (in layer ’R’). Both add-ons are installed in one system. SAP now creates an upgrade package (AOU) for add-on 1 in layer ’I’. This contains the modified object again. When add-on 1 is upgraded, Add-On Installation Tool detects conflicts with add-on 2 and aborts the upgrade package installation process, in order to prevent the modifications from add-on 2 from being overwritten.

If you created the add-on, you are responsible for resolving the conflict. You also do this by creating an upgrade package (AOU).

To do this, you need to assign the extended attribute MULTISTEP_INSTALL to your upgrade package in Software Delivery Assembler. This allows Add-On Installation Tool to install two upgrade packages in one installation queue at the same time. In this case, these are: AOU 1 for add-on 1 and AOU 2 for add-on 2. Normally, only one installation or one upgrade package

01.06.06 91


is allowed. While registering the package, select the Extended Attributes tab page and select MULTISTEP_INSTALL. Then assign the value T (=True) to this attribute.

Layer ‘C‘

Layer ‘R‘

Layer ‘I ‘

SAP_APPL


Add-On 1

Add-On 2 Add-On 1 isprerequisite forAdd-On 2

AOU 1

SAP_APPL


Add-On 1

Add-On 2

AOU 1

AOU 2 withMULTIST EP_INSTALL

AOU 2

#

x

xx


x

11.2.3 Conflicts When Importing Support Packages Whenever Support Packages are imported, Support Package Manager checks for conflicts with add-on components from higher layers.

Example: An add-on from layer ’C’ modifies an object from component SAP_APPL (from layer ’R’). If a SAP_APPL Support Package contains corrections to the modified object, Support Package Manager identifies a conflict and prompts the user to add a Conflict Resolution Transport to the queue.

If you created the add-on, you are responsible for resolving the conflict. You do this by creating a Conflict Resolution Transport for the Support Package. The procedure is described under Creating a Conflict Resolution Transport [Page 80].

Add-On

SAP_APPL


#Layer ‘C‘

Layer ‘R‘

SP

Add-On

SAP_APPL

CRT



92 01.06.06


11.3 CD for the Add-On Delivery This document contains information about the following topics:

● Structure of an installation CD/add-on upgrade CD

○ Structure of a CD with an add-on for multiple SAP Releases

○ Structure of a CD with multiple add-ons for one SAP Release

● Creating packed CD delivery data

● Unpacking SAR archives

Structure of an installation CD/add-on upgrade CD This structure is valid for a CD with an add-on for one SAP release.

Determine the structure of the CD as follows:

● DATA (mandatory)

In this directory, store the SAR archive for each add-on package.

● LANGUAGE (optional)

If there are any language-specific files, store them in this directory.

● PATCHES (optional)

If necessary, you can store the SAR archives for each Add-On Support Package in this directory.

● DOCU (optional)

Store the technical documentation about the import procedure in this directory. (See: Template: Installation Instructions [Page 71])

You can also store the add-on-specific documentation in this directory.

● README.ASC (mandatory)

This file lists all the files that are on the CD and includes a short description of each.

Create the README.ASC file. After creating this file under UNIX, create the relevant EBCDIC file using the following command:

dd if=README.ASC of=README.EBC conv=ebcdic

You need the dd command in order to convert the README.ASC file for the IBM eServer iSeries and IBM z/OS platforms into README.EBC.

The dd command is known under UNIX. For Windows, you have to install the additional package Windows Services for UNIX.

Structure of a CD with an add-on for multiple SAP Releases ● Directory for SAP Release 1

○ DATA (see above)

○ (LANGUAGE) (see above)

01.06.06 93


○ (PATCHES) (see above)

○ (DOCU) (see above)

● Directory for SAP Release n





● README.ASC (see above)

● README.EBC (see above)

Structure of a CD with multiple add-ons for one SAP Release ● Directory for add-on 1





● Directory for add-on n





● README.ASC (see above)

● README.EBC (see above)

Creating packed CD delivery data When delivering an add-on by CD, you have to store the actual delivery data as a packed SAR archive in the DATA subdirectory on the CD.

To generate *.SAR archives, use the SAPCAR tool. SAPCAR is on the Kernel CD in every hardware directory (HPUX, AIX, and so on). For more information on the SAPCAR tool, see SAP Note 212876.

The SAR archive must conform to ISO standard 9660, level 2 for file and directory names.

● Maximum of 31 characters for all file and directory names

● Use only uppercase letters, numbers and underscores.

To create SAP archives for delivery packages, proceed as follows (example Unix): ...

94 01.06.06


1. Change to the transport directory: cd /usr/sap/trans

2. Copy the *.PAT file from the EPS/out directory to the EPS/in directory:

cp EPS/out/<PAT file> EPS/in/<PAT file>

The *.PAT file is the delivery package that was created with Software Delivery Assembler.

3. Use the following command to pack the files in the transport directory: SAPCAR -cvf <name>.SAR EPS/in/<PAT file>

Replace <name> with the name that corresponds to your add-on package and the ISO norm mentioned earlier.

Unpacking SAR archives The command for manually unpacking SAR archives for Unix is SAPCAR –xvf /usr/sap/trans/<name>.SAR.

To unpack SAR archives, you can use the function Load Packages → From Front End in Support Package Manager or Add-On Installation Tool. This uploads the SAR archive and unpacks it at the same time. To do this, choose on of the following menu options:

Import/Installation Tool Menu Option

Support Package Manager Support Package → Load Packages → From Front End.

Add-On Installation Tool Installation Package → Load Packages → From Front End.

11.4 Troubleshooting You can enter messages regarding the Add-On Assembly Kit in the SAP Support Portal, under service.sap.com/message. Use the component XX-PROJ-AAK.

See the corrections to Software Delivery Composer and Software Delivery Assembler in the SAP Notes 943780 and 943901.

01.06.06 95


11.5 Paths to Documentation in SAP Help Portal This section provides you with paths for further information in the various releases in SAP Help Portal, under help.sap.com.

Topic Release Further information in SAP Help Portal

SAP NW 2004s

Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Logistics → Change and Transport System ( → Transport Management System (BC-CTS-TMS)/Language Transport (BC-CTS-LAN))

SAP NW 2004 (SAP Web AS 6.40)

Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver → Solution Lifecycle Management Software Change Management → Change and Transport System ( → Transport Management System (BC-CTS-TMS)/Language Transport (BC-CTS-LAN))

SAP Web AS 6.20

Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.20: English → mySAP-Technology Components → SAP Web Application Server → Change and Transport System (BC-CTS) ( → Transport Management System (BC-CTS-TMS)/Language Transport (BC-CTS-LAN))

SAP Web AS 6.10

Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.10: English → SAP Web Application Server → Change and Transport System (BC-CTS) ( → Transport Management System (BC-CTS-TMS)/Language Transport (BC-CTS-LAN))

Change and Transport System

Transport Management System

Language Transport

SAP Basis 4.6C

Documentation → SAP R/3 and R/3 Enterprise → SAP R/3 Release 4.6C → English → Basis → Change and Transport System (BC-CTS) ( → Transport Management System (BC-CTS-TMS)/Language Transport (BC-CTS-LAN))

SAP NW 2004s

Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP-NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Software Life-Cycle Management → Software Maintenance


Documentation → SAP NetWeaver → SAP NetWeaver 2004 → English → SAP NetWeaver → Solution Life Cycle Management → Software Change Management → Software Maintenance

Software Maintenance

(To receive the current version of the documentation for the software maintenance tools, call the help function in the toolbar on the entry screen for the tool in question)

SAP Web AS 6.20

Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.20:

96 01.06.06

http://help.sap.com/saphelp_nw04s/helpdata/en/14/94fc3f8fc2c542e10000000a1550b0/frameset.htm







http://help.sap.com/saphelp_nw04/helpdata/en/14/94fc3f8fc2c542e10000000a1550b0/frameset.htm






http://help.sap.com/saphelp_webas620/helpdata/en/ea/fab8c64eed11d192f60000e829fbc6/frameset.htm












http://help.sap.com/saphelp_46c/helpdata/en/ea/fab8c64eed11d192f60000e829fbc6/frameset.htm





http://help.sap.com/saphelp_nw2004s/helpdata/en/06/d2bf629c1644489c156ffc094bedd8/frameset.htm





http://help.sap.com/saphelp_nw04/helpdata/en/06/d2bf629c1644489c156ffc094bedd8/frameset.htm




http://help.sap.com/saphelp_webas620/helpdata/en/14/d07447b6b211d2ab110000e829fbc6/frameset.htm



English → mySAP-Technology Components → SAP Web Application Server → General Upgrade (BC-UPG) → Online Correction Support (BC-UPG-OCS)

SAP Web AS 6.10

Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.10: English → SAP Web Application Server → General Upgrade (BC-UPG) → Online Correction Support (BC-UPG-OCS)

SAP Basis 4.6C

Documentation → SAP R/3 and R/3 Enterprise → SAP R/3 Release 4.6C → English → Basis → General Upgrade (BC-UPG) → Online Correction Support (BC-UPG-OCS)

SAP NW 2004s

Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP-NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → Documentation and Translation Tools (BC-DOC)


Documentation → SAP NetWeaver → SAP NetWeaver 2004 → English → SAP NetWeaver → Application Platform → ABAP Technology → Documentation and Translation Tools (BC-DOC)

SAP Web AS 6.20

Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.20: English → mySAP-Technology Components → SAP Web Application Server → Documentation and Translation Tools (BC-DOC)

SAP Web AS 6.10

Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.10: English → SAP Web Application Server → Documentation and Translation Tools (BC-DOC)

Documentation and translation tools

SAP Basis 4.6C

Documentation → SAP R/3 and R/3 Enterprise → SAP R/3 Release 4.6C → English → Basis → Documentation and Translation Tools (BC-DOC)

SAP NW 2004s

● Documentation → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Programming and Runtime Environment (BC-ABA)

● Documentation → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench (BC-DWB)

Basic knowledge of ABAP programming

SAP NW 2004 (SAP Web AS

● Documentation → SAP NetWeaver → SAP NetWeaver 2004 → English → SAP NetWeaver → Application Platform → ABAP Technology → ABAP Programming and Runtime Environment

01.06.06 97






http://help.sap.com/saphelp_46c/helpdata/en/14/d07447b6b211d2ab110000e829fbc6/frameset.htm




http://help.sap.com/saphelp_nw2004s/helpdata/en/dd/ae56554bb411d192f20000e829fbc6/frameset.htm





http://help.sap.com/saphelp_nw04/helpdata/en/dd/ae56554bb411d192f20000e829fbc6/frameset.htm




http://help.sap.com/saphelp_webas620/helpdata/en/dd/ae56554bb411d192f20000e829fbc6/frameset.htm









http://help.sap.com/saphelp_46c/helpdata/en/dd/ae56554bb411d192f20000e829fbc6/frameset.htm



http://help.sap.com/saphelp_nw2004s/helpdata/en/6f/c7b041548011d192fd0000e829fbc6/frameset.htm






http://help.sap.com/saphelp_nw2004s/helpdata/en/ab/5c46f64c5911d192f30000e829fbc6/frameset.htm





http://help.sap.com/saphelp_nw04/helpdata/en/6f/c7b041548011d192fd0000e829fbc6/frameset.htm





6.40) (BC-ABA)

● Documentation → SAP NetWeaver 2004 → English → SAP NetWeaver → Application Platform → ABAP Technology → ABAP Workbench (BC-DWB)

SAP Web AS 6.20

● Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.20: English → mySAP Technology Components → SAP Web Application Server → ABAP Programming and Runtime Environment (BC-ABA)

● SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.20: English → mySAP Technology Components → SAP Web Application Server → ABAP Workbench (BC-DWB)

SAP Web AS 6.10

● Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.10: English → SAP Web Application Server → ABAP Programming and Runtime Environment (BC-ABA)

● Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.10: English → SAP Web Application Server → ABAP Workbench (BC-DWB)

SAP Basis 4.6C

● Documentation → SAP R/3 and R/3 Enterprise → SAP R/3 Release 4.6C → English → Basis → ABAP Programming and Runtime Environment (BC-ABA)

● Documentation → SAP R/3 and R/3 Enterprise → SAP R/3 Release 4.6C → English → Basis → ABAP Workbench (BC-DWB)

SAP NW 2004s

Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP-NetWeaver Library → SAP NetWeaver by Key Capability → Application Platform by Key Capability → ABAP Technology → ABAP Workbench (BC-DWB) → ABAP Workbench: Tools → Package Builder


Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP-NetWeaver → Application Platform → ABAP Technology → ABAP Workbench (BC-DWB) → ABAP Workbench: Tools → Package Builder

SAP Web AS 6.20

Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.20: English → mySAP-Technology Components → SAP Web Application Server → ABAP Workbench (BC-DWB) → BC - ABAP Workbench: Tools → Package Builder

Package concept

SAP Web Documentation → SAP NetWeaver → Prior to SAP

98 01.06.06


http://help.sap.com/saphelp_nw04/helpdata/en/ab/5c46f64c5911d192f30000e829fbc6/frameset.htm



http://help.sap.com/saphelp_webas620/helpdata/en/6f/c7b041548011d192fd0000e829fbc6/frameset.htm





http://help.sap.com/saphelp_webas620/helpdata/en/ab/5c46f64c5911d192f30000e829fbc6/frameset.htm













http://help.sap.com/saphelp_46c/helpdata/en/6f/c7b041548011d192fd0000e829fbc6/frameset.htm




http://help.sap.com/saphelp_46c/helpdata/en/ab/5c46f64c5911d192f30000e829fbc6/frameset.htm



http://help.sap.com/saphelp_nw2004s/helpdata/en/af/40bd38652c8c42e10000009b38f8cf/frameset.htm






http://help.sap.com/saphelp_nw04/helpdata/en/af/40bd38652c8c42e10000009b38f8cf/frameset.htm




http://help.sap.com/saphelp_webas620/helpdata/en/af/40bd38652c8c42e10000009b38f8cf/frameset.htm







AS 6.10 NetWeaver 2004 → SAP Web Application Server 6.10: English → SAP Web Application Server → ABAP Workbench (BC-DWB) → BC - ABAP Workbench: Tools → Package Builder

SAP Basis 4.6C

No documentation available.

SAP NW 2004s

● BC-Sets: Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Customizing → Business Configuration Sets (BC-CUS)

● IMG Enhancements: Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP NetWeaver Library → SAP NetWeaver by Key Capability → Solution Lifecycle Management by Key Capability → Customizing → Customizing → Implementation Guide (IMG) → Working with the IMG → Enhancing the IMG


● BC-Sets: Documentation → SAP NetWeaver → SAP NetWeaver 2004 → English → SAP-NetWeaver → Solution Lifecycle Management → Customizing → Business Configuration Sets (BC-CUS)

● IMG Enhancements: Documentation → SAP NetWeaver → SAP NetWeaver 2004 → English → SAP NetWeaver → Solution Lifecycle Management → Customizing → Customizing → Implementation Guide (IMG) → Working with the IMG → Enhancing the IMG

SAP Web AS 6.20

● BC-Sets: Documentation → SAP NetWeaver → Prior to SAP NetWeaver → SAP Web Application Server 6.20 → English → mySAP Technology Components → SAP Web Application Server → Customizing (BC-CUS) → Business Configuration Sets (BC-CUS)

● IMG enhancements: Documentation → SAP NetWeaver → Prior to SAP NetWeaver → SAP Web Application Server 6.20 → English → mySAP-Technology Components → SAP Web Application Server → Customizing (BC-CUS) → Customizing (BC-CUS) → Implementation Guide (IMG) → Working with the IMG → Enhancing the IMG

BC sets and IMG enhancements

SAP Web AS 6.10

● BC-Sets: Documentation → SAP NetWeaver → Prior to SAP NetWeaver → SAP Web Application Server 6.10 → English → SAP Web Application Server → Customizing (BC-CUS) → Business Configuration Sets (BC-CUS)

01.06.06 99

http://help.sap.com/saphelp_nw2004s/helpdata/en/cd/a22237406d183fe10000009b38f889/frameset.htm






http://help.sap.com/saphelp_nw2004s/helpdata/en/db/864e4052d411d182c50000e829fbfe/frameset.htm







http://help.sap.com/saphelp_nw04/helpdata/en/cd/a22237406d183fe10000009b38f889/frameset.htm





http://help.sap.com/saphelp_nw04/helpdata/en/db/864e4052d411d182c50000e829fbfe/frameset.htm






http://help.sap.com/saphelp_webas620/helpdata/en/cd/a22237406d183fe10000009b38f889/frameset.htm






http://help.sap.com/saphelp_webas620/helpdata/en/db/864e4052d411d182c50000e829fbfe/frameset.htm













● IMG enhancements: Documentation → SAP NetWeaver → Prior to SAP NetWeaver → SAP Web Application Server 6.10 → English → SAP Web Application Server → Customizing (BC-CUS) → Customizing (BC-CUS) → Implementation Guide (IMG) → Working with the IMG → Enhancing the IMG

SAP Basis 4.6C

● BC-Sets: Documentation → SAP R/3 and R/3 Enterprise → SAP R/3 Release 4.6C → English → Basis → Customizing (BC-CUS) → Business Configuration Sets (BC-CUS)

● IMG enhancements: Documentation → SAP R/3 and R/3 Enterprise → SAP R/3 Release 4.6C → English → Basis → Customizing (BC-CUS) → Implementation Guide (IMG) → Working with the IMG → Enhancing the IMG

SAP NW 2004s

Documentation → SAP NetWeaver → SAP NetWeaver 2004s → English → SAP-NetWeaver Library → SAP NetWeaver by Key Capability → Security → Identity Management → Users and Roles (BC-SEC-USR)


Documentation → SAP NetWeaver → SAP NetWeaver 2004 → English → SAP-NetWeaver → Security → Identity Management → Users and Roles (BC-SEC-USR)

SAP Web AS 6.20

Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.20: English → mySAP-Technology Components → SAP Web Application Server → Security (BC-SEC) → Users and Roles (BC-SEC-USR)

SAP Web AS 6.10

Documentation → SAP NetWeaver → Prior to SAP NetWeaver 2004 → SAP Web Application Server 6.10: English → SAP Web Application Server → Computing Center Management System (BC-CCM) → Users and Roles (BC-CCM-USR)

Roles and authorizations

SAP Basis 4.6C

Documentation → SAP R/3 and R/3 Enterprise → SAP R/3 Release 4.6C → English → Basis → Computing Center Management System (BC-CCM) → Users and Roles (BC-CCM-USR)

100 01.06.06








http://help.sap.com/saphelp_46c/helpdata/en/cd/a22237406d183fe10000009b38f889/frameset.htm




http://help.sap.com/saphelp_46c/helpdata/en/db/864e4052d411d182c50000e829fbfe/frameset.htm





http://help.sap.com/saphelp_nw2004s/helpdata/en/52/671126439b11d1896f0000e8322d00/frameset.htm




http://help.sap.com/saphelp_nw04/helpdata/en/52/671126439b11d1896f0000e8322d00/frameset.htm



http://help.sap.com/saphelp_webas620/helpdata/en/52/671126439b11d1896f0000e8322d00/frameset.htm










http://help.sap.com/saphelp_46c/helpdata/en/52/671126439b11d1896f0000e8322d00/frameset.htm





11.6 Terminology This is a list of some of the most common terms in this documentation:

● Add-On

Software component that can be installed in the system as an extra. Add-ons can be industry, country, or company-specific enhancements of the standard SAP system, and can also be customer or partner projects.

They are installed using a delivery package that is imported using Add-On Installation Tool. The delivery package is a combination of a number of transport requests and contains the development objects from the add-on.

● Add-On Delta Upgrade

An add-on release change without a simultaneous SAP system upgrade.

● Add-On Exchange Package

Used for the add-on exchange upgrade, Add-On Exchange Packages were introduced in SAP NetWeaver 2004s.

● Add-On Exchange Upgrade

An add-on release change with a simultaneous SAP system upgrade.

● Add-On Support Package

Support Package for an add-on. Depending on the underlying SAP release, the package type is either AOP (for Add-On Support Packages up to and including SAP Web AS 6.20) or CSP (for Component Support Packages from NetWeaver 2004/SAP Web AS 6.40 onwards).

● Application Component

Software component that is not part of the SAP NetWeaver ´04 platform and cannot be installed subsequently in an SAP system, such as SAP_APPL or SAP_HR.

● Change List

A list of all new and changed objects in Software Delivery Composer, which are relevant for a given delivery.

These include:

○ Change piece list

○ Supplement change piece list

○ Support Package

○ CRT

● Change Piece List

A list in Software Delivery Composer with new, changed and deleted objects for the delivery component for an add-on upgrade.

● Change Request

Information source in the Transport Organizer that records and manages all changes made to Repository objects and Customizing settings during a development project.

01.06.06 101


● Component Piece List

A list in Software Delivery Composer of all objects in the current delivery component for an add-on installation.

The component piece list includes the current change piece list and the component piece list from the previous version.

● Conflict Resolution Transport (CRT) ...

a. A list in Software Delivery Composer with adjusted software objects for a modified delivery component for a Conflict Resolution Transport. A Conflict Resolution Transport can also contain corrected software objects for the delivery component.

b. Package type in Software Delivery Assembler. Restores add-on specific modifications that have been overwritten by SAP Support Packages.

● Delivery

Group of software objects that are delivered together.

A delivery consists of a delivery component. Deliveries are used for installations, upgrades, Support Packages and Conflict Resolution Transports.

There may be dependencies between different deliveries, so that only certain combinations of deliveries can produce a functioning system.

● Delivery Component

Set of software objects. A delivery component is made up of the following objects:

○ Software objects from the modifying software component

○ Modified objects from another software component

● Delivery Request

List in Software Delivery Composer of all transport and software objects that are relevant for a particular delivery.

These include:

○ Change list

○ Component piece list

○ Supplement component piece list

○ Exchange component piece list

○ Exclusion lists

● Delivery Type

The delivery type defines how the delivery and the required delivery requests are created. When a delivery is created, Software Delivery Composer distinguishes the following delivery types:

○ Installation/Upgrade

○ Upgrade Supplement (up to SAP NetWeaver ´04)

○ Conflict Resolution Transport

102 01.06.06


○ Support Package

● Exchange Component Piece List

A list of all objects in the current delivery component for an add-on exchange upgrade.

The exchange component piece list includes the current component piece list and the component piece lists from the predecessor versions supported as start releases.

The package type with which the exchange component piece list is registered in Software Delivery Assembler depends on the SAP Web AS / SAP NetWeaver release:

○ SAP Web AS 6.20 and 6.40:

Add-On upgrade package (AOU) with extended attribute 'CREATE_FULLTASK=T'

○ SAP NetWeaver 2004s:

Add-On Exchange Package (AOX)

● Exclusion List

A list of objects in a software component that are not to be delivered with the current delivery.

● Main Component (up to and including SAP Web AS 6.10)

Software component in the SAP system that is not defined as an add-on, such as SAP_BASIS or SAP_HR. In later releases, main components are divided into application components and Web-AS NetWeaver components.

● Modification

Customer-specific change to SAP Repository objects

Modified SAP Repository objects are identified and offered for modification adjustment when you import changes that are made by SAP.

In the case of Add-On Assembly Kit, a modification is a change that is made by the add-on development to an object in the standard SAP System.

● Namespace

ID assigned by SAP that allows SAP customers and SAP partners to develop their own SAP components and products using SAP applications, without the risk of naming conflicts. (Naming conflicts can occur during transports to external SAP Systems or when importing external products into your own systems.) To acquire a namespace, you need to request it in SAP Service Marketplace.

You assign objects to a namespace in the ABAP Workbench by placing the namespace prefix in front of the object name. The namespace ID begins and ends with a delimiter (“/”), and can be up to 10 characters long.

A namespace is also required when creating the add-on software component and the delivery using Add-On Assembly Kit.

● Namespace Role

Defines the origin of the development objects and the type of changes that you are permitted to make to the objects in this namespace.

You can only choose the producer role P if you have a known development license. You can create new objects.

01.06.06 103


You can use the recipient role C for repairs if you have entered a valid repair license. Systems that are the recipients of the namespace always have the role C. You can use the functions developed in this namespace. However, no developments are possible.

● Package Type

Type of importable package.

Software Delivery Assembler converts delivery requests into importable packages. You can use Add-On Assembly Kit to create the following package types:

○ Add-On Installation Package (AOI)

○ Add-On Upgrade Package (AOU)

○ Add-On Support Package (AOP or CSP)

○ Conflict Resolution Transport (CRT)

○ Add-On Exchange Package (AOX)

● SAP Standard

Standard SAP software. This includes all components in an SAP delivery, such as SAP R/3 Enterprise or mySAP Business Suite, with all the accompanying components.

● SAP System Upgrade

SAP software release change - performed using the SAP upgrade tool R3up or SAPup. The SAP system upgrade generally contains a SAP Basis/SAP Web Application Server/SAP NetWeaver release change.

● Software Component

Set of software objects that are grouped in packages and can only be delivered together. There are usually several release versions of a software component. These components are updated by upgrades.

You can create Support Packages for each software component.

● Supplement change piece list

A list in Software Delivery Composer with new and changed software objects for the delivery component for an upgrade supplement; that is, for the connection to the SAP system upgrade. The supplement change piece list is available for releases up to and including SAP Web AS 6.10.

● Support Package ...

a. A list in Software Delivery Composer with corrected software objects for the delivery component for an Add-On Support Package.

b. Package type in Software Delivery Assembler. Contains improvements in quality for a specific software component.

104 01.06.06

aak tool version 4.0

Documents