Help Texts for Web Dynpro Applications

Help Texts for End Users

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 define a help text (info object) that was created in the Knowledge Warehouse.

1. In the Web Dynpro explorer go to Properties for the application or window where you want to create the help link.

2. Choose Help Links.

   An overview of all existing help links appears, which you can display by choosing the Test Help Link symbol. In change mode you can change or delete the help links, or change the text that is displayed as the title in the help browser window.

3. To create an additional help link, choose Append Line.

   You go automatically to the Knowledge Warehouse system where you can select the context, area, structure, and the required info object.

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

   The title of the topic from Knowledge Warehouse is automatically suggested in the Text (OTR) field as the title for the browser window, and is created as an OTR text. You can also change this text by overwriting it, or replacing it with an OTR alias in the notation $OTR:alias name. Alternatively, you can add the title using the Web Dynpro Text Browser.

   Note

   If you use an OTR alias, a where-used list for the alias text is available in the Usage field.

4. Choose OK.

   Your new help link has been added to the list of existing help links.

5. Save your entries.

Calling Help

As an end user you can call help in your application using the F1 help key, or you choose the relevant help link, if available. Depending on how the Help Center is configured, it appears next to your application in the side panel, or in a new browser window (see application parameter WDHELPCENTERDISPLAY). The section Worth Knowing contains help links to Knowledge Warehouse documentation.

Activating the Help Center

To activate the display of the Help Center, proceed as described in Activating and Configuring the Help Center for SAP Applications.

More information: Providing Information for users in the Help Center and Help Center for Web Dynpro ABAP Applications

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.
            

Title in the Business Client

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

Help Texts for Developers

In the system you can create developer documentation for Web Dynpro components and controllers. To do this, in the development environment use function Component Documentation or Controller Documentation in the respective component or controller.

Both these documentation classes can also be accessed using the documentation maintenance transaction (SE61) and single object editing.

• WD

  Abbreviation for the documentation for components/component interfaces.

• WC

  Abbreviation for the documentation for controllers (including component controllers, custom controllers, view controllers, and window controllers).

As with the other documentation objects in the system, these documentation objects are linked to the transport, correction and translation systems.