SAPLibInstGuide 640 En

7/27/2019 SAPLibInstGuide 640 En

http://slidepdf.com/reader/full/saplibinstguide-640-en 1/27

Installation Guide

SAP® Library (SAP

Web Application

Server Release 6.40

or higher)

Document version: 2.0, May 08, 2006

PUBLIC



© Copyright 2006 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, Outlook, PowerPoint, and SQL Server are

registered trademarks of Microsoft Corporation.

IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex,

MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries, pSeries,

xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity,

Tivoli, and Informix are trademarks of IBM Corporation 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 of Citrix Systems, Inc.

HTML, XML, XHTML and W3Care 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, mySAP, mySAP.com, SAP NetWeaver, xApps, xApp, and

other SAP products and services mentioned herein as well as their

respective logos are trademarks or registered trademarks of SAP AG

in Germany and in several other countries all over the world. All other

product and service names mentioned are the trademarks of their

respective companies. Data contained in this document serves

information purposes only. National product specifications may vary.

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.

Disclaimer

Some components of this product are based on Java™. Any code

change in these components may cause unpredictable and severe

malfunctions and is therefore expressively 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 on SAP Service Marketplace

You can find this documentation at the following address:http://service.sap.com/

SAP AGNeurottstraße 1669190 Walldorf GermanyT +49/18 05/34 34 24F +49/18 05/34 34 20www.sap.com



Typographic Conventions

Type Style Description

Example Text Words or characters quotedfrom the screen. These includefield names, screen titles,pushbuttons labels, menunames, menu paths, and menuoptions.

Cross-references to other documentation

Example text Emphasized words or phrasesin body text, graphic titles, andtable titles

EXAMPLE TEXT Technical names of systemobjects. These include reportnames, program names,transaction codes, tablenames, and key concepts of aprogramming language whenthey are surrounded by body

text, for example, SELECT andINCLUDE.

Exampl e t ext Output on the screen. Thisincludes file and directorynames and their paths,messages, names of variablesand parameters, source text,and names of installation,upgrade and database tools.

Example text Exact user entry. These arewords or characters that youenter in the system exactly asthey appear in thedocumentation.

<Exampletext>

Variable user entry. Anglebrackets indicate that youreplace these words andcharacters with appropriateentries to make entries in thesystem.

EXAMPLE TEXT Keys on the keyboard, for

example, F2 or ENTER.

Icons

Icon Meaning

Caution

Example

Note

Recommendation

Syntax

Additional icons are used in SAPLibrary documentation to help youidentify different types of information ata glance. For more information, see

Help on Help → General InformationClasses and Information Classes for

Business Information Warehouse onthe first page of any version of SAPLibrary.



Installation of SAP Library

4 May 2006

Contents

Installation of SAP Library ...............................................................5

Variants of SAP Library .........................................................................6

HtmlHelpFile .................................................................................................8

PlainHtmlHttp ............................................................................................... 9

PlainHtmlFile .............................................................................................. 10

DynamicHelp .............................................................................................. 11

Criteria for Selecting the Help Type.......................................................... 12

Installation of SAP Library ..................................................................13

Using a Web Browser or Viewer ............................................................... 14

Offline Access to Help Files ...................................................................... 16

Installing HtmlHelpFile............................................................................... 17

Installing PlainHtmlHttp and PlainHtmlFile.............................................. 18

Setting Variants for SAP Library ............................................................... 20

Local Override of Help Settings on Front Ends ................................22

File sapdoccd.in i ........................................................................................ 23

Parameters in the File sapdoccd.ini ......................................................... 24

Logging of Help Calls ................................................................................ 26



Installation o f SAP Library

May 2006 5

Installation of SAP LibraryPurpose

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

Installing HtmlHelpFile [page 17]

Installing PlainHtmlHttp and PlainHtmlFile [page 18]

Separately from the installation, you can also override the help settings on the front end:

Local Override of Help Settings on Front Ends [page 22]

Implementation ConsiderationsOn Microsoft Windows front ends, at least SAP GUI 6.40 must be installed to enable accessto the documentation from the SAP system. For more information, see SAP Note 66971(supported front-end platforms).

See also the information in the file r eadme. t xt on the SAP Library DVD.

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-

IWN-DIS for any issues relating to static help; use the component KM-KW for any issuesrelating to dynamic help.




6 May 2006

Variants of SAP Library

Overview

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 betweenthe help types are the storage format (Standard HTML or Compiled HTML), the way youaccess the help documents (Web server or file server), and the search and print functions.

Help Types

HtmlHelpFile PlainHtmlHttp PlainHtmlFile

Front-end platforms All Windowsplatforms supportedby Microsoft

All All Windowsplatforms supportedby 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 InternetExplorer required)

Web browser (Microsoft InternetExplorer or Netscape)

Web browser (Microsoft InternetExplorer or Netscape)

Global full-textsearch X

(from SAP HelpPortal at

http://help.sap.com;launched, for example, from thebanner of the DVD)

Local full-text search X (in CHM file) Printing of singletopics X X X Printing of multipletopics X Supported operatingsystems for the helpinstallation

Microsoft Windows ● IBM AIX

● HP-UX

● Sun Solaris

● Linux 32

● DEC

● MicrosoftWindows

● IBM AIX

● HP-UX

● Sun Solaris

● Linux 32

● DEC

● MicrosoftWindows




May 2006 7

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

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




8 May 2006

HtmlHelpFileThis help type stores documents in Compiled HTML format (*.CHM). They are accessed from

a file server and displayed in HTML Help Viewer.

Compiled HTML is a format developed by Microsoft for storing HTML files in compressedform. CHM files require about one tenth of the disk space required for uncompressed HTMLfiles and about the same space as required for WinHelp files. HTML Help Viewer wasintroduced by Microsoft as a successor to WinHelp. It is based on Internet Explorer.

Features

● Can be used only on Windows 32-bit 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 98 Pentium 133 MHz

64 MB RAM Microsoft Windows NT 4.0, Service Pack 6a Pentium 133 MHz

64 MB RAM

Microsoft Windows 2000 Pentium 133 MHz

128 MB recommended

Microsoft Windows XP Pentium 233 MHz (300 MHz recommended)

128 MB RAM (256 MB recommended)

Server Requirements for HtmlHelpFile

300-800 MB of free disk space for each language version




May 2006 9

PlainHtmlHttpThis help type stores documents in Standard HTML format. They are available from a Web

server and can be displayed in a standard Web browser.

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

System Requirements

System Requirements for PlainHtmlHttp

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 eachlanguage version, depending on the file system

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




10 May 2006

PlainHtmlFileThis help type stores documents in Standard HTML format. They are available from a file

server and can be displayed in a standard Web browser.

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 Webbrowser

Server Between 850 MB (Microsoft Windows NT) and2 GB (UNIX) of free disk space for eachlanguage version, depending on the file system




May 2006 11

DynamicHelpThe 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. Beforeyou can launch DynamicHelp, SAP Knowledge Warehouse must be installed in the systemlandscape. Files are accessed through SAP IKS (Internet Knowledge Servlet). The contentitself 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 contextin the SAP system (see SAP Note 594231). This context must also be defined in the SAPKnowledge Warehouse system.




12 May 2006

Criteria for Selecting the Help TypeThe decision about which help type to install in a given SAP system depends to a great

extent on the operating system of the front-end clients.

● If you use front ends on Microsoft Windows only, we recommend that you install thehelp type HtmlHelpFile. This help type offers more extensive search and printfunctions than the other two help types. You are free to install any help type, of course.

If you are using different front-end platforms in parallel, and therefore have tochoose a help type other than HtmlHelpFile, you can still use the help typeHtmlHelpFile (see Local Override of Help Settings on Front Ends [page 22])on clients running on Microsoft Windows.

● If you use front-end platforms other than Microsoft Windows, we also recommend thatyou install PlainHtmlHttp, since this help type provides a full-text search function fromthe SAP help portal.

● If you do not have a Web server and you use front-end platforms other than MicrosoftWindows 32-bit, 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, youcannot use help type HtmlHelpFile.

Figure: Choosing a Help Type

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

Front Ends onMicrosoft Windows

98/NT/2000/XP

PlainHtmlFile

PlainHtmlHttp

HtmlHelpFile

No

Web server

available?Yes

Yes

No




May 2006 13


Purpose

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

Prerequisites

You have received the SAP Library DVD. The online help is delivered on this DVD in two fileformats: Standard HTML and Compiled HTML (HTMLHelpFile). Subdirectories contain thedifferent language versions.

Process Flow

For online access from the SAP system, both formats require the following steps to beperformed:

● Installation of the help files

○ Installing HtmlHelpFile [page 17]

○ Installing PlainHtmlHttp and PlainHtmlFile [page 18]

● Button

● Maintain setting variants for the online help (transaction SR13) (see Setting Variants for SAP Library [page 20]).

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.




14 May 2006

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. Certain requirements and restrictions must be observed,however, depending on the particular platform. The following table shows which browsers canbe used with which front-end platforms.

Web Browser for Help Documentation

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

Microsoft InternetExplorer 5.01 SP 2(or higher)

Netscape 4.06 (or higher)

Microsoft Windowsplatforms X X X

Apple Macintosh X (3.01) X

UNIX X X

Note the following points:

● If you are using HTML Help Viewer in Microsoft Windows or Netscape on UNIX, a newinstance of the viewer or browser is opened each time you access help documentation.

● On UNIX, the Web browser is called by the help processor of the SAP system with the

logical file name NETSCAPE. To adapt this call to your file system, the logical file name

and the corresponding logical path NETSCAPE_PATHmust be defined in transaction

FILE. Note that the logical file name NETSCAPE does not imply which Web browser you

launch with this name. (The name was chosen when the Netscape Navigator 3.0 wasthe only browser available for UNIX front ends.)

● Under 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.

● If you choose help type HtmlHelpFile, you must use HTML Help Viewer, which is basedon (and requires) Microsoft Internet Explorer. If you use help types PlainHtmlHttp andPlainHtmlFile you can use either Microsoft Internet Explorer or Netscape. For the helpstructure implemented with JavaScript and displayed as a compressed tree, JavaScriptmust 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 6.40 fromthe CD 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 may be overwritten.

Microsoft Internet Explorer is installed with the operating system. You can download updatesfrom the Microsoft Web site. You can also download Microsoft Internet Explorer for Macintoshfrom the Microsoft Web site.




May 2006 15

To use the HTML Help Viewer, you have to activate ActiveX in the MicrosoftInternet Explorer. In the Internet Explorer choose security level Medium or

Low under the Local intranet zone in the menu path Tools → Internet Options,tab page Security.For more information, see SAP Note 594271 (SAP Library: ActiveX for chmFiles) and SAP Note 857216 (this note handles any current issues arisingfrom the implementation of Microsoft Security Bulletins).

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




16 May 2006

Offline Access to Help FilesTo view the documentation offline, that is, without connecting to the SAP system, you need to

install a suitable browser or viewer on your computer (see Using a Web Browser or Viewer [page 14]) and have access to the help files. For the standard HTML help files, this requiresyou to unpack the archive Pl ai nht m. xxx from the DVD to your hard drive.

HtmlHelpFile: Offline Access to Help Files

To add SAP Library as an option to the Microsoft Windows menu Start → Programs, run theprogram set up. exe in the root directory of the SAP Library DVD.

The directory <CD dr i ve>: \ Ht ml hel p\ Hel pdat a\ <l anguage key>\ shor t cut

contains the command line script nt 4. cmd (for Microsoft Windows NT 4.0, 2000, and XP) or

wi n9x. bat (for Microsoft Windows 98). You can use this script to add SAP Library entries to

the Microsoft Windows menu Start → Programs. These menu entries provide access points

to different parts of the online documentation. You can edit the script and, if required,integrate and distribute it in background processes.

To create the menu entries, proceed as follows:...

1. In Microsoft Windows Explorer, navigate to the directory containing the command line

scripts and select the script file nt 4. cmd (or \ shor t cut \ wi n9X. bat on Microsoft

Windows 98).

2. Choose Open from the context menu.

If you do not want to create a menu entry, you can select the file

Ht ml hel p\ Hel pdat a\ <l anguage key>\ 00000001. chmin Microsoft Windows Explorer

and double-click. This opens SAP Library and you can navigate from there.

The file Ht ml hel p\ Hel pdat a\ Over vi ew. t xt or Ht ml hel p\ Hel pdat a\ Over vi ew. ht mcontains a list of SAP components and the CHM files that describe them.

PlainHtmlHttp and PlainHtmFile: Offl ine Access to the Help Files

On Front Ends on Microsoft Windows

After you have unpacked the online documentation on the Web server, the directory

<I nst al l Di r >\ hel pdata\ <l anguage key>\ shor t cut contains the command line

script nt 4. cmd (for Microsoft Windows NT 4.0, 2000, and XP) or wi n9x. bat (for Microsoft

Windows 98). You can use this script to add SAP Library entries to the Microsoft Windows

menu Start → Programs. These menu entries provide access points to different parts of theonline documentation. You can edit the script and, if required, integrate and distribute it inbackground processes.

To create the menu entries, proceed as follows:...

1. In Microsoft Windows Explorer, navigate to the directory containing the command line

scripts and select the script file nt 4. cmd (on Microsoft Windows NT 4.0/2000/XP) or

wi n9X. bat (on Microsoft Windows 98).

2. Choose Open from the context menu.

On Front Ends Not on Microsoft Windows

Open the file Home. ht min the directory containing the help files (<I nst al l Di r >\ hel pdata\ <l anguage key>). This loads the documentation homepage in your Web

browser. From here you can navigate to all parts of the documentation. Add thedocumentation homepage to your browser favorites or bookmarks.




May 2006 17

Installing HtmlHelpFile

Use

This procedure describes how you install HtmlHelpFile. The Compiled HTML files for helptype 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 (asdescribed in the procedure below).

Prerequisites

To install SAP Library, you require the SAP Library DVD.

To display the documentation, a suitable browser or viewer must be installed on your computer (see Using a Web Browser or Viewer [page 14]).

Procedure...

1. Create a directory on your file server for the help files (documentation directory). Approximately 1 GB of disk space is needed for the English and German languageversions.

2. Insert the appropriate DVD into the DVD/CD drive.

3. Copy the directory Ht ml hel p\ Hel pdat a\ <l anguage 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 transactionSR13, you can access the documentation both from the SAP system and offline. When youmaintain setting variants (see Setting Variants for SAP Library [page 20]), you define whichhelp variant(s) are available to the user.




18 May 2006

Installing PlainHtmlHttp and PlainHtmlFile

Use

This procedure describes how to install PlainHtmlHttp or PlainHtmlFile. The Standard HTMLfiles for help types PlainHtmlHttp and PlainHtmlFile are stored in a packed format in the

archive Pl ai nht m. xxx on the DVD. They cannot be viewed directly from the DVD but must

first be unpacked on the local hard drive or on a file server. To unpack the help files you must

use the i nst al l program (or the i nst hel p program), which is delivered in various

platform-specific versions on the DVD.

The complete installation comprises about 200,000 files in about 100,000directories for one language version. Depending on the file system and theconfiguration of the hard disk they require between 850 MB (NTFS) and 2 GB

(UNIX) of disk space.

Prerequisites

To install SAP Library, you require the SAP Library DVD.

To display the documentation, a suitable browser or viewer must be installed on your computer (see Using a Web Browser or Viewer [page 14]).

When you call the search function from the banner of the relevantdocumentation DVD, an Internet connection is opened enabling a full textsearch from the DVD. To use the full text search function, you need anInternet connection.

If Java scripting is not enabled, the binoculars button for the full-text searchfunction appears in the browser banner even though this function is onlyavailable with help type PlainHtmlHttp. If you press the button, an error message appears. To remove the binoculars button from the banner whenusing PlainHtmlFile, enable Java scripting in your browser settings:

Under Netscape 4.06 (or later): Edit → Preferences → Advanced → Enable JavaScript

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

Procedure...

1. Create a directory on your Web server for the help files. Approximately 600 MB of diskspace are required for one language version (Windows NTFS). Storage requirementsdepend on the particular file system and can be up to 2 GB (UNIX).

The help cannot be installed on a Microsoft FAT32 file system because this filesystem cannot handle the large number of files and directories.

If your web server runs on Microsoft Windows, do not install the helpdocumentation on the system partition; choose another partition instead.

2. Insert the DVD with the language version you want to install (for example, English) intoa DVD/CD drive.




May 2006 19

3. To install the help files, use the version of the i nst al l program (or i nst hel p

program) appropriate for the operating system of your Web server. The programs are

located in the subdirectory Pl ai nht m/ I nst al l / <oper at i ng sys t em>on the

DVD.

The i nst al l program uses the i nst hel p program and is available only for MicrosoftWindows and UNIX. On UNIX, you have to use the program i nst hel p if you have not

installed a graphical user interface.

Follow the procedure below:

Microsoft Windows:

Run the i nst al l program located in the directory Pl ai nht m\ I ns t al l \ Wi ndows on

the DVD.

You will be asked to specify:

○ The path to the archive Pl ai nht m. xxx

○ The path of the directory where you want to install the documentation, that is thedirectory you created in step one.

Note that the installation programs for Microsoft Windows do not run on Alphamachines.

UNIX (with graphical user interface)

Run the i nst al l program located in directory Pl ai nht m\ I nst al l \ <your UNI Xvar i ant >on the DVD.

You will be asked to specify:

○ The path to the archive Pl ai nht m. xxx

○ The path of the directory where you want to install the documentation, that is thedirectory you created in step one.

Result

The archive Pl ai nht m. xxx is unpacked, and the help files written to the Web server. This

process takes about 30 minutes, depending on the operating system and the data transfer rate of the DVD/CD drive.

The directory tree created on the Web server when you install the English language versionhas the following structure:

<I nst al l Di r >

- hel pdat a

+ EN (help files, English version)

For PlainHtmlHttp, you must create the alias /saphelp. Define this alias to

point to your installation directory <I nst al l Di r >. The Web server requires

read access for /saphelp.

You have installed SAP Library. Once you have maintained the setting variants in transactionSR13, you can access the documentation both from the SAP system and offline. When youmaintain setting variants (see Setting Variants for SAP Library [page 20]), you define which

help variant(s) are available to the user.




20 May 2006

Setting Variants for SAP LibraryIn the IMG activity (transaction SR13), you specify which help variant(s) 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).

Special Features of the Help Types

HtmlHelpFile

• The path names specified in the setting variants must not contain special characterssuch as blanks or ampersands. Also, path names must not be longer than 64characters.

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. Also, path names must not be longer than 64characters.

PlainHtmlFile

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

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

f i l e: / / / K: / pl ai nht ml / 640/ EN/ e1/ 8e51341a06084de10000009b38f 83b/ f r ameset . ht m). 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 ensure that this drive letter points to the file server onthe front end.

Assignment of the Disk Drive Letter to the File Server

Front End Does the drive letter have tobe assigned to the fileserver?

Front End

Microsoft Windows Only if Netscape Navigator isused Microsoft Windows

Apple Macintosh Yes Apple Macintosh

Your front-end PC runs on Apple Macintosh and the help files reside in

subdirectory pl ai nht ml \ 640\ ENof the shared directory docu on server

\ \ p99999.

If the share name \ \ p99999\ docu is assigned to drive letter K: on the front

ends, then the entry in the Path field must be K: \ pl ai nht ml \ 640.




May 2006 21

Examples of Setting Variants for Help Types

Example for HtmlHelpFile: Setting Variant for the Help Documentation

Variant HTML Help 6.40 English

Platform WN32

Area IWBHELP

Path \\p12345\HTMLhelp640\helpdata

Language EN

Default Yes

Example for PlainHtmlHttp: Setting Variant for the Help Documentation

Variant HTML (Web) 6.40 English

Platform WN32

Area IWBHELP

Server p12345:1080

Path PlainHttp640/helpdata

Language EN

Example for PlainHtmlFile: Setting Variant for the Help Documentation

Variant HTML (File) 6.40 English

Platform WN32

Area IWBHELP

Path \\p12345\PlainFile640\helpdata

Language EN

Default Yes




22 May 2006

Local Override of Help Settings on FrontEndsThe help setting variants configured in the SAP system can be overridden locally on MicrosoftWindows front ends. This facility enables you to use a different help type and/or get help froma location other that than defined in the setting variants defined by the system administrator.

If you have not defined any entries for the setting variants in transactionSR13, the local front ends cannot be overridden. You must select a help typein transaction SR13.




May 2006 23

File sapdoccd.iniOverride information is entered in the file sapdoccd. i ni . This file can be stored in the

following locations:

● In the Microsoft Windows directory of the front-end PC (c: \ Wi ndows or c: \ WI NNT)

● 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. i ni 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 parentdirectory 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 settingvariant of the SAP system [page 20] currently in use.

To override the SAP system setting variant, look for a sapdoccd. i ni file in the locations

mentioned above and modify its content according to your requirements. Otherwise, create anew 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

sapdoccd. i ni contains entries in Microsoft Windows INI format. The names of sections and

parameters are not case-sensitive, but parameter values are.

Apart from the settings for HTML-based help in systems with Release 4.0A

and later, the sapdoccd. i ni file may also contain control information for the

WinHelp-based help in systems with Releases 3.xx. These settings do notaffect each other.




24 May 2006

Parameters in the File sapdoccd.iniThe 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 noparameter <HelpType>Path-<language> hasbeen specified for the current logon language

The help type DynamicHelp can only be used if SAP Knowledge Warehouseis installed.The help type GetFromR3 is not a proper help type; it is used to copy thevalues of the currently active setting variant of the SAP system. If you specify

GetFromR3 as the help type (Hel pType=Get Fr omR3), the settings from the

SAP system are used. If you also specify the server and/or path in

sapdoccd. i ni , 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 by entering parameter values in the

relevant sections in sapdoccd. i ni . Entries for overriding the HTML-based help can apply

to:

● All SAP systems

Entries in section [ HTMLHELP] apply to all SAP systems.

● SAP systems with a specific release

Entries in sections [ HTMLHELP- <Rel ease>] apply to all SAP systems with this release.

They override the entries in section [ HTMLHELP] .

● Individual SAP systems

Entries in sections [ Syst emI d- <SAP Syst em>] apply to <SAP system> and override

both the global entries in section [ HTMLHELP] and the release-specific entries in

sections HTMLHELP- <Rel ease>] .

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




May 2006 25

[ HTMLHELP]

Hel pType=Pl ai nHtml Ht t p

Pl ai nHt ml Ht t pServer =p99999. sap- ag. de: 1080

Pl ai nHt ml Ht t pPat h- DE=saphel p/ hel pdat a/ DE

Pl ai nHt ml Ht t pPat h=saphel p/ hel pdata/ EN

[ HTMLHELP- 40B]

Hel pType=Ht ml Hel pFi l e

Ht ml Hel pFi l ePat h- DE=\ \ DWDF042\ docu\ 40b\ ht ml hel p\ hel pdat a\ DE

Ht ml Hel pFi l ePat h- EN=\ \ DWDF042\ docu\ 40b\ ht ml hel p\ hel pdat a\ EN

Ht ml Hel pFi l ePat h=\ \ DWDF042\ docu\ 40b\ ht ml hel p\ hel pdat a\ EN

[ Syst emI d- B20]Hel pType=Ht ml Hel pFi l e

Ht ml Hel pFi l ePat h- DE=\ \ p12345\ html hel p\ hel pdat a\ DE

Ht ml Hel pFi l ePat h=\ \ p12345\ html hel p\ hel pdat a\ EN

[ Syst emI d- B40]

Hel pType=Pl ai nHt ml Fi l e

Pl ai nHt ml Fi l ePat h- DE=\ \ p44444\ Pl ai nHt ml \ hel pdat a\ DE

Pl ai nHt ml Fi l ePat h=\ \ p44444\ Pl ai nHt ml \ hel pdat a\ EN

[ Syst emI d- B60]

Hel pType=Get Fr omR3

Ht ml Hel pFi l ePat h- DE=\ \ p99999\ html hel p\ hel pdat a\ DE

Ht ml Hel pFi l ePat h=\ \ p99999\ html hel p\ hel pdat a\ EN




26 May 2006

Logging of Help Calls A log for each call is written to the file sapdoccd. l og.

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

1. Command line used to launch the start program for help (SHH. EXE) from the SAP

system.

2. Default parameters (transaction SR13) extracted from the command line

3. Parameters extracted from the file sapdoccd. i ni

4. Start parameters resulting from 2 and 3

5. Browser/viewer version (for help type HtmlHelpFile only)

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

progr am pat h = C: \ Progr amFi l es\ SAPpc\ SAPGUI \ HTMLHELP\ SHH. EXE

SHH ver si on = 4. 5. 2. 1

command l i ne = TYPE=2&SERVER=p99999. sap-ag. de: 1080&PATH=saphel p/ hel pdat a/ EN

&SYSTEM=B20&_CLASS=I WB_EXTHLP

&_LOI O=a4d47d8e49e111d189730000e8322d00

&_SLOI O=a4d480e449e111d189730000e8322d00

&LANGUAGE=EN&RELEASE=620

&I WB_COUNTRY=&I WB_I NDUSTRY=

i nf o: - - - def aul t set t i ngs f r omcommand l i ne - - -

i nf o: Hel pType=Pl ai nHt ml Ht t p

i nf o: Pl ai nHt ml Ht t pSer ver =p99999. sap- ag. de: 1080

i nf o: Pl ai nHt ml Ht t pPat h=saphel p/ hel pdata/ DE

i nf o: - - - cont ent s of pr of i l e"C: \ WI NNT\ sapdoccd. i ni " - - -

i nf o: Hel pType="Ht ml Hel pFi l e"

i nf o: Ht ml Hel pFi l ePat h-EN="\ \ p12345\ html hel p\ hel pdat a\ EN"

i nf o: - - - st ar t i ng Ht ml Hel p - - -

i nf o: i nif i l e="\ \ p12345\ ht ml hel p\ hel pdata\ EN\ ht ml hel p. i ni "

i nf o: chmf i l e="\ \ p12345\ ht ml hel p\ hel pdat a\ EN\ 00000619. chm"

i nf o: ht mf i l e="/ cf 21ea0b446011d189700000e8322d00/ cont ent . ht m"

i nf o: - - - ver si on i nf o - - -




i nf o: Mi cr osof t I nt ernet Expl orer ver si on i s4. 70. 0. 1300

i nf o: Mi cr osof t HTML- Hel p ver si on i s 4. 73. 8474. 0

In the example, help type HtmlHelpFile is used and the help files are accessed

from the directory \ ht ml hel p\ hel pdat a\ ENon the file server \ \ p12345. If

you launched the help documentation from the SAP system B40, the help typePlainHtmlFile would be used. In all other SAP systems, the default help typePlainHtmlHttp (defined in transaction SR13) would be used.

SAPLibInstGuide 640 En

Documents

Transcript of SAPLibInstGuide 640 En