Chapter 10 online help & documentation1
Download as PPT, PDF0 likes840 views
This document discusses online help and documentation functions in SAP. It describes how to create and view documentation for data elements, including data element documentation displayed for all related fields when F1 is pressed and optional supplemental documentation specific to each screen. It also mentions documenting tables, structures and domains, and storing data element supplements and their references in table THLPF.
Chapter 10 online help & documentation1
- 1. Online Help & Documentation March-2005 Online Help & Documentation | 2.10
- 2. Objectives • The participants will be able to: – View the Documentation for Dictionary Objects. – Use the F1 and F4 Help functions. – Describe how to create data element documentation/supplemental documentation. March-2005 Online Help & Documentation | 2.10 2
- 3. Online Help & Documentation March-2005 Online Help & Documentation | 2.10 3 F4: Possible Input Values F1: Field Help DE doc. DE supp. doc. Other documentation: Tables Structures Domains
- 4. Data Element Documentation March-2005 Online Help & Documentation | 2.10 4 Data element documentation is displayed for all fields which refer to the data element. Data element supplemental documentation reflects screen-specific information for an input field. When the user hits the F1 key, both data element documentation and data element supplemental documentation is displayed (if each is maintained).
- 5. Creating Data Element Documentation March-2005 Online Help & Documentation | 2.10 5 1. Transaction SE61 2. Enter the Data Element Name 4. Enter appropriate Documentation 3. Click Create 5. Save
- 6. Demonstration • Creation of documentation for a Data Element. March-2005 Online Help & Documentation | 2.10 6
- 7. Practice • Creation of documentation for a Data Element. March-2005 Online Help & Documentation | 2.10 7
- 8. Table THLPF March-2005 Online Help & Documentation | 2.10 8 Program Screen Table/field No entry necessary DE Supplement number Data element supplements, along with their program, screen, and table/field references, are contained in table THLPF.
- 9. Creating Primary and Secondary Documentation March-2005 Online Help & Documentation | 2.10 9
- 10. Summary • Documentation can be created for Tables/structures, Domains & Data Elements. • Data element documentation is displayed for all fields which refer to the data element. • Data element supplemental documentation reflects screen- specific information for an input field. • When the user hits the F1 key, both data element documentation and data element supplemental documentation is displayed (if each is maintained). • Data element supplements, along with their program, screen, and table/field references, are contained in table THLPF. March-2005 Online Help & Documentation | 2.10 10
- 11. Questions • What documentation is displayed with the F1 function button ? • What are the different ways Data element documentation and data element supplemental documentation ? • What is displayed with the F4 function button ? March-2005 Online Help & Documentation | 2.10 11
Editor's Notes
- #4: Documentation can be created for the following ABAP Dictionary objects: Tables/structures (used as technical information, available in a Table manual if program RSSDOCTB is run) Domains (used as technical information, not displayed in online help) Data elements (used in online help - F1) Data element documentation and supplemental documentation is called when using F1 help on an input field. Allowed input values are revealed with F4 help. These values are derived from: Domain values Foreign keys Search Helps
- #5: Documentation for tables/structures and domains can be created within the ABAP Dictionary maintenance screen for the object. Use menu path Goto Documentation. In this chapter, we will focus on data element documentation and supplemental documentation. Data element documentation is field-specific and is displayed for all fields which refer to the data element. Data element supplemental documentation reflects screen-specific information for an input field. When the user hits the F1 key, both data element documentation and data element supplemental documentation is displayed (if each is maintained).
- #6: Data element documentation and data element supplemental documentation can be created in several ways: Transaction SE61 Within the ABAP Dictionary: Change Data Element maintenance screen Through F1 help Through the Screen Painter To create data element documentation and/or supplemental documentation from a screen: Place the cursor on the screen field for which you want to create documentation. Click the F1 key. Click the ‘Edit Documentation’ button and you will be prompted to create data element documentation or supplemental documentation. To create documentation and/or supplemental documentation from the screen painter (tcode: SE51): Position the cursor on the appropriate input field and use the following menu path: Goto Documentation Data element doc., or Goto Documentation DE supplement doc.
- #9: Supplemental documentation entered from the screen or screen painter is maintained automatically in table THLPF. To view this, do the following: On the screen for which supplemental documentation has been created, go to System Status and find the program (GUI) and screen number. Go to System Services Maintenance Extended table maintenance. Type THLPF in the Table input field and click Display. Scroll to the bottom of the table display. Click the ‘Position’ button at the bottom and type the Program (GUI) and Screen Number and hit enter. This will search for the entry which the system created in the table for your supplemental documentation. The system will scroll through the table entries to display those entries matching your search criteria. Data element supplements, along with their program, screen, and table/field references, are contained in table THLPF. Entries in this table are created automatically if the data element supplement was created through the Screen Painter or through F1 help. Entries in this table must be made manually if the data element supplement was created through the ABAP Dictionary or through transaction SE61 (System Services Maintenance Expended table maintenance). If these entries are not made, the data element documentation will not be displayed when the user hits F1 on the input field.
- #10: Data element documentation and supplemental documentation can be created in the ABAP Dictionary: Change Data Element screen. Navigate through the ABAP Dictionary to the Data Element you want to create documentation for Click the Documentation button to create or maintain Data Element Documentation Click the Supplementary documentation button to create or maintain Data Element Supplementary Documentation