Installation Guide | PUBLIC

Software Provisioning Manager 1.0 SP32

Document Version: 3.7 – 2021-06-21

Installation of SAP Library for SAP systems based

on SAP NetWeaver 7.0 and Higher on UNIX
© 2021 SAP SE or an SAP affiliate company. All rights reserved.

THE BEST RUN

Content

1 About this Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2 Variants of SAP Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2.1 Criteria for Selecting the Help Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.2 SAP Help Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.3 PlainHtmlHttp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
2.4 PlainHtmlFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.5 HtmlHelpFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

3 Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3.1 Installing PlainHtmlHttp and PlainHtmlFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Adding PlainHTML Redirects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Adding Glossary Files To a PlainHTML Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.2 Installing HtmlHelpFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
3.3 Installation of Help Files Using Software Provisioning Manager 1.0. . . . . . . . . . . . . . . . . . . . . . . . . . 20
Preparations for the Installation with Software Provisioning Manager 1.0. . . . . . . . . . . . . . . . . . .20
Installing and Updating SAP Library Using Software Provisioning Manager 1.0. . . . . . . . . . . . . . . 24

4 Post-Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.1 Using a Web Browser or Viewer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.2 Offline Access to Help Files - PlainHtmlHttp and PlainHtmFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
4.3 Offline Access to Help Files - HtmlHelpFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
4.4 Setting Variants for SAP Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4.5 Configuring Documentation Provided on the SAP Help Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Enabling Product-Specific Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4.6 Providing Read Permissions for Installed Help Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

5 Additional Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
5.1 About the Installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Useful Information about the Installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Interrupted Processing of the Installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Troubleshooting with the Installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
5.2 Local Override of Help Settings on Front Ends. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
File sapdoccd.ini. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Parameters in File sapdoccd.ini. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
Logging of Help Calls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
2 PUBLIC Content
Document History

 Note

Before you start reading, make sure you have the latest version of this installation guide, which is available
at https://support.sap.com/sltoolset System Provisioning Install a System using Software
Provisioning Manager Installation Option of Software Provisioning Manager 1.0 SP <Current
Number> .

The following table provides an overview on the most important document changes:

Version Date Description

3.7 2021-06-21 Updated version for Software Provision­

ing Manager 1.0 SP32 (SL Toolset 1.0
SP32)

3.6 2021-02-15 Updated version for Software Provision­

ing Manager 1.0 SP31 (SL Toolset 1.0
SP31)

3.5 2020-10-05 Updated version for Software Provision­

ing Manager 1.0 SP30 (SL Toolset 1.0
SP30)

3.4 2020-06-08 Updated version for Software Provision­

ing Manager 1.0 SP29 (SL Toolset 1.0
SP29)

3.3 2020-01-20 Updated version for Software Provision­

ing Manager 1.0 SP28 (SL Toolset 1.0
SP28)

3.2 2019-09-16 Updated version for Software Provision­

ing Manager 1.0 SP27 (SL Toolset 1.0
SP27)

3.1 2019-05-27 Updated version for Software Provision­

ing Manager 1.0 SP26 (SL Toolset 1.0
SP26)

3.0 2019-01-21 Updated version for Software Provision­

ing Manager 1.0 SP25 (SL Toolset 1.0
SP25)

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Document History PUBLIC 3
Version Date Description

2.9 2018-09-17 Updated version for Software Provision­

ing Manager 1.0 SP24 (SL Toolset 1.0
SP24)

2.8 2018-05-07 Updated version for Software Provision­

ing Manager 1.0 SP23 (SL Toolset 1.0
SP23)

2.7 2018-01-15 Updated version for Software Provision­

ing Manager 1.0 SP22 (SL Toolset 1.0
SP22)

2.6 2017-09-11 Updated version for Software Provision­

ing Manager 1.0 SP21 (SL Toolset 1.0
SP21)

2.5 2017-05-22 Updated version for Software Provision­

ing Manager 1.0 SP20 (SL Toolset 1.0
SP20)

2.4 2017-02-06 Updated version for Software Provision­

ing Manager 1.0 SP19 (SL Toolset 1.0
SP19)

2.3 2016-10-07 Updated version for Software Provision­

ing Manager 1.0 SP18 (SL Toolset 1.0
SP18)

2.2 2016-06-06 Updated version for Software Provision­

ing Manager 1.0 SP17 (SL Toolset 1.0
SP17)

2.1 2016-02-15 Updated version for Software Provision­

ing Manager 1.0 SP10 (SL Toolset 1.0
SP16)

2.0 2015-10-12 Updated version for Software Provision­

ing Manager 1.0 SP09 (SL Toolset 1.0
SP15)

1.9 2015-09-14 Updated version for Software Provision­

ing Manager 1.0 SP09 (SL Toolset 1.0
SP14)

1.8 2015-04-27 Updated version for Software Provision­

ing Manager 1.0 SP08 (SL Toolset 1.0
SP13)

1.7 2014-11-24 Updated version for Software Provision­

ing Manager 1.0 SP07 (SL Toolset 1.0
SP12)

1.6 2014-07-07 Updated version for Software Provision­

ing Manager 1.0 SP06 (SL Toolset 1.0
SP11)

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
4 PUBLIC Document History
 Version Date Description

1.51 2014-04-11 Updated version for Software Provision­

ing Manager 1.0 SP05 (SL Toolset 1.0
SP10 )

1.5 2014-03-17 Updated version for Software Provision­

ing Manager 1.0 SP05 (SL Toolset 1.0
SP10 )

1.4 2013-07-23 Updated Version

1.3 2013-07-15 Updated version

1.2 2012-12-20 Updated version

1.1 2012-09-28 Updated version

1.0 2012-08-06 Initial version

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Document History PUBLIC 5
1 About this Document

This guide explains how to install or update SAP Library for SAP systems based on SAP NetWeaver using the
installation tool Software Provisioning Manager 1.0 SP32 (“installer” for short), which is part of SL Toolset 1.0
SP32. It also explains how to configure the help settings to optimize how your users access the SAP Library.

This guide is relevant for installations based on Unix operating systems. This refers to the operating system of
the file server or Web server on which you plan to install the SAP Library, not to the operating systems of the
front ends used to display application help. There is a separate guide for installations based on Windows
operating systems. You can find this on the SAP Help Portal at Installation of SAP Library for SAP systems
based on SAP NetWeaver 7.0 and Higher on Windows.

The SAP NetWeaver-based system products and releases for which this documentation is valid are listed in
SAP Note 1680045 . Examples of these SAP systems include SAP ERP, SAP Customer Relationship
Management, SAP Solution Manager, and SAP Supply Chain Management.

 Note

If you want to install documentation for an SAP S/4HANA system, see the Installation Guide for the specific
SAP S/4HANA release you are using for information on how to proceed.

SAP Library is an HTML-based solution for documentation. It provides the basis for context-sensitive
application help. The SAP Library can be displayed in a Web browser on all front-end platforms that your
product supports. SAP Library is available in several different variants; the installation of each variant is
described in this guide:

● Installing PlainHtmlHttp and PlainHtmlFile [page 16]

● Configuring Documentation Provided on the SAP Help Portal [page 38]
● Installing HtmlHelpFile [page 19]

Software Provisioning Manager 1.0

Software Provisioning Manager is the successor of the product-specific and release-specific delivery of
provisioning tools, such as SAPinst. Before you perform an installation or system copy, we recommend that
you always download the latest version of the Software Provisioning Manager [page 21] which is part of the
Software Logistics Toolset (SL Toolset for short). This way, you automatically get the latest SAPinst version
including latest fixes in the tool and supported processes. For more information about Software Provisioning
Manager as well as the products and releases that it supports, see SAP Note 1680045 .

As a result, SAPinst has been renamed to Software Provisioning Manager (“installer” for short) in this
documentation.

However, the term “SAPinst” is still used in:

● Texts and screen elements in the Software Provisioning Manager GUI

● Naming of executables, for example sapinst.
● Naming of command line parameters, for example SAPINST_USE_HOSTNAME

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
6 PUBLIC About this Document
 ● Operating system user groups, for example additional group sapinst

Prerequisites

You have obtained the DVD set of SAP Library, either as a physical DVD or CD provided as part of the
installation package for your SAP system or by downloading the documentation package from the SAP
Software Download Center (SWDC) at https://launchpad.support.sap.com/#/softwarecenter .

We deliver the documentation in the format standard HTML (Plain HTML) and in some cases in the format
compiled HTML (HTML help). Subdirectories contain the different language versions that the documentation is
available in.

 Note

For the sake of simplicity in this guide, we refer to the SAP Library DVD/CD or documentation download
package from SWDC as the “SAP Library DVD”.

For more information about downloading the documentation package from SWDC, see Downloading
Installation Media [page 23]

Implementation Considerations

If you have any problems installing or displaying SAP Library, go to the SAP Support Portal at https://
launchpad.support.sap.com/ and choose the tile Find a Solution. If you cannot find an answer to your
question, choose Submit an Incident to create a customer incident.

Use one of the following components to search for SAP Notes or to submit an incident:

● BC-DOC-IWB-DIS for issues relating to customizing of the documentation.

● BC-INS-NT for issues relating to installation on Windows.
● BC-INS-UNX for issues relating to installation on Unix.
● UA-DOC for issues relating to the content of the documentation and the SAP Library DVDs you need.

SAP Notes for the Installation

You must read SAP Note 1261881 before you start the installation. This SAP Note contains the most recent
information on the installation process and corrections to the installation documentation.

Make sure that you have the most up-to-date version of each SAP Note, which you can find on the SAP Support
Portal .

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
About this Document PUBLIC 7
2 Variants of SAP Library

To handle the demands and features presented by different front-end platforms, the HTML-based
documentation is provided in several variants (help types). The main differences between the help types are
the storage format (Standard HTML or Compiled HTML), the way you access the help documents (Web server
or file server), and the search and print functions.

This table allows you to compare the help types and their main features. For more information about each help
type, go to the corresponding help type listed in the Related Information section.

Help Types

SAP Help Portal PlainHtmlHttp PlainHtmlFile HtmlHelpFile

Front-end platforms All All All All Windows platforms

supported by Micro­
soft

File format Standard HTML Standard HTML Standard HTML Compiled HTML

Accessed from SAP Help Portal Web server File server File server

Displayed in Web browser: Web browser (Micro­ Web browser (Micro­ HTML Help Viewer (in­
soft Internet Explorer soft Internet Explorer) stallation of Microsoft
● Google Chrome:
or Google Chrome) Internet Explorer re­
7.4 and higher
quired)
● Microsoft Internet
Explorer: 9 and
higher
● Microsoft Edge:
April 2017 and
higher
● Mozilla Firefox: 66
and higher
● Safari: 12.1 and
higher

Global full-text search X (from SAP Help Por­ X (from SAP Help Por­ X (from SAP Help Por­
tal at https:// tal at https:// tal at https://
help.sap.com ) help.sap.com ; help.sap.com ;
launched, for example, launched, for example,
from the banner of the from the banner of the
installed documenta­ installed documenta­
tion) tion)

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
8 PUBLIC Variants of SAP Library
 SAP Help Portal PlainHtmlHttp PlainHtmlFile HtmlHelpFile

Local full-text search X (using the This X (in CHM file)

document or This
product option in the
search bar above the
content)

Printing of single top­ X X X X

ics

Supported operating Not applicable ● Linux ● Linux ● Linux (see the

systems for the help ● Microsoft Win­ ● Microsoft Win­ note below this ta­
installation dows dows ble)
● Microsoft Win­
dows

Restrictions The documentation This help type is not Not all product docu­
you want to consume compatible with Goo­ mentation is provided
must be available on gle Chrome. in this help type, for ex­
the SAP Help Portal. ample SAP ERP has
For more information,
discontinued this help
The users must have see SAP Note 2622352
type.
access to the Internet. .
For more information,
You can specify only
see SAP Note 2572047
one combination of
.
product and version.

For more information,

see SAP Note
2652009 .

 Note

If you install HtmlHelpFile format on a Unix server, you must note that only users of Microsoft Windows
front ends can display the application help in this format. To access the file system from Microsoft Windows
front ends, you need to install additional software on the Unix server.

 Caution

SAP does not provide support for additional software.

Related Information

Criteria for Selecting the Help Type [page 10]

SAP Help Portal [page 11]
PlainHtmlHttp [page 12]

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Variants of SAP Library PUBLIC 9
PlainHtmlFile [page 13]
HtmlHelpFile [page 13]

2.1 Criteria for Selecting the Help Type

You can choose the help type to use in your SAP system. The following graphic shows you the factors you need
to take into account.

 Recommendation

If documentation is available on the SAP Help Portal for the product and version that you are using, we
recommend that you configure the connection to the SAP Help Portal.

If you decide to use a local installation in your system landscape, bear in mind the following criteria:

● If you want to access the SAP Library with Google Chrome, we recommend that you install the SAP Library
on a Web server (help type PlainHtmlHttp). This help type contains a script that is used to enhance the
rendering. While embedded in a Web server, there are no issues with Google Chrome; but when the SAP
Library is installed on a file system, Google Chrome prevents the execution of these scripts.
For more information, see SAP Note 2622352 .

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
10 PUBLIC Variants of SAP Library
 ● If you want to use the Web Application Server ABAP (Web AS ABAP) of an SAP system as your Web server,
see SAP Note 1019805 .
● If you use front-end platforms other than Microsoft Windows, we recommend that you install
PlainHtmlHttp because this help type provides a full-text search function from the SAP Help Portal.
● If you do not have a Web server and you use front-end platforms other than Microsoft Windows, you must
use help type PlainHtmlFile.

2.2 SAP Help Portal

You can use the help type SAP Help Portal on all front-end platforms. Like the PlainHtml help types, it uses a
standard HTML file format, and a standard Web browser for viewing. You must configure the connection to the
SAP Help Portal in your SAP system. In this case, you do not need to install the help files in your system
landscape and can go directly to the Post-Installation section of this guide.

Features

Characteristics

● Can be used on all front-end platforms that your product supports. For more information, see the SAP
Product Availability Matrix at https://apps.support.sap.com/sap/support/pam .
● Documents displayed with one of the following Web browsers:

Browser Minimum Version

Google Chrome 7.4

Microsoft Internet Explorer 9

Microsoft Edge April 2017

Mozilla Firefox 66

Safari 12.1

● Full-text search in all SAP documentation on the SAP Help Portal http://help.sap.com
● Navigation in structures (tables of contents) and using hyperlinks
● Printing of individual help documents and generation of custom PDFs

System Requirements

System Requirements for SAP Help Portal

System Requirements

Front end No requirements other than those of the Web browser

Limitations

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Variants of SAP Library PUBLIC 11
● The documentation you want to consume must be available on the SAP Help Portal. If the product version
that you are using is not available on the SAP Help Portal, you must install the documentation in your local
system landscape using the SAP Library DVD provided.
For more information and to check if your product version is available on the SAP Help Portal, see 2652009
.
● The users who consume the documentation must have access to the Internet. If this is not the case, you
must install the documentation in your local system landscape using the SAP Library DVD provided.
● You can configure an ABAP system to connect to only one combination of product and version. If you want
to consume documentation for more than one product, you must install the documentation in your local
system landscape using the SAP Library DVD provided.

Related Information

Configuring Documentation Provided on the SAP Help Portal [page 38]

2.3 PlainHtmlHttp

This help type stores documents in Standard HTML format. They are available from a Web server and can be
displayed in a standard Web browser.

Features

Characteristics

● Can be used on all front-end platforms that your product supports. For more information, see the SAP
Product Availability Matrix at https://apps.support.sap.com/sap/support/pam .
● Documents displayed with a standard Web browser (Microsoft Internet Explorer or Google Chrome)
● Full-text search in all SAP documents on the SAP Help Portal https://help.sap.com
● Navigation in structures (tables of contents) and using hyperlinks
● Printing of single help documents

System Requirements

System Requirements for PlainHtmlHttp

System Requirements

Front end No requirements other than those of the Web browser

Server See Hardware and Software Requirements [page 20].

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
12 PUBLIC Variants of SAP Library
2.4 PlainHtmlFile

This help type stores documents in Standard HTML format. They are available from a file server and can be
displayed in a standard Web browser.

Features

Characteristics

● Can be used on all front-end platforms that your product supports. For more information, see the SAP
Product Availability Matrix at https://apps.support.sap.com/sap/support/pam .
● Documents displayed with a standard Web browser (Microsoft Internet Explorer)
● Full-text search in all SAP documents on the SAP Help Portal https://help.sap.com
● Navigation in structures (tables of contents) and using hyperlinks
● Printing of single help documents

System Requirements

System Requirements for PlainHtmlFile

System Requirements

Front end No requirements other than those of the Web browser

Server See Hardware and Software Requirements [page 20]

2.5 HtmlHelpFile

This help type stores documents in Compiled HTML format (*.CHM). They are accessed from a file server and
displayed in the HTML Help Viewer. Compiled HTML is a format developed by Microsoft for storing HTML files
in compressed form. HTML Help Viewer was introduced by Microsoft as a successor to WinHelp and is based
on the Internet Explorer.

 Caution

Not all product documentation is provided in this help type because Microsoft have ceased the support for
their Compiled HTML Help (CHM) format. SAP´s documentation contains an increasing amount of
interactive elements that are not rendered appropriately on older versions of Microsoft Internet Explorer.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Variants of SAP Library PUBLIC 13
Features

● Can be used only on Windows front-end platforms

● Documentation can be accessed directly from the SAP Library DVD; no unpacking is required
● Documentation is displayed in HTML Help Viewer (requires Microsoft Internet Explorer)
● Navigation in structures and using hyperlinks
● Full-text search in the documentation in the current help file (local search)
● Multiple documents within the same structure can be printed simultaneously.

System Requirements

Front-End Requirements for HtmlHelpFile

For information about the front-end requirements for this help type and the supported SAP GUI platforms, see
SAP Note 66971 .

Server Requirements for HtmlHelpFile

See Hardware and Software Requirements [page 20].

 Note

If you install HtmlHelpFile format on a Unix server, you must note that only users of Microsoft Windows
front ends can display the application help in this format. To access the file system from Microsoft Windows
front ends, you need to install additional software on the Unix server.

 Caution

SAP does not provide support for additional software.

 Note

If HtmlHelpFile works correctly only when called locally, but not from a network share, you need to apply
specific Microsoft Security Bulletins to all front ends and servers. For more information, see SAP Note
857216 .

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
14 PUBLIC Variants of SAP Library
3 Installation

When you install the SAP Library, you provide the users of your SAP systems with the entire documentation in
your local system landscape.

Prerequisites

You have obtained the SAP Library DVD for your SAP product. We deliver the documentation in the file format
Standard HTML and in some cases the file format Compiled HTML (HTMLHelpFile). Subdirectories contain
the different language versions that the documentation is available in.

Process Flow

If you have more than one SAP Library DVD to install, proceed in the following installation sequence:

● SAP Library of the underlying SAP NetWeaver release including SPS download packages, if available
● SAP Library of the product that you want to install
● SAP Library of the addon product that you want to install
● Redirect files (PlainHTML only)
● Glossary files

For access from the SAP system, you must work through the following steps:

1. You install the PlainHtmlHttp and PlainHtmlFile using Software Provisioning Manager 1.0 as
described in Installing PlainHtmlHttp and PlainHtmlFile [page 16].

 Note

For the sake of simplicity we refer to Software Provisioning Manager 1.0 as “Software Provisioning
Manager” or – if suitable – simply as “installer” in the following.

2. You maintain setting variants for the documentation in transaction SR13 as described in Setting Variants
for SAP Library [page 35].

Result

Once you have completed the steps in this section, you can access SAP Library both from the SAP system and
directly in your local system landscape.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Installation PUBLIC 15
3.1 Installing PlainHtmlHttp and PlainHtmlFile

This procedure describes how to install PlainHtmlHttp and PlainHtmlFile. The Standard HTML files for
help types PlainHtmlHttp and PlainHtmlFile are stored in a packed format in the folder PLAINHTM on the
SAP Library DVD. They cannot be viewed directly, but must first be installed on the Web server or file server; to
do this, you must use Software Provisioning Manager as described in Installation of Help Files Using the
Software Provisioning Manager [page 20].

 Caution

A complete installation of SAP NetWeaver and SAP ERP with PlainHTML redirects comprises about
750,000 files in about 350,000 directories for one language version. Depending on the file system and the
configuration of the hard disk, this requires approximately 2.6 GB of disk space.

Prerequisites

● To install SAP Library, you require the SAP Library DVD (see Preparing the Installation Media [page 21]).
● To display the documentation, a suitable browser or viewer must be installed on your computer. For more
information, see Using a Web Browser or Viewer [page 32].

 Note

When you call the search function from the banner of the relevant documentation, an Internet connection is
opened enabling a full-text search from the SAP Help Portal. To use the full-text search function, you need
an Internet connection.

 Note

If Java scripting is not enabled, the button for the full-text search function appears in the browser banner
but if you choose the button, an error message appears. To activate the button, enable Java scripting in
your browser settings as follows:

For Google Chrome, go to Customize and control Google Chrome Settings . Then choose Privacy
and security Content settings JavaScript and toggle the switch to Allowed.

Procedure

Install PlainHtmlHttp and PlainHtmlFile using Software Provisioning Manager as described in Installing and
Updating SAP Library Using Software Provisioning Manager 1.0 [page 24].

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
16 PUBLIC Installation
Result

The archives in the folder PLAINHTM are unpacked and the help files are written to the Web server or the file
server. The duration of this operation depends on the operating system and the data transfer rate of the local
machine or network share. The directory tree created on the Web server when you install the English language
version has the following structure:

<InstallDir>

- PLAINHTML

+ EN (help files, English version)

 Note

For PlainHtmlHttp, you must create the alias /saphelp. Define this alias to point to your installation
directory <InstallDir>. The Web server must allow read access for /saphelp for all users.

You have installed SAP Library. Once you have maintained the variants in transaction SR13, you can access the
documentation from the SAP system and when you have no connection to the SAP system. You maintain
variants to define which help variants are available to the user. For more information, see Setting Variants for
SAP Library [page 35]

 Note

See SAP Note 2304237 for instructions on how to proceed if the following error appears when you open
the SAP Library:

Could not find file \\<path><language>\e1\8e51341a06084de10000009b38f83b\frameset.htm

 Note

See SAP Note 2575073 for instructions on how to proceed if an HTTP 404 error occurs when you open
the SAP Library with the following URL:

http://<webserver>/helpdata/<language>/77/daf75305610114e10000000A174cb4/frameset.htm

3.1.1 Adding PlainHTML Redirects

Context

The IDs listed in table IWREFERENC in ABAP systems are incorrect in some cases due to the conversion of SAP
documentation to a newer format. You need to add the partner ID information so that the correct content can
be found. This is implemented using a set of redirect files that you add to the local SAP Library installation.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Installation PUBLIC 17
PlainHTML redirects are provided as a ZIP file that you can extract and merge with your local documentation
installation for each language. The size of the ZIP file is 200MB. These redirects are available for use with the
PlainHTML documentation format only.

 Caution

We recommend that you back up your local SAP library installation before starting in case you want to
revert to the content without redirects afterwards.

 Restriction

Do not use the Software Provisioning Manager to install these redirects because it will overwrite and thus
remove existing content with the same file names.

If you have installed the SAP Library on Unix or Linux, proceed as follows:

Procedure

1. Go to the following page on the SAP Help Portal: https://help.sap.com/viewer/product/UA-DOC/1.0/en-

US.
2. Choose the link with the title Plain HTML Redirects.
3. Download the ZIP file plainhtml_redirects.zip to your SAP Help server.
4. Enter the following command to switch to the SAP Help directory: cd /<saphilfe PLAINHTM>/<2-
digit language code>/
5. Enter the following command to extract the content of the ZIP file plainhtml_redirects.zip directly to
the PlainHTML folder path in your SAP Library installation: unzip -n /<path to
plainhtml_redirects.zip>

You must add -n to make sure that you do not overwrite the existing content with the content of the
plainhtml_redirects.zip.
6. Repeat this process for all of your local SAP Library installations in all languages.

3.1.2 Adding Glossary Files To a PlainHTML Installation

Context

After installing the SAP Library for your software locally using the Software Provisioning Manager, the menu
path Help Glossary or Glossary link in the SAP Library banner do not work. You can add the glossary to
your local SAP Library installation.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
18 PUBLIC Installation
  Caution

Make sure that you choose the correct language and file format for the local SAP Library installation that
you want to add the glossary to. The glossary is provided in English and German only.

Procedure

1. Open the following URL on the SAP Help Portal: https://help.sap.com/doc/

02d356bcbc0e4b3e858f86e397ccc151/latest/en-US/Glossary_PLAINHTM_SAR.zip.
2. Download the ZIP file glossary_PLAINHTM_SAR.zip to your SAP Help server.
3. Open the Software Provisioning Manager and add the downloaded files to your local SAP Library
installation.
4. Repeat this process for all local SAP Library installations that you want to add the glossary to.

3.2 Installing HtmlHelpFile

This procedure describes how you install HtmlHelpFile. The Compiled HTML files for help type
HtmlHelpFile can be viewed directly from the documentation medium in Microsoft HTML Help Viewer. For
better performance, we recommend that you install the help files on a file server. To do this, you use the
Software Provisioning Manager as described in Installation of Help Files Using Software Provisioning Manager
[page 20].

Prerequisites

● To install SAP Library, you require the SAP Library DVD (see Preparing the Installation Media [page 21]).
● To display the documentation, a suitable browser or viewer must be installed on your computer, as
described in Using a Web Browser or Viewer [page 32].

Procedure

Install HtmlHelpFile using Software Provisioning Manager as described in Installing and Updating SAP Library
Using Software Provisioning Manager 1.0 [page 24].

Result

You have installed SAP Library. Once you have maintained the setting variants in transaction SR13, you can
access the documentation from the SAP system and when you have no connection to the SAP system. When

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Installation PUBLIC 19
you maintain setting variants, you define which help variants are available to the user. For more information,
see Setting Variants for SAP Library [page 35].

3.3 Installation of Help Files Using Software Provisioning

Manager 1.0

Related Information

Preparations for the Installation with Software Provisioning Manager 1.0 [page 20]
Installing and Updating SAP Library Using Software Provisioning Manager 1.0 [page 24]

3.3.1 Preparations for the Installation with Software

Provisioning Manager 1.0

You have to perform the following steps to prepare the installation or update of the SAP Library with software
provisioning manager (“installer” for short).

Procedure

1. Check that your installation host meets the hardware and software requirements [page 20].
2. Make sure that the required installation media [page 21] are available.

3.3.1.1 Hardware and Software Requirements

Make sure that your host meets the hardware and software requirements.

Requirements for Running the Installer

● Minimum RAM:
0.5 GB

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
20 PUBLIC Installation
 ● Minimum disk space (based on PlainHtmlHttp installation SAP NetWeaver and SAP ERP):
○ Approximately 2.6 GB of disk space are required for one language version (Windows NTFS)
○ 5 GB of temporary disk space for each required installation medium that you have to copy to a local
hard disk
○ 2 GB of temporary disk space for the installation

Requirements for Help Files to be Installed

● Minimum disk space for an SAP NetWeaver Library installation:

○ HtmlHelp (if available): 1 GB
○ PlainHtmlHttp: 1.4 GB

● Minimum disk space for an SAP Business Suite Library installation:

○ HtmlHelp (if available): 2 GB
○ PlainHtmlHttp: 2.6 GB

3.3.1.2 Preparing the Installation Media

This section describes how to prepare the installation media.

Installation media are available as follows:

● The Software Provisioning Manager 1.0 archive containing the installer

You always have to download the latest version of the Software Provisioning Manager 1.0 archive.
For more information, see Downloading and Extracting the Software Provisioning Manager 1.0 Archive
[page 22].
● The Documentation Installation Media
<SAP_Product> Support Package Stack <Number> HTML-Help for <OS> Standard HTML
(Plain HTML) Number <Material_Number>

 Example

SAP NetWeaver 7.5 Support Package Stack 12 HTML-Help for Windows Standard
HTML (Plain HTML) Number 50143290

You can obtain it in one of the following ways:

○ Use the physical DVD or CD provided as part of the installation package of your SAP system.
○ Download the documentation package from the SAP Software Download Center (SWDC) at https://
launchpad.support.sap.com/#/softwarecenter .
For more information, see Downloading Installation Media [page 23].

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Installation PUBLIC 21
3.3.1.2.1 Downloading and Extracting the Software
Provisioning Manager 1.0 Archive

You must always download and extract the Software Provisioning Manager 1.0 archive from the SAP Software
Download Center because you must use the latest version.

Prerequisites

● Make sure that you are logged on as a user with root authorizations, and that the download directory has
at least the permissions 755.
● Make sure that you use the latest version of the SAPCAR tool when manually extracting the Software
Provisioning Manager archive.

 Note

An older SAPCAR version might extract archive files in a wrong way and this could prevent the installer
from working consistently.

Proceed as follows to get the latest version of SAPCAR:

1. Go to https://launchpad.support.sap.com/#/softwarecenter SUPPORT PACKAGES & PATCHES
By Category SAP TECHNOLOGY COMPONENTS SAPCAR .
2. Select the archive file for your operating system and download it to an empty directory.
3. To check the validity of the downloaded executable, right-click the executable and choose Properties.
On the Digital Signatures tab you can find information about the SAP signature with which the
executable was signed.
4. Rename the executable to sapcar.exe.
For more information about SAPCAR, see SAP Note 212876 .

Procedure

1. Download the latest version of the Software Provisioning Manager 1.0 archive
[70]SWPM10SP<Support_Package_Number>_<Version_Number>.SAR :
○ Valid for SAP systems based on SAP NetWeaver 7.0 and SAP NetWeaver 7.0 including enhancement
package <Number>:
Download the 70SWPM10SP<Support_Package_Number>_<Version_Number>.SAR
○ Valid for SAP systems based on :
Download the SWPM10SP<Support_Package_Number>_<Version_Number>.SAR

https://support.sap.com/sltoolset System Provisioning Download Software Provisioning

Manager
2. Unpack the Software Provisioning Manager archive to a local directory using the following command:

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
22 PUBLIC Installation
 /<Path to SAPCAR>/sapcar -xvf <Path to Download Directory>/
[70]SWPM10SP<Support_Package_Number>_<Version_Number>.SAR -R <Path to Unpack
Directory>

 Note

Make sure that all users have at least read permissions for the directory to which you unpack the
installer.

 Caution

Make sure that you unpack the Software Provisioning Manager archive to a dedicated folder. Do not
unpack it to the same folder as other installation media.

3.3.1.2.2 Downloading Installation Media

This section describes how you can download media from the SAP Software Download Center.

Procedure

1. Download and unpack the latest version of Software Provisioning Manager as described in Downloading
and Extracting the Software Provisioning Manager 1.0 Archive [page 22].
2. You identify the required media as listed in Preparing the Installation Media [page 21] .
3. Identify all download objects that belong to one medium according to one of the following:

 Note

Installation media might be split into several files. In this case, you have to reassemble the required files
after the download.

○ Download path or location:

○ To download the complete kernel media, go to https://support.sap.com/sltoolset System
Provisioning Software Provisioning Manager 1.0 SP<Current Version> Download Kernel
releases delivered for SL Toolset SL TOOLSET 1.0 (INSTALLATIONS AND UPGRADES) KERNEL
FOR INSTALLATION/SWPM .
○ To download all media required for your SAP product, you can use one of the following navigation
paths:
○ https://launchpad.support.sap.com/#/softwarecenter INSTALLATIONS & UPGRADES
By Category SAP NETWEAVER AND COMPLEMENTARY PRODUCTS <Product>
<Product Release>
○ https://launchpad.support.sap.com/#/softwarecenter INSTALLATIONS & UPGRADES
By Alphabetical Index (A-Z) <First Letter of Product> <Product> <Product
Release>

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Installation PUBLIC 23
 ○ Material number
All download objects that are part of an installation medium have the same material number and an
individual sequence number:
<Material_Number>_<Sequence_Number>

 Example

51031387_1

51031387_2

...

○ Title
All objects that are part of an installation medium have the same title, such as
<Solution><Media_Name><OS> or <Database>RDBMS<OS> for database media.
4. Download the objects to the download directory.
5. To correctly re-combine the media that are split into small parts, unpack all parts into the same directory.

In the unpacking directory, the system creates a subdirectory with a short text describing the medium and
copies the data into it. The data is now all in the correct directory, the same as on the medium that was
physically produced. For more information, see SAP Note 1258173 .

 Caution

Make sure that you unpack each installation media to a separate folder. Do not unpack installation
media to the same folder where you unpack the Software Provisioning Manager archive.

Do not unpack installation media to the same folder where you unpack the SAP kernel archives for
archive-based installation.

3.3.2 Installing and Updating SAP Library Using Software

Provisioning Manager 1.0

This procedure tells you how to install and update SAP Library with software provisioning manager (“installer”
for short).

Prerequisites

● The installation host meets the hardware and software requirements for the SAP Library installation as
described in Hardware and Software Requirements [page 20].
● The required installation media are available on the installation host as described in Preparing the
Installation Media [page 21].

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
24 PUBLIC Installation
Context

● Install means that you install SAP Library from scratch.

● Update means that you update an existing version of SAP Library.

Procedure

1. Make sure that the installation host meets the prerequisites for running the installer.

Fore more information, see Prerequisites for Running the Installer [page 25].
2. Run the installation or update.

Fore more information, see Running the Installer (Software Provisioning Manager) [page 28]

3.3.2.1 Prerequisites for Running the Installer

Make sure you fulfil the following prerequisites before running the installer.

● For the SL Common GUI, make sure that the following web browser requirements are met:
○ You have one of the following supported browsers on the device where you want to run the SL
Common GUI:
○ Google Chrome (recommended)
○ Mozilla Firefox
○ Microsoft Edge
○ Microsoft Internet Explorer 11 or higher.
Always use the latest version of these web browsers.
○ If you copy the SL Common GUI URL manually in the browser window, make sure that you open a new
Web browser window in private browsing mode (Internet Explorer), incognito mode (Chrome) or
private browsing mode (Firefox). This is to prevent Web browser plugins and settings from interfering
with the SL Common GUI.

 Caution

The installer uses a self-signed certificate, which is used temporarily only while the installer is running.
This certificate is not trusted by the browser unless it is imported manually by the user running the
installer. This behavior is intentionally designed in this way because - unlike ordinary public web servers
- the installer has different usage patterns. You must configure your browser do trust the self-issued
certificate of the installer after carefully performing the “thumbprint” verification described in Running
the Installer [page 28] . For more information about adding trusted certificates, see the
documentation of your browser.

For more information about the SL Common GUI, see Useful Information about the Installer [page 42].

● The installer uses shell scripts to obtain the environment for user <sapsid>adm.
○ If user <sapsid>adm does not yet exist, a working /bin/csh must be available on the host where you
run the installer. For more information about recommended login shells, see SAP Note 202227 .

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Installation PUBLIC 25
 ○ If <sapsid> already exists and uses csh, before you start the installer, execute the following command
as user <sapsid> to make sure that the csh scripts are up-to-date, depending on your UNIX OS
platform:
/bin/csh -c "source /home/<sapsid>adm/.cshrc;env" or /bin/csh -c "source /home/
<sapsid>adm/.login;env"
● Make sure that your operating system does not delete the contents of the temporary directory /tmp or the
contents of the directories to which the variables TEMP, TMP, or TMPDIR point, for example by using a
crontab entry.
Make sure that the temporary directory has the permissions 755.
● Make sure that you have at least 300 MB of free space in the installation directory for each installation
option. In addition, you need 300 MB free space for the installer executables. If you cannot provide 300 MB
free space in the temporary directory, you can set one of the environment variables TEMP, TMP, or TMPDIR
to another directory with 300 MB free space for the installer executables.
You can set values for the TEMP, TMP, or TMPDIR environment variable to an alternative installation
directory as described in section Useful Information About the Installer [page 42].
● Make sure that umask is set to 022 for the user with root permissions that you want to use for running the
installer.
As the user with root permissions that you want to use for running the installer, enter the following
command: umask 022
● Only valid for 'Platform': AIX
AIX: Make sure that you have set the limits for operating system users as described in SAP Note 323816
.
End of 'Platform': AIX

● Only valid for 'Platform': Linux, HP-UX, Oracle Solaris

HP-UX, Linux, Oracle-Solaris: Make sure that you have set the limits for operating system users root,
<sapsid>adm, and your database-specific operating system users (see also sections Creating Operating
System Users and Groups and Running the Installer in the installation guide).

 Caution

Caution: the limit mechanism supports hard- and soft-limits. The soft-limit cannot be bigger than the
hard-limit. The hard-limit can be set/increased by the root user like: limit -h <limit>
<new_value>, for example limit -h datasize unlimited .

○ Using csh shell, the output of command limit needs to be at least as follows:

 Example

The following table lists example output taken from SUSE Linux Enterprise Server 11 (x86_64).

Output Properties

cputime unlimited

filesize unlimited

datasize unlimited

stacksize 8192 KB

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
26 PUBLIC Installation
 Output Properties

coredumpsize unlimited

descriptors 8192

memoryuse unlimited

○ Using sh or ksh shell, the output of command ulimit -a needs to be at least as follows:

 Example

The following table lists example output taken from SUSE Linux Enterprise Server 11 (x86_64).

Output sh Output ksh Properties

cpu time (seconds) cpu time (seconds) unlimited

file size (blocks) file size (blocks) unlimited

data seg size (kbytes) data size (Kibytes) unlimited

stack size (kbytes) stack size (Kibytes) 8192 KB

core file size (blocks) core file size (blocks) unlimited

open files nofile 8192

max memory size (kbytes) max memory size (Kibytes) unlimited

End of 'Platform': Linux, HP-UX, Oracle Solaris

● Make sure that the following ports are not used by other processes:
○ Port 4237 is used by default as HTTPS port for communication between the installer and the SL
Common GUI.
If this port cannot be used, you can assign a free port number by executing sapinst with the following
command line parameter:
SAPINST_HTTPS_PORT=<Free Port Number>
○ Port 4239 is used by default for displaying the feedback evaluation form at the end of the installer
processing.
The filled-out evaluation form is then sent to SAP using HTTPS.
If this port cannot be used, you can assign a free port number by executing sapinst with the following
command line parameter:
SAPINST_HTTP_PORT=<Free Port Number>

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Installation PUBLIC 27
3.3.2.2 Running the Installer

This section describes how to run the installer.

Prerequisites

For more information, see Prerequisites for Running the Installer [page 25].

Context

The installer has a web browser-based GUI named “SL Common GUI of the Software Provisioning Manager” -
“SL Common GUI” for short.

This procedure describes an installation where you run the installer and use the SL Common GUI, that is you
can control the processing of the installer from a browser running on any device.

For more information about the SL Common GUI, see Useful Information About the Installer [page 42].

Procedure

1. Log on to the installation host as a user with root permissions.

 Caution

Make sure that the user with root permissions that you want to use for running the installer has not
set any environment variables for a different SAP system or database.

If your security policy requires that the person running the installer is not allowed to know the credentials
of a user with root permissions on the installation host, you can specify another operating system user for
authentication purposes. You do this using the SAPINST_REMOTE_ACCESS_USER parameter when starting
the sapinst executable from the command line. You must confirm that the user is a trusted one. For more
information, see SAP Note 1745524 .
2. Start the installer from the directory to which you unpacked the Software Provisioning Manager archive by
entering the following command:

<Path_To_Unpack_Directory>/sapinst

 Note

<Path_To_Unpack_Directory>/sapinst SAPINST_USE_HOSTNAME=<Virtual_Host_Name>

3. The installer is starting up.

The installer now starts and waits for the connection with the SL Common GUI.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
28 PUBLIC Installation
 You can find the URL you require to access the SL Common GUI at the bottom of the shell from which you
are running the installer.

...
************************************************************************
Open your browser and paste the following URL address to access the GUI
https://[<hostname>]:4237/sapinst/docs/index.html
Logon users: [<users>]
************************************************************************
...

 Note

If the host specified by <hostname> cannot be reached due to a special network configuration,
proceed as follows:
1. Terminate the installer as described in Useful Information about the Installer [page 42].
2. Restart the installer from the command line with the SAPINST_GUI_HOSTNAME=<hostname>
property.
You can use a fully-qualified host name.

If you have a supported web browser (see Prerequisites for Running the Installer [page 25]) installed on the
host where you run the installer, you can open this URL directly in the shell. Otherwise, open the URL in a
supported web browser that runs on another device.

 Caution

After opening the browser URL, make sure that the URL in the browser starts with “https://” to avoid
security risks such as SSL stripping .

Before you reach the Welcome screen, your browser warns you that the certificate of the sapinst
process on this computer could not be verified.

Proceed as follows to avoid security risks such as a man-in-the-middle attack:

1. Click on the certificate area on the left hand side in the address bar of your browser, and view the
certificate.
2. Open the certificate fingerprint or thumbprint, and compare all hexadecimal numbers to the ones
displayed in the console output of the installer.
Proceed as follows to get the certificate fingerprint or thumbprint from the server certificate
printed in the installer console:
1. Go to the sapinst_exe.xxxxxx.xxxx directory in the temporary directory to which the
installer has extracted itself:
<User_Home>/.sapinst/
2. In the sapinst_exe.xxxxxx.xxxx directory, execute the sapgenpse tool with the
command line option get_my_name -p.
As a result, you get the server fingerprint or thumbprint from the server certificate.
3. Accept the warning to inform your browser that it can trust this site, even if the certificate could not
be verified.

The SL Common GUI opens in the browser by displaying the Welcome screen.
4. On the Welcome screen, choose the required option:

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Installation PUBLIC 29
 ○ If you are using the 70SWPM*.SAR:
Choose your product, then go to Software Life-Cycle Options SAP Library Installation and
Update and choose Install/Update SAP Library
○ If you are using the SWPM*.SAR:
Go to Generic Options <Database> SAP Library Installation and Update and choose Install/
Update SAP Library
5. Choose Next.

 Note

If there are errors during the self-extraction process of the installer, you can find the log file
dev_selfex.out in the temporary directory.

6. Follow the instructions on the installer screens and enter the required parameters.

 Note

To find more information on each parameter during the Define Parameters phase, position the cursor
on the required parameter input field , and choose either F1 or the HELP tab. Then the available help
text is displayed in the HELP tab.

 Caution

The signature of installation media and installation archives is checked automatically during the Define
Parameters phase while processing the Media Browser and - if you perform an archive-based
installation - the Software Package Browser screens.

Note that this automatic check is only committed once and not repeated if you modify artifacts such
as SAR archives or files on the media after the initial check has been done. This means that - if you
modify artefacts later on either during the remaining Define Parameters phase or later on during the
Execute Service phase - the signature is not checked again.

For more information, see SAP Note 2393060 .

After you have entered all requested input parameters, the installer displays the Parameter Summary
screen. This screen shows both the parameters that you entered and those that the installer set by default.
If required, you can revise the parameters before starting the installation.
7. To start the installation, choose Next.

The installer starts the installation and displays the progress of the installation. When the installation has
finished, the installer shows the message: Execution of <Option_Name> has completed.
8. If required, delete directories with the name sapinst_exe.xxxxxx.xxxx after the installer has finished.
Sometimes these directories remain in the temporary directory.

9. If you copied the installer software to your hard disk, you can delete these files when the installation has
successfully completed.
10. For security reasons, we recommend that you remove the operating system users from the group sapinst
after you have completed the installation.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
30 PUBLIC Installation
  Note

This step is only required, if you did not specify during the Define Parameters phase that the operating
system users are to be removed from the group sapinst after the execution of the installer has
completed.

11. For security reasons, we recommend that you delete the .sapinst directory within the home directory of
the user with which you ran the installer:

<User_Home>/.sapinst/
12. The installer log files contain IP addresses and User IDs such as the ID of your S-User. For security, data
protection, and privacy-related reasons we strongly recommend that you delete these log files once you do
not need them any longer.
You find the installer log files in the sapinst_instdir directory. For more information, see Useful
Information about the Installer [page 42].

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Installation PUBLIC 31
4 Post-Installation

The following sections provide information about activities after the installation of the SAP Library has finished
successfully.

Related Information

Using a Web Browser or Viewer [page 32]

Offline Access to Help Files - PlainHtmlHttp and PlainHtmFile [page 34]
Offline Access to Help Files - HtmlHelpFile [page 34]
Setting Variants for SAP Library [page 35]
Configuring Documentation Provided on the SAP Help Portal [page 38]
Enabling Product-Specific Documentation [page 40]
Providing Read Permissions for Installed Help Files [page 41]

4.1 Using a Web Browser or Viewer

The HTML-based documentation can be displayed in a Web browser on all front-end platforms supported by
SAP. However, you must observe certain requirements and restrictions depending on the specific platform. The
following table shows which browsers can be used with which front-end platforms.

Web Browser for Help Documentation

Microsoft Internet Ex­ Mozilla Firefox Google Chrome HTML Help Viewer
plorer with Microsoft Inter­
net Explorer 5.01 SP 2
(or higher)

Microsoft Windows X X X X
platforms

Apple Macintosh X X

UNIX X X X

Note the following points:

● If you use help types PlainHtmlHttp and PlainHtmlFile, you can use either Microsoft Internet
Explorer or Google Chrome. For the help structure implemented with JavaScript and displayed as a
compressed tree, JavaScript must be activated in the browser used.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
32 PUBLIC Post-Installation
  Note

If you want to access the SAP Library with Google Chrome, we recommend that you install the SAP
Library on a Web server (help type PlainHtmlHttp). This help type contains a script that is used to
enhance the rendering. While embedded in a Web server, there are no issues with Google Chrome; but
when the SAP Library is installed on a file system, Google Chrome prevents the execution of these
scripts. For more information, see 2622352 .

● On UNIX, the help processor of the SAP system with the logical file name WEBBROWSER calls the default
Web browser. To adapt this call to your file system, you must go to transaction FILE and define this logical
file name and the corresponding logical file path WEBBROWSER_PATH.
● On UNIX front ends, the symbol used in the SAP Library for describing menu paths (→) cannot be displayed
in the Web browser. A different symbol is displayed instead.
● On UNIX and Linux front ends, you cannot choose < (Previous Topic) button and > (Next Topic) button in
the Firefox Web browser for help type Plain HTML.
● If you use HTML Help Viewer in Microsoft Windows, a new instance of the viewer or browser is opened each
time you access the documentation.
● If you choose help type HtmlHelpFile, you must use HTML Help Viewer, which is based on Microsoft
Internet Explorer and requires this to function.

Installation of Microsoft HTML Help Viewer and Microsoft Internet Explorer

Microsoft HTML Help Viewer is installed automatically when you install SAP GUI from the Presentation DVD
on your front-end PC. Note that HH.exe (HTML Help Viewer) is also installed with Microsoft Internet Explorer,
and therefore any version already installed might be overwritten.

Microsoft Internet Explorer is installed with the operating system. You can download updates from the
Microsoft Web site.

 Note

To use the HTML Help Viewer, you have to activate ActiveX in Microsoft Internet Explorer. In Internet
Explorer, choose security level Medium or Low under the Local intranet zone in the menu path Tools
Internet Options Security .

For more information, see SAP Note 594271 and SAP Note 857216 .

To display documentation on how to use HTML Help Viewer, choose Help in the Viewer toolbar.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Post-Installation PUBLIC 33
4.2 Offline Access to Help Files - PlainHtmlHttp and
PlainHtmFile

To view the documentation without connecting to the SAP system, you need to fulfill the following
prerequisites:

● Install a suitable browser or viewer on your computer as described in table Web Browser for Help
Documentation in Using a Web Browser or Viewer [page 32].
● Ensure that you have access to the help files. For the standard HTML help files, this requires you to install
the archives in the folder PLAINHTM on the SAP Library DVD to a Web server or a file server. For more
information, see Installing PlainHtmlHttp and PlainHtmlFile [page 16].

Procedure

1. Navigate to the directory <InstallDir>/PLAINHTM/<language key>.

This is the directory containing the help files.
2. Open the index.htm file.
This loads the documentation homepage in your Web browser. From here you can navigate to all parts of
the documentation.
3. Add the documentation homepage to your browser favorites or bookmarks.

4.3 Offline Access to Help Files - HtmlHelpFile

Display the HtmlHelpFile documentation directly on the server you have installed it on.

Context

If you install HtmlHelpFile format on a Unix server, you must note that only users of Microsoft Windows front
ends can display the application help in this format. To access the file system from Microsoft Windows front
ends, you need to install additional software on the Unix server.

 Caution

SAP does not provide support for additional software.

To view the documentation without connecting to the SAP system, you need to fulfill the following
prerequisites:

● Install a suitable browser or viewer on your Microsoft Windows front end as described in table Web Browser
for Help Documentation in Using a Web Browser or Viewer [page 32].

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
34 PUBLIC Post-Installation
 ● Ensure that you have access to the help files. For the standard HTML help files, this requires you to install
the archives in the folder HTMLHELP on the SAP Library DVD to a file server. For more information, see
Installing HtmlHelpFile [page 19].

Procedure

1. Navigate to the directory <InstallDir>\HTMLHELP\<language key>using Microsoft Windows

Explorer. This is the directory containing the help files.
2. Double-click file 00000001.chm.This opens SAP Library. From here you can navigate to all parts of the
documentation.
3. Add the documentation homepage to your browser favorites or bookmarks.

4.4 Setting Variants for SAP Library

Use

In transaction SR13 you specify which help variants you want to make available to users of the SAP system.

For more information about the HTTPS protocol configuration, see SAP Note 1842462 .

For more information about configuring the help settings and to see examples for each help type, see SAP KBA
2149786 .

Procedure

General guidelines

● Do not use special characters, such as blanks or ampersands, in variant names or in the path names
specified in the setting variants.
● Enter variant names in block capitals.
● Create variants for the areas IWBHELP and XML_DOCU for each front-end platform and language
respectively.
● The maximum length of the path name is 62 characters.

PlainHtmlHttp

● Enter the name of the Web server including the port.

● Enter the path in the URL syntax.

PlainHtmlFile

Use the syntax of the front-end platform when specifying a path name.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Post-Installation PUBLIC 35
Example

You can find below examples of the variants needed for each help type for the WIN32 platform.

 Note

You have to create entries for the documentation area (IWBHELP) and the XML documentation area
(XML_DOCU) for each platform you are using and each language in which you want to provide
documentation. You must create variants for the platforms WN32, NONE, and ITS as a minimum; if you are
using other platforms, create variants for these as well.

Example for PlainHtmlHttp

Variant HTML_WEB_WN32_IWBHELP_EN

Platform WN32

Area IWBHELP

Server p12345:1080

Path PlainHttp

Language EN

Example for PlainHtmlHttp

Variant HTML_WEB_WN32_XML_DOCU_EN

Platform WN32

Area XML_DOCU

Server p12345:1080

Path PlainHttp

Language EN

Example for PlainHtmlFile

Variant HTML_FILE_WN32_IWBHELP_EN

Platform WN32

Area IWBHELP

Path \\p12345\PlainFile

Language EN

Default Yes

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
36 PUBLIC Post-Installation
Example for PlainHtmlFile

Variant HTML_FILE_WN32_XML_DOCU_EN

Platform WN32

Area XML_DOCU

Path \\p12345\PlainFile

Language EN

Default Yes

Example for HtmlHelpFile

Variant HTML_HELP_WN32_IWBHELP_EN

Platform WN32

Area IWBHELP

Path \\p12345\HTMLHELP

Language EN

Default Yes

Example for HtmlHelpFile

Variant HTML_HELP_WN32_XML_DOCU_EN

Platform WN32

Area XML_DOCU

Path \\p12345\HTMLHELP

Language EN

Default Yes

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Post-Installation PUBLIC 37
4.5 Configuring Documentation Provided on the SAP Help
Portal

You can configure the settings in transaction SR13 to point to documentation that is provided on the SAP Help
Portal.

Context

You can configure your backend system to access documentation that is provided on the SAP Help Portal.

● The documentation you want to access must be available on the SAP Help Portal. To check if this is the
case, see the list of products and versions available on the SAP Help Portal at https://help.sap.com/
viewer/product/UA-DOC/1.0/en-US, entry Providing Documentation Content.
● The users who access the documentation must have access to the Internet.
● You can configure an ABAP system to connect to only one combination of product and version.

If you cannot fulfill one or more of these prerequisites, you must install the documentation in your local system
landscape using the download packages or DVDs/CDs provided.

Procedure

1. Open transaction sr13.

2. Select the tab PlainHtmlHttp.
3. Choose New Entries.

 Caution

You have to create entries for the documentation area (IWBHELP) and the XML documentation area
(XML_DOCU) for each platform you are using and each language in which you want to provide
documentation. You must create variants for the platforms WN32, NONE, and ITS as a minimum; if you
are using other platforms then you create variants for these as well.

You must use the exact combination of uppercase and lowercase characters specified in the product
and version.

* To find the correct entry for the Path field, see the list of products and versions referenced in SAP Note
2652009 .
4. To create entries for the documentation area, enter the following values:

Name Value to be entered

Variant Enter a name for the variant.

Platform Select the platform relevant for your implementation from

the list of available platforms, for example, WN32.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
38 PUBLIC Post-Installation
 Name Value to be entered

Area Select Documentation from the list; this will display as

IWBHELP in the table.

Server Names https://help.sap.com/http.svc/ahp2

Path <product/version> *

Language Select the language you need from the list.

5. To create entries for the XML documentation area, enter the following values:

Name Value to be entered

Variant Enter a name for the variant (any name).

Platform Select the platform relevant for your implementation from

the list of available platforms, for example, WN32.

Area Select XML Documentation from the list; this will display
as XML_DOCU in the table.

Server Names https://help.sap.com/http.svc/ahp2

Path <product/version> *

Language Select the language you need from the list.

6. Repeat steps 4 and 5 for each relevant platform and language.

7. Select one entry as the default language for each platform and area.
8. Save your entries.

Results

You have configured the settings to point to documentation that is provided on the SAP Help Portal.

Related Information

SAP Note 2149786

SAP Note 2652009

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Post-Installation PUBLIC 39
4.5.1 Enabling Product-Specific Documentation

Allow the system to open the documentation for the specific product you are using when context-sensitive
application help is not available. This procedure is relevant only for on-premise software products and if you
configure your system to display documentation provided on the SAP Help Portal.

Prerequisites

Context

After you have configured the settings in transaction SR13, you need to enable the product-specific
documentation with program RSIWBH04 in transaction SE38.

 Note

If report RSIWBH04 is not available in your system, implement the correction described in SAP Note
2369844 .

Procedure

1. Open transaction SE38.

2. Enter the program name RSIWBH04 in the Program field and choose Execute.
3. Under Product-Specific SAP Library, enter the ID of the entry topic for the SAP Library in the Structure/
DITA Map ID field.

 Remember

To find out the ID of the entry topic for the SAP Library, open your SAP Library and access the topic
that you want the documentation to open at. Then identify the 32-digit ID associated with this topic:

SAP Help Portal The character string directly before the ".html" part of
the URL

PlainHTML The characters between the language code and the

"frameset.htm" parts of the URL; remove the forward
slash after the first two characters.

4. Enter the class XDP_STRUCT.

 Caution

Make sure that you have selected the Change radio button.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
40 PUBLIC Post-Installation
 5. Choose Execute to run the program.

Results

You have changed the default entry topic to one relevant for the product you are using. To test the change, open
a new system session.

4.6 Providing Read Permissions for Installed Help Files

Use

Once the installation has finished, only user root and users belonging to the sapinst authorization group can
read the help files. You have to change the permissions assigned to these files in order to allow all users to read
them.

Procedure

1. Open a command prompt on the machine where you installed the SAP Library files.
2. Change to the directory where you installed the SAP Library files.
3. Execute the following command: chmod -R a+r *

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Post-Installation PUBLIC 41
5 Additional Information

● About the Installer (Software Provisioning Manager) [page 42]

● Local Override of Help Settings on Front Ends [page 48]

5.1 About the Installer

5.1.1 Useful Information about the Installer

This section contains some useful technical background information about the installer and the installer GUI.

● Software Provisioning Manager (the “installer” for short) has the web browser-based “SL Common GUI of
the Software Provisioning Manager” - “SL Common GUI” for short.
The SL Common GUI uses the SAP UI Development Toolkit for HTML5 - also known as SAPUI5 - a client-
side HTML5 rendering library based on JavaScript. The benefits of this new user interface technology for
the user are:
○ Zero foot print, since only a web browser is required on the client
○ New controls and functionality, for example, view logs in web browser.
As of version 1.0 SP24 Patch Level (PL) 5, Software Provisioning Manager comes with a new look and feel of
the SL Common GUI. For more information, see https://blogs.sap.com/2018/11/10/new-look-for-
software-provisioning-manager/ .
The SL Common GUI connects the web browser on a client with the sapinst executable - which is part of
Software Provisioning Manager - running on the installation host using the standard protocol HTTPS.
For the SL Common GUI the installer provides a pre-generated URL at the bottom of the shell from which
you are running the installer . If you have a supported web browser installed on the host where you run the
installer, you can start the SL Common GUI directly from this URL. Otherwise, open a web browser
supported by the SL Common GUI on any device and run the URL from there.
For more information about supported web browsers see Prerequisites for Running the Installer [page 25].
If you need to run the SL Common GUI in accessibility mode, apply the standard accessibility functions of
your web browser.

● As soon as you have started the sapinst executable, the installer creates a .sapinst directory
underneath the /home/<User> directory where it keeps its log files. <User> is the user with which you
have started the installer.
After you have reached the Welcome screen and selected the relevant installer option for the SAP system
or instance to be installed , the installer creates a directory sapinst_instdir where it keeps its log files,
and which is located directly below the temporary directory. The installer finds the temporary directory by
checking the value of the TEMP, TMP, or TMPDIR environment variable. If no value is set for these variables,
the installer uses /tmp by default.
All log files which have been stored so far in the .sapinst folder are moved to the sapinst_instdir
directory as soon as the latter has been created.
If you want the sapinst_instdir directory to be created in another directory than /tmp, set the
environment variable TEMP, TMP, or TMPDIR to this directory before you start the installer.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
42 PUBLIC Additional Information
 Shell Used Command

Bourne shell (sh) TEMP=<Directory>

export TEMP

C shell (csh) setenv TEMP <Directory>

Korn shell (ksh) export TEMP=<Directory>

 Caution

Make sure that the installation directory is not mounted with NFS, or there might be problems when
the Java Virtual Machine is started.

The installer records its progress in the keydb.xml file located in the sapinst_instdir directory.
Therefore, if required, you can continue with the installer from any point of failure, without having to repeat
the already completed steps and without having to reenter the already processed input parameters. For
security reasons, a variable encryption key is generated as soon as the sapinst_instdir directory is
created by the installer. This key is used to encrypt the values written to the keydb.xml file.

 Recommendation

We recommend that you keep all installation directories until the system is completely and correctly
installed.

● The installer extracts itself to the temporary directory. These executables are deleted again after the
installer has stopped running.
Directories called sapinst_exe.xxxxxx.xxxx sometimes remain in the temporary directory after the
installer has finished. You can safely delete them.
The temporary directory also contains the log file dev_selfex.out from the self-extraction process of
the installer, which might be useful if an error occurs.

 Caution

If the installer cannot find a temporary directory, the installation terminates with the error FCO-00058.

● To see a list of all available installer properties, start the installer as described above with the option -p:
./sapinst -p

● If required, stop the installer by choosing the Cancel button.

 Note

If you need to terminate the installer, press Ctrl + C .

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Additional Information PUBLIC 43
5.1.2 Interrupted Processing of the Installer

Here you find information about how to restart the installer if its processing has been interrupted.

Context

The processing of the installer might be interrupted for one of the following reasons:

● An error occurred during the Define Parameters or Execute phase:

The installer does not abort the installation in error situations. If an error occurs, the installation pauses
and a dialog box appears. The dialog box contains a short description of the choices listed in the table
below as well as a path to a log file that contains detailed information about the error.

● You interrupted the processing of the installer by choosing Cancel in the SL Common GUI.

 Caution

If you stop an option in the Execute phase, any system or component installed by this option is
incomplete and not ready to be used. Any system or component uninstalled by this option is not
completely uninstalled.

The following table describes the options in the dialog box:

Option Definition

Retry The installer retries the installation from the point of failure without repeating any of
the previous steps.

This is possible because the installer records its progress in the keydb.xml file.

We recommend that you view the entries in the log files, try to solve the problem, and
then choose Retry.

If the same or a different error occurs, the installer displays the same dialog box
again.

Stop The installer stops the installation, closing the dialog box, the installer GUI, and the
GUI server.

The installer records its progress in the keydb.xml file. Therefore, you can continue
with the installer from the point of failure without repeating any of the previous steps.
See the procedure below.

Continue The installer continues the installation from the current point.

View Log Access installation log files.

 Note

You can also terminate the installer by choosing Ctrl + C but we do not recommend this because it kills
the process immediately.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
44 PUBLIC Additional Information
The following procedure describes the steps to restart an installation, which you stopped by choosing Stop, or
to continue an interrupted installation after an error situation.

Procedure

1. Log on to the installation host as a user with the required permissions as described in Running the Installer
[page 28] .
2. Make sure that the installation media are still available.

For more information, see Preparing the Installation Media [page 21] .

 Recommendation

Make the installation media available locally. For example, if you use remote file shares on other
Windows hosts, CIFS shares on third-party SMB-servers, or Network File System (NFS), reading from
media mounted with NFS might fail.

Only valid for 'Platform': Oracle Solaris

 Note

Oracle Solaris: If you mount installation media, make sure that you do this with option nomaplcase.

End of 'Platform': Oracle Solaris

3. Make sure that the installation media are still available.

For more information, see Preparing the Installation Media [page 21] .

 Recommendation

Make the installation media available locally. For example, if you use remote file shares on other
Windows hosts, CIFS shares on third-party SMB-servers, or Network File System (NFS), reading from
media mounted with NFS might fail.

Only valid for 'Platform': Oracle Solaris

 Note

Oracle Solaris: If you mount installation media, make sure that you do this with option nomaplcase.

End of 'Platform': Oracle Solaris

4. Restart the installer from the directory to which you unpacked the Software Provisioning Manager archive
by executing the following command:
<Path_To_Unpack_Directory>/sapinst
5. The installer is restarting.

The installer now starts and waits for the connection with the SL Common GUI.

You can find the URL you require to access the SL Common GUI at the bottom of the shell from which you
are running the installer.

...

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Additional Information PUBLIC 45
 ************************************************************************
Open your browser and paste the following URL address to access the GUI
https://[<hostname>]:4237/sapinst/docs/index.html
Logon users: [<users>]
************************************************************************
...

 Note

If the host specified by <hostname> cannot be reached due to a special network configuration,
proceed as follows:
1. Terminate the installer as described in Useful Information about the Installer [page 42].
2. Restart the installer from the command line with the SAPINST_GUI_HOSTNAME=<hostname>
property.
You can use a fully-qualified host name.

If you have a supported web browser (see Prerequisites for Running the Installer [page 25]) installed on the
host where you run the installer, you can open this URL directly in the shell. Otherwise, open the URL in a
supported web browser that runs on another device.

 Caution

After opening the browser URL, make sure that the URL in the browser starts with “https://” to avoid
security risks such as SSL stripping .

Before you reach the Welcome screen, your browser warns you that the certificate of the sapinst
process on this computer could not be verified.

Proceed as follows to avoid security risks such as a man-in-the-middle attack:

1. Click on the certificate area on the left hand side in the address bar of your browser, and view the
certificate.
2. Open the certificate fingerprint or thumbprint, and compare all hexadecimal numbers to the ones
displayed in the console output of the installer.
Proceed as follows to get the certificate fingerprint or thumbprint from the server certificate
printed in the installer console:
1. Go to the sapinst_exe.xxxxxx.xxxx directory in the temporary directory to which the
installer has extracted itself:
<User_Home>/.sapinst/
2. In the sapinst_exe.xxxxxx.xxxx directory, execute the sapgenpse tool with the
command line option get_my_name -p.
As a result, you get the server fingerprint or thumbprint from the server certificate.
3. Accept the warning to inform your browser that it can trust this site, even if the certificate could not
be verified.

The SL Common GUI opens in the browser by displaying the Welcome screen.
6. From the tree structure on the Welcome screen, select the installation option that you want to continue and
choose Next.

The What do you want to do? screen appears.

7. On the What do you want to do? screen, decide between the following alternatives and continue with Next:

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
46 PUBLIC Additional Information
 Alternative Behavior

Perform a new run The installer does not continue the interrupted installation option. Instead, it
moves the content of the old installer directory and all installer-specific files to
a backup directory. Afterwards, you can no longer continue the old option.

The following naming convention is used for the backup directory:

log_<Day>_<Month>_<Year>_<Hours>_<Minutes>_<Seconds>

 Example
log_01_Oct_2016_13_47_56

 Note
All actions taken by the installation before you stopped it (such as creating
directories or users) are not revoked.

 Caution
The installer moves all the files and folders to a new log directory, even if
these files and folders are owned by other users. If there are any processes
currently running on these files and folders, they might no longer function
properly.

Continue with the existing one The installer continues the interrupted installation from the point of failure.

5.1.3 Troubleshooting with the Installer

This section tells you how to proceed when errors occur while the installer is running.

Context

If an error occurs, the installer:

● Stops processing
● Displays a dialog informing you about the error

Procedure

1. Check SAP Note 2393060 for known installer issues.

2. If an error occurs during the Define Parameters or the Execute Service phase, do one of the following:

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Additional Information PUBLIC 47
 ○ Try to solve the problem:
○ To check the installer log files (sapinst.log and sapinst_dev.log) for errors, choose the LOG
FILES tab.

 Note

The LOG FILES tab is only available if you have selected on the Welcome screen the relevant
installer option for the SAP product to be installed .

If you need to access the log files before you have done this selection, you can find them in
the .sapinst directory underneath the /home/<User> directory, where <User> is the user
that you used to start the installer.

For more information, see Useful Information about the Installer [page 42].

○ To check the log and trace files of the installer GUI for errors, go to the directory
<User_Home>/.sapinst/
○ Then continue by choosing Retry.
○ If required, abort the installer by choosing Cancel in the tool menu and restart the installer. For more
information, see Interrupted Processing of the Installer [page 44].
3. If you cannot resolve the problem, report an incident using the appropriate subcomponent of BC-INS*.
For more information about using subcomponents of BC-INS*, see SAP Note 1669327 .

5.2 Local Override of Help Settings on Front Ends

You can override the help setting variants configured in the SAP system locally on Microsoft Windows front
ends. This feature allows you to use a different help type and/or call help from a location other that than
defined in the setting variants defined by the system administrator.

 Note

You can only override the local front ends if you have defined entries for the setting variants in transaction
SR13. You must select a help type in transaction SR13.

5.2.1 File sapdoccd.ini

You enter override information in file sapdoccd.ini. You can store this file in the following locations:

● In the Microsoft Windows directory of the front-end PC (c:\Windows)

● In the SAP GUI directory (locally or on a server)
● In the parent directory of the SAP GUI directory

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
48 PUBLIC Additional Information
Order of Evaluation

Each time the user accesses help in the SAP system ( Help Application Help) , the help processor
evaluates the sapdoccd.ini file in the Microsoft Windows directory of the front-end PC. If the file is not there,
the help processor next searches for it in the SAP GUI directory and then in the parent directory of the SAP GUI
directory. If the file cannot be found or if it does not contain any override information for HTML-based help, the
help processor copies the values of the setting variant of the SAP system currently in use. For more
information, see Setting Variants for SAP Library [page 35]. To override the default variant configured in the
SAP system, look for a sapdoccd.ini file in the locations mentioned above and modify its content according
to your requirements. Otherwise, create a file with any ASCII editor (for example, Notepad). Make sure you
observe the sequence of evaluation if the file exists in more than one place.

Content and Format of sapdoccd.ini

The sapdoccd.ini file contains entries in Microsoft Windows INI format. The names of sections and
parameters are not case-sensitive, but parameter values are.

5.2.2 Parameters in File sapdoccd.ini

The following parameters and parameter values can be used:

HelpType PlainHtmlHttp, PlainHtmlFile, HtmlHelpFile, DynamicHelp

<HelpType>Server Name of the Web server on which the files for <HelpType>
reside

<HelpType>Path-<language> Path to the help files for logon language <language>

<language> is a two character language key.

<HelpType>Path Path to the help files you want to display if no parameter

<HelpType>Path-<language> is specified for the current
logon language

 Note

The help type DynamicHelp can only be used if SAP Knowledge Warehouse is installed.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Additional Information PUBLIC 49
Validity Range of Parameters

You can specify the SAP systems to which the override applies by entering parameter values in the relevant
sections in sapdoccd.ini. Entries for overriding the HTML-based help can apply to the following:

● All SAP systems

Entries in section [HTMLHELP] apply to all SAP systems.
● SAP systems with a specific release
Entries in sections [HTMLHELP-<Release>] apply to all SAP systems with this release. They override the
entries in section [HTMLHELP].
● Individual SAP systems
Entries in sections [SystemId-<SAP System>] apply to <SAP system> and override both the global entries
in section [HTMLHELP] and the release-specific entries in sections HTMLHELP-<Release>].

 Note

If an entry for a particular release (for example, Release 7.50) specifies a language-specific path
(<HelpType>Path<Language>), while an entry for a particular system with the same release specifies a
generic path (<HelpType>Path), the release-specific entry applies.

 Example

[HTMLHELP] HelpType=PlainHtmlHttp

PlainHtmlHttpServer=p99999.sap-ag.de:1080

PlainHtmlHttpPath-DE=saphelp/DE

PlainHtmlHttpPath=saphelp/EN

[HTMLHELP-750] HelpType=HtmlHelpFile

HtmlHelpFilePath-DE=\\ABCD042\docu\750\HTMLHELP\DE

HtmlHelpFilePath-EN=\\ABCD042\docu\750\HTMLHELP\EN

HtmlHelpFilePath=\\ABCD042\docu\750\HTMLHELP\EN

[SystemId-B20] HelpType=HtmlHelpFile

HtmlHelpFilePath-DE=\\p12345\HTMLHELP\DE

HtmlHelpFilePath=\\p12345\HTMLHELP\EN

[SystemId-B40] HelpType=PlainHtmlFile

PlainHtmlFilePath-DE=\\p44444\PLAINHTM\DE

PlainHtmlFilePath=\\p44444\PLAINHTM\EN

In the above example, the default help type is PlainHtmlHttp (defined in transaction SR13). If you launch the
application help from an SAP system with release level 7.50, the help type HtmlHelpFile is used and the help
files are accessed from the directory \docu\750\HTMLHELP on the file server \\ABCD042 is used. If you
launch the application help from the SAP system B20, the help type HtmlHelpFile is used and the help files
are accessed from the directory \HTMLHELP on the file server \\p12345. If you launch the application help
from the SAP system B40, the help type PlainHtmlFile is used.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
50 PUBLIC Additional Information
Related Information

SAP Note 94849

5.2.3 Logging of Help Calls

 Note

This is possible only for Microsoft Windows front-ends (platform WN32).

A log for each call is written to the file sapdoccd.log.

The log file contains the following information, separated by spaces:

● Command line used to launch the start program for help (SHH.EXE) from the SAP system
● Default parameters (transaction SR13) extracted from the command line
● Parameters extracted from the file sapdoccd.ini
● Start parameters resulting from the previous two points
● Browser/viewer version (for help type HtmlHelpFile only)

The following is an example of a log produced when application help is launched from an SAP system called
ABC:

 Example

Program path = C:\Program Files (x86)\SAP\FrontEnd\SAPgui\HTMLHELP\SHH.EXE

SHH version = 7.5.0.8
Command line = "TYPE=2&SERVER=https://help.sap.com/http.svc/ahp2/
&PATH=ABAP_PLATFORM_1909/201909.000/
EN&SYSTEM=ABC&_CLASS=IWB_EXTHLP&_LOIO=afe8b540afc87c2ae10000000a155106&_SLOIO=
b5e8b540afc87c2ae10000000a155106&LANGUAGE=EN&RELEASE=760&IWB_COUNTRY=&IWB_INDU
STRY=&_SCLASS=IWB_STRUCT"
Info: --- Default settings from command line ---
Info: HelpType=PlainHtmlHttp
Info: PlainHtmlHttpServer=https://help.sap.com/http.svc/ahp2
Info: PlainHtmlHttpPath=ABAP_PLATFORM_1909/201909.000/EN
Info: --- Contents of profile "C:/WINDOWS/sapdoccd.ini" ---
Info: Default value "PlainHtmlHttp" for "HelpType" assumed.
Info: Default value "https://help.sap.com/http.svc/ahp2" for
"PlainHtmlHttpServer" assumed.
Info: Default value "ABAP_PLATFORM_1909/201909.000/EN" for
"PlainHtmlHttpPath" assumed
Info: --- Starting PlainHtml ---
Info: URL="https://help.sap.com/http.svc/ahp2/
ABAP_PLATFORM_1909/201909.000/EN/af/e8b540afc87c2ae10000000a155106/
frameset.htm"
Info: --- Version info ---
Info: Microsoft Windows 10 version 10.0 (Build 9200)
Info: Microsoft Internet Explorer version is 11.0.17763.1
Info: Microsoft HTML-Help version is 6.2.17763.1

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Additional Information PUBLIC 51
Related Information

SAP Note 1466434

SAP Note 95309

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
52 PUBLIC Additional Information
Important Disclaimers and Legal Information

Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:

● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:

● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.

● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such
links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.

Videos Hosted on External Platforms

Some videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any
advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within
the control or responsibility of SAP.

Beta and Other Experimental Features

Experimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by
SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use
the experimental features in a live operating environment or with data that has not been sufficiently backed up.
The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your
feedback (e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.

Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.

Gender-Related Language
We try not to use gender-specific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.

Installation of SAP Library for SAP systems based on SAP NetWeaver 7.0 and Higher on UNIX
Important Disclaimers and Legal Information PUBLIC 53
www.sap.com/contactsap

© 2021 SAP SE or an SAP affiliate company. All rights reserved.

No part of this publication may be reproduced or transmitted in any form

or for any purpose without the express permission of SAP SE or an SAP
affiliate company. The information contained herein may be changed
without prior notice.

Some software products marketed by SAP SE and its distributors

contain proprietary software components of other software vendors.
National product specifications may vary.

These materials are provided by SAP SE or an SAP affiliate company for

informational purposes only, without representation or warranty of any
kind, and SAP or its affiliated companies shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP or
SAP affiliate company products and services are those that are set forth
in the express warranty statements accompanying such products and
services, if any. Nothing herein should be construed as constituting an
additional warranty.

SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.

Please see https://www.sap.com/about/legal/trademark.html for

additional trademark information and notices.

THE BEST RUN