Setting up Tin Canny Reporting for LearnDash

Overview

The Tin Canny Reporting > Settings page is where you decide how learner data is captured and shown, how the Mark Complete button behaves, how modules appear on the page, and how data is cleared when you need a fresh start. This article walks through every setting in the order it appears on the page.

Reports

• Disable wp-admin dashboard widget — Yes / No. Tin Canny adds a small reporting summary to your WordPress admin home screen. If you’d rather keep that dashboard uncluttered, set this to Yes to hide the widget.
• Enable sorting by % complete — Yes / No. Lets you sort report tables by each learner’s completion percentage. Sorting that column pulls a large amount of data at once, which can slow the reports down — or time out — on sites with a lot of users, so it’s best left off unless your user base is small and you want the convenience.
• Enable Tin Can Report on front end — Yes / No. Adds the Tin Can Report as a tab inside the front-end reporting interface created by the [tincanny] shortcode, so admins and Group Leaders can reach it from a page instead of the dashboard.
• Enable xAPI Quiz Report on front end — Yes / No. Does the same for the xAPI Quiz Report, adding it as a tab in the [tincanny] front-end interface.
• User identifier(s) — Display Name / First Name / Last Name / Username / Email Address. Choose which identifying columns appear in the user list of the Course Report and User Report. Pick whatever combination makes it easiest to recognize your learners at a glance.

Course/User Report Settings

• Default group for Reports — All Users, or any of your groups. Pre-selects a group so the Course and User reports open already filtered to it. On a large site this is a real time-saver, since the report isn’t loading every learner each time. You can still switch to a different group (or back to All Users) from within the reports whenever you like.
• Default page length — 10 / 25 / 50 / 100 / 200. Sets how many rows load per page in the reports. Smaller numbers load faster; larger numbers mean less paging back and forth. Choose what fits your data and your patience.

Tin Can/SCORM

• Capture Tin Can and SCORM data — Yes / No. Controls whether Tin Canny records the Tin Can/SCORM statements your uploaded modules send. If you’re using modules from a supported authoring tool (Storyline, Rise, Captivate, iSpring) and want their results in your reports, turn this on. Set it to No to stop capturing — and note that when data capture is off, the Tin Can Report and xAPI Quiz Report tabs disappear from the reporting interface.
• Protect SCORM/Tin Can modules — Yes / No. Turns on basic protection that limits viewing of your uploaded modules (Storyline, Rise, Captivate, iSpring) to signed-in users, so anonymous visitors can’t open the module files directly from outside your site. Two things worth knowing: the protection does not cover modules you place on standalone pages or posts (anyone can view those), and while you can set protection globally here and fine-tune it per lesson/topic, if it’s switched off globally you can’t turn it back on for an individual lesson or topic. If modules are having trouble loading, try disabling this. It also relies on hosts that support mod_rewrite.

• SCORM Driver Compatibility — Async (default) / Sync. Determines how newly uploaded modules communicate with your site. Async is the default and performs best in most environments; switch to Sync only if SCORM/xAPI results aren’t being tracked the way you expect. Because the mode is set at upload time, changing this setting affects future uploads — to apply it to an existing module, upload that module again.

Mark Complete button

• Behavior — Sets what the LearnDash Mark Complete button does on lessons and topics that contain an embedded Tin Canny module. Choose a site-wide default here; you can override it on any individual lesson or topic. The options are:
  • Always Enabled — the button works normally, whether or not the learner has finished the module.
  • Disabled until complete — the button stays greyed out until the learner completes the embedded module.
  • Hidden until complete — the button is hidden and only appears once the module is finished.
  • Hidden and autocomplete — there’s no button at all; the lesson or topic marks itself complete as soon as the learner finishes the module. (Be sure to give learners another way to move on, since there’s no button to click.)
  • Hidden and autoadvance — the same as autocomplete, but it also sends the learner straight on to the next lesson or topic the moment they finish.
• Enable compatibility mode — Yes / No. A more dependable (if slightly slower) method of recording xAPI statements and unlocking the Mark Complete behaviors. Switch it on if completion isn’t unlocking reliably — for instance, when a module sends its final statement at the same moment it closes.
• Custom label — Replace the default Mark Complete button text with wording of your own whenever a Tin Canny module is embedded in the lesson or topic — for example, “Finish module” or “I’m done.”
• Autocomplete Lessons and Topics even if Tin Canny content on page (Uncanny Toolkit Pro) — Yes / No. Works hand-in-hand with the Autocomplete Lessons & Topics feature in Uncanny LearnDash Toolkit Pro. Normally, when a lesson or topic holds a Tin Canny module, completion is decided by the Mark Complete button behavior above. With this turned on, the lesson or topic is instead marked complete automatically on page load, even though a module is present. Without Toolkit Pro (and its Autocomplete Lessons and Topics module) active, completion simply continues to follow the Mark Complete behavior.

Lightbox

• Transition — Fade / Zoom / None. The visual effect used when a module opens in a lightbox. Choose Fade or Zoom for a little motion, or None for an instant open.
• Default lightbox size — Sets the default dimensions of modules shown in a lightbox. Enter a Width (px / % / vw) and Height (px / % / vh) and pick the units that suit you — fixed pixels, or percentage/viewport units that scale with the screen. These defaults can be overridden on an individual lesson or topic.

Reset data

These actions are permanent and can’t be undone — export anything you need first.

• Reset Tin Can data — the Reset data button permanently deletes all captured Tin Can data. Useful when you’re testing or starting over, but there’s no way back.
• Reset xAPI Quiz data — the Reset Quiz Data button permanently deletes all xAPI Quiz data.
• Reset bookmark data — the Reset bookmark data button clears the saved resume positions for uploaded modules, so every learner starts their modules from the beginning again.
• Purge statements — pick a verb (Answered, Attempted, or Passed) and click Purge statements to delete only the SCORM/xAPI statements that use that verb. This is a more surgical cleanup than wiping everything at once.
• Purge Answered statements — a one-click shortcut (the Purge Answered statements button) that removes every stored xAPI statement with the “Answered” verb.

Delete Tin Canny Data

• Delete all Tin Canny data on uninstall — By default, your data is kept even if you remove the plugin. Enable this option only if you want a completely clean removal: with Delete all data on uninstall turned on, uninstalling Tin Canny permanently erases all of its data — SCORM/xAPI statements, quiz data, uploaded modules, module bookmarks, plugin settings, and everything related. There is no undo, so switch it on deliberately.