About this plugin: This plugin was designed around the LearningLocker ADL Compliant Learning Record Store (LRS). This plugin has also been successfully tested with many other LRS systems and integrates seemlessly into LifterLMS. LearnDash xAPI adds the following features to LearnDash: With these features, LearnDash is the only xAPI, cmi5 and CASS compliant WordPess based Learning, and Learning Content, Management System on the market. To help you get started, watch this video playlist demonstrating how to setup LearnDash xAPI, create competencies, upload / link your TIN CAN e-learning courses, create your launch button or iFrame, and configuring your LearnDash courses, lessons, quizzes and questions for optimum reporting. Once you’ve got the LearnDash xAPI plugin installed, you can head to the WP-Admin > LearnDash LMS > LearnDash xAPI page and step through the inline Help panels located in the top right corner of the TIN CAN Records list page to find process oriented Help topics. Registering your LRS: To use your, you will need to subscribe to an LRS service. You can find compatible services at scorm.com, LearningLocker, Watershed, Wax, or the recommended Learning-Templates.com websites. If you require LRS setup support, please contact your LRS service provider for support. With this information entered into the “Register Your LRS” form, click the Update button and visit your WordPress Dashboard to login using the email and password enter here. Done! You now have your own LRS service working with LearnDash xAPI. Switching LRS systems on-the-fly: Once you have your LRS working with LearnDash xAPI, and find you wish to change LRS systems later, you can easily do this without interrupting your LearnDash service. You can literally change LRS’s on-the-fly by simply changing the credentials outlined above. If you have setup an account on the new LRS and already created your LRS Client in that service, correctly entering credentials into the LearnDash xAPI > LRS Settings (per your LRS requirements) then clicking on the Update button will instantly switch you over to your new LRS. Creating your TIN CAN e-learning course: TIN CAN e-learning courses are created using third-party tools such as Storyline version 2+, Studio version 2+, Captivate version 9+ or Lectora version 8+. To upload or link a TIN CAN e-learning course into LearnDash xAPI, perform the following: Uploading a course: What happens when you upload the course is; the we read the files and show you what we found in the Course URL and and Activity ID fields. If this information is incorrect, you can change it at any time in LearnDash xAPI. You can override Activity ID URLs for any uploaded or linked TIN CAN e-elearning course in LearnDash xAPI. Linking to an external TIN CAN e-learning course: TIN CAN e-learning courses are created using third-party tools such as Storyline version 2+, Studio version 2+, Captivate version 9+ or Lectora version 8+. External e-learning couses can be shared with you by the owner. The course does not need to be delivered to you, only a URL to the start file and the Activity ID (verb) that courses uses when launch need to be provided to you. Linking an external course: You can override Activity ID URLs for any uploaded or linked TIN CAN e-elearning course in LearnDash xAPI. If you have an e-learning course hosted elsewhere on the internet, or you want your local e-learning course structure to use content hosted elsewhere on the internet, perform the following: Before you begin: Ensure you have access to that content from within your WordPress website. Example: Content hosted on a CDN with controlled access where your current domain is allowed access. Upload the course structure: What happens when you upload the course structure is; the we read the files and show you what we found in the Course URL and and Activity ID fields. If this information is incorrect, you can change it at any time in LearnDash xAPI. You can override Activity ID URLs for any uploaded or linked TIN CAN e-elearning course in LearnDash xAPI. Updating a course: To update a course, you need the same 3 pieces of information as when you created the course. The process of updating a course is the same as creating a new course so you can refer to the Create a Course Help Tab, or, watch the Updating a course video for further details. If you are replacing a previously uploaded ZIPped TIN CAN e-elearning course, simply click on the Browse button,locate and upload the new course ZIPped file. If you are updating a linked TIN CAN e-learning course, replace the Start URL and Activity Id URL with your new ones. In either case, click on the Update button to complete this task. Creating the iframe: NOTE: As of LearnDash xAPI version 3.0 you will no longer view the content of an iFrame from any WordPress Administration screens or LearnDash xAPI panels in the WordPress Administration > post editing screens, but the content will be visible in the website itself. This is intentionally done so your uploaded e-learning does not report your administration activities to the LRS. Showing your e-elearning in an iFrame provides the student an integrated view of your e-learning inside your Course, Lesson, Quiz or Question content. iframes do, however, restrict your content form being viewed offline. To allow your e-elearning content to be viewed offline, you need to display it in a lightbox, AND, you need to use an offline player (or app) provided by that e-learning product provider. When you update an xAPI e-learning course, you do not need to recreate your iFrame. As the final step for any uploaded or linked TIN CAN e-learning Record, you will need to add an iFrame in any Course, Lesson, Quiz or Question. Your xAPI e-learning course in now available for use in your LearnDash Course, Lesson, Topic, Quiz or Question in the website. Creating your competencies: Before you can record xAPI data, you need to create competencies. To learn more about competencies, visit the Association for Talent Development website. Competency Assessment Templates (CAT) can be created for LearnDash posts and for your linked or uploaded e-learning courses. To learn more about CAT, read this Competency Assessment Template guide. Click here to download a Competency Examples with Performance Statements Word document that you can copy/paste and edit to your specific needs. To assign your competency to one or more types, check the box(es) related to one or more of these types in the Competency panel, then click on the Save or Update button to complete this task. Using your competencies: Assigning the Competency to one or more types makes it available in the Activity ID drop-down menu in a course, lesson, topic, quiz or question > Course Options >Manage This Course Experience tab. You need only select it from the list. Looking for some competency examples? Click here to download a Word document containing competency examples. H5P is an open source authoring tool that plugs into WordPress content management systems. It includes a variety of content types from simple multiple choice questions to interactive games. While we haven’t tested every content type, we have tested the Multiple Choice, content presentation, Image Hot Spot, Drag and Drop, Drag N Sort and Single Choice content types used in conjunction with LearnDash and LearnDash xAPI. Because you can preview any H5P content and interaction type combinations prior to pushing them, we recommend you use your imagination and try any combination available. You have fun testing these highly interactive products. To enable H5P Content to work with LifterLMS xAPI, you need only install the H5P xAPI plugin provided with LearnDash xAPI and any H5P content you have already, or will create will automatically be recorded. LearnDash xAPI currently controls the Mark Complete button for H5P interactions that are xAPI enabled (please view the LearnDash xAPI Changelog – v1.2.0 – 2017-09-15 – to view the list of tested interactions). The Mark Complete button is not made available until the user has completed the H5P interaction. Lectora’s xAPI implementation offers flexibility not found in other authoring tools, while at the same time sending useful statements with default settings. We’ve tested Lectora Publisher Pro and Pro Suite (v9+), Lectora Inspire and the latest version of Lectora Online, and the data works great with LearnDash xAPI. To use Lectora products for xAPI, you need to select the Tin Can API in your Publishing Options, then simply upload the published ZIP file into LifterLMS xAPI. LearnDash xAPI can control the Mark Complete button for Lectora courses when you add them to your lessons. When selecting the related checkbox, the Mark Complete button is not made available until the user has completed the e-learning. With Adobe Captivate 9 you can go seamlessly from storyboarding to responsive eLearning design. Dip into the exclusive 50,000+ asset store or use assets from Adobe Stock to enrich your content. Create amazing courses that run seamlessly across desktops and mobile. To use Captivate 9 published projects with LearnDash xAPI, simply upload your published ZIP file into LearnDash xAPI. LearnDash xAPI can control the Mark Complete button for Captivate courses when you add them to your lessons. When selecting the related checkbox, the Mark Complete button is not made available until the user has completed the e-learning. Articulate was one of the first authoring tools to support the prerelease version of the xAPI specification. There have been some important changes in Articulates xAPI tracking since then, and courses published in Storyline version 2.5 as well as Studio 360 and higher work well with LearnDash xAPI. To use Storyline and Studio 360 published projects with LifterLMS xAPI, simply upload your published ZIP file into LearnDash xAPI. LearnDash xAPI can control the Mark Complete button for Storyline and Studio 360 courses when you add them to your lessons. When selecting the related checkbox, the Mark Complete button is not made available until the user has completed the e-learning. Note: Articulate Rise is not supported in LearnDash xAPI at this time. SurveyGizmo is a popular survey tool that can be used for learning evaluation surveys, assessments, and anything else that requires asking questions and tracking the answers. SurveyGizmo data is especially useful if you want to report on where people complete surveys because it includes metadata about learners’ locations and devices. To use SurveyGizmo with LearnDash xAPI, you’ll need the following LearnDash xAPI information to link it with SurveyGizmo. Note: Survey Gizmo does not link directly to LearnDash or LearnDash xAPI, it links to, and is reported in, your LRS Dashboard. With this information, log into SurveyGizmo and go to Account > Integrations. Note: Only admin users will have access to this area of account settings. Enter a Label for your integration. This will probably be your LMS/LRS product name, e.g. LearnDash xAPI. Then enter your Endpoint URL, API Key/User, API Secret/Password xAPI Apps is a collection of applications used to record job performance observations and attendance at events. You can track real-world experiences for analysis alongside your training data. To use xAPI Apps with LearnDash xAPI, you’ll need the following LearnDash xAPI information to link it with xAPI Apps. Note: xAPI Apps does not link directly to LearnDash or LearnDash xAPI, it links to, and is reported in, your LRS Dashboard. With this information, log into xAPI Apps and select LearningLocker from the Learning Record Store area and enter the listed information. An important note about xAPI Apps: Even though the name lends to mobile apps, xAPI Apps also work on laptop/desktop computers. Zapier currently has integrations with the Watershed LRS and the Wax LRS. You will need to use one of these services to use Zapier. Support for Zapier and your chosen LRS is provided by that LRS. Perhaps our most significant integrations on the list, Zapier is a service that allows you to capture data from a whole range of popular applications and report on them in LearnDash xAPI. The list of potential applications is huge and keeps growing. Here are just a few integrations: To use Zapier with LearnDash xAPI, you’ll need the following LearnDash xAPI information to link it with Zapier. Once liked with Zapier, all the Apps will automatically communicate with your LearnDash LRS. Note: Zapier does not link directly to LearnDash or LearnDash xAPI, it links to, and is reported in, your LRS Dashboard. With this information, log into Zapier and select Your LRS from the Learning Record Store area and enter the listed information. How to use the Reporting tools: This widget will only work once you register your LRS. Drag this widget to the top of your dashboard. To use your TIN CAN Reporting pages (buttons along the top of this page), you will need to log into the LRS using this widget. Once logged in, your LRS Dashboard will be visible. If you are connecting LearnDash xAPI to a LearningLocker LRS: The Dashboard provides you statistical information about all user activity in a graphical format as well as displaying top statics when scrolled down. LiftLMS xAPI provides a tool for filtering statements that we call “reporting”. This page documents everything you can do with the reporting tool. Create a report: Click the (green) “Add” button. A new entry will appear in the list of reports, you can then edit that report. Remove a report: Click the (red) “Delete” button next to the report. Then select “OK” in the message that pops up. Edit a report: Click the (blue) “Edit” button next to the report. From there you will be taken to a page where you can add filters to your report. Filter by actor: This category lets you filter actors (people that did activities). Click the (grey) square that says “Who”. You can then add and remove actors from the list that appears below. Adding an actor: Click the (green) “Add” button (below the list of actors – which may be empty at this point). This will add a new entry to the list of actors, you can then type the name ( Removing an actor: Click the (red) minus icon next to the actor. Then select “OK” in the message that pops up. Filter by verb: The did category lets you filter by verbs (how actors interacted with activities, i.e. “completed”). Click the (grey) square that says “Did”. You can then add and remove verbs from the list that appears below. Adding a verb: Click the (green) “Add” button (below the list of verbs – which may be empty at this point). This will add a new entry to the list of verbs, you can then type the name ( Removing a verb: Click the (red) minus icon next to the verb. Then select “OK” in the message that pops up. Filter by activity: This category allows you to filter by activities (what people did). Click the (grey) square that says “What”. You can then add and remove “activities” and “activity types” from the lists that appears below. Adding an activity or activity type: Click the (green) “Add” button (below the list you’d like to add to – which may be empty at this point). This will add a new entry to the list, you can then type the name of the “activity” ( Removing an activity or activity type: Click the (red) minus icon next to the item. Then select “OK” in the message that pops up. Filter by context: Allows you to filter in terms of the context that activities took place in. Click the (grey) square that says “Where”. You can then add and remove “parent activities”, “grouping activities”, “platforms”, “instructors”, or “languages” from the lists that appears below. Adding an activity or activity type: Click the (green) “Add” button (below the list you’d like to add to – which may be empty at this point). This will add a new entry to the list, you can then type the name of the “parent activity” ( Removing an activity or activity type: Click the (red) minus icon next to the item. Then select “OK” in the message that pops up. Filter by result: Click the (grey) square that says “With result”. You can then filter by score, success, or completion. Filter by score: You can set a min (left-most box) and/or a max (right-most box) for each of the scales. You can filter by maximum (max – Filter by success: Success ( Filter by completion: Complete ( Filter by date: Click the (grey) square that says “When”. You can then select a since and/or until date which will determine the date ( View statements in a graph: Click the (green) “Graph” button next to the report. From there you will be taken to a page where you can view the statements returned from your report in a graph. View statements in a list: Click the (green) “Statements” button next to the report. From there you will be taken to a page where you can view the statements returned from your report in a list. If you are connecting LearnDash xAPI to a Watershed LRS, refer to the related reporting and administration pages for those LRS providers.LearnDash xAPI
Once you have selected and subscribed to one of these services, you will be provided with the following information to enter into the LRS Settings page below:
When a course is published by the developer, it needs to be published as TIN CAN version 1.0 or higher to work with LearnDash xAPI.
Once published, that course will be packaged as a ZIPped file ready for upload into LearnDash xAPI.
Alternatively, you can also create your own TIN CAN competency before-hand in LifterLMS > Competencies and paste its permalink into the Activity ID field, replacing the existing link.
When a course is published by the developer, it needs to be published as TIN CAN version 1 or higher to work with LifterLMS xAPI.
Alternatively, you can also create your own TIN CAN competency before-hand in LearnDash > Competencies and paste its permalink into the Activity ID field, replacing the existing link.
We will then delete the old course and remap the new course for you. Once again, you shouold verify the start URL and Activity Id URL are correct.
Follow these steps to complete this task:
To do this, Open the Courses > Competencies page and click on the Add Competency button.
Once you have created your competency and assigned it a type, you need to assign it to a course, lesson, quiz, question or TIN CAN uploaded or linked e-learning course.H5P
Lectora
Captivate 9
Articulate Storyline 2, 3, and 360 as well as Articulate Studio 360
SurveyGizmo
xAPI Apps
Zapier
Located in your WordPress Dashboard, you will find a new full page widget named LearnDash xAPI Statistics.statement.actor.name
) of the actor you’re searchng for in the text box. If the actor’s name doesn’t appear as you type it you probably misspelled their name or they haven’t done anything according to your LRS. Currently the report will filter by the email (statement.actor.mbox
) associated with the actor you’ve selected.statement.verb.id
) of the verb you’re searchng for in the text box.statement.object.id
) or “activity type” (statement.object.definition.type
) you’re searchng for in the text box.statement.context.contextActivities.parent.id
), “grouping activiy” (statement.context.contextActivities.grouping.id
), “platform” (statement.context.platform
), “instructor” (statement.context.instructor
), or “language” (statement.context.language
) you’re searchng for in the text box.statement.result.score.max
), minimum (min – statement.result.score.min
), the actual mark (raw – statement.result.score.raw
), and the percentage of the raw mark in relation to the max mark (scaled – statement.result.score.scaled
). Change the min and max by entering a number into the boxes, you can remove these filters by clicking the (red) “Clear” button next to the score.statement.result.success
) may determine whether a learner was successful in passing a test. Setting this filter to true
will return all the statements that show a successful pass and false
will do the opposite. You can remove this filter by clicking the (red) “Clear” button next to success.statement.result.completion
) may determine whether a learner completed a test. Setting this filter to true
will return all the statements that show a completed test and false
will do the opposite. You can remove this filter by clicking the (red) “Clear” button next to success.statement.timestamp
) range you’re interested in. Statements that were not made during your date range will not be returned (unless it meets certain conditions regarding statement refs).