Inst Sap Library Windows

Installation GuideSAP Library Installation and Update on WindowsFor SAP systems based on SAP NetWeaver 7.0 EHP1 (SAP ERP 6.0 EHP4, SAP CRM 7.0, SAP SCM 7.0, SAP SRM 7.0)

Target Audience ■ System Administrators ■ Technical Consultants

PUBLICDocument version: 1.0 – 2009-01-23

Document History

The following table provides an overview of the most important document changes.

Version Date Description

1.0 2009-01-23 Initial Version

2/38 PUBLIC 2009-01-23

Table of Contents

Chapter 1 Introduction ........................................................................................................... 5

Chapter 2 Variants of SAP Library ......................................................................................... 72.1 HtmlHelpFile ............................................................................................................. 82.2 PlainHtmlHttp .......................................................................................................... 82.3 PlainHtmlFile ............................................................................................................ 92.4 DynamicHelp ............................................................................................................ 92.5 Criteria for Selecting the Help Type ........................................................................ 10

Chapter 3 Installation .............................................................................................................. 113.1 Installing HtmlHelpFile ............................................................................................ 113.2 Installing PlainHtmlHttp and PlainHtmlFile .......................................................... 123.3 Installation of Help Files Using SAPinst .................................................................. 133.3.1 Preparations for the Installation with SAPinst ....................................................... 133.3.1.1 Hardware and Software Requirements ................................................................... 133.3.1.2 Required Installation DVDs ..................................................................................... 143.3.1.3 Enhancement Package for Business Suite Applications only: Creating the List of

Active Business Functions ........................................................................................ 153.3.1.4 Prerequisites Before Starting SAPinst ...................................................................... 153.3.2 Installation with SAPinst .......................................................................................... 163.3.2.1 Installing and Updating SAP Library ....................................................................... 163.3.2.2 Installing and Updating SAP Library Content for an Enhancement Package ..... 18

Chapter 4 Post-Installation ..................................................................................................... 214.1 Using a Web Browser or Viewer ............................................................................... 214.2 Offline Access to Help Files - SAP Library Navigation ............................................ 224.3 Setting Variants for SAP Library .............................................................................. 22

Chapter 5 Additional Information ........................................................................................ 255.1 About SAPinst ........................................................................................................... 255.1.1 Downloading Installation DVDs from SAP Service Marketplace ......................... 255.1.2 Using SAPinst GUI .................................................................................................... 265.1.3 Performing a Remote Installation with SAPinst .................................................... 275.1.4 Starting SAPinst GUI Separately .............................................................................. 285.1.5 Interrupted Installation with SAPinst ..................................................................... 30

2009-01-23 PUBLIC 3/38

5.1.6 EHP/Business Function Content Installation: Sequence of Steps ......................... 315.1.7 Troubleshooting with SAPinst ................................................................................ 325.2 Local Override of Help Settings on Front Ends ...................................................... 325.2.1 File sapdoccd.ini ........................................................................................................ 325.2.2 Parameters in File sapdoccd.ini ................................................................................ 335.2.3 Logging of Help Calls ................................................................................................ 34

4/38 PUBLIC 2009-01-23

1 Introduction

This document explains how to install SAP Library.SAP Library is an HTML-based solution for online documentation. It provides the basis for context-sensitive application help and also includes the SAP glossary. The contents of SAP Library can be displayed in a Web browser on all front-end platforms supported by SAP. SAP Library is available in several different variants; the installation of each of these variants is described in its own topic:

■ Installing HtmlHelpFile [page 11]

■ Installing PlainHtmlHttp and PlainHtmlFile [page 12]

■ Separately from the installation, you can also override the help settings on the front end:Local Override of Help Settings on Front Ends [page 32]

Prerequisites

You have received the DVD/CD set of SAP Library. We deliver the online help on these DVDs/CDs in two formats: standard HTML (Plain HTML) and compiled HTML (HTML help). Subdirectories contain the different language versions.

Implementation Considerations

On Microsoft Windows front ends, at least SAP GUI 7.10 must be installed to enable access to the documentation from the SAP system. For more information, see SAP Note 66971.

NOTE

See also the information in the README.TXT file on the Documentation DVD (see Required Installation DVDs [page 14]).

If you have any problems installing or displaying SAP Library, create a customer message on SAP Service Marketplace under the quick link message. Use the component BC-DOC-IWB-DIS for any issues relating to static help or the component KM-KW for any issues relating to dynamic help.

SAP Notes for the Installation

You must read SAP Note 1261881before you start the installation. This SAP Note contains the most recent information on the installation, as well as corrections to the installation documentation.Make sure that you have the up-to-date version of each SAP Note, which you can find at http://service.sap.com/notes.

1 Introduction

2009-01-23 PUBLIC 5/38

http://service.sap.com/~form/handler?_APP=01100107900000000342&_EVENT=REDIR&_NNUM=66971&_NLANG=en&_NVERS=0


http://service.sap.com/notes

http://service.sap.com/notes

This page is left blank for documents that are printed on both sides.

2 Variants of SAP Library

To handle the demands and features presented by different front-end platforms, the HTML-based online help 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.

Help Types

HtmlHelpFile PlainHtmlHttp PlainHtmlFile

Front-end platforms

All Windows platforms supported by Microsoft

All All Windows platforms supported by Microsoft

File format Compiled HTML Standard HTML Standard HTML

Accessed from File server Web server File server

Displayed in HTML Help Viewer (installation of Microsoft Internet Explorer required)

Web browser (Microsoft Internet Explorer or Netscape)

Web browser (Microsoft Internet Explorer or Netscape)

Global full-text search

X (from SAP Help Portal at http://help.sap.com; launched, for example, from the banner of the DVD)

Local full-text search

X (in CHM file)

Printing of single topics

X X X

Printing of multiple topics

X

Supported operating systems for the help installation

Microsoft Windows ■ IBM AIX ■ HP-UX ■ Sun Solaris ■ Linux 32 ■ DEC ■ Microsoft Windows

■ IBM AIX ■ HP-UX ■ Sun Solaris ■ Linux 32 ■ DEC ■ Microsoft Windows

NOTE

Customers using SAP Knowledge Warehouse can call both SAP documentation and their own custom-made documentation dynamically from SAP KW (help type DynamicHelp).

For more information about selecting a help type, see Criteria for Selecting the Help Type [page 10].


2009-01-23 PUBLIC 7/38

http://help.sap.com

http://help.sap.com

2.1 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. CHM files require about one-tenth of the disk space required for uncompressed HTML files and about the same space as required for WinHelp files. HTML Help Viewer was introduced by Microsoft as a successor to WinHelp. It is based on the Internet Explorer.

Features

■ Can be used only on Windows front-end platforms

■ Documents can be accessed directly from the DVD

■ Documents are displayed in HTML Help Viewer (requires Microsoft Internet Explorer)

■ Navigation in structures and from hyperlinks

■ Full text search in the documents in the current help file (local search)

■ Multiple documents within the same structure can be printed simultaneously.

System Requirements

Front-End Requirements for HtmlHelpFile

Operating System Requirements

Microsoft Windows 2000 Pentium 233 MHz (300 MHz recommended)1 GB RAM

Microsoft Windows 2003 Pentium 233 MHz (300 MHz recommended)1 GB RAM

Microsoft Windows XP Pentium 233 MHz (300 MHz recommended)1 GB RAM

Microsoft Windows VISTA Pentium 2.00 GHz (3.00 GHz recommended)1 GB RAM (2 GB recommended)

Server Requirements for HtmlHelpFile

See Hardware and Software Requirements [page 13].

2.2 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

■ Documents displayed with a standard Web browser (Microsoft Internet Explorer or Netscape)

■ Full-text search in all SAP documents from the help portal http://help.sap.com

■ Navigation in structures (tables of contents) and from hyperlinks

■ Printing of single help documents


2.1 HtmlHelpFile

8/38 PUBLIC 2009-01-23

http://help.sap.com

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 13].

NOTE

See also SAP Note 563776 (Supported Web Servers for Windows).

2.3 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

■ Documents displayed with a standard Web browser (Microsoft Internet Explorer or Netscape)

■ Navigation in structures (tables of contents) and from 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 Between 850 MB (Microsoft Windows NT) and 2 GB (UNIX) of free disk space for each language version, depending on the file system

2.4 DynamicHelp

The help type DynamicHelp can be used on all front-end platforms. Like the PlainHtml help types it uses a standard HTML file format, and a standard Web browser for viewing. Before you can launch DynamicHelp, SAP Knowledge Warehouse must be installed in the system landscape. Files are accessed through SAP IKS (Internet Knowledge Servlet). The content itself is stored on a content server, which means you do not need to install the help files.To display the correct information from DynamicHelp, you must set the correct target context in the SAP system. For more information, see SAP Note 594231. This context must also be defined in the SAP Knowledge Warehouse system.


2.3 PlainHtmlFile

2009-01-23 PUBLIC 9/38



2.5 Criteria for Selecting the Help Type

The decision about which help type to install in a given SAP system mainly depends on the operating system of the front-end clients.

■ If you use front ends on Microsoft Windows only, we recommend that you install the help type HtmlHelpFile. This help type offers more extensive search and print functions than the other two help types. However, you are free to install any help type.

NOTE

If you are using different front-end platforms in parallel, and therefore have to choose a help type other than HtmlHelpFile, you can still use the help type HtmlHelpFile. For more information, see Local Override of Help Settings on Front Ends [page 32] on clients running on Microsoft Windows.

■ If you use front-end platforms other than Microsoft Windows, we also recommend that you install PlainHtmlHttp, since 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.

■ If you want to access SAP documentation from both SAP GUI for Windows (Win GUI) and SAP GUI for HTML (Web GUI), or from a browser-based SAP application, you cannot use help type HtmlHelpFile.

The following figure helps you to choose the correct help type:

Figure 1:


2.5 Criteria for Selecting the Help Type

10/38 PUBLIC 2009-01-23

3 Installation

When you install the SAP Library, you provide the users of your SAP systems with the entire help documentation online.

Prerequisites

You have received the SAP Library DVD. We deliver the online help on this DVD in two file formats: Standard HTML and Compiled HTML (HTMLHelpFile). Subdirectories contain the different language versions.

Process Flow

For online access from the SAP system, both formats require you to perform the following steps:1. You install the help files in one of the following ways:

■ You install the HtmlHelpFile either manually or using SAPinst as described in Installing HtmlHelpFile [page 11].

■ You install the PlainHtmlHttp and PlainHtmlFile using SAPinst as described in Installing PlainHtmlHttp and PlainHtmlFile [page 12].

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

Result

Once you have completed these steps, you can access SAP Library both online in the SAP system and offline when you have no connection to the system.

3.1 Installing HtmlHelpFile

This procedure describes how you install HtmlHelpFile. The Compiled HTML files for help type HtmlHelpFile can be viewed directly from the DVD in Microsoft HTML Help Viewer. For better performance, copy the help files to your local hard disk or to a file server (as described in the procedure below).You can also use SAPinst to install the HtmlHelpFile. If you want to do this, do not follow the procedure below but instead proceed as described in Installation of Help Files Using SAPinst [page 13].

RECOMMENDATION

We strongly recommend that you install the HtmlHelpFile with SAPinst.

PrerequisitesTo install SAP Library, you require the Documentation DVD (see Required Installation DVDs [page 14]). 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 21].

3 Installation

3.1 Installing HtmlHelpFile

2009-01-23 PUBLIC 11/38

Procedure

1. Create a directory on your file server for the help files.This called the documentation directory. Approximately 2 GB of disk space is needed for the English and German language versions.

2. Insert the appropriate DVD into the DVD/CD drive.3. Copy the directory HTMLHELP\<language key> with all its subdirectories from the DVD to the

documentation directory on the server.4. Share the directory.

Result

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

3.2 Installing PlainHtmlHttp and PlainHtmlFile

This procedure describes how to install PlainHtmlHttp or PlainHtmlFile. The Standard HTML files for help types PlainHtmlHttp and PlainHtmlFile are stored in a packed format in the archive PLAINHTM.SAR on the DVD. They cannot be viewed directly from the DVD but must first be unpacked to the local hard drive or on a file server. To install the help files, you must use SAPinst as described in Installation of Help Files Using SAPinst [page 13].

CAUTION

The complete installation comprises about 200,000 files in about 100,000 directories for one language version. Depending on the file system and the configuration of the hard disk, they require they require up to 850 MB of disk space.

Prerequisites

To install SAP Library, you require the Documentation DVD. 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 21].

NOTE

When you call the search function from the banner of the relevant documentation DVD, an Internet connection is opened enabling a full text search from the DVD. 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 even though this function is only available with help type PlainHtmlHttp. If you choose the button, an error message appears. To remove the button from the banner when using PlainHtmlFile, enable Java scripting in your browser settings as follows:

3 Installation

3.2 Installing PlainHtmlHttp and PlainHtmlFile

12/38 PUBLIC 2009-01-23

For Microsoft Internet Explorer 5.01 (or later), choose level Medium or Low from the Internet option Security in the Local intranet zone.

ProcedureInstall PlainHtmlHttp and PlainHtmlFile using SAPinst as described in Installation of Help Files Using SAPinst [page 13].

ResultThe archive PLAINHTM.SAR is unpacked and the help files are written to the Web server. This takes about 30 minutes, depending on the operating system and the data transfer rate of the DVD drive. The directory tree created on the Web server when you install the English language version has the following structure:<InstallDir>

- PLAINHTM

+ 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 requires read access for /saphelp.

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

3.3 Installation of Help Files Using SAPinst

3.3.1 Preparations for the Installation with SAPinst

You have to perform the following steps to prepare the installation or update of the SAP Library with SAPinst:1. Check that your installation host meets the hardware and software requirements [page 13].2. Make sure that the required installation DVDs [page 14] are available.3. If you want to install or update SAP Library content for an Enhancement Package, create a list of active

Business Functions [page 15].4. Check the prerequisites before starting SAPinst [page 15].

3.3.1.1 Hardware and Software Requirements

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

■ Minimum RAM:0.5 GB

■ Minimum disk space:

3 Installation


2009-01-23 PUBLIC 13/38

● 2.2 GB in the help destination directory

● Approximately 600 MB of disk space are required for one language version (Windows NTFS)

● 4.3 GB of temporary disk space for every required installation DVD that you have to copy to a local hard disk

● 1.2 GB of temporary disk space for the installation

■ For supported operating system releases, see the Product Availability Matrix at http://service.sap.com/pam.

CAUTION

You cannot install SAP Library help files on a Microsoft FAT32 file system because this file system cannot handle the large number of files and directories. If your web server runs on Microsoft Windows, do not install the help documentation on the system partition. Instead, choose another partition.

3.3.1.2 Required Installation DVDs

Make sure that you have the following installation DVDs available:

■ Installation Master DVD – contains the installation with SAPinst

■ Documentation DVD – contains the SAP Library Help FilesThe media names listed above are abbreviated. For the full names, see the Media List / Media Information for your SAP application on SAP Service Marketplace:

■ You can find the full names of all media shipped with SAP Solution Manager in the appropriate Media List at:http://service.sap.com/instguides SAP Components SAP Solution Manager Release <current

release number>

■ You can find the full names of all media shipped with your SAP ERP applications in section Media Information in the appropriate Master Guide at http://service.sap.com/erp-inst

■ You can find the full names of all media shipped with your SAP SRM applications in the appropriate Media List at http://service.sap.com/srm-inst

■ You can find the full names of all media shipped with your SAP CRM applications in the appropriate Media List at http://service.sap.com/crm-inst

■ You can find the full names of all media shipped with your SAP SCM applications in the appropriate Master Guide at http://service.sap.com/instguides SAP Business Suite Applications SAP SCM

■ You can find the full names of all media shipped with your SAP NetWeaver applications in the appropriate Media List at http://service.sap.com/installNW70 .

You can also download installation DVDs from SAP Service Marketplace. For more information, see Downloading Installation DVDs from SAP Service Marketplace (Optional) [page 25].

3 Installation


14/38 PUBLIC 2009-01-23

http://service.sap.com/pam

http://service.sap.com/pam

http://service.sap.com/instguides

http://service.sap.com/erp-inst

http://service.sap.com/srm-inst

http://service.sap.com/crm-inst

http://service.sap.com/instguides

http://service.sap.com/installNW70

3.3.1.3 Enhancement Package for Business Suite Applications only: Creating the List of Active Business Functions

This section is only relevant for you, if you installed one or more Enhancement Packages for Business Suite applications (SAP ERP, SAP CRM, SAP SRM, SAP SCM). Enhancement Package(s) for a standalone SAP NetWeaver system do not contain Business Functions.With report RKW_UPDATE_BF_IO, you can determine the business functions that are already active for each SAP system. By running this report, a list containing the technical names of business functions is saved to a TXT file. Running this report is only required if you want to install or update SAP Library Content for an Enhancement Package, as described in Installing and Updating SAP Library Content for an Enhancement Package [page 18].

Prerequisites

In the SAP application system, at least one enhancement package has been imported. If there is no enhancement package in the SAP application system, you do not need to determine the active business functions.

Procedure

To create and download the list of active business functions, proceed as follows:1. Log on to the SAP application system.2. Call transaction SA38 or SE38.3. Enter report name RKW_UPDATE_BF_IO in the Program field.4. Follow the instructions in the report documentation.

3.3.1.4 Prerequisites Before Starting SAPinst

■ Check that the account used for the installation is a member of the local Administrators group.

■ You need at least 200 MB of free space in the installation directory for each installation option. In addition, you need 60 - 200 MB free space for the SAPinst executables.

■ Note the following information about SAPinst:

● When you start SAPinst, SAPinst GUI and the GUI server also start. SAPinst GUI connects to the GUI server with a secure SSL connection, and the GUI server connects to SAPinst.

● SAPinst creates the installation directory sapinst_instdir, where it keeps its log files, and which is located directly in the Program Files directory. If SAPinst is not able to create sapinst_instdir there, it tries to create sapinst_instdir in the directory defined by the environment variable TEMP.

RECOMMENDATION

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

● SAPinst creates a subdirectory for each installation option called <sapinst_instdir>\<installation_option>, which is located in %ProgramFiles%\sapinst_instdir.

3 Installation


2009-01-23 PUBLIC 15/38

● The SAPinst Self-Extractor extracts the executables to a temporary directory: TEMP, TMP, TMPDIR, or SystemRoot. These executables are deleted after SAPinst has stopped running.Directories called sapinst_exe.xxxxxx.xxxx sometimes remain in the temporary directory. You can safely delete them.The temporary directory also contains the SAPinst Self-Extractor log file dev_selfex.out, which might be useful if an error occurs.

CAUTION

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

● If you want to terminate SAPinst and the SAPinst Self-Extractor, choose one of the following options:

◆ Right-click the icon for the SAPinst output window located in the Windows tray and choose Exit.

◆ Click the icon for the SAPinst output window located in the Windows tray and choose File Exit .

3.3.2 Installation with SAPinst

You can run SAPinst to perform one of the following options:

■ Installing and Updating SAP Library [page 16]

■ Installing and Updating SAP Library Content for an Enhancement Package [page 18]

3.3.2.1 Installing and Updating SAP Library

This procedure tells you how to install and update SAP Library with SAPinst:

■ Install means that you install SAP Library from scratch.

■ Update means that you update an existing version of SAP Library.SAPinst includes a SAPinst GUI and a GUI server, which both use Java.This section describes how to run SAPinst, SAPinst GUI, and the GUI server on the same host and on the local display: When you start SAPinst, SAPinst GUI and the GUI server also start. SAPinst GUI connects via a secure SSL connection to the GUI server and the GUI server connects to SAPinst.If you need to see the installation on a remote display, we recommend that you perform a remote installation with SAPinst [page 27], where SAPinst GUI is running on a separate host from SAPinst and the GUI server.Alternatively you can use an X server for Microsoft Windows or other remote desktop tools like vncviewer or nxserver/nxclient – offered by various vendors or open source – for remote access to SAPinst GUI on Windows workstations. We recommend you use the Hummingbird Exceed X Server, which we use to validate installations with SAPinst. For more information, see SAP Note 1170809.

Prerequisites

■ The installation host meets the hardware and software requirements for the SAP Library installation as described in Hardware and Software Requirements [page 13].

3 Installation


16/38 PUBLIC 2009-01-23


■ The required installation DVDs are available on the installation host as described in Required Installation DVDs [page 14].

■ The installation host meets the prerequisites before starting SAPinst as described in Prerequisites Before Starting SAPinst [page 15].

Procedure1. Log on to the host with a user account that is a member of the local Administrators group.2. Create a help destination directory with sufficient disk space where you want SAP Library to be

installed.3. Insert the DVD/CD with the language version you want to install into your DVD/CD drive or

mount it locally.4. Start SAPinst from the SAP Installation Master DVD by double-clicking sapinst.exe from the

following path:<DVD drive>:\IM_WINDOWS_<platform>

SAPinst GUI starts automatically by displaying the Welcome screen.

NOTE

■ During the installation, the default ports 21200, 21212, and 4239 are used for communication between SAPinst, GUI server, SAPinst GUI, and HTTP server. SAPinst uses port 21200 to communicate with the GUI server. The GUI server uses port 21212 to communicate with SAPinst GUI. 4239 is the port of the HTTP server, which is part of the GUI server. You receive an error message if one of these ports is already in use by another service.In this case, you must execute sapinst using the following parameters:SAPINST_DIALOG_PORT=<free_port_number_sapinst_to_gui_server>

GUISERVER_DIALOG_PORT=<free_port_number_gui_server_to_sapinst_gui>

GUISERVER_HTTP_PORT=<free_port_number_http_server>.

■ To view a list of all available SAPinst properties, start SAPinst as described above with the option -p:./sapinst -p

5. In the Welcome screen, choose <your SAP application> Software Life-Cycle Options SAP Library Installation and Update Install/Update SAP Library and then choose Next.

6. Follow the instructions in the SAPinst screens and enter the required parameters.

NOTE

To find more information on each parameter during the Define Parameters phase of the installation, position the cursor on the field of the relevant parameter and press F1 .

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

8. To start the installation, choose Start.SAPinst starts the installation and displays the progress of the installation. .When the installation has successfully completed, SAPinst displays the screen Finished successfully.

3 Installation


2009-01-23 PUBLIC 17/38

More Information

See SAP Note 1272588 for known issues when installing the SAP Library with SAPinst.

3.3.2.2 Installing and Updating SAP Library Content for an Enhancement Package

This procedure tells you how to update an already installed SAP Library after installing additional enhancement packages and activating new Business Functions.

■ Install means that you install SAP Library content for additional enhancement packages from scratch.

■ Update means that you update existing SAP Library content for additional enhancement packages.SAPinst includes a SAPinst GUI and a GUI server, which both use Java.This section describes how to run SAPinst, SAPinst GUI, and the GUI server on the same host and on the local display: When you start SAPinst, SAPinst GUI and the GUI server also start. SAPinst GUI connects via a secure SSL connection to the GUI server and the GUI server connects to SAPinst.If you need to see the installation on a remote display, we recommend that you perform a remote installation with SAPinst [page 27], where SAPinst GUI is running on a separate host from SAPinst and the GUI server.Alternatively you can use an X server for Microsoft Windows or other remote desktop tools like vncviewer or nxserver/nxclient – offered by various vendors or open source – for remote access to SAPinst GUI on Windows workstations. We recommend you use the Hummingbird Exceed X Server, which we use to validate installations with SAPinst. For more information, see SAP Note 1170809.

Prerequisites

■ The installation host meets the hardware and software requirements for the SAP Library installation as described in Hardware and Software Requirements [page 13]).

■ You have created a file with the list of active business functions as described in Creating the List of Active Business Functions [page 15])

■ The required installation DVDs are available on the installation host (see Required Installation DVDs [page 14]).

■ The installation host meets the prerequisites before starting SAPinst as described in Prerequisites Before Starting SAPinst [page 15].

Procedure

1. Log on to the host with a user account that is a member of the local Administrators group.2. Insert the DVD/CD with the language version you want to install into your DVD/CD drive or

mount it locally.3. Start SAPinst from the SAP Installation Master DVD by double-clicking sapinst.exe from the

following path:<DVD drive>:\IM_WINDOWS_<platform>

SAPinst GUI starts automatically by displaying the Welcome screen.

3 Installation


18/38 PUBLIC 2009-01-23



NOTE

■ During the installation, the default ports 21200, 21212, and 4239 are used for communication between SAPinst, GUI server, SAPinst GUI, and HTTP server. SAPinst uses port 21200 to communicate with the GUI server. The GUI server uses port 21212 to communicate with SAPinst GUI. 4239 is the port of the HTTP server, which is part of the GUI server. You receive an error message if one of these ports is already in use by another service.In this case, you must execute sapinst using the following parameters:SAPINST_DIALOG_PORT=<free_port_number_sapinst_to_gui_server>

GUISERVER_DIALOG_PORT=<free_port_number_gui_server_to_sapinst_gui>

GUISERVER_HTTP_PORT=<free_port_number_http_server>.

■ To view a list of all available SAPinst properties, start SAPinst as described above with the option -p:./sapinst -p

4. In the Welcome screen, choose <your SAP application> Software Life-Cycle Options SAP Library Installation and Update Install/Update EHP for SAP Library and then choose Next.

5. Follow the instructions in the SAPinst screens and enter the required parameters.

NOTE

To find more information on each parameter during the Define Parameters phase of the installation, position the cursor on the field of the respective parameter and press F1 .

6. After you have entered all requested input parameters, SAPinst displays the Parameter Summary screen. This screen shows both the parameters that you entered and those that SAPinst set by default. If required, you can revise the parameters before starting the installation.

7. To start the installation, choose Start.SAPinst checks which Business Functions are installed and activated in your system and updates the SAP Library according to information about activated Business Functions. For more information about the sequence of steps that SAPinst executes, see EHP/Business Function Content Installation: Sequence of Steps [page 31]When the installation has successfully completed, SAPinst displays the screen Finished successfully.

More InformationSee SAP Note 1272588 for known issues when updating an already installed SAP Library after installing additional enhancement packages and activating new Business Functions.

3 Installation


2009-01-23 PUBLIC 19/38


This page is left blank for documents that are printed on both sides.

4 Post-Installation

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

■ Using a Web Browser or Viewer [page 21]

■ Offline Access to Help Files – SAP Library Navigation [page 22]

■ Setting Variants for SAP Library [page 22]

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

HTML Help Viewer with Microsoft Internet Explorer 5.01 SP 2 (or higher)

Microsoft Internet Explorer 5.01 SP 2 (or higher)

Firefox Mozilla 2.xx

Netscape 4.06 (or higher)

Microsoft Windows platforms

X X X

Note the following points:

■ If you are using HTML Help Viewer in Microsoft Windows, a new instance of the viewer or browser is opened each time you access help documentation.

■ If you choose help type HtmlHelpFile, you must use HTML Help Viewer, which is based on Microsoft Internet Explorer and requires it. If you use help types PlainHtmlHttp and PlainHtmlFile you can use either Microsoft Internet Explorer or Netscape. For the help structure implemented with JavaScript and displayed as a compressed tree, JavaScript must be activated in both browsers.

Installation of Microsoft HTML Help Viewer and Microsoft Internet Explorer

Microsoft HTML Help Viewer is installed automatically when you install SAP GUI 7.10 from the DVD Presentation on your front-end PC (versions of file HH.exe older than 1.32 are overwritten).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. You can also download Microsoft Internet Explorer for Macintosh from the Microsoft Web site.

4 Post-Installation

4.1 Using a Web Browser or Viewer

2009-01-23 PUBLIC 21/38

NOTE

To use the HTML Help Viewer, you have to activate ActiveX in the Microsoft Internet Explorer. In the 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.

4.2 Offline Access to Help Files - SAP Library Navigation

To view the documentation offline – that is, without connecting to the SAP system – you need to:

■ 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 21].

■ Have access to the help files. For the standard HTML help files, this requires you to unpack the archive PLAINHTM.SAR from the DVD to your hard drive.

Procedure

HtmlHelpFile: Offline Access to Help Files

1. Navigate to the directory <InstallDir>\HTMLHELP\<language key> using the Microsoft Windows Explorer.This is the directory containing the help files.

2. Double-click on 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.

PlainHtmlHttp and PlainHtmFile: Offline Access to the Help Files

1. Navigate to the directory <InstallDir>\HTMLHELP\<language key>.This is the directory containing the help files.

2. Open file Home.htm.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 Setting Variants for SAP Library

In the IMG activity (transaction SR13), you specify which help variants you want to make available to users of the SAP system. For more information about the definition of setting variants, see the SAP NetWeaver Implementation Guide (IMG).

NOTE

On some front-end platforms, the URLs of the help files displayed in the browser must contain a local drive identifier assigned to the file server instead of the name of the file server itself (for

4 Post-Installation

4.2 Offline Access to Help Files - SAP Library Navigation

22/38 PUBLIC 2009-01-23



example file:///K:/PLAINHTM/710/EN/e1/8e51341a06084de10000009b38f83b/frameset.htm). In this case, the entry in the Path field must start with a drive letter and not with the name of the file server. You must also make sure that this drive letter points to the file server on the front end.

Procedure

Special Features of the Help Types

HtmlHelpFile

The path names specified in the setting variants must not contain special characters such as blanks or ampersands. In addition, path names must not be longer than 64 characters.

PlainHtmlHttp

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

■ Enter the path in the URL syntax. Path names must not contain special characters such as blanks or ampersands. In addition, path names must not be longer than 64 characters.

PlainHtmlFile

Use the syntax of the front-end platform when specifying a path name. Path names must not contain special characters such as blanks or ampersands. In addition, path names must not be longer than 64 characters.

Assignment of the Disk Drive Letter to the File Server

Front End Does the drive letter have to be assigned to the file server? Front End

Microsoft Windows Only if Netscape Navigator is used Microsoft Windows

Apple Macintosh Yes Apple Macintosh

EXAMPLE

Your front-end PC runs on Apple Macintosh and the help files reside in subdirectory PLAINHTM\710\EN of the shared directory docu on server \\p99999. If the share name \\p99999\docu is assigned to drive K: on the front ends, then the entry in the Path field must be K:\PLAINHTM\710.

ExampleExample for HtmlHelpFile: Setting Variant for the Help Documentation

Variant HTML Help 7.10 English

Platform WN32

Area IWBHELP

Path \\p12345\HTMLHELP710

Language EN

Default Yes

Example for PlainHtmlHttp: Setting Variant for the Help Documentation

Variant HTML (Web) 7.10 English

Platform WN32

4 Post-Installation


2009-01-23 PUBLIC 23/38

Area IWBHELP

Server p12345:1080

Path PlainHttp710

Language EN

Example for PlainHtmlFile: Setting Variant for the Help Documentation

Variant HTML (File) 7.10 English

Platform WN32

Area IWBHELP

Path \\p12345\PlainFile710

Language EN

Default Yes

4 Post-Installation


24/38 PUBLIC 2009-01-23

5 Additional Information

■ About SAPinst [page 25]

■ Local Override of Help Settings on Front Ends [page 32]

5.1 About SAPinst

The following sections provide additional information about the installation tool SAPinst and about activities related to the installation process:

■ Downloading Installation DVDs from SAP Service Marketplace [page 25]

■ Using SAPinst GUI [page 26]

■ Performing a Remote Installation with SAPinst [page 27]

■ Starting SAPinst GUI Separately [page 28].

■ Interrupted Installation with SAPinst [page 30]

■ EHP/Business Function Content Installation: Sequence of Steps [page 31]

■ Troubleshooting with SAPinst [page 32]

5.1.1 Downloading Installation DVDs from SAP Service Marketplace

You normally obtain the installation DVDs as part of the installation package from SAP.However, you can also download installation DVDs from:http://service.sap.com/swdc Download Installations and Upgrades Entry by Application Group <SAP

solution> <SAP product> <SAP release> Installation and Upgrade <operating system> <database>If you download installation DVDs, note that DVDs might be split into several files. In this case, you have to reassemble the required files after the download.

Prerequisites

To extract the downloaded SAR files make sure that you use the latest SAPCAR version, which you can find at http://service.sap.com/swdc. You need at least SAPCAR 700 or SAPCAR 640 with patch level 4 or higher because older versions of SAPCAR can no longer unpack current SAR files. For more information, see SAP Note 212876.

Procedure

1. Create a download directory on the host on which you want to run SAPinst.2. Identify all download objects that belong to one installation DVD according to one or both of the

following:


5.1 About SAPinst

2009-01-23 PUBLIC 25/38

http://service.sap.com/swdc

http://service.sap.com/swdc


■ Material numberAll download objects that are part of an installation DVD have the same material number and an individual sequence number:<material_number>_<sequence_number>

EXAMPLE

51031387_151031387_2...

■ TitleAll objects that are part of an installation DVD have the same title, such as <solution><DVD_name><OS> or <database>RDBMS<OS> for RDBMS DVDs.

3. Download the objects to the download directory.4. Extract the individual download objects using SAPCAR, starting with the lowest sequence number

– for example 51031387_1, then 51031387_2, and so on.During the download SAPCAR sets up the structure of the installation DVD.

NOTE

SAPCAR asks if you want to replace existing files, for example LABELIDX.ASC. Always accept with Yes.

5.1.2 Using SAPinst GUI

The following table shows the most important functions that are available in SAPinst GUI:

SAPinst GUI Functions

Input Type Label Description

Function key F1 Displays detailed information about each input parameter

Menu option File Exit Stops the SAPinst GUI, but SAPinst and the GUI server continue running

NOTE

If you need to log off during the installation from the host where you control the installation with SAPinst GUI, the installation continues while you are logged off. You can later reconnect to the same SAPinst installation from the same or another host.For more information, see Starting SAPinst GUI Separately [page 28].

Menu option SAPinst Log Browser Displays the Log Viewer dialogThis dialog enables you to access the following log files directly: ■ Installation log (sapinst_dev.log) ■ Log files from the SAPinst GUI server

Menu option SAPinst Cancel Cancels the installation with the following options:


5.1 About SAPinst

26/38 PUBLIC 2009-01-23

Input Type Label Description

■ StopStops the installation (SAPinst GUI, SAPinst, and the GUI server) without further changing the installation filesYou can restart and continue the installation later from this point.

■ ContinueContinues the installation

Message button Retry Performs the installation step again (if an error has occurred)

Message button Stop Stops the installation without further changing the installation filesYou can continue the installation later from this point.

Message button Continue Continues with the option you chose previously

5.1.3 Performing a Remote Installation with SAPinst

You use this procedure to install your SAP system on a remote host. In this case, SAPinst and the GUI server run on the remote host, and SAPinst GUI runs on the local host. The local host is the host from which you control the installation with SAPinst GUI.Alternatively you can use an X server for Microsoft Windows or other remote desktop tools such as VNC Viewer or NX Server / NX Client – offered by various vendors or open source – for remote access to SAPinst GUI on Windows workstations. We recommend you use the Hummingbird Exceed X Server, which we use to validate installations with SAPinst. For more information, see SAP Note 1170809.You can run SAPinst GUI on a PC with 32-bit while SAPinst is running on a 64-bit installation host.

CAUTION

The behavior of SAPinst has changed compared to previous versions. SAP no longer delivers any JCE policy archives within the SAP Java Virtual Machine (SAP JVM). You have to download the required Java Cryptography Extension (JCE) policy zip file from SAP on the remote host. For more information, see SAP Note 1238121.

Prerequisites

■ The remote host meets the prerequisites for starting SAPinst as described in Installing and Updating SAP Library [page 16] or Installing and Updating SAP Library Content for an Enhancement Package [page 18].

■ Both computers are in the same network and can ping each other.To test this:1. Log on to your remote host and enter the command ping <local host>.2. Log on to the local host and enter the command ping <remote host>.

Procedure1. Log on to your remote host as a user that is a member of the local administrators group.2. Insert the Installation Master DVD in the DVD drive on your remote host.


5.1 About SAPinst

2009-01-23 PUBLIC 27/38



3. Download the JCE policy zip file from SAP as described in SAP Note 1240081.4. Set the environment variable JCE_POLICY_ZIP to the location of the downloaded policy zip archive

by entering the following command:set JCE_POLICY_ZIP=<policy zip archive>

5. Enter the following commands:cd <DVD drive>:\IM_WINDOWS_<platform>

sapinst.exe -nogui

SAPinst now starts and waits for the connection to the SAPinst GUI. You see the following at the command prompt:guiengine: no GUI connected; waiting for a connection on host <host_name>, port

<port_number> to continue with the installation

6. Start SAPinst GUI on your local host as described in Starting SAPinst GUI Separately [page 28].

5.1.4 Starting SAPinst GUI Separately

You use this procedure to start SAPinst GUI separately. You might need to start SAPinst GUI separately in the following cases:

■ You have logged off from SAPinst.If you logged off during the installation and you later want to reconnect to the installation while it is still running, you can start SAPinst GUI separately.

■ You want to perform a remote installation [page 27].If SAPinst GUI runs on a different host from SAPinst and the GUI server, you have to start SAPinst GUI separately on the local host.

CAUTION

The behavior of SAPinst has changed compared to previous versions. SAP no longer delivers any JCE policy archives within the SAP JVM. You have to download the required JCE policy zip file from SAP on the local host. For more information, see SAP Note 1238121.

Procedure

Starting SAPinst GUI on Windows

1. Log on as a member of the local administrators group.2. Download the JCE policy zip file from SAP as described in SAP Note 1240081.3. Set the environment variable JCE_POLICY_ZIP to the location of the downloaded policy zip archive

by entering the following command:set JCE_POLICY_ZIP=<policy zip archive>

4. Insert the SAP Installation Master DVD into your DVD drive.5. Change to the directory of the sapinst executables:

<DVD drive>:\IM_WINDOWS_<platform>

6. Start SAPinst GUI by double-clicking sapinstgui.exeSAPinst GUI starts and tries to connect to the GUI server and SAPinst, using the local host as default.


5.1 About SAPinst

28/38 PUBLIC 2009-01-23




If SAPinst and the GUI server are running on another host, SAPinst GUI cannot connect and the SAP Installation GUI Connection dialog appears.In this case, enter the name of the host on which SAPinst is running and choose Log on.The first dialog of the installation appears and you can perform the remote installation from your local host.

NOTE

Optionally you can start sapinstgui.exe with the following parameters:

■ host=<host name>, where <host name> is the host name of the installation host

■ port=<nr>, where <nr> is the port number for the connection to the GUI server

■ -accessible enables accessibility modeExample:./sapinstgui.exe host=lsi1209 port=3000 -accessible

Starting SAPinst GUI on UNIX

1. Log on as user root.

CAUTION

Make sure that the root user has not set any environment variables for a different SAP system or database.

2. Download the JCE policy zip file from SAP as described in SAP Note 1240081.3. Set the environment variable JCE_POLICY_ZIP to the location of the downloaded policy zip archive

as follows:

Shell Used Command

Bourne shell (sh) JCE_POLICY_ZIP=<policy zip archive>

export JCE_POLICY_ZIP

C shell (csh) setenv JCE_POLICY_ZIP <policy zip archive>

Korn shell (ksh) export JCE_POLICY_ZIP=<policy zip archive>

4. Mount your Installation Master DVD.

NOTE

Mount the DVD locally. We do not recommend that you use Network File System (NFS).5. Change to the directory of the sapinst executables:

<mountpoint_of_Installation_Master_DVD>/IM_<OS>

NOTE

If you want to start SAPinst GUI on a Linux 32–bit platform, change to the following directory:<mountpoint_of_Installation_Master_DVD>/IM_LINUX_I386

6. Start SAPinst GUI by executing ./sapinstguiSAPinst GUI starts and tries to connect to the GUI server and SAPinst, using the local host as default.If SAPinst and the GUI server are running on another host, SAPinst GUI cannot connect and the SAP Installation GUI Connection dialog appears.In this case, enter the name of the host on which SAPinst is running and choose Log on.The first dialog of the installation appears and you can perform the remote installation from your local host.


5.1 About SAPinst

2009-01-23 PUBLIC 29/38


NOTE

Optionally, you can start sapinstgui with the following parameters:

■ host=<host name>, where <host name> is the host name of the installation host

■ port=<nr>, where <nr> is the port number for the connection to the GUI server

■ - accessible enables accessibility modeExample:./sapinstgui host=lsi1209 port=3000 -accessible

5.1.5 Interrupted Installation with SAPinst

The SAP system installation might be interrupted for one of the following reasons:

■ An error occurred during the Define Parameters or Execute phase:SAPinst 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 installation by choosing Cancel in the SAPinst menu.The following table describes the options in the dialog box:

Option Definition

Retry SAPinst retries the installation from the point of failure without repeating any of the previous steps.This is possible because SAPinst records the installation 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, SAPinst displays the same dialog box again.

Stop SAPinst stops the installation, closing the dialog box, the SAPinst GUI, and the GUI server.SAPinst records the installation progress in the keydb.xml file. Therefore, you can continue the installation from the point of failure without repeating any of the previous steps (see the procedure below).

Continue SAPinst continues the installation from the current point.

View Log Access installation log files.

Procedure

This procedure describes the steps to restart an installation, which you stopped by choosing Stop, or to continue an interrupted installation after an error situation.1. Log on as a user who is a member of the local administrators group.2. Insert the Installation Master DVD in your DVD drive.3. Change to the required directory:

<DVD drive>:\IM_WINDOWS_<platform>

Double-click sapinst.exe.


5.1 About SAPinst

30/38 PUBLIC 2009-01-23

4. From the tree structure in the Welcome screen, select the installation service that you want to continue and choose Next.

NOTE

If there is only 1 component to install, the Welcome screen does not appear.

The What Do You Want to Do? screen appears.5. In the What Do You Want to Do? screen, decide between the following alternatives and confirm with

OK:

Alternative Behavior

Run a New Option SAPinst does not continue the interrupted installation option. Instead, it moves the content of the old installation directory and all installation-specific files to a backup directory. Afterwards, you can no longer continue the old installation option.For the backup directory, the following naming convention is used:<log_day_month_year_hours_minutes_seconds>.

EXAMPLE

log_01_Oct_2008_13_47_56

Continue with the Old Option SAPinst continues the interrupted installation option from the point of failure.

5.1.6 EHP/Business Function Content Installation: Sequence of Steps

When you select the option Install/Update EHP for SAP Library, SAPinst processes installation and update steps according to the following algorithm:1. Read the list of Business Functions (for example, BF_FUNCTION_LIST.TXT) that are active in your

SAP system.Active Business Functions are identified using RFC or customer text file.

2. Install the files from the Business Functions directories, except GENERAL and BF_ALL, using the following logic:

■ For the active Business Functionss, read the EHP assignment in the DVD manifest (file BF_FUNCTION_LIST.TXT)

■ For each active Business Functions, go to the Business Functions directory of the relevant EHP.

■ For all active Business Functions, the installation starts with the lowest EHP release (for example, EHP02) and proceeds with the installation sequence of all Business Functions from the higher EHP release (for example, EHP03) and so on (EHPnn+1).

■ All Business Functions files of each EHP will be substitute files in the target directory.3. Install all files from the directories GENERAL and BF_ALL from the most recent EHP for which an

active Business Function was determined in Step 2.4. A subsequent Business Functions activation from a lower EHP means that the installation must

be repeated as a new complete installation. The installation sequence starts from the beginning of steps 1 – 3.


5.1 About SAPinst

2009-01-23 PUBLIC 31/38

5.1.7 Troubleshooting with SAPinst

This section tells you how to proceed when errors occur during the installation with SAPinst.If an error occurs, SAPinst:

■ Stops the installation.

■ Displays a dialog informing you about the error.

Procedure1. To view the log file, choose View Logs.2. If an error occurs during the Define Parameters or Execute phase, do either of the following:

■ Try to solve the problem

■ Abort the installation by choosing Cancel in the SAPinst menu.For more information, see Interrupted Installation with SAPinst [page 30].

■ After resolving the problem, you can continue the installation by choosing Retry.3. Check the log and trace files of the GUI server and SAPinst GUI in the directory %userprofile%

\.sdtgui\ for errors.

■ If GUI server or SAPinst GUI do not start, check the file sdtstart.err in the current %userprofile% directory.

■ If SAPinst GUI aborts during the installation without an error message, restart SAPinst GUI as described in Starting SAPinst GUI Separately [page 28].

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 facility enables 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 or c:\WINNT)

■ In the SAP GUI directory (locally or on a server)

■ In the parent directory of the SAP GUI directory

Order of Evaluation

Each time the user accesses help in the SAP system ( Help Application Help) , the sapdoccd.ini file is evaluated in the Microsoft Windows directory of the front-end PC. If the file is not there, it is first searched for 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



32/38 PUBLIC 2009-01-23

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 22]. To override the SAP system setting variant, look for a sapdoccd.ini file in the locations mentioned above and modify its content according to your requirements. Otherwise, create a new file with any ASCII editor (for example, Editor). Make sure you observe the order 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.

NOTE

Apart from the settings for HTML-based help in systems with Release 4.0A and later, the sapdoccd.ini file can also contain control information for the WinHelp-based help in systems with Releases 3.xx. These settings do not affect each other.

5.2.2 Parameters in File sapdoccd.ini

The following parameters and parameter values can be used:

HelpType PlainHtmlHttp, PlainHtmlFile, HtmlHelpFile, DynamicHelp, GetFromR3

<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. The help type GetFromR3 is not a proper help type. It is used to copy the values of the currently active setting variant of the SAP system. If you specify GetFromR3 as the help type (HelpType=GetFromR3), the settings from the SAP system are used. If you also specify the server and/or path in sapdoccd.ini, these settings override the settings in the SAP system. The paths used to override help settings locally must include the language key.

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:

■ All SAP systemsEntries in section [HTMLHELP] apply to all SAP systems.

■ SAP systems with a specific releaseEntries in sections [HTMLHELP-<Release>] apply to all SAP systems with this release. They override the entries in section [HTMLHELP].

■ Individual SAP systems



2009-01-23 PUBLIC 33/38

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>].

■ If an entry for a particular release (for example, Release 7.10) 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-710] HelpType=HtmlHelpFile

HtmlHelpFilePath-DE=\\DWDF042\docu\710\HTMLHELP\DE

HtmlHelpFilePath-EN=\\DWDF042\docu\710\HTMLHELP\EN

HtmlHelpFilePath=\\DWDF042\docu\710\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

[SystemId-B60] HelpType=GetFromR3

HtmlHelpFilePath-DE=\\p99999\HTMLHELP\DE

HtmlHelpFilePath=\\p99999\HTMLHELP\EN

5.2.3 Logging of Help Calls

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 B20:



34/38 PUBLIC 2009-01-23

EXAMPLE

Figure 2:

In the example, help type HtmlHelpFile is used and the help files are accessed from the directory \HTMLHELP\EN on the file server \\p12345. If you launched the help documentation from the SAP system B40, the help type PlainHtmlFile is used. In all other SAP systems, the default help type PlainHtmlHttp (defined in transaction SR13) is used.



2009-01-23 PUBLIC 35/38

Typographic Conventions

Example Description

<Example> Angle brackets indicate that you replace these words or characters with appropriate entries to make entries in the system, for example, “Enter your <User Name>”.

ExampleExample

Arrows separating the parts of a navigation path, for example, menu options

Example Emphasized words or expressions

Example Words or characters that you enter in the system exactly as they appear in the documentation

http://www.sap.com Textual cross-references to an internet address

/example Quicklinks added to the internet address of a homepage to enable quick access to specific content on the Web

123456 Hyperlink to an SAP Note, for example, SAP Note 123456

Example ■ Words or characters quoted from the screen. These include field labels, screen titles, pushbutton labels, menu names, and menu options.

■ Cross-references to other documentation or published works

Example ■ Output on the screen following a user action, for example, messages ■ Source code or syntax quoted directly from a program ■ File and directory names and their paths, names of variables and parameters, and

names of installation, upgrade, and database tools

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

EXAMPLE Keys on the keyboard

36/38 PUBLIC 2009-01-23

http://www.sap.com



SAP AGDietmar-Hopp-Allee 16

69190 WalldorfGermany

T +49/18 05/34 34 34F +49/18 05/34 34 20

www.sap.com

© Copyright 2009 SAP AG. 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 AG. The information contained herein may be changed without prior notice.Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation.IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation.Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries.Oracle is a registered trademark of Oracle Corporation.UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc.HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology.Java is a registered trademark of Sun Microsystems, Inc.JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape.SAP, R/3, xApps, xApp, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (“SAP Group”) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

DisclaimerSome components of this product are based on Java™. Any code change in these components may cause unpredictable and severe malfunctions and is therefore expressly prohibited, as is any decompilation of these components.Any Java™ Source Code delivered with this product is only to be used by SAP’s Support Services and may not be modified or altered in any way.

Documentation in the SAP Service MarketplaceYou can find this document at the following address: https://service.sap.com/instguides

2009-01-23 PUBLIC 37/38

https://service.sap.com/instguides

SAP AGDietmar-Hopp-Allee 1669190 WalldorfGermanyT +49/18 05/34 34 34F +49/18 05/34 34 20www.sap.com

© Copyright 2009 SAP AG. All rights reserved.