Application Development Discussions
Join the discussions or start your own on all things application development, including tools and APIs, programming models, and keeping your skills sharp.
cancel
Showing results for 
Search instead for 
Did you mean: 

Is there a comprehensive UI5 Annotation Reference and Guide somewhere?

martinc_mb
Participant
433

Something I am struggling to understand is the concept of local annotations to OData service metadata in UI5 apps (specifically for OData v4, I think...).

I have managed to do little things like make an input multi-line, or hide and element, by using examples gleaned from here or there, but I cannot find any comprehensive reference on annotations, and especially a good guide that explains the basic concepts, and how annotations are structured (For example, when and how do you use Collection and Record and Propertypath elements, etc).

There are little bits of documentations and blogs that show how to do one thing all over the place, so it's really a lot of trial and error (and mostly error!) and little to no success.

If anyone knows of a comprehensive body of documentation that covers this topic, please share!

4 REPLIES 4

Marian_Zeis
Active Contributor
0 Kudos
368

Best way is to create annotation in your Backend System and not locally (CAP or RAP).

You can find showcases here:

RAP: https://github.com/SAP-samples/abap-platform-fiori-feature-showcase 
CAP: https://github.com/SAP-samples/fiori-elements-feature-showcase 

More information about the annotions in this blog post:
https://community.sap.com/t5/technology-blogs-by-sap/vocabulary-based-annotations/ba-p/13046984 

0 Kudos
354

Hello Marian, thanks for the reply.

However, in situations where you should or need to make use of local UI5 annotations, there must surely be a comprehensive guide from SAP on how to use it; after all, they show it here and there in the SDK documentation as a viable options, so it's reasonable to expect there should be some better documentation for it. 

0 Kudos
277

Hello Peter, thanks, I've looked through all of that as well, but that is far from comprehensive! It really only touches lightly on the subject and in the SDK. Moreover, the first link expressly says that it has not been updated for OData v4.

Surely SAP must have detailed documentation on this internally. How about making that available to the community?