Uploaded image for project: 'PUBLIC - Liferay Portal Community Edition'
  1. PUBLIC - Liferay Portal Community Edition
  2. LPS-124236

As a content author, I want to be able to export data to an .xls file

    Details

      Description

      Motivation

      The content dashboard is the only place in the portal where content managers can see all their web contents at once, regardless of the site or asset library it is stored or published in.

      Currently there isn’t a way to export the list of contents in an easy way, and it is something that we’ve been asked for by customers and users.

      This story tries to cover the MVP for downloading the list of contents without selecting columns, metadata or dates.

      Use cases

      1. A content marketing team wants to run a content audit out of the portal or using an external tool.
      2. A content marketing team wants to plan their publications and so they need the list of available assets.(both use cases related to this spreadsheet of our content mkt team: !https://developers.google.com/drive/images/drive_icon.png!Content Creation Matrix )
      3. A company wants to upgrade / migrate and they need a way to control or audit the existing content.

      Objectives

      1. Users must be able to download a .xls file with all items in the list (considering filters applied)
      2. The ..xls file will include at least all the visible columns in the list.
      3. Users won’t be able to select columns or other metadata at the moment.

      Design

      Figma File

      Requirements

      1.There will be a button "Export" on the right top of the list to download the .xls file
      2. When clicking on the button, .xls file will automatically download (with no preferences setting)
      3. The .xls file must include all assets included in the list, considering any filters applied
      4. The .xls file must include all metadata visible in the table, that is:
      *Title / Author / Type / Subtype / Site or Asset Library / Status / Categories / Modified Date
      5. The .xls file could include other metadata not visible in columns, as for example: Display date (only web content) / Creation Date / All categories / ID / Languages translated into (web content)
      6. The .xls file processing will run on the background, and the UI will inform the user:

      6.1. that the process is running, through a loader and a message "Generating CSV" "Generating file"

      6.2. that it has ended, through a floating alert that must persist until the user closes it

      7. The user must be able to cancel the processing at anytime. Cancelling will delete the process from the queue (no resuming is allowed).

      8. The button will be disabled while the processing of a file is running

      9. There will be a tooltip when hovering over the button: "Export"

      10. In case there's an error while processing the .xls file, the alert will show with the message: content.xls generation has failed. Try again.

      11. _ If the user tries to leave the page  While the xls is being generated, an alert will show: _Your XLS file is in progress. Leaving this page will cancel the process. Do you want to wait for the file? Wait / Cancel

      • Wait will continue the process
      • Cancel will stop the xls generation __ 

       Acceptance Criteria

      Requirements
       
      Acceptance Criteria
       
      Test Strategy
       
      Covered by frontend test? (Yes/No)
       
      Covered by backend test? (Yes/No)
       
      1. There will be a button on the right top of the list to download the .xls file
      • Given the Content Dashboard
      • Then there will be a button on the right top of the list to download the .xls file
      Low Yes   No
      2. When clicking on the button, a xls will automatically download (with no preferences setting)
      • Given the Content Dashboard
      • When the user clicks on the download xls button
      • Then a xls will automatically download
      Low Yes   No
      3. The xls must include all assets included in the list, considering any filters applied
      • Given the Content Dashboard
      • When the user downloads the xls file
      • Then it will contain all assets included in the list, considering any filters applied
      Critical  No  Yes
      4. The xls must include all metadata visible in the table, that is:
      *Title / Author / Type / Subtype / Site or Asset Library / Status / Categories / Modified Date
      • Given the Content Dashboard
      • When the user downloads the xls file
      • Then the metadata visible in the table, that is: Title / Author / Type / Subtype / Site or Asset Library / Status / Categories / Modified Date, will appear as columns in the xls file
      High  No  Yes
      5. The xls could include other metadata not visible in columns, as for example: Display date (only web content) / Creation Date / All categories / ID / Languages translated into (web content)
      • Given the Content Dashboard
      • When the user downloads the xls file
      • Then the metadata not visible in the table, that is: Display date (only web content) / Creation Date / All categories / ID / Languages translated into (web content), will appear as columns in the xls file
      High  No  Yes
      6. The xls processing will run on the background, and the UI will inform the user:
      6.1. that the process is running, through a loader and a message "Generating file"
      6.2. that it has ended, through a floating alert that must persist until the user closes it
      • Given the Content Dashboard
      • When the user has clicked on the download xls button
      • Then the process will start, through a loader and a message "Generating file"
      Low  Yes  No
       
      • Given the user has clicked on the download xls button
      • When the process has ended
      • Then a floating alert is displayed informing the user and it must persist until the user closes it
      Low  Yes  No
      7. The user must be able to cancel the processing at anytime. Cancelling will delete the process from the queue (no resuming is allowed).
      • Given the user has clicked on the download xls button
      • When the process is running
      • Then there will be a Cancel button to cancel the processing at anytime
      Low  Yes  No
       
      • Given the user has clicked on the download xls button
      • When the process is running
      • And the user cancels the process
      • Then the process is cancelled and it is deleted from the queue
      Medium  Yes No 
      8. The button will be disabled while the processing of a file is running
      • Given the user has clicked on the download csv button
      • When the process is running
      • Then the download xls button is disabled
      Low  Yes  No
      9. There will be a tooltip when hovering over the button: "Download xls"
      • Given the Content Dashboard
      • When the user hovers the download xls button
      • Then a tooltip is shown: "Download xls"
      Low  Yes  No
      10. In case there's an error while processing the xls, the alert will show with the message: content.xls generation has failed. Try again.
      • Given the user has clicked on the download xls button
      • When there's any error while processing the xls
      • Then the alert will show with the message: content.xls generation has failed. Try again.
      Low  Yes  No
      11. _ If the user tries to leave the page  While the xls is being generated, an alert will show: _Your XLS file is in progress. Leaving this page will cancel the process. Do you want to wait for the file? Wait / Cancel * Wait will continue the process
      • Cancel will stop the xls generation 
      • Given the user has clicked on the download xls button
      • When the xls is being generated and the user tries to leave the page
      • Then an alert will show: Your XLS file is in progress. Leaving this page will cancel the process. Do you want to wait for the file? Wait / Cancel
      Low  No  No
       
      • Given the alert appears
      • When the user clicks on Wait
      • Then the process will continue and the alert is closed
      Medium  No  No
       
      • Given the alert appears
      • When the user clicks on Cancel and leave
      • Then the xls generation is stopped and the user is lead out of the Content Dashboard
      Medium  No  No
       
      • Given the Content Dashboard
      • When there are no contents in the list
      • Then the Export XLS button is disabled
      Medium  No No 

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              support-qa Support QA
              Reporter:
              julia.molano Julia Molano
              Engineering Assignee:
              Yurena Cabrera
              Recent user:
              Sophia Zhang
              Participants of an Issue:
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Packages

                  Version Package
                  7.4.3.5 CE GA5
                  7.4.13 DXP U1
                  Master