Start of Content Area

Object documentation Documents as Online Documentation Locate the document in its SAP Library structure

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 for the affected metadata object, by choosing the This graphic is explained in the accompanying text Display Documentation pushbutton. The F1 Help is displayed in the Web browser.

·        In the Administrator Workbench, by opening the F1 Help for a BW object.

·        By selecting a BW object from the metadata repository. The online documentation is displayed under the header Documentation.

·        You open a query in the BEx Analyzer or in the Web browser, or you call up a Web application. You can display the online documentation for a characteristic using This graphic is explained in the accompanying text or This graphic is explained in the accompanying text Display Documents or using Goto ® Documents from the context menu.

Caution

Note that you first see the document symbols if you have chosen the following setting in the query properties: Tab page Display ® Display Options ® Display Document Links. For more information, see Query Properties 

Structure

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

...

       1.      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)

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

Note

In a generated version of the online documentation, you can use the search function (see Search 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.

Caution

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 front end 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.

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

Example

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.

On the Tab Page: Online Documentation, you can deactivate the where-used list ort he data flow.

Integration

BW documents for metadata objects as http service

The document designated as online documentation (or the only document) for a metadata object can be addressed with a logical URL. This URL has to follow the following schema:

<Protocol>://<Server>:<Port>/sap/bw/doc/meta/fldmeta/default?tlogo=<Objecttype>&objnm=<Name of the Object>

The document is displayed without the generated documentation for the metadata repository.

Example

Example for a query:

<Protocol>://<Server>:<Port>/sap/bw/doc/meta/fldmeta/default?tlogo=<Objecttype>&objnm=<Name of the Object>

Note

You can find more information under ICF-Services in SAP BW.

 

End of Content Area