User Guide PUBLIC SAP Add-On Assembly Kit 5.0 Support Package 1.1 Document Version: 1.0 – 2016-05-23 SAP Add-On Assembly Kit Content 1 SAP Add-On Assembly Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.1 Authorization Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 2 About This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 2.1 Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 2.2 New Features in Version 5.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 3 Background Information: Add-Ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 4 Software Component Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14 4.1 Software Component Hierarchy from SAP Web AS 6.40 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16 5 Process Flow: SAP Add-On Assembly Kit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18 6 Defining the Delivery Strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 7 Defining the Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21 7.1 Rules for Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22 7.2 Reserving a Namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 7.3 Add-On Software Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 7.4 Add-On Release Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 7.5 Naming Conventions for Delivery Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27 8 Setup of the System Landscape and Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 8.1 System Landscape for Add-On Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Setting Up a Development Landscape for the First Add-On Release . . . . . . . . . . . . . . . . . . . . . . . . 30 Setting Up a Development Landscape for Further SAP Releases . . . . . . . . . . . . . . . . . . . . . . . . . . .31 8.2 System Landscape for Add-On Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 Setting Up Systems for Add-On Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33 8.3 Developing Multiple Add-Ons in a System Landscape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35 8.4 Client Layout and Transport Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36 8.5 Installing SAP Add-On Assembly Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38 8.6 Making Settings for the Development and Consolidation System . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Entering a Namespace and Defining a Namespace Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39 Creating or Updating an Add-On Software Component and Add-On Release Name . . . . . . . . . . . . . 40 Setting the System Change Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Configuring Parameters for the Transport Control Program tp . . . . . . . . . . . . . . . . . . . . . . . . . . . .42 8.7 Making Settings for the Maintenance Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 8.8 Upgrading the Development and Maintenance Landscape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 PUBLIC SAP Add-On Assembly Kit 2 © 2016 SAP SE or an SAP affiliate company. All rights reserved. Content 8.9 Test Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45 9 Add-On Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46 9.1 Creating and Assigning Packages (Transaction SE80) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46 9.2 Rules for Add-On Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Rules for Developing Add-Ons in Multiple SAP Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 9.3 Additional Information About Enhancements and Modifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 9.4 Documentation and Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50 10 Delivering the Add-On Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52 10.1 Package Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53 10.2 Final Assembly System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56 10.3 Creating Deliveries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Object List Checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61 10.4 Creating Add-On Installation Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68 10.5 Making a Delivery Available . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Template: Installation Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69 10.6 Delivering Languages Translated Retroactively . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 11 Maintenance and Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 11.1 Rules for Add-On Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76 11.2 Creating Maintenance Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Creating Add-On Support Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 11.3 Creating Add-On Upgrade Packages (Upgrading the Add-On Software) . . . . . . . . . . . . . . . . . . . . . . . .77 11.4 Add-On Behavior in SAP System Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78 11.5 End of Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 12 Add-On Uninstallation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 12.1 Checklist: Development Aspects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82 12.2 Checklist: Landscape Aspects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 12.3 Checklist: System Aspects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84 12.4 Checklist: Test Aspects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 12.5 Checking Add-Ons for Uninstallability. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 12.6 Attributes for Uninstallations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 12.7 Plug-In Interface for Add-Ons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88 12.8 Handling Object Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89 13 Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 13.1 Compatibility of SAP NetWeaver Releases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 13.2 Overview: Import Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115 13.3 Modifications and Their Consequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Setting Up a Development Landscape for Modifying Add-On. . . . . . . . . . . . . . . . . . . . . . . . . . . . .116 Maintenance for a Modifying Add-On. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118 SAP Add-On Assembly Kit PUBLIC Content © 2016 SAP SE or an SAP affiliate company. All rights reserved. 3 Rules for Developing a Modifying Add-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 Creating Conflict Resolution Transports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120 13.4 Conflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122 Background Information: Conflict Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122 Conflicts When Installing/Upgrading an Add-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 Conflicts When Importing Support Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127 13.5 Examples: Attributes in Software Delivery Assembler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 Examples: Attributes for Add-On Uninstallations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 Examples: Attributes for Enhancement Packages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Examples: Attributes for SAP HANA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130 13.6 CDs for Add-On Deliveries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 13.7 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 13.8 Links in SAP Help Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133 13.9 Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 PUBLIC SAP Add-On Assembly Kit 4 © 2016 SAP SE or an SAP affiliate company. All rights reserved. Content 1 SAP Add-On Assembly Kit Purpose You can use SAP Add-On Assembly Kit to develop industry-specific, country-specific, or enterprise-specific enhancements to the standard SAP system, plus customer and partner projects, while taking advantage of the full range of add-on techniques. SAP Add-On Assembly Kit provides you with a toolset that supports you throughout the entire software lifecycle of your add-on. Its detailed documentation helps you to verify the quality of your development work in the planning phases and its tools support you when creating your delivery and installing it. SAP Add-On Assembly Kit also provides you with methods for updating and maintaining your software. Features Documentation The SAP Add-On Assembly Kit documentation describes the following steps in the add-on delivery process: 1. Defining the Delivery Strategy Here you need to answer questions such as: ○ What is the underlying SAP release of your development work? ○ Does your development work make modifications to the standard SAP system? ○ What is your maintenance and upgrade strategy? ○ Do you want your add-on to be uninstallable? Once you have answered these questions, you have defined a strategy for the delivery of your add-on. 2. Defining the namespaces When you use a namespace protected by SAP, you ensure that, once delivered, your development objects do not conflict with objects created by other vendors or by SAP. This is the first quality assurance step for your add-on. 3. Setup of the system landscape The setup of your system landscape for your add-on development is specified by the delivery strategy you choose. In this step, you also install the SAP Add-On Assembly Kit tools in your system landscape. 4. Add-on development In this step, you develop the software itself in the systems you have configured. This documentation provides you with rules for avoiding errors in the development phase. 5. Delivering the add-on The SAP Add-On Assembly Kit tools provide you with help when assembling the delivery and when packing the software into importable packages. 6. Maintenance and Upgrade SAP Add-On Assembly Kit also provides help in the maintenance and upgrade of your add-on. You can use the SAP Add-On Assembly Kit tools to create importable packages that remove any errors in your add-on, as well as to update your add-on or make sure it can run on a higher SAP release. SAP Add-On Assembly Kit PUBLIC SAP Add-On Assembly Kit © 2016 SAP SE or an SAP affiliate company. All rights reserved. 5 7. Uninstalling the add-on SAP Add-On Assembly Kit contains instructions and checks that verify that your add-on can be uninstalled. Tools Software Delivery Composer (SDC, transaction SSDC) collects all delivery-relevant parts of your development work, checks their consistency, and composes them as a delivery. Software Delivery Assembler (SDA, transaction SSDA) packs the delivery into an importable package format. You can also use SDA to define any import conditions to be respected before the packages can be imported correctly. Imports made using SAP Add-On Assembly Kit are performed with SAP import tools. The appendix contains a list of these import tools [page 115] . 1.1 Authorization Roles Only users with the relevant authorizations can compose and create add-ons with the SAP Add-On Assembly Kit. The SAP Add-On Assembly Kit provides various predefined authorization roles, which can be assigned to users depending on their activities and the tools they will be using. For example, you can define whether a user has change rights or display-only rights, and you can grant specific system authorizations (for example, to change RFC destinations) separately. This ensures security in organizations where tasks are divided across employees. The following table provides an overview of the available roles and their functions: Table 1: Overview of Roles Type of Role Name of Role Description of Functions Read Access SAP_AAK_SDC_DISPLAY Display-only authorization for all data for composing an add-on or delivery event (SDC) Read Access SAP_AAK_SDA_DISPLAY Display-only authorization for all data for creating an add-on or package (SDA) Write Access SAP_AAK_SDC_CHANGE Change authorization for composing add-ons and delivery events (SDC) Write Access SAP_AAK_SDA_CHANGE Change authorization for creating add-ons and packages Note This does not include authorization for creating RFC destinations for read access to SDC data. For this, you need the role SAP_AAK_SDA_RFC. Write Access SAP_AAK_SDA_RFC Change authorization for creating and changing RFC destinations. This role is always required if the SDC system is not the same as the SDA system. PUBLIC SAP Add-On Assembly Kit 6 © 2016 SAP SE or an SAP affiliate company. All rights reserved. SAP Add-On Assembly Kit 2 About This Document Validity This document is an overview of the process when using SAP Add-On Assembly Kit 5.0 to create add-ons: SAP Add-On Assembly Kit 5.0 is available for SAP components based on SAP NetWeaver 7.0 and higher SAP NetWeaver releases. Note Note that you can use SAP Add-On Assembly Kit for ABAP development work only. Target Audience The information in this documentation is intended for the following groups: ● Add-on producers who are creating add-ons for their own enterprise or for their customers ● System administrators who are setting up systems for add-on development and add-on maintenance ● Software developers involved in add-on development ● Add-on assemblers who are using the SAP Add-On Assembly Kit to create add-on packages Prerequisites Before you work with SAP Add-On Assembly Kit, you should have knowledge of the following topics: ● Installation of SAP systems For further information, see SAP Service Marketplace under https://service.sap.com/instguides . ● System copy For further information, see SAP Community Network under System Copy and Migration . ● Setting up the system landscape (including Change and Transport System) For further information, see the documentation Change and Transport System in SAP Help Portal. ● ABAP programming basics For further information, see the documentation Application Development on AS ABAP in SAP Help Portal. ● ABAP software maintenance For further information, see the documentation Software Logistics in SAP Help Portal. ● Documentation and translation tools For further information, see the documentation Services for Information Developers and Translators in SAP Help Portal. SAP Add-On Assembly Kit PUBLIC About This Document © 2016 SAP SE or an SAP affiliate company. All rights reserved. 7 Overview of SAP Notes The following SAP Notes are important when working with SAP Add-On Assembly Kit and are referenced in this documentation: Table 2: Note Number Short Description 104010 Restrictions on development in namespaces 105132 Reserving namespaces from R/3 Release 4.0 16466 Customer namespace for SAP objects 195442 Language imports and support packages 212876 New archiving tool SAPCAR 1883223 Note on general add-on uninstallations Integration This documentation describes the processed required when creating an add-on using SAP Add-On Assembly Kit. For detailed information about the SAP Add-On Assembly Kit tools, use the help button in the tool in question to display its online documentation 2.1 Naming Conventions Documentation Links in SAP Help Portal Any links to further documentation in SAP Help Portal specified here apply to Release SAP NetWeaver 7.4. Example Change and Transport System To access the documentation in question, select the link or search for the title or release on SAP Help Portal. In the case of lower releases, an appendix contains a list of links to documentation in specific releases [page 133]. PUBLIC SAP Add-On Assembly Kit 8 © 2016 SAP SE or an SAP affiliate company. All rights reserved. About This Document 2.2 New Features in Version 5.0 General Information ● You can use Support Package 1 of SAP Add-On Assembly Kit 5.0 to download the PAT file of a package as an SAR file. You can then use the transaction codes SPAM and SAINT to download this SAR file directly to the system. You can also reopen any confirmed deliveries. ● For the first time, Version 5.0 of SAP Add-On Assembly Kit makes it possible to create uninstallable add-ons. ● Version 5.0 of SAP Add-On Assembly Kit supports SAP NetWeaver 7.0 and higher releases. Software Delivery Composer ● Confirmed deliveries can be reopened ● Object list checks The following object list checks were added: ○ Can objects be deleted in an uninstallation? Add-on installations cannot delete every category of data from the system. This check searches the delivery request for any objects and table entries that cannot be deleted. If these objects are delivered, the add-on cannot be uninstalled. ○ Generic checks and automatic corrections The content of the delivery request is checked for obsolete objects. Any changes to the current object types (for example, replacements by logical transport objects) are made automatically. No further manual modifications are necessary. These checks are always performed. ● A comment function was added in the results list of the object list checks. Software Delivery Assembler ● The PAT file of a package can be downloaded as an SAR file. ● The SSDA online documentation was updated. ● The following new extended attributes were added: ○ DEINSTALL_ALLOWED For the package types AOI, AOU, and AOX only: This software component version can be uninstalled. Also see the information about Add-On Uninstallation [page 81]. Possible value: A valid note number. Since you cannot create SAP Notes yourself containing information about uninstalling your add-on, the SAP Note 1883223 can be used instead. If you do not specify a value for this attribute, the system enters 1883223 by default. ○ DEINSTALL_PLUGIN For the package types AOI, AOU, and AOX only: If this attribute is set, the methods defined in an interface class of the add-on in question are called in the uninstallation process This is applicable if the following prerequisites are met: ○ This software component version can only be uninstalled under certain conditions. This decision can be made in the local system only. SAP Add-On Assembly Kit PUBLIC About This Document © 2016 SAP SE or an SAP affiliate company. All rights reserved. 9 ○ The add-on in question created dynamic objects. To delete the add-on in the uninstallation process, a method of the interface class of the add-on is called. This method returns a list of the dynamically created objects to the uninstallation framework as a return parameter and hence makes it possible to delete these objects. Also see the information under Attributes for Uninstallations [page 87]. You use the software component version to deliver the class of the add-on in question. Specify the name of the calling interface class in the add-on as the value for the attribute. ○ KERNEL_VERSION From SAP Web AS 6.10: Specifies the kernel version required to import the package, for example: 620/00123. ○ LANGUAGE_BY_SP This attribute can be used for packages of the type AOU and CSP from SAP NetWeaver 7.0. If new languages are delivered with a packages with one of these types, they can be registered as new installed languages in the import to a target system by setting the attribute LANGUAGE_BY_SP. The languages specified in the attribute must already exist in the attribute LANGUAGE. The values for this attribute must be specified using the two-character ISO language key. Example LANGUAGE_BY_SP ISO-FRJA This package delivers the languages FR (French) and JA (Japanese). ○ NEEDED_DBSYS Applies to packages of the type AOI, AOU, and AOX from SAP NetWeaver 7.0. Specifies a list of database systems where the add-on can be installed. A warning appears if the package is imported on any other database system. Despite this, the package can still be imported, but cannot run on this system. This step may be necessary, for example, before a database migration. If you want the package to only be imported on one of the specified database systems, add :R to the list. :R can only be specified at the end of the package list. In this case, the system refuses to install the package on any other database system than the ones specified. The current possible values are: ○ ADA = MaxDB ○ DB2 = IBM DB2/390 ○ AS4 = IBM DB2/400 ○ DB6 = IBM DB2/LUW ○ HDB = HANA ○ INF = Informix ○ ORA = Oracle ○ MSS = MS SQL Server ○ SYB = Sybase ASE Example The package is to be imported on one of the following database systems: NEEDED_DBSYS HDB,INF The package must be imported on one of the following two database systems: NEEDED_DBSYS HDB,INF:R PUBLIC SAP Add-On Assembly Kit 10 © 2016 SAP SE or an SAP affiliate company. All rights reserved. About This Document