21
Field Help (Documentation and or Supplementary /Additional Documentation) 1 of 21 Creating Field Help Prerequisites 1) Transport Request [see StepByStepCreateTransportRequestUsingSE80.pdf] 2) Package [use the package created in the first class] or create new [see StepByStep_ABAP_Create_Package.doc] 3) Copy Z027393_007A as Z027393_009A [See StepByStep_Copy_Function_Group_Program.pdf] Instead of creating from scratch we are using an exiting program, duplicating it and making changes. First copy the program and continue from here. Note: There are three methods for creating the Field Help 1) Method 1: Documentation: Here the data element documentation help is specified in the ABAP dictionary for every data element by using Go To > Documentation menu. 2) Method 2: Additional Documentation: This is used in case the data element documentation help is not applicable, here the additional documentation is entered that can be called from the dynpro using the Process on Help Request (POH) event as shown below. PROCESS ON HELP-REQUEST. FIELD fieldname WITH num. 3) Method 3: This is a custom help where you may call your own screens etc from a module mod that in turn is trigger by the Process on Help Request (POH) event as shown below. PROCESS ON HELP-REQUEST. FIELD fieldname MODULE mod. In the following instructions, we are creating Field Help using the 1 st and 2 nd methods. Step by Step Instructions (complete prerequisites shown above before you proceed) Launch SE80. Ensure that you are on the ‘Repository Browser’. Select Package from the drop down and enter your Package name [ZxxxxxxA], then click on the [Display] button. Your Function Group should be displayed below the package [if it was previously copied correctly to this package.] Open the Function Group Zxxxxxx_009A that was previously copied from Zxxxxxx_007A (if not already opened.)

Step bystep abap_field help or documentation

  • Upload
    mkpatil

  • View
    1.727

  • Download
    2

Embed Size (px)

DESCRIPTION

 

Citation preview

Page 1: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

1 of 21

Creating Field Help Prerequisites

1) Transport Request [see StepByStepCreateTransportRequestUsingSE80.pdf] 2) Package [use the package created in the first class] or create new [see

StepByStep_ABAP_Create_Package.doc] 3) Copy Z027393_007A as Z027393_009A [See

StepByStep_Copy_Function_Group_Program.pdf] Instead of creating from scratch we are using an exiting program, duplicating it and making changes. First copy the program and continue from here. Note: There are three methods for creating the Field Help 1) Method 1: Documentation: Here the data element documentation help is specified in the ABAP dictionary for every data element by using Go To > Documentation menu. 2) Method 2: Additional Documentation: This is used in case the data element documentation help is not applicable, here the additional documentation is entered that can be called from the dynpro using the Process on Help Request (POH) event as shown below. PROCESS ON HELP-REQUEST. FIELD fieldname WITH num. 3) Method 3: This is a custom help where you may call your own screens etc from a module mod that in turn is trigger by the Process on Help Request (POH) event as shown below. PROCESS ON HELP-REQUEST. FIELD fieldname MODULE mod. In the following instructions, we are creating Field Help using the 1st and 2nd methods. Step by Step Instructions (complete prerequisites shown above before you proceed) Launch SE80. Ensure that you are on the ‘Repository Browser’. Select Package from the drop down and enter your Package name [ZxxxxxxA], then click on the [Display] button. Your Function Group should be displayed below the package [if it was previously copied correctly to this package.] Open the Function Group Zxxxxxx_009A that was previously copied from Zxxxxxx_007A (if not already opened.)

Page 2: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

2 of 21

To display the property page, double click on the program name (node - Zxxxxxx_009A). The properties may be updated by clicking on the [Change <> Display] icon (Ctrl+F1). If any values are updated (example: the short text), ensure they are saved by clicking on the [Save] button.

Now, click on the [Main program] button.

Page 3: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

3 of 21

After the main program is opened, toggle the [Change <> Display] icon (Ctrl+F1) to update the program code. Note the name of the Main Program [SAPLZ027393_009A] it will be used to create a transaction code (T-code) later.

Add description on the top as shown. *&---------------------------------------------------------------------* *& Module Pool Z027393_009A *& DEMO -> Field Help (Documemtation and Additional Documentation.) *&---------------------------------------------------------------------*

Save the program. Activate the Function Group by clicking on the [Activate] button on the top tool bar.

Page 4: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

4 of 21

If a list of objects to be activated is provided, select all the objects (related to this program), by clicking on each of them and then click on the [Continue] button or [hit Enter] to activate them all. Before we make any changes to create the Input Help, we will confirm that the program runs fine using the T-Code. If you have not created a Transaction Code while copying the program, create it now. To create a Transaction Code (T-Code), we need the name of the Function Group Main program [SAPLZ027393_009A] and use following menu in SE80 (or by directly using T-Code SE93 – not shown here.)

Page 5: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

5 of 21

Enter the Transaction Code name and a short description. Leave remaining fields as default as shown below on this screen. Click [Continue] or hit [Enter].

Page 6: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

6 of 21

Page 7: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

7 of 21

Enter program name as [main program - SAPLZ027393_009A] and the (starting) Screen number as [0100]. Save. Accept the Package and the Transport Request in the subsequent screens. Run the program by entering the T-code/Transaction Code [Z027393_009A] or [/nZ027393_009A], to confirm that the program runs fine. Note: /n is required if you are not currently in the SAP Easy Access screen, but in another transaction. Note: If the program is not working correctly, check the name of the Functions and the Program name in three places – see next 3 screenshots. Update if necessary.

Page 8: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

8 of 21

Page 9: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

9 of 21

Page 10: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

10 of 21

Save and Activate. After you ensure that you have a working program to get started, the following (new) changes that will demo the Field Help may be done. METHOD 1: We need to add the documentation to the Date Element of the field that needs the F1 help documentation. To access the Data Element, we can access the Table first, then the Field, and finally the Data Element. Open the Function Group and access the TOP include (LZ027393_009ATOP) [or directly using the T-Code se11 – Dictionary: Maintain Table]

Page 11: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

11 of 21

Double click on the Table name ZBC400_S_DYNCONN shown above (highlighted.) The Table definition is displayed.

Page 12: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

12 of 21

Double click on the ZCITYFROM Data Element. Click on the [Display <> Update] button to make this data element updateable.

Page 13: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

13 of 21

Now click on the ‘Documentation’ button displayed on the top tool bar.

Page 14: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

14 of 21

After the Documentation is entered, Click on Save and Activate (the Documentation.) Then click on the green back button two time to get back to the Table Definition, or go back to TOP include (LZ027393_009ATOP) and Double click on the Table name ZBC400_S_DYNCONN. METHOD 2: To demo method 2 (Supplementary/Additional Documentation) access a different field ZCITYTO. Double click on the ZCITYTO Data Element.

Page 15: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

15 of 21

Click on the [Display <> Update] button to make this data element updateable.

Page 16: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

16 of 21

Now click on the ‘Supplementary Documentation’ button displayed on the top tool bar.

Page 17: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

17 of 21

Enter ‘0001’ for the Data Element Suppl field. Click on [Change] button shown above.

After entering the supplementary documentation, Save and Activate it. Click on the green back button. Then click on the sub screen 0202 (because this has the CITYTO field), and access the Flow Logic Tab. Enter the code shown below for the POH Logic. PROCESS ON HELP-REQUEST. FIELD ZBC400_S_HDR_CURR-CITYTO WITH '0001'.

Page 18: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

18 of 21

Save and Activate. Run the program, using its T-Code created earlier.

Page 19: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

19 of 21

Click (one time) on the CITYFROM field (to move cursor focus) and then hit the F1 help button.

Page 20: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

20 of 21

The Documentation is displayed as shown above. Exit the documentation by clicking on the [x] at the top right corner. Now access the second tab and click (one time) on the CITYTO field.

Page 21: Step bystep abap_field help or documentation

Field Help (Documentation and or Supplementary /Additional Documentation)

21 of 21

Advantage of using the Additional or Supplementary documentation is that we can define multiple instances of the supplementary documentation (‘0001’, ‘0002’, ‘0003’, etc) and call the appropriate [supplementary] documentation from any DYNPRO screen - based on requirement of the field. In other words, theoretically we could have various different [numerous] documentation for one field and any one of these could be accessed - depending on the DYNPRO screen the field is displayed.