SAP-docs / sapui5

This is the markdown version of the official SAPUI5 documentation from the SAPUI5 Demo Kit for external contributions.
Creative Commons Attribution 4.0 International
71 stars 116 forks source link

Fiori Element Add column to table missing crucial information #110

Closed NSXBLUE closed 2 months ago

NSXBLUE commented 4 months ago

Issue description

The documentation of extending Fiori Element responsive table is missing the name of the fragment files you are supposed to create. It mentions you need two extensions, then it provides code for the two extensions, but it only specifies the file name for the second code snippet. It took me hours to find out what I was doing wrong.

https://sapui5.hana.ondemand.com/#/topic/28e95702b5854b938ac51c4bc2d078ab.html

The first code snippet needs to mention create a file: webapp/ext/fragments/ListReportResponsiveTableCells.fragment.xml

The equivalent doc for grit table extension is also missing this crucial piece of information.

Also, the documentation fails to indicate how to deploy this FE extension and run it in Fiori Launchpad. How do you ensure your new columns will be available when users click on the original app's tile? I'm still stuck on that, trying to find other online sources to explain the process.

Thanks

Feedback Type (Optional)

examples or samples

Page Title on SAP Help Portal (prefilled)

Example: Adding Columns to a Responsive Table in the List Report

Page URL on SAP Help Portal (prefilled)

https://sapui5.hana.ondemand.com/#/topic/28e95702b5854b938ac51c4bc2d078ab.html

OlMue commented 4 months ago

Hi @NSXBLUE, thanks for your contribution! We'll look into it and get back to you.

mishuagrawal commented 4 months ago

Hello @NSXBLUE, we are working on your concern and will share an update here soon. Kindly bear with us while we try to resolve this. Thank you!

anjan-poonacha commented 4 months ago

@mishuagrawal I could add the following code in my test repository. As a result a custom column is visible.

<!-- Generate the custom column fragment -->
<!-- fragments/ResponsiveTableColumns.fragment.xml -->
<core:FragmentDefinition xmlns:core="sap.ui.core" xmlns="sap.m">
    <!--Column 1 Header-->
    <Column id="textColumn">
        <Text text="Extension Column"/>
        <customData>
            <core:CustomData key="p13nData" value="\{'columnKey': 'CustomColumn1', 'leadingProperty': 'Depth', 'columnIndex': '101'}"/>
        </customData>
    </Column>
</core:FragmentDefinition>
<!-- Generate custom cell fragment -->
<!-- fragments/ResponsiveTableCells.fragment.xml -->

<core:FragmentDefinition xmlns:core="sap.ui.core" 
    xmlns="sap.m">
    <!--Column 1 Cell-->
    <Text text="Breakout Column"></Text>
</core:FragmentDefinition>
// Add extension settings to the manifest
// manifest.json

"sap.ui.viewExtensions": {
    "sap.suite.ui.generic.template.ListReport.view.ListReport": {
        "ResponsiveTableColumnsExtension|STTA_C_MP_Product": {
            "className": "sap.ui.core.Fragment",
            "fragmentName": "stta.prod.man.typescript.ext.fragments.ResponsiveTableColumns",
            "type": "XML"
        },
        "ResponsiveTableCellsExtension|STTA_C_MP_Product": {
            "className": "sap.ui.core.Fragment",
            "fragmentName": "stta.prod.man.typescript.ext.fragments.ResponsiveTableCells",
            "type": "XML"
        }
    }
}

image

mishuagrawal commented 3 months ago

Hello @NSXBLUE,

Thank you for your patience. As you can see, our dev has reviewed your concern and they have confirmed that they were able to add the mentioned code in the test repository and were also able to create a custom column. If you are still facing issues, please let us know.

Also, regarding the deployment of FE extension to SAP Fiori launchpad, kindly check the Deploying an Application (https://help.sap.com/docs/SAP_FIORI_tools/17d50220bcd848aa854c9c182d65b699/1b7a3be8d99c45aead90528ef472af37.html) documentation. This document is for SAP Fiori Tools.

Please let us know if this resolves your query.

Thanks and regards, Mishu Agrawal

mishuagrawal commented 3 months ago

Hello @NSXBLUE,

We are waiting to hear from you. Kindly write back to us and let us know how we can help you further in this regard.

Best, Mishu Agrawal

NSXBLUE commented 3 months ago

I guess I wasn't clear about the issue, sorry. What I'm saying is that there are two pieces of code for two fragments. One of them (the second one) clearly specifies the file name and location it needs to be saved in: /webapp/ext/fragments/ListReportResponsiveTableColumns.fragment.xml. But the first one does not.

Please see screenshot below. What is the name and location of the first fragment?

image

NSXBLUE commented 3 months ago

If you're specifying clearly the name and location of the second fragment, then the first one should also be specified.

Also regarding deployment, the link you provided was for general deployment of apps. What I think should be mentioned here is how to make sure these extensions (fragments) are being deployed, ie so when the original standard tile is executed by the user, our extensions are being executed,.

mishuagrawal commented 3 months ago

Hello @NSXBLUE,

Thank you for writing back to us. This helps. We are now working on your concerns and will get back to you soon.

Thanks and regards, Mishu Agrawal

cfg74 commented 2 months ago

Hi @NSXBLUE I would like to address your deployment question. When extensions are made to the app in your development environment, then they are part of the app's code, and will be deployed when you redeploy the now modified app. The documentation you are following assumes that the app is your own custom developed application where you own the lifecycle.

In case you want to extend an application which was delivered to you (like a SAP provided app), you have to create an adaptation project which is a different process with also partly different tooling. Please refer to https://sapui5.hana.ondemand.com/#/topic/52fc48b479314d0688be24f699778c47

mishuagrawal commented 2 months ago

Hello @NSXBLUE,

Thank you for your patience. I apologies that it took us some time to resolve your concern.

We have now enhanced the document. We have mentioned the file name and location for both the code fragments now. Regarding your deployment query, my colleagues @cfg74 has responded to it. I hope this resolves your concern.

If yes, I kindly request you to close this issue. If you have any concerns, you can reach out to us.

Thanks and regards, Mishu Agrawal

NSXBLUE commented 2 months ago

Thanks for your help. Closing the issue.

sap-doc-bot[bot] commented 1 month ago

Thank you for your valuable feedback contribution, @NSXBLUE! So that we can recognize your contribution in the SAP Community, please check your SAP Community user ID (this is a number) in your personal settings page and share it with us in a reply to this comment. Make sure you just include the number in the reply.

Your user ID is displayed as follows:

Change display name for User ID N

where N is your user ID. For example, 53 is the user ID of the user 'qmacro'.

Please note that we are currently refactoring our profile and badge system on the SAP Community, and will start assigning badges again when that's complete.