Documents as Online Documentation (SAP Library

Documents as Online Documentation

Definition

Online documentation for a BW object is a document that has been generated for a particular metadata object. This document can contain a text written by the user.

Use

Online documentation is usually displayed as F1 Help for the object to which it is assigned.

Online documentation is displayed in the following situations:

In the Documents screen, when choosing the Display Documentation pushbutton. The F1 Help is displayed in the Web browser.
In the Administrator Workbench, when opening the F1 Help for a BW object. You get to the Documents screen. Click on the Display Documentation pushbutton to display the F1 Help in the Web browser.
When selecting a BW object from the metadata repository. The online documentation is displayed under the header Documentation.
When opening a BW Web query in a Web browser. You can display the online documentation for a characteristic by selecting the appropriate option from the context menu (right mouse click) or by following the menu path Goto -> Documents.

Structure

The online documentation for a BW object is made up of the following parts:

The first part contains general information about the object, such as

Object type (with symbol) and name of the object
Date the object was created
Technical name
System
Description (short)
Description (long)

The Documentation part contains the following text:

If the user has created a text document or an HTML document for the object and designated this text as online documentation, the system displays this text.

In a generated version of the online documentation, you can use the search function (see Searches in Documents). You can find additional information about the necessary settings for managing the document administration under Tab Page: Indexing for a Search.

If the user has not written any online documentation, the system displays the Business Content documentation.

To include SAP Content documentation in the online documentation generated for metadata objects, it must be installed in plain html http format for static help and using a Web server. The Content documentation can then be read by the Web server from any frontend platform using the http protocol, and displayed in a Web browser.

You can find additional information about maintaining setting variants for online help (transaction SR13) in the Business Information Warehouse Implementation Guide (IMG), under the node General BW Settings ® Settings for Displaying SAP Content Documentation.

If there is no Business Content documentation for the object, the system does not display a text. If there are links to other documents, these links are displayed.

The third part contains links to the online documentation of dependent objects.

For a characteristic this would be, for example:

Objects with which the characteristic is compounded
Display attributes
Navigation attributes

Under Additional Objects, for example:

Objects from which the characteristic receives data (transfer rules, for example)
Objects from which the characteristic is used

The links are generated dynamically from the metadata repository and are, therefore, always up-to-date, even if the data model is changed.