Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-72035

Course completion report Excel download should include BOM to ensure correct character encoding

    XMLWordPrintable

    Details

    • Testing Instructions:
      Hide

      Prerequisites

      You will need access to Microsoft Excel. The version available in Office 365 is suitable.

      Steps

      1. Create a course.
      2. Add an activity to the course for example a quiz called "Quiz 1".
      3. In the course:
        1. Select the menu (Actions) and select Course completion.
        2. Under Condition: Activity completion select the activity created in step 2 and click Save changes.
      4. Add a user:
        1. Username: yuri
        2. First name: Юрий (copy and paste this text if needed)
        3. Surname: Гагарин (copy and paste this text if needed)
        4. Email address: yuri@example.com
      5. Enrol user yuri on the course.
      6. In the course:
        1. Select the menu (Actions) and select More....
        2. Under Reports select Course completion.
        3. Click the link Download in Excel-compatible format (.csv) and save the file.
      7. Open the downloaded CSV file in Microsoft Excel.

      Expected results

      In Excel ensure the Name column contains "Юрий Гагарин".

      Show
      Prerequisites You will need access to Microsoft Excel. The version available in Office 365 is suitable. Steps Create a course. Add an activity to the course for example a quiz called "Quiz 1". In the course: Select the ⚙ menu (Actions) and select Course completion . Under Condition: Activity completion select the activity created in step 2 and click Save changes . Add a user: Username: yuri First name: Юрий (copy and paste this text if needed) Surname: Гагарин (copy and paste this text if needed) Email address: yuri@example.com Enrol user yuri on the course. In the course: Select the ⚙ menu (Actions) and select More... . Under Reports select Course completion . Click the link Download in Excel-compatible format (.csv) and save the file. Open the downloaded CSV file in Microsoft Excel. Expected results In Excel ensure the Name column contains "Юрий Гагарин".
    • Affected Branches:
      MOODLE_310_STABLE, MOODLE_311_STABLE
    • Fixed Branches:
      MOODLE_310_STABLE, MOODLE_311_STABLE
    • Pull from Repository:
    • Pull 3.10 Branch:
      MDL-72035-excel_csv_bom-310
    • Pull 3.11 Branch:
      MDL-72035-excel_csv_bom-311
    • Pull Master Branch:
      MDL-72035-excel_csv_bom

      Description

      In the Course Completion report (report/completion/index.php) there are options:

      1. Download in spreadsheet format (UTF-8 .csv)
      2. Download in Excel-compatible format (.csv)

      These links download the same file, noted previously in a comment to MDL-39156.

      It could be useful if the Excel-compatible format added the UTF-8 byte order mark (BOM) to avoid Excel using the wrong character encoding.

      The Activity Completion report (report/progress/index.php) CSV export is not affected because it uses different code to generate the file. This includes the BOM – and uses UTF-16 – when the "Excel-compatible" link is used. See MDL-45832 regarding this discrepancy.

      This issue (MDL-72035) may be a duplicate or partial duplicate of MDL-70762.

        Attachments

          Activity

            People

            Assignee:
            leonstr Leon Stringer
            Reporter:
            leonstr Leon Stringer
            Peer reviewer:
            Sujith Haridasan Sujith Haridasan
            Integrator:
            Ilya Tregubov Ilya Tregubov
            Tester:
            Angelia Dela Cruz Angelia Dela Cruz
            Participants:
            Component watchers:
            Adrian Greeve, Jake Dallimore, Mathew May, Mihail Geshoski, Peter Dias, Sujith Haridasan
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:
              Fix Release Date:
              13/Sep/21

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 30 minutes
                30m