Hilfetexte in und für Web-Dynpro-Applikationen 

Es gibt verschiedene Möglichkeiten, für Endbenutzer kürzere Hilfetexte sowohl innerhalb von Web-Dynpro-Applikationen, also auf den verschiedenen Views für UI-Elemente, zu platzieren, als auch für eine komplette Anwendung bzw. ein Window längere Dokumentationstexte aus dem Knowledge Warehouse anzuzeigen.

Informationen über die Web-Dynpro-Autorenumgebung finden Sie unter Der Web-Dynpro-Text-Browser.

Informationen über die Aspekte, die für die Übersetzung zu berücksichtigen sind, finden Sie unter Internationalisierung und Übersetzung.

Hilfetexte für UI-Elemente

Für Oberflächenelemente gibt es die folgenden Möglichkeiten, Hilfetexte zu hinterlegen:

●      Über das UI-Element Explanation

●      Über die Eigenschaft explanation

●      Über die Klassische F1-Hilfe

Hilfetexte für eine Applikation oder ein Window (Help Center)

Für eine Web-Dynpro-Applikation oder ein Window können Sie einen im Knowledge Warehouse erstellten Hilfetext (Info-Objekt) als Hilfe hinterlegen. Dazu verzweigen Sie zu den Eigenschaften der Anwendung bzw. des Windows:

●      Unter Hilfe-Menü-Text geben Sie den Text für den Titel des Hilfe-Fensters an.

●      Unter Hilfe-Link geben Sie das gewünschte Info-Objekt im Knowledge-Warehouse-System über das entsprechende Symbol rechts vom Eingabefeld an (Link anlegen/ändern). Dazu benötigen Sie eine gepflegte RFC-Verbindung AIO_FOR_HELP_LINKS zu Ihrem Knowledge-Warehouse-System.

Beachten Sie, dass Sie bei der Auswahl des geeigneten Info-Objekts im Knowledge Warehouse den zum Produktivsystem passenden Knowledge-Warehouse-Kontext sowie den entsprechenden Bereich auswählen, z.B. Documentation.

Bei der Auswahl des Info-Objekts im Knowledge Warehouse haben Sie folgende Möglichkeiten:

○       Auswahl eines Topics und danach der dazugehörigen Struktur

○       Auswahl eines Topics ohne Struktur (Schließen Sie hierfür den Strukturdialog ohne Auswahl)

Beachten Sie, dass sowohl Topic als auch Struktur im Knowledge Warehouse freigegeben sein müssen.

 

Sie können für Web-Dynpro-ABAP-Applikationen und Windows anstelle von einem einzigen Hilfe-Link auch mehrere Hilfe-Links definieren. Diese zusätzlichen Hilfe-Links werden dann zur Laufzeit im Help Center unter Hilfreiche Links angezeigt. Sie können die Hilfe-Links mit dem Report WDY_AUTHORING_HELP_LINKS anlegen.

Die Hilfe kann zur Laufzeit über F1 oder über den Hilfe-Button in der Titelzeile aufgerufen werden. Angezeigt wird dann das Help Center für die jeweilige Applikation und das Window. Darin enthalten sind die Angabe über die Soforthilfe (Explanation), die Knowledge-Warehouse-Dokumentation, sowie als weiterführende Informationen Links auf die SAP-Bibliothek und Links, die an Windows der Applikation hinterlegt sind.

Sie können auch in der Applikation einen Link derart erstellen, dass die Applikation selbst das Help Center triggern kann. Gehen Sie dazu vor wie folgt:

...

       1.      Fügen Sie in Ihrer View einen LinkToAction ein.

       2.      Fügen Sie eine nicht-validierende Action ein.

       3.      Hinterlegen Sie für die Action das folgende Coding:

data: l_api_componentcontroller type ref to if_wd_component. data l_appl type ref to if_wd_application. l_api_componentcontroller = wd_comp_controller->wd_get_api( ). l_appl = l_api_componentcontroller->get_application( ). l_appl->open_help_center( ).

 

Beispiel für eine Hilfe an der Applikation:

Informationen über den Titel im Business Client finden Sie unter PageHeader.

Dynamisches Übersteuern des Applikations-Hilfe-Links

Wenn Sie in Ihrer Web-Dynpro-Applikation nicht den an der Anwendung definierten Hilfe-Link im Help-Center angezeigt bekommen möchten, sondern auswahlweise einen Link auf ein spezielles Hilfe-Topic, können Sie dynamisch den Applikations-Link übersteuern. Dazu verwenden Sie die Methode SET_HELP_LINK des Interface IF_WD_RR_APPLICATION und geben die APPLICATION_INFO an.

Beispiel

method onactionchange_appl_helplink .   data api_main2        type ref to if_wd_view_controller.   data component        type ref to if_wd_component.   data application      type ref to if_wd_application.   data application_info type ref to if_wd_rr_application.   api_main2 = wd_this->wd_get_api( ).   component = api_main2->get_component( ).   application = component->get_application( ).   application_info = application->get_application_info( ).   application_info->set_help_link( 'HELPTYPE=SAPHELP&_LOIO=452C8201E9EF48D882BD10244D085661&_CLASS=BIC_OOO' ). endmethod.

 

Beispiel

Sie finden ein Beispiel im System in der Component WDR_TEST_HELP.