Dokument als Online-Dokumentation 

Definition

Online-Dokumentation zu einem BI-Objekt ist ein generiertes Dokument zu dem betreffenden Metadaten-Objekt, das auch einen vom Benutzer erstellten Text enthalten kann.

Verwendung

Die Online-Dokumentation wird standardmäßig als F1-Hilfe zu demjenigen Objekt angezeigt, dem sie zugeordnet ist.

Die Online-Dokumentation kommt in folgenden Fällen zur Anzeige:

·        Sie wählen vom Bild Dokumente zu dem betreffenden Metadaten-Objekt die Drucktaste  Dokumentation anzeigen. Die F1-Hilfe wird im Web Browser angezeigt.

·        Sie wählen in der Data Warehousing Workbench die F1-Hilfe zu einem BI-Objekt.

·        Sie wählen im Metadata Repository ein BI-Objekt. Die Online-Dokumentation wird unter der Gruppenüberschrift Dokumentation angezeigt.

·        Sie öffnen eine Query im BEx Analyzer bzw. im Web Browser oder Sie rufen eine Web Application auf. Die Online-Dokumentation können Sie sich zu einem Merkmal über  bzw. Dokumente ® Dokumente anzeigen aus dem Kontextmenü anzeigen lassen.

Beachten Sie, dass Sie die Dokumentsymbole erst dann sehen, wenn Sie in den Eigenschaften der Query folgende Einstellung gewählt haben: Registerkarte Darstellung ® Anzeigeoptionen ® Dokumentenlinks anzeigen. Weitere Informationen finden Sie unter Eigenschaften der Query.

Struktur

Die Online-Dokumentation zu einem BI-Objekt besteht aus folgenden Teilen:

...

       1.      Der erste Teil enthält allgemeine Angaben zum Objekt wie

¡        Objekttyp (mit Symbol) und Name

¡        Erstellungsdatum

¡        Technischer Name

¡        System

¡        Beschreibung (kurz)

¡        Beschreibung (lang)

       2.      Der Teil Dokumentation enthält einen der folgenden Texte:

¡        Wenn der Benutzer zu dem betreffenden Objekt ein Text- oder HTML-Dokument angelegt und für die Anzeige als Online-Dokumentation gekennzeichnet hat, zeigt das System diesen Text.

¡        Wenn es keine vom Benutzer angelegte Online-Dokumentation gibt, zeigt das System die Business Content Dokumentation.

Um die SAP-Content-Dokumentation in die zu Metadaten-Objekten generierte Online-Dokumentation einbinden zu können, muß sie im PlainHtmlHttp-Format für Statische Hilfe und über einen Web Server installiert sein. Die Content-Dokumentation kann dann auf jeder Frontend-Plattform über das HTTP-Protokoll von dem Web Server gelesen und im Web Browser angezeigt werden.

Weitere Informationen über die Pflege der Einstellungsvariante für die Online Hilfe (Transaktion SR13) finden Sie im SAP Customizing Einführungsleitfaden (IMG) unter SAP NetWeaver ® Business Intelligence ® Allgemeine BI Einstellungen  ® Einstellungen zur Anzeige von SAP Content Dokumentation. 

-         Wenn es auch keine Business Content Dokumentation zu dem betreffenden Objekt gibt, zeigt das System in diesem Abschnitt keinen Text. Gegebenenfalls werden Links auf weitere Dokumente angefügt.

       3.      Der dritte Teil enthält Links zur Online-Dokumentation abhängiger Objekte.

Zu einem Merkmal beispielsweise:

§         Objekte, an die das Merkmal geklammert ist

§         Anzeigeattribute

§         Navigationsattribute

Unter Weitere Objekte beispielsweise:

§         Objekte, von denen das Merkmal Daten empfängt (z.B. Übertragungsregeln)

§         Objekte, von denen das Merkmal verwendet wird

Die Links werden dynamisch aus dem Metadata Repository erzeugt und sind daher immer auf dem neuesten Stand, auch wenn das Datenmodell geändert wird.

Auf der Registerkarte: Online-Dokumentation können Sie den Verwendungsnachweis oder den Datenfluß abschalten.

Integration

BI-Dokumente zu Metadaten-Objekten als HTTP-Service

Das als Online-Dokumentation gekennzeichnete Dokument (oder das einzige Dokument) eines Metadaten-Objektes kann über eine logische URL angesprochen werden. Diese URL muss dem folgenden Schema entsprechen:

<Protokoll>://<Server>:<Port>/sap/bw/doc/meta/fldmeta/default?tlogo=<Objekttyp>&objnm=<Name des Objektes>

Das Dokument wird ohne die generierte Dokumentation des Metadata Repository angezeigt.

Beispiel für eine Query:

<Protokoll>://<Server>:<Port>/sap/bw/doc/meta/fldmeta/default?tlogo=elem&objnm=<Name der Query>

Diese URL gilt für die BEx Web-Laufzeit (Java) und die BEx Web-Laufzeit (ABAP).

Weitere Informationen finden Sie unter ICF-Services im BI.