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

      https://www.figma.com/file/N002NJSHo19KSkZnmFeSyz/LPS-129241-As-a-content-manager-I-want-to-export-the-list-of-assets-to-a-csv-file?node-id=0%3A1

      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 / Vocab1 / Vocab 2 / 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.

       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 .csv file
      • Given the Content Dashboard
      • Then there will be a button on the right top of the list to download the .csv file
      Low Yes   
      2. When clicking on the button, a csv will automatically download (with no preferences setting)
      • Given the Content Dashboard
      • When the user clicks on the download csv button
      • Then a csv will automatically download
      Low Yes   
      3. The csv must include all assets included in the list, considering any filters applied
      • Given the Content Dashboard
      • When the user downloads the csv file
      • Then it will contain all assets included in the list, considering any filters applied
      Critical  No  
      4. The csv must include all metadata visible in the table, that is:
      *Title / Author / Type / Subtype / Site or Asset Library / Status / Vocab1 / Vocab 2 / Modified Date
      • Given the Content Dashboard
      • When the user downloads the csv file
      • Then the metadata visible in the table, that is: Title / Author / Type / Subtype / Site or Asset Library / Status / Vocab1 / Vocab 2 / Modified Date, will appear as columns in the csv file
      High  No  
      5. The csv 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 csv 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 csv file
      High  No  
      6. The csv 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"
      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 csv button
      • Then the process will start, through a loader and a message "Generating CSV"
      Low  Yes  
       
      • Given the user has clicked on the download csv 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  
      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 csv button
      • When the process is running
      • Then there will be a Cancel button to cancel the processing at anytime
      Low  Yes  
       
      • Given the user has clicked on the download csv 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  
      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 csv button is disabled
      Low  Yes  
      9. There will be a tooltip when hovering over the button: "Download csv" Given the Content Dashboard
      • When the user hovers the download csv button
      • Then a tooltip is shown: "Download csv"
      Low  Yes  
      10. In case there's an error while processing the csv, the alert will show with the message: content.csv generation has failed. Try again. Given the user has clicked on the download csv button
      • When there's any error while processing the csv
      • Then the alert will show with the message: content.csv generation has failed. Try again.
      Low  Yes  

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              beltran.rengifo Beltran Rengifo
              Reporter:
              julia.molano Julia Molano
              Engineering Assignee:
              Yurena Cabrera
              Recent user:
              Rubén Heras
              Participants of an Issue:
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Dates

                Created:
                Updated:

                  Packages

                  Version Package
                  Master