SAP Add-On Installation & Plugin

Updates:
1. Add-On Installation Tool (SAINT)

 Purpose: Manages the installation, upgrade, or uninstallation of SAP Add-Ons.

 Transaction Code: SAINT
 Detailed Steps:
1. Preparation:
 Download the required add-on package files (SAR or PAT files) from the
SAP Service Marketplace or SAP Support Portal.
 Place the downloaded files in the system's transport directory
(/usr/sap/trans).
2. Execution:
 Log in to SAP using a user with administrative privileges
(SAP_ALL/SAP_NEW).
 Execute the SAINT transaction.
 Choose the add-on package to install or upgrade.
 Follow the step-by-step installation wizard:
 Pre-Checks: Verifies dependencies and system readiness.
 Installation: Applies the add-on in the system.
3. Post-Installation:
 Perform required configuration or corrections using transaction SPRO or
other relevant settings.

2. Software Update Manager (SUM)

 Purpose: Central tool for complex software updates, including add-on installation and
plugin updates.
 Steps:
1. Preparation in Maintenance Planner:
 Go to the SAP Maintenance Planner tool (cloud-based, via SAP Support
Portal).
 Select your system, plan the update, and generate the Stack XML file.
2. Using SUM:
  Download the SUM tool (latest version) from the SAP Support Portal.
 Extract it to the /usr/sap directory.
 Start the SUM tool by running STARTUP from the SUM directory.
 Use the stack XML file generated by the Maintenance Planner.
 Follow the SUM GUI wizard steps for the add-on/plugin installation.
3. Validation:
 SUM will validate the consistency of the update.
 Address any errors or warnings before proceeding.

3. Maintenance Planner

 Purpose: Essential for planning and preparing updates and ensuring compatibility.
 Steps:
1. Log in to the SAP Maintenance Planner
(https://support.sap.com/maintenanceplanner).
2. Select your system in the landscape.
3. Add or update the required add-ons/plugins.
4. Generate the stack XML file for use in SUM or SAINT.
5. Download the software packages and stack XML.

4. Add-On Assembly Kit (AAK)

 Purpose: Used by developers or SAP partners to create and deliver custom add-ons.
 Steps:
1. Develop the custom functionality.
2. Package it using AAK tools to ensure compatibility with SAP NetWeaver.
3. Test the add-on in a sandbox or development environment.

5. Support Package Manager (SPAM)

 Purpose: Applies updates for installed SAP components or plugins.

 Transaction Code: SPAM
 Steps:
 1. Log in as an administrative user.
2. Execute the transaction SPAM.
3. Load the package file (SAR) into the system using transaction SNOTE or
manually place it in /usr/sap/trans/EPS/in.
4. Select the package to apply and follow the on-screen instructions.
5. Monitor logs for errors and take corrective actions if required.

Prerequisites and Best Practices

 System Backup: Always perform a complete backup, including file systems and
database.
 Space Availability: Check directories such as /usr/sap/trans, /usr/sap/<SID>, and
the database log/data volumes.
 Dependencies: Ensure the required support packages and kernel versions are already
installed.
 Transport Readiness: If transports are needed, ensure they are imported into the
system in advance.

Here are step-by-step commands and GUI walkthroughs for SAINT,

SUM, and SPAM to help you install and update SAP Add-Ons and Plugins
effectively.

1. Add-On Installation Tool (SAINT)

Step-by-Step Instructions:
1. Log in to SAP GUI:
o Use an administrative account with the required authorizations
(SAP_ALL/SAP_NEW).
2. Check Prerequisites:
o Ensure that the add-on package files (.SAR or .PAT) are downloaded from the
SAP Support Portal.
o Place these files in the directory /usr/sap/trans/EPS/in on your SAP application
server.
3. Start SAINT:
 o Execute the transaction SAINT in the command bar.

4. Prepare Installation:
o The initial screen will show installed components and available add-ons.

o Click on Installation Package → Load Packages → From Application

Server.
o The system will list available add-on files.

5. Select the Add-On:

o Choose the add-on/plugin you want to install from the list and click Continue.

6. Start Installation:
o Follow the guided wizard:

 Dependency Check: The system will check for conflicts or missing

prerequisites.
 Installation Process: Click Start to initiate the installation.
7. Monitor Progress:
o Use the logs displayed during the installation for progress and errors.

8. Post-Installation Tasks:
o Once installation is complete, verify using transaction SPAM (Support Package
Manager).
o Perform required configuration in SPRO or relevant transactions.

2. Software Update Manager (SUM)

Step-by-Step Instructions:
1. Download SUM Tool:
o Access SAP Support Portal and download the latest SUM tool.

2. Prepare SUM Directory:

o Extract the SUM archive into the /usr/sap/<SID> directory on your SAP
application server.
3. Generate Stack XML File:
o Use the Maintenance Planner to select your system and generate a stack XML
file.
o Download this XML file to the server.

4. Start SUM:
o Navigate to the SUM directory.

o Run the command: ./STARTUP.

5. Access SUM via Web Interface:

 o Open a browser and navigate to
http://<hostname>:1128/lmsl/sumjava/<SID>/index.html.
6. Upload the Stack XML:
o Upload the stack XML file generated in Maintenance Planner.

7. Follow the SUM Wizard:

o Choose the Add-On Installation or Update Plugins option.

o Follow the steps for:

 Pre-Checks: SUM validates dependencies and environment readiness.

 Execution: The tool installs or updates the add-on/plugin.
8. Monitor Logs:
o Check the SUM logs for errors and warnings.

o Address any inconsistencies before proceeding.

9. Completion:
o Perform system validation after SUM finishes the process.

3. Support Package Manager (SPAM)

Step-by-Step Instructions:
1. Log in to SAP GUI:
o Use an administrative account.

2. Check Prerequisites:
o Ensure that the .SAR package files are downloaded and placed in
/usr/sap/trans/EPS/in.
3. Start SPAM:
o Execute transaction SPAM.

4. Load Support Packages:

o Go to Support Package → Load Packages → From Application Server.

o This will list available packages.

5. Select and Apply Package:

o Choose the package you want to install and click Apply.

o Monitor the process and address any errors during package import.

6. Post-Installation Checks:
o Verify the package installation using SPAM.

o Check for dumps or logs for unresolved issues.

 Useful Transactions

 SPAM: For package management and checking add-on installations.

 SAINT: For installing or upgrading add-ons.
 SUM: For comprehensive updates, including add-ons and system upgrades.
 SPRO: For customizing settings after the installation.

Detailed Guide for Generating a Stack XML File via Maintenance Planner

Step 1: Access Maintenance Planner

1. Open your browser and log in to the SAP Maintenance Planner:
Maintenance Planner Portal.
2. Use your S-User credentials to access the tool.

Step 2: Select Your System

1. Navigate to the Systems tab.
2. Select the target system from the list of available systems in your landscape.
o If the system is not listed, ensure that system data is synchronized using SAP
Solution Manager or the LMDB (Landscape Management Database).

Step 3: Plan Maintenance

1. Click Plan for Maintenance or Add-ons for the selected system.
2. Choose the required action:
o Add new Add-Ons.

o Update existing software components or install Enhancement Packages.

3. Select the desired components or updates:

o Use the search bar to find specific add-ons/plugins.

o Verify that selected components are compatible with the system.

Step 4: Validate the Selection

1. The system will perform a compatibility check and list any potential conflicts.
2. Resolve conflicts by:
o Including additional dependencies.
 o Adjusting version selections.

Step 5: Generate the Stack XML

1. After confirming your selections, click Generate Stack XML.
2. Save the file to your local machine.
o The file will be named something like MP_<SystemID>_<Timestamp>.XML.

Step 6: Download Add-On/Plugin Files

1. Along with the Stack XML, download the software packages.
o Use the Download Manager provided in the Maintenance Planner.

2. Place the downloaded files in the directory /usr/sap/trans/EPS/in.

Step 7: Use the Stack XML

 For SUM: Provide the Stack XML during the execution wizard to guide the process.
 For SAINT/SPAM: The XML ensures that selected packages are compatible.

Handling Common Issues

1. Missing System in Maintenance Planner:

o Check if the system data is properly synced from Solution Manager.

o Use the SLD (System Landscape Directory) to ensure the system is

registered.
2. Compatibility Errors:
o Check that the system kernel, database, and other components are up-to-date.

o Include all required dependencies listed in the compatibility matrix.

3. Download Issues:
o Ensure you have the latest SAP Download Manager and correct S-user
authorization for software download.

Error Handling and Troubleshooting During Add-On Installation/Update

1. Troubleshooting in SAINT
Common Issues in SAINT:
 Add-On Installation Fails with Dependency Errors
o Cause: Missing prerequisite software components or incorrect versions.

o Resolution:

1. Open the Maintenance Planner and re-check dependencies.

2. Download and install the required support packages or kernel updates.
3. Retry the add-on installation in SAINT.
 Transport Directory Error
o Cause: The .SAR or .PAT files are not correctly placed in the transport directory.

o Resolution:

1. Verify that the file is in /usr/sap/trans/EPS/in.

2. Check for sufficient space in the file system.
3. Use tp import in command line to test if the transport system is
functioning.
 "Package is Already Being Processed"
o Cause: A previous installation attempt is incomplete or stuck.

o Resolution:

1. Check for unfinished jobs in transaction SM37 (job logs).

2. Resolve the stuck process by canceling or restarting the job.
3. Reset the installation queue in SAINT (if prompted).
How to Analyze Logs in SAINT:
1. After an error occurs, click on Logs in the SAINT menu.
2. Check the Action Log and Error Messages for details.
3. Use transaction SLG1 (Application Log) for additional error details.

2. Troubleshooting in SUM

Common Issues in SUM:

 SUM Stops at Pre-Checks
o Cause: Missing prerequisites, such as the stack XML file or kernel patch.

o Resolution:

1. Ensure the Stack XML file is generated and uploaded.

2. Update the system kernel to the recommended version.
3. Re-run pre-checks from the SUM interface.
 SUM Cannot Start
 o Cause: Missing permissions or incorrect directory setup.

o Resolution:

1. Verify that the SUM directory has the correct file permissions (chmod -R
755 SUM).

2. Check logs in /SUM/sdt/log for startup issues.

3. Restart the SUM process using the ./STARTUP script.

 Error During Execution

o Cause: Conflicts with database, network, or file system.

o Resolution:

1. Monitor the SUM logs (/SUM/sdt/log).

2. Address specific errors, such as:

 Database Connection Failure: Check DB credentials and
connectivity.
  Disk Space Issues: Ensure /usr/sap/trans, /SUM, and other
volumes have enough free space.
3. Resume the update after resolving the issue.
 SUM Hangs During Execution
o Cause: Resource overload or network timeout.

o Resolution:

1. Monitor the application server (CPU, memory, network).

2. Restart the SUM process if necessary. SUM supports resuming from the last
step.
How to Analyze Logs in SUM:
1. Navigate to /SUM/sdt/log/ and review:
o SUM.ECO: High-level summary of execution.

o UPGRADECONTROL.LOG: Details about errors during execution.

2. Use transaction ST22 (Short Dump Analysis) in SAP GUI for further details on runtime
errors.

To navigate to the /SUM/sdt/log/ directory and review logs, follow these steps:
Steps to Navigate to /SUM/sdt/log/ and Review Logs:
1. Log in to the SAP System's Application Server:
o Use a secure shell (SSH) client like PuTTY or any terminal to access the server
hosting the SAP system.
o You need to have sufficient permissions to access the SAP directories (e.g., user
saphost or adm).
2. Navigate to the Directory:
o Once logged in, navigate to the /SUM/sdt/log/ directory, where SUM (Software
Update Manager) stores log files:
 Replace <SID> with the actual SAP system ID (e.g., PRD or DEV).
3. List the Log Files:
o Use the ls command to view the log files in this directory:

4. Review the Logs:

o The logs will contain detailed information regarding the installation, updates, and
issues encountered during the add-on installation or system update process.
o Common log files to look for:

 SUM_<date>.log: Contains general information about the software

update.

 SDT_LOG_<date>.log: Specific logs related to the SDT (Software

Deployment Tool) phase.

 sapup_<date>.log: Logs related to the SAP kernel upgrade process.

5. Use the cat, more, or less Commands to Read the Log Files:
o For example, to view the latest log file, use the following:

o You can also use tail to view the last few lines of a log file in real-time (helpful
during an ongoing installation):

6. Look for Errors or Warnings:

o Pay close attention to any error messages (usually indicated by ERROR, FATAL, or
similar terms).
 o Warnings (often prefixed with WARNING) may indicate potential issues but aren't
critical.

Analyzing Logs for Issues:

 Check for Missing Files or Dependencies: Look for any messages indicating
missing components, or failed prerequisite checks.
 Installation Errors: Errors like "Add-on installation failed" or "Error during
deployment" might indicate issues with the add-on package or transport.
 Database or System-Specific Issues: If any database connectivity issues appear,
check the database logs for further insight.

3. General Tips for Handling Errors

1. Always Perform Backups:

o Ensure full backups (including database and file systems) are taken before any
installation or update.
2. Review Notes and Guides:
o Refer to SAP Notes related to the add-on or update.

o Example Notes:

 SUM Tool Documentation: SUM Guides

 Known issues related to your SAP version.
3. Monitor Background Jobs:
o Use SM37 to check for stuck or failing jobs during the update process.

o Re-execute or restart failed jobs if necessary.

4. Network and User Permissions:

o Ensure the SUM tool has unrestricted access to required files and databases.

o Avoid session timeout by increasing SAP GUI and web browser session limits.

Useful SAP Notes for Add-On Installation and Updates

1. General Notes for SAINT (Add-On Installation Tool)

 SAP Note 2187425: SAINT Upgrade Pre-Checks and Common Errors
 o Describes the prerequisites and known issues when upgrading or installing add-
ons using SAINT.
 SAP Note 2615030: Troubleshooting Add-On Installation Failures in SAINT
o Covers dependency errors, transport issues, and reset steps for stuck
installations.
 SAP Note 1803986: Handling Component Conflicts During SAINT Installation
o Explains how to manage conflicts when component dependencies are
mismatched.

2. Notes for SUM (Software Update Manager)

 SAP Note 2888431: Latest SUM Versions and Download Links
o Provides the download links and patch notes for the latest SUM versions.

 SAP Note 2536549: Troubleshooting Pre-Check Failures in SUM

o Detailed guidance for resolving common issues during the pre-check phase.

 SAP Note 2293176: Handling Resource Shortages During SUM Execution

o Recommendations for optimizing disk space, memory, and network
configurations.
 SAP Note 2345952: SUM Hangs During Execution – Restart and Resume Guidelines
o Steps to safely resume SUM after an unexpected halt.

3. Notes for Maintenance Planner

 SAP Note 2546220: Generating and Validating Stack XML in Maintenance Planner
o Explains common validation errors and how to fix them.

 SAP Note 2368481: System Not Visible in Maintenance Planner

o Steps to synchronize system data from Solution Manager or SLD.

 SAP Note 2756148: Compatibility Checks for Add-Ons and Plugins

o Lists tools and guidelines to ensure add-ons are compatible with the system
landscape.

4. Notes for SPAM (Support Package Manager)

 SAP Note 1947546: Error Handling in SPAM During Support Package Import
o Solutions for common errors like "Transport Directory Full" or "Package
Processing Stuck."
 SAP Note 2801776: Loading SAR Files Manually in SPAM
o Describes how to upload and validate packages without using SAP GUI.

5. Notes for Specific Issues

  SAP Note 2650173: Out of Memory Errors During SUM or SAINT Execution
o Recommendations to increase heap size and optimize memory usage.

 SAP Note 2102547: How to Debug SUM Execution Errors

o Explains the process for enabling debugging and log analysis.

 SAP Note 1781961: Resetting Stuck Add-On Installations in SAINT

o Steps to clear partially completed installations.

How to Access SAP Notes

1. Log in to SAP Support Portal: SAP Support Portal.
2. Use the SAP Note/KBA Search feature.
3. Enter the SAP Note number and download it.
4. Follow the steps or apply corrections as specified.

Here’s a detailed guide on how to navigate and utilize SAP Notes effectively:

Steps to Access and Apply SAP Notes

1. Accessing SAP Notes via the SAP Support Portal

1. Log in to the SAP Support Portal:
o Open your browser and go to SAP Support Portal.

o Use your S-User credentials provided by SAP.

2. Navigate to the SAP Note Search:

o On the portal homepage, click on "Knowledge Base & Guides" → "SAP
Note/KBA Search".
3. Search for the SAP Note:
o Enter the SAP Note number (e.g., 2187425) in the search bar and hit Search.

o Open the note to view its contents.

4. Review the Details:

o Notes typically include:

 Description: Explanation of the issue.

 Cause: Technical reasons for the problem.
 Solution: Steps or corrections required.
  Attachments: Files or scripts, if any, needed for resolution.
5. Download Attachments (if available):
o Some SAP Notes may include .SAR files, .TXT instructions, or other artifacts.

o Save these files to the relevant directories on your system.

2. Applying SAP Notes in the SAP System

1. Log in to SAP GUI with a user authorized for basis tasks.
2. Execute Transaction SNOTE:
o This is the central transaction for implementing SAP Notes.

3. Load the SAP Note:

o Click on "Download SAP Note" and enter the SAP Note number.

o The system will download the Note from SAP Service Marketplace.

4. Check Prerequisites:
o Ensure the system meets all prerequisites mentioned in the note.

o Some notes require the latest kernel or other components.

5. Apply the Note:

o Select the downloaded note and click "Implement".

o Follow the guided process. The system will check:

 Dependencies
 Code changes (if applicable)
o Confirm the changes and let the process complete.

6. Validate Implementation:
o Use the Implementation Status tab in SNOTE to confirm successful
application.
o Test the issue or functionality addressed by the note.

Key Tips for SAP Notes

 Read Notes Carefully:

o Ensure the note applies to your SAP version (e.g., NetWeaver, ECC, S/4HANA).

o Check for conflicts or side effects in the note details.

 Apply Only What’s Necessary:

o Avoid implementing unnecessary notes that might affect system stability.

 Transport Notes to Other Systems:

 o Use the transport mechanism to move applied notes from the development
system to QAS and PRD.
 Backup First:
o Always perform a system backup before applying critical notes.

Navigating Related Content

 SAP KBA (Knowledge Base Articles):

o Often listed alongside SAP Notes, KBAs provide detailed troubleshooting steps.

 SAP Note Categories:

o Hot News: High-priority issues.

o Security Notes: Address vulnerabilities.

o Correction Notes: Fix bugs in standard programs.

To place the downloaded add-on files in the system's transport directory

(/usr/sap/trans), follow these steps:

Steps to Place Downloaded Files in the Transport Directory:

1. Verify Access Permissions:
o Ensure you have the necessary permissions to access the SAP system's file
system and transport directory.
o Typically, Basis administrators or users with OS-level access can perform this
step.
2. Connect to the SAP Application Server:
o Use a secure shell (SSH) tool like PuTTY or a similar terminal to connect to the
SAP application server.
3. Locate the Transport Directory:
o Navigate to the transport directory on the server:

4. Transfer Files to the Server:

o Use a file transfer method like WinSCP, FileZilla, or SCP to upload the
downloaded files from your local machine to the transport directory.
  In WinSCP/FileZilla:
 Open a session with the server.
 Drag and drop the files into the /usr/sap/trans folder.
 Using SCP Command:

5. Verify the Files:

o Once transferred, ensure the files are correctly placed in the directory:

o Check the file names and sizes to confirm the transfer is complete and correct.

6. Adjust File Permissions (if necessary):

o Ensure the files have the correct ownership and permissions for SAP to access: