Help Texts for Web Dynpro Applications 

There are various ways for the end user to put short help texts in Web Dynpro applications (in various UI element views), and to display longer documentation texts from the Knowledge Warehouse for a complete application or window.

For more information on the Web Dynpro authoring environment, see The Web Dynpro Text Browser.

For more information about issues you need to consider for translation, see Internationalization and Translation.

Help Texts for UI Elements

You can use the following ways to define help texts for interface elements:

●      UI Element Explanation

●      Property Explanation

●      Classic F1 Help.

Help Texts for an Application or a Window (Help Center)

For a Web Dynpro application or a window you can store a help text (info object) that was created in the Knowledge Warehouse. To do this, you go to the Properties of the application or the window.

●      Under Help Menu Text enter the text for the help window title.

●      Under Help Link specify the required info object in the Knowledge Warehouse system using the symbol to the right of the input field (Create/Change Link). To do this you need a defined RFC connection AIO_FOR_HELP_LINKS to your Knowledge Warehouse system.

Note that you when you select the relevant info object in Knowledge Warehouse you are selecting the Knowledge Warehouse context appropriate for the productive system and the appropriate area, for instance, documentation.

When you select the info object in Knowledge Warehouse you have the following options:

○       Select a topic and then the associated structure

○       Select a topic without the structure (close the structure dialog box without selecting one)

Note that both the topic and the structure must be released in the Knowledge Warehouse.

 

You can also define multiple help links for Web Dynpro ABAP applications and windows instead of one single help link. These additional help links are displayed at runtime in the help center under Helpful Links.  You can create help links using report WDY_AUTHORING_HELP_LINKS.

Help can be called at runtime by choosing F1 or the Help button in the title bar. The help center and the window for the respective application are then displayed. The explanation for the quick help, the Knowledge Warehouse documentation, links to the SAP Library, and links defined for the application windows are contained in the help center.

You can create a link in the application so that the application itself can trigger the help center. Proceed as follows:

...

       1.      Insert a LinkToAction into your view.

       2.      Insert a non-validating action.

       3.      Define the following source code for the action:

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

 

Example of a help text for the application:

For information about the title in the Business Client see Page Header.

Dynamic Override of Application Help Links

If in your Web Dynpro application you do not want the help link defined for the application to be displayed in the help center, and you would rather display a link to a different help topic, you can override the application help link dynamically. To do this use method SET_HELP_LINK of interface IF_WD_RR_APPLICATION and specify APPLICATION_INFO.

Example

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.

 

Example

You can find an example in the system in component WDR_TEST_HELP.