The recipes page for developers gives a great overview of what recipes are. Put simply, recipes describe what xAPI statements are recorded for a particular type of experience. Learning designers need to know which recipes exist and what they track so that they can design learning experiences and statements to follow the recipe.
It’s really important that we all follow the same recipe when tracking the same type of experience so that 3rd party systems, such as reports, know how to handle the data. If different applications record on the same types experiences in different ways, we’d have to create custom reports for each application, defeating the point of using an interoperability specification like xAPI. The recipes page for developers gives an example of how this can go wrong. Recipes are the solution to that problem.
This page is a high level overview of recipes that exist today. For types of learning experiences that don’t have recipes, we’d love to help you create one. Contact us.
The attendance recipe defines the statements issued for people attending an event. This can be any kind of event such as meetings, classes, conferences etc. The recipe comes in two flavors: simple and detailed. The simple recipe simply tracks that a group of people attended an event. The detailed recipe additionally tracks the following experiences:
- I scheduled an event
- I registered for an event
- I unregistered from an event
- I joined an event
- I left an event
- I opened (i.e. started) an event
- I adjourned an event
- I resumed an event
- I closed an event
The bookmarklet recipe defines statements that can be sent by tools that bookmark the learner’s activity on the internet. It covers the following experiences:
- I experienced a web page
- I read a web page
- I bookmarked a web page
- I tweeted a web page
The checklist recipe defines statements relating to checklists for performance observation, for example, a manager assessing an employee against a set of competencies. In this recipe, the person being observed is always the actor and the observer is the instructor. The recipe tracks these experiences:
- Observee’s observation started
- Observee’s observation was resumed
- Observee’s observation was closed
- Observee’s observation ended incomplete
- Observee’s observation was completed/passed/failed
- Observee completed/passed/failed a checklist item
- An item in Observee’s checklist was cleared (i.e. they need to be observed on that item again).
Open Badges are digital credentials awarded for achievement, engagement or improvement. The Open Badges recipe defines the statement to be sent when the learner earns an Open Badge.
There are a collection of recipes describing the statements issued by the xAPI prototypes. These include a content launcher, a traditional e-learning course, a game of Tetris and a location based mobile game. These recipes and prototypes can be followed by real applications following a similar pattern. Together these recipes describe the following events:
- I experienced a web page
- I launched a learning experience
- I initialized a session for an e-learning course
- I terminated a session for an e-learning course
- I attempted an e-learning course
- I resumed an attempt at an e-learning course
- I suspended an attempt at an e-learning course
- I passed an e-learning course
- I failed an e-learning course
- I experienced a page of an e-learning course
- I answered an e-learning course question
- I initialized a session for a game
- I terminated a session for a game
- I attempted a game
- I completed a game
- I completed a game level
- I was at a location
- I attempted a task
- I completed a task
The video recipe describes statements used to convey a learner’s interactions with videos. It covers the following experiences:
- I played a video
- I paused a video
- I watched a video
- I skipped a video
- I completed a video
This page is an overview of available recipes. You can read more about recipes and how to implement them on the recipes page for developers.
We love to help people implement existing recipes and create new ones.