Skip to Content
3

Can SAP provide JSDoc based Documentation for the standard Fiori apps?

Apr 25, 2017 at 08:25 PM

228

avatar image

Hello SAP Fiori Developers,

currently I'm involved in an implementation of the Fiori App: My Opportunities for SAP CRM on Premise. As we have some custom fields we need to make use of the provided UI Controller Extensions. Unfortunately the descriptions in the Fiori Apps Library -> IMPLEMENTATION INFORMATION -> Extensibility do not match the functionality that is described in the @ControllerHook annotations in the SAP delivered source of the standard application. The examples below show some samples for the S5.controller.js (Sorry for the formatting but the new SAP Community doesn't allow tables):

Hook Name: extHookAppendConfigOperation

Hook Use: Allows you to bypass the default determination handler method and handle the returned partner data
JSDoc: custom logic for getting the configuration. For example, add the new URL for getting the configuration.

Hook Name: extHookCustomHandleOrgData
Hook Use: Allows you to switch on the lazy load of error message
JSDoc: allow customer to bypass the default determination returned partners data handle logic (fill out participants list automatically). And to add the custom handler method.

Hook Name: extHookCustomHandlePartnerData

Hook Use: Allows you to bypass the default determination handler method and handle the returned organization data
JSDoc: allow customer to bypass the default determination returned partners data handle logic (fill out participants list automatically). And to add the custom handler method.

Hook Name: extHookCustomInit

Hook Use: Allows you to customize logic for the newly added extension points
JSDoc: provides the flexibility to init customer's code. For example, switch on and off the determination; attach the new event.

As you see the JSdoc is matching the functionality better. Even when the documentation for the extHookCustomHandleOrgData hook wasn't adjusted to org-data instead of partner data.

But why is this documentation buried in code? I think it would make sense to make it available either at help.sap.com or in the Fiori Apps Library.

I've tried to create the documentation on my own but as the tag @ControllerHook is not part of the standard JSDoc templates it was not extracted. I would guess SAP has JSDoc template which takes care of that.

Best regards
Gregor

10 |10000 characters needed characters left characters exceeded
* Please Login or Register to Answer, Follow or Comment.

1 Answer

Sven Krueppel-Berndt
May 31, 2017 at 04:52 PM
2

Hi Gregor,

the source code annotations are just comments by developers. Those comments are extracted and are achor points for the official documentation of the extension points, which are stored in the file extensionDocu.properties resp. extensionDocu.template.properties of the archive ...extPointDocu.zip. The content of this file is uploaded to the Fiori apps reference library. If the quality of this documentation is not sufficicient, please create a support ticket on the component of the app.

Best regards
Sven Krüppel-Berndt

Show 1 Share
10 |10000 characters needed characters left characters exceeded

Hi Sven,

thank you for the update. Should I able to find the extensionDocu.properties or the archive ...extPointDocu.zip in the BSP container of my ABAP system where the app is installed? If not i still think it would be a great help to have a possibility to get the JSDoc template out to the community.

Best regards
Gregor

0