Skip to Content

Fiori OData Annotations - documentation?

With the release of the Fiori Overview Page and a few blogs giving a quick overview of its use, I'm wondering where I can not get detailed information about creating annotation files for use in the WebIDE's OVP plugin..?

Iv'e seen the introduction blogs listed here (SAP Fiori Overview Page) but to do anything usable with OVP we need the full doco. ;-)

Add a comment
10|10000 characters needed characters exceeded

Assigned Tags

Related questions

4 Answers

  • Best Answer
    Posted on Dec 15, 2015 at 10:53 AM
    Add a comment
    10|10000 characters needed characters exceeded

    • Thanks for the response Raz. I think I'll mark this as answered for now and wait for the coming information...

      I have read the comments on the blog you mentioned and managed to get a basic OVP working with the List and Table Cards but thats it - very hard to chagne it up without knowing the details on the annotations schema, etc. The SAPUI5 help does mention these things but doesn't do it for me either. ;-)

      Looking forward to the future updates. Thanks.

  • Posted on Dec 17, 2015 at 01:15 PM

    Hi Jason,

    If you want to know annotation structure for a particular OVP card, you can enable debug mode first and then trace corresponding XML fragment file. For example,

    • List card: List.fragment.xml
    • Stack card: Quickview.fragment.xml and ObjectList.fragment.xml
    • Table card: Table.fragment.xml

    If you want to dig it by yourself, it's a way to figure out the puzzle. Cheers.

    Kind Regards,

    Nick

    Add a comment
    10|10000 characters needed characters exceeded

  • author's profile photo Former Member
    Former Member
    Posted on Jan 11, 2016 at 02:45 PM

    Hi Jason,

    I was trying to create Chart card , but i am not able to get data in the card.

    I have followed below link.

    Analytic Cards - User Interface Add-On for SAP NetWeaver - SAP Library

    I Used Northwind odata model to do pracitce.

    I am not sure how to create annotation file in case of Analytic Cards.

    Below is the code for my Manifest and annotation file which i have tried.

    Annotation file

    <Schema Namespace="NorthwindModel" sap:schema-version="1" xmlns="">

    <Annotations Target="NorthwindModel.Summary_of_Sales_by_Year" xmlns="">

    <Annotation Qualifier="SummaryOfSalesByYear" Term="com.sap.vocabularies.UI.v1.Chart">

    <Collection>

    <Record Type="com.sap.vocabularies.UI.v1.DataField">

    <Annotation EnumMember="com.sap.vocabularies.UI.v1.ImportanceType/High" Term="com.sap.vocabularies.UI.v1.Importance" />

    <PropertyValue Property="Value" Path="OrderID"/>

    </Record>

    <Record Type="com.sap.vocabularies.UI.v1.DataField">

    <Annotation EnumMember="com.sap.vocabularies.UI.v1.ImportanceType/High" Term="com.sap.vocabularies.UI.v1.Importance" />

    <PropertyValue Property="Value" Path="ShippedDate"/>

    </Record>

    <Record Type="com.sap.vocabularies.UI.v1.DataField">

    <Annotation EnumMember="com.sap.vocabularies.UI.v1.ImportanceType/High" Term="com.sap.vocabularies.UI.v1.Importance" />

    <PropertyValue Property="Value" Path="Subtotal"/>

    </Record>

    </Collection>

    </Annotation>

    </Annotations>

    </Schema>

    Manifest Files :

    I have only added this part which is IMP.

    "sap.ovp": { "_version": "1.1.0", "globalFilterModel": "NorthwindModel", "globalFilterEntityType": "Summary_of_Sales_by_Year", "cards": { "cardchartsline": { "model": "NorthwindModel", "template": "sap.ovp.cards.charts.line", "settings": { "category": "{{cardchartsline_category}}", "entitySet": "NorthwindEntities.Summary_of_Sales_by_Years", "selectionAnnotationPath": "com.sap.vocabularies.UI.v1.SelectionVariant#SummaryOfSalesByYear", "chartAnnotationPath": "com.sap.vocabularies.UI.v1.Chart#SummaryOfSalesByYear", "presentationAnnotationPath": "com.sap.vocabularies.UI.v1.PresentationVariant#SummaryOfSalesByYear", "dataPointAnnotationPath": "com.sap.vocabularies.UI.v1.DataPoint#SummaryOfSalesByYear", "idenfiticationAnnotationPath": "com.sap.vocabularies.UI.v1.Identification#SummaryOfSalesByYear" } } } }

    Please reply.

    Thanks,

    JP

    Add a comment
    10|10000 characters needed characters exceeded

    • Hi Raz,

      I am trying to create analytic card but not getting any data in it i.e (cannot load a data in card) .I had created annotation file taking reference from SAPUI5 SDK - Demo Kit .

      Getting error in console

      resource ChartOverview/Component-changes.json could not be loaded from ../Component-changes.json. Check for 'file not found' or parse errors.

      Uncaught (in promise) TypeError: s[P].push is not a function(…)

      Annotation.xml

      <Annotations Target="NorthwindModel.Summary_of_Sales_by_Year" xmlns="http://docs.oasis-open.org/odata/ns/edm">

      <Annotation Qualifier="DataPoint" Term="UI.DataPoint">

      <Record>

      <PropertyValue Property="Title" String="{@i18n&gt;@ORDERID}"/>

      <PropertyValue Path="OrderID" Property="Value"/>

      <PropertyValue Property="Criticality" String="UI.CriticalityType/Negative"/>

      <PropertyValue Property="Trend" String="UI.TrendType/Down"/>

      <PropertyValue Property="CriticalityCalculation">

      <Record Type="UI.CriticalityCalculationType">

      <PropertyValue Property="ImprovementDirection" String="UI.ImprovementDirectionType/Maximize"/>

      <PropertyValue Path="Subtotal" Property="ToleranceRangeLowValue"/>

      <PropertyValue Path="Subtotal" Property="ToleranceRangeHighValue"/>

      </Record>

      </PropertyValue>

      <PropertyValue Property="ValueFormat">

      <Record Type="UI.NumberFormat">

      <PropertyValue Decimal="1000" Property="ScaleFactor"/>

      <PropertyValue Byte="1" Property="NumberOfFractionalDigits"/>

      </Record>

      </PropertyValue>

      <PropertyValue Property="TrendCalculation">

      <Record Type="UI.TrendCalculationType">

      <PropertyValue Path="Subtotal" Property="ReferenceValue"/>

      <PropertyValue Decimal="100" Property="UpDifference"/>

      <PropertyValue Decimal="200" Property="StrongUpDifference"/>

      <PropertyValue Decimal="100" Property="DownDifference"/>

      <PropertyValue Decimal="200" Property="StrongDownDifference"/>

      </Record>

      </PropertyValue>

      </Record>

      </Annotation>

      <Annotation Qualifier="SelectionVariant" Term="UI.SelectionVariant">

      <Record>

      <PropertyValue Property="SelectOptions">

      <Collection>

      <Record Type="UI.SelectOptionType">

      <PropertyValue Property="PropertyName">

      <PropertyPath>OrderID</PropertyPath>

      </PropertyValue>

      </Record>

      </Collection>

      </PropertyValue>

      </Record>

      </Annotation>

      <Annotation Qualifier="Chart" Term="UI.Chart">

      <Record>

      <PropertyValue Property="Measures">

      <Collection>

      <PropertyPath>Subtotal</PropertyPath>

      </Collection>

      </PropertyValue>

      <PropertyValue Property="Dimensions">

      <Collection>

      <PropertyPath>Subtotal</PropertyPath>

      </Collection>

      </PropertyValue>

      <PropertyValue Property="ChartType" String="UI.ChartType/Line"/>

      <PropertyValue Property="MeasureAttributes">

      <Collection>

      <Record Type="UI.ChartMeasureAttributeType">

      <PropertyValue Property="Measure">

      <PropertyPath>Subtotal</PropertyPath>

      </PropertyValue>

      <PropertyValue Property="Role" String="UI.ChartMeasureRoleType/Axis1"/>

      </Record>

      </Collection>

      </PropertyValue>

      <PropertyValue Property="DimensionAttributes">

      <Collection>

      <Record Type="UI.ChartDimensionAttributeType">

      <PropertyValue Property="Dimension">

      <PropertyPath>Subtotal</PropertyPath>

      </PropertyValue>

      <PropertyValue Property="Role" String="UI.ChartDimensionRoleType/Series"/>

      </Record>

      </Collection>

      </PropertyValue>

      </Record>

      </Annotation>

      <Annotation Qualifier="groupbyandorder" Term="UI.PresentationVariant">

      <Record>

      <PropertyValue Int="1" Property="InitialExpansionLevel"/>

      <PropertyValue Property="GroupBy">

      <Collection>

      <PropertyPath>OrderID</PropertyPath>

      </Collection>

      </PropertyValue>

      <PropertyValue Property="TotalBy">

      <Collection>

      <PropertyPath>Subtotal</PropertyPath>

      </Collection>

      </PropertyValue>

      <PropertyValue Property="Total">

      <Collection>

      <PropertyPath>ShippedDate</PropertyPath>

      </Collection>

      </PropertyValue>

      <PropertyValue Property="Visualizations">

      <Collection>

      <AnnotationPath>@UI.Chart#Chart</AnnotationPath>

      </Collection>

      </PropertyValue>

      <PropertyValue Property="RequestAtLeast">

      <Collection>

      <PropertyPath>OrderID</PropertyPath>

      </Collection>

      </PropertyValue>

      <PropertyValue Property="SortOrder">

      <Collection>

      <Record Type="Common.SortOrderType">

      <PropertyValue Property="Property">

      <PropertyPath>Subtotal</PropertyPath>

      </PropertyValue>

      <Annotation EnumMember="UI.ImportanceType/High" Term="UI.Importance"/>

      </Record>

      </Collection>

      </PropertyValue>

      </Record>

      </Annotation>

      </Annotations>

      Manifest.json

      "sap.ovp": {

      "_version": "1.1.0",

      "globalFilterModel": "NorthwindModel",

      "globalFilterEntityType": "Summary_of_Sales_by_Year",

      "cards": {

      "card00": {

      "model": "NorthwindModel",

      "template": "sap.ovp.cards.charts.line",

      "settings": {

      "category": "{{card00_category}}",

      "entitySet": "Summary_of_Sales_by_Years",

      "selectionAnnotationPath": "com.sap.vocabularies.UI.v1.SelectionVariant#SelectionVariant",

      "chartAnnotationPath": "com.sap.vocabularies.UI.v1.Chart#Chart",

      "presentationAnnotationPath": "com.sap.vocabularies.UI.v1.PresentationVariant#groupbyandorder",

      "dataPointAnnotationPath": "com.sap.vocabularies.UI.v1.DataPoint#DataPoint",

      "idenfiticationAnnotationPath": "com.sap.vocabularies.UI.v1.Identification#DataPoint"

      }

      }

      Regards,

      Abhishek lohiya

  • author's profile photo Former Member
    Former Member
    Posted on Jan 22, 2016 at 01:46 PM

    Hi All,

    I am trying to create analytic card but not able to get any chart in card.I created annotation file by myself taken reference from Analytic Cards - User Interface Add-On for SAP NetWeaver - SAP Library

    but not able to get charts .

    Kindly help me out with annotation.

    Regards,

    Ayushi

    Add a comment
    10|10000 characters needed characters exceeded

    • Hi All,

      There are quite a few of you who are posting questions to this already answered Discussion. Please create a new Discussion marked as a Question. Since the solution posted here does not appear to solve your problem, you have a different problem. The Rules of Engagement refer to this as necromancy which is defined as a violation. While your issues are similar or related to the subject of this Discussion, your solutions will be more visible to others if not buried in a Discussion which already has a different solution already identified. If a Discussion (or a Blog or Document) is related, put in a link.

      NOTE: Getting the link is easy enough for both the author and Blog. Simply MouseOver the item, Right Click, and select Copy Shortcut. Paste it into your Discussion. You can also click on the url after pasting. Click on the A to expand the options and select T (on the right) to Auto-Title the url.

      Thanks, Mike (Moderator)

      SAP Technology RIG

      This thread is now locked.

Before answering

You should only submit an answer when you are proposing a solution to the poster's problem. If you want the poster to clarify the question or provide more information, please leave a comment instead, requesting additional details. When answering, please include specifics, such as step-by-step instructions, context for the solution, and links to useful resources. Also, please make sure that you answer complies with our Rules of Engagement.
You must be Logged in to submit an answer.

Up to 10 attachments (including images) can be used with a maximum of 1.0 MB each and 10.5 MB total.