Function module Documentation

[Former Member]

Hello,

I am creating the documentation for custom function module and below are the steps i performed

1. Goto->documentation. Gave the modification name as ZTest and selected  Template(with header) radio button.

2. It gave me 4 header templates. &functionality&, &Example&, &Hints& &Further_sources_of_inf&

Here are my questions.

1. When i change any of the headers  for eg :   change &Example& to &Example1& and activate it, i dont see the header at all.

2.  After activating, when i come back to function module and click on 'Function module documentaion' button, the text displayed in word document instead of SAP standard editor to show the help text.

3. How to create  links to perticular texts. For example, i would like to list the input parameters of the FM and would like to explain each parameters separately by making a hyperlink to each of those parameters.

Appriciate you response.

[Former Member]

Hi Ramso,

Point 1:

&EXAMPLE& is SAP standard.

Remove & if you like to give your custom header.

Can use appropriate header paragraph format if font size needs to be changed.

Point 2:

In menu bar, there is an option 'Change Editor'.

You can switch between Word editor and SAP editor.

Point 3:

PFB link:

http://help.sap.com/saphelp_nw70/helpdata/en/a4/d47e8049e111d189730000e8322d00/frameset.htm

Links to other objects

To insert a link in your document, proceed as follows:

2. Position the cursor to where you want to insert the link.
4. Choose Include
5. ® Link. A
   dialog box for selecting the type of link appears.
6. 
   
   • Select a document class or action in the Link target type field.
   • Enter the name of the object you want to link to and the text you want to
     insert in your document as a hotspot (Link text).
   • Choose Continue. The link is inserted into the text.
   • Test the link: Choose Document
7. ® Screen output
   and double-click on the highlighted text.

Regards,

Nisha Vengal.

[Former Member]

thank you Nisha,

but for the 2nd point, the 'change editor' option will be used to switch between editors to input our commands.

But the problem iam having is, when i click on the 'function module document' button from se37, it directly taking me to the word editor by default instead of showing it in the 'performance assistant screen'.

This is happening only to my custom FMs. when i click on the 'function module document' button for the standard FM it shows it in 'performance assitant screen'.

[Former Member]

Hi Ramso,

i have a simple logic for it.

have your function module in change mode. click on Function module Documentation , forget about its headers here you could give what you like and what describes your function module the best save and activate it.

Your function module doc is ready, you can see the same by having your function module in display mode.

Now about the links of your input parameters document. Go to input/export/tables parameters you would find 'Long text' there, open it in change mode and provide document for your parameters. save and activate it.

now open your function module document in display mode, you would find what you are looking for there in your document.

Regards,

Satish Chandra

[Former Member]

Hi Ramso,

I am not sure what could be the issue.

1.

Which is your SAP version ? 4.7 / ECC ?

2.

Are you trying to check in "Display" mode ?

SE37-Enter FM name - Display FM code - Click 'Function Module Documentation' button

3.

Please check if SAP standard tool bar- User settings - Perfomance Assistant, modal window etc. are correct.

4.

Also probably you can just logout and login and test again.

Test from your colleagues's machine too.

5.

Is the Documentation activated after editing ?

PFB related links:

SAP note 1079479 : http://search.sap.com/notes?id=0001079479  

                  954128 :  http://search.sap.com/notes?id=0000954128

http://scn.sap.com/thread/736458

http://scn.sap.com/thread/478256

Regards,

Nisha Vengal.

[Former Member]

1. I have ECC6

2. Yes, iam trying to check in display mode in se37

3. yes they are correct

4. tried, but still the same

5. Yes, it is activated.

The only change i noticed between standard FM and my custom FM is .. for the custom FM there is an entry created in table SMODILOG with INT_TYPE = 'DOCU'.No standard FM have this entry created.

After debugging deeply, i figured this is what causing the issue. If i remove this entry from the table, it works fine. But nor sure it its the correct way of doing it.

[Former Member]

Hi Ramso,

Good work !

I got an interesting SAP note  772807: http://search.sap.com/notes?id=0000772807

Did you create Documentation in Original Language (DE, German) and then created EN version also ?

Regards,

Nisha Vengal.

[Former Member]

Thanks for the note.

No, i Just created in it in EN. Is that the problem?

[Former Member]

Hi Ramso,

I am not quite sure.

Can you try creating in Original Language also (If DE text is not available, can paste EN text itself).

Let me know if it still doesn't work.

Regards,

Nisha Vengal.

[Former Member]

Still the same result.

Would you mind creating a sample custom FM and create FM documentation and see if it opens in word editor or in performance assistance screen.

thank you very much for ur help so far.

[Former Member]

Hi Ramso,

i have a simple logic for it.

have your function module in change mode. click on Function module Documentation , forget about its headers here you could give what you like and what describes your function module the best save and activate it.

Your function module doc is ready, you can see the same by having your function module in display mode.

Now about the links of your input parameters document. Go to input/export/tables parameters you would find 'Long text' there, open it in change mode and provide document for your parameters. save and activate it.

now open your function module document in display mode, you would find what you are looking for there in your document.

Regards,

Satish Chandra