Brickfield Education Labs

Table of Contents

Introduction

The Conversion Errors report displays all conversion request errors for the course, or courses.

Where to find the Conversion Errors report

The Conversion Errors report can be accessed via:

  • Site administration > Plugins > Local plugins > Report for Alternate Formats, and then click on the Conversion Errors tab.
  • Course actions menu > More > Reports > File Conversions, and then click on the Conversion Errors tab.

How to use the Conversion Errors report

The Conversion Errors report displays a page which includes a table where each row is one of the errors.

The Conversion errors report displaying the report heading, dates its showing data from, collapsed filters section, download table data as dropdown menu and download button, and the conversion errors table. The conversion errors table has 7 columns: filename, requested by, conversion, conversion details, error code, information, time of error, and actions.

The heading and filtering area of the report will show whether the errors listed are for one course or many courses.

  • If the results are for one course, the course name is displayed.
  • If the results are for more than one course, the number of courses is displayed.

 

The table displays a row for each course that contains eight parts:.

  • Filename
  • Requested by
  • Conversion
  • Conversion Details
  • Error code
  • Info
  • Time of Error
  • Actions
    • Go to resource
    • Retry conversion OR
    • Successful conversion tick icon

Retry the failed conversions in your course(s)

To retry the failed conversions in your course(s):

  1. Ensure you are viewing the “Conversion Errors report”.
  2. Select the “Retry conversion” icon to retry the conversion.

View the conversion errors in your course(s)

To view the conversion errors in your course(s):

  1. Ensure you are viewing the “Conversion Errors report”.
  2. View the table in the report for the breakdown of the downloads per role.

Edit the conversions errors resource

To edit the conversion errors resource:

  1. Ensure you are viewing the “Conversion Errors report”.
  2. Select the “Go to resource” icon to edit the conversion errors resource.

The available filters for the Conversion Errors report

This Users reports table data is filterable by the following:

  • Categories *
  • Courses *
  • Roles
  • Types
  • Date from
  • Date to

 

Please note: Categories and Courses don’t appear if you have landed from an inpidual course’s report link, as it will be filtered on one course already. Use the “View All My Courses tab” to filter on multiple courses or categories.

The available download options for the Conversion Errors report

This Conversion Errors reports table data can be usually downloaded as the following, however this is dependent on your Moodle site’s admin settings as to which download options are enabled:

  • Comma separated values (.csv)
  • Microsoft Excel (.xlsx)
  • HTML table
  • Javascript Object Notation (.json)
  • OpenDocument (.ods)
  • Portable Document Format (.pdf)

Receiving conversion error notifications

When a conversion request fails, an error notification is sent to the user who requested it.

The system will also additionally send out alert error notifications to other users as required, for admin or monitoring purposes. The ability to receive alert error notifications is enabled by two different options:

  1. The ‘local/bfaltformat:recieveerrornotification’ capability as outlined in the below section.
  2. Adding email addresses to the global setting called “senderrorbyemails”.

 

For more information on the global settings, see: Alternate format configuration

Capability Requirements

Access to Brickfield Alternate Formats is controlled by capabilities, and users must have the correct capabilities in the correct context.

  • ‘local/bfaltformat:viewsystemreport’ capability – View Brickfield Alternate Format Jobs System Report
  • ‘local/bfaltformat:viewcoursereport’ capability – View Brickfield Alternate Format Jobs Course Report
  • ‘local/bfaltformat:recieveerrornotification’ capability –  Recieve conversion error notifications

 

For more information, see: Capabilities.