Atch (1)_APPENDIX K S2025 xAPI Requirements - 06 Dec 2019.docx

06 December 2019 APPENDIX K: Sailor 2025 RRL FY 21 Content Conversion xAPI Requirements

Navy Common Reference xAPI Profile Version 0.2 Draft Revision History

STOP! Do not read further unless….

You are familiar with the xAPI Data Specification, the xAPI Profile Specification, and the JSON-LD specification. These specifications contain a wealth of information that is impractical to repeat here, but are necessary for understanding the purpose and content of this document. This document produced in a facility that also processes products containing peanuts.

Structure of Profiles in this Document This document describes the Navy Common Reference xAPI Profile and its Extension Profiles. Although the xAPI Profile specification allows and encourages re-use of concepts, it does not provide a mechanism for directly extending one profile into another. The product of this document, then, is multiple xAPI Profiles:

· Navy Common Reference xAPI Profile, which consists of the concepts defined in Core Concepts, Core Templates, and Core Patterns

· Navy Schoolhouse Extension xAPI Profile, which consists of concepts, templates, and patterns defined in the Schoolhouse Extension, and intended to be in conjunction with the Navy Common Reference xAPI Profile.

· Navy VRT Extension xAPI Profile, which consists of concepts, templates, and patterns defined in the VRT Extension, and intended to be in conjunction with the Navy Common Reference xAPI Profile.

This document also lays the groundwork for future extensions of the Navy Common Reference xAPI Profile in the Future Systems Addendum. tio SCORM Compatibility The Navy Common Reference Profile includes many SCORM-like verbs, templates, and patterns to provide consistency with traditional and existing SCORM content. It does not provide a mechanism for replacing SCORM’s content delivery and navigation. For efforts intending to replicate SCORM’s functionality, the SCORM Profile should be explored.

SCORM Profile The SCORM Profile is a separate profile, defined by ADL labs. Its stated purpose is to facilitate modifying SCORM content to post learning events (xAPI Statements) to an LRS to allow other systems to access the data typically stored in an LMS. The Navy Common Reference Profile does not replace the SCORM Profile, but the two can be used in conjunction.

CMI5 Profile The CMI5 Profile is another, separate Profile intended to track CMI5 activities with as much detail and granularity as the CMI5 specification. Use the CMI5 profile If convertingCMI content to xAPI.

Profile Declaration in a Statement

[NOTE: IRIs that have not been created are in yellow] Validation Learning Record Providers adhering to this Profile should author statements that follow at least one Template, and sets of Statements issued should follow at least one Pattern in the Navy Common Reference Profile. A Statement conforming to one of the Extension Profiles in this document should follow at least one Template and sets should follow at least one Pattern in the Extension Profile. For more information on Template and Pattern matching, please see the xAPI Profiles specification, Part Two: 8.0-9.0 (Templates and Patterns), and also Part Three: Communication.

Pattern Validation should be performed by the Learning Record Provider as outlined in Part Three.

Actor Identifiers In xAPI, a single inverse-functional identifier (either an email address, SHA-1 hashed email address, openID, or other account) must identify each actor. One and only one identifier should be used. For this Profile and its extensions, the “account” property will be used to identify actors. The following values will be used:

account

Profile Metadata

Navy Common Reference xAPI Profile

Core Concepts Verbs

The Navy Common Reference xAPI Profile does not define any Activities. See above.

Activity Types As the name sounds, Activity Types are defined types, classes, or groups of activities. A set of SCORM-like Activity Types have been included, just as with the verbs, to facilitate recording data from SCORM content in xAPI.

Activity Extensions

"type": "string”

Context Extensions

"type": "string”

"type": "string”

Document Resources

None defined in this document, see above. Comment by Theodore_Wiegel: It this mini-table necessary? + Where is “above”?

Core Templates

Following a Template Templates are sets of rules to follow when authoring Statements that conform to a Profile. Each template has one of more Defining Properties, which are the conditions under which the Template applies. It can also contain a set of Rules, which are the constraints on Statements that meet the Defining Properties.

Naming Convention Templates should be named in a way that reflects the verbs or activity types in the Defining Properties of the Template. If possible, a present progressive form should be used if the Template is defined by a Verb (e.g., “completing” or “commenting”), a noun if the Template is defined by an Activity (“SCO Activity”), or a grammatically parallel structure for combinations (“starting a video). A Template should not have the same name as any other Template, Concept, or Pattern. Comment by Theodore_Wiegel: Insert “i.e.,” or “e.g.,” before “starting” – and remove quotation marks and parens. Comment by Theodore_Wiegel: Revise page break?

Templates

http://adlnet.gov/expapi/verbs/responded, http://w3id.org/xapi/ncrp/verbs/skipped

Comment by Theodore_Wiegel: Check for improved page/section break.

Core Patterns Pattern Grammar

Patterns Statements generated by a learning record provider should match at least one of the Patterns described below. This is not to say that Statements should be withheld from the LRS until an entire Pattern is matched; Statements should be sent to the LRS as soon as possible once they are generated. Rather, learning record providers should ensure that any path through their learning activity produces a set of Statements that match at least one Pattern.

https://w3id.org/xapi/ncrp/templates/initializing, https://w3id.org/xapi/ncrp/patterns/session-activities, https://w3id.org/xapi/ncrp/templates/terminating

https://w3id.org/xapi/ncrp/patterns/activities, https://w3id.org/xapi/ncrp/patterns/results

https://w3id.org/xapi/ncrp/templates/question, https://w3id.org/xapi/ncrp/templates/watching-video, https://w3id.org/xapi/ncrp/templates/listening-to-audio, https://w3id.org/xapi/ncrp/templates/commenting, https://w3id.org/xapi/ncrp/templates/practicing, https://w3id.org/xapi/ncrp/templates/reading, https://w3id.org/xapi/ncrp/templates/experiencing, https://w3id.org/xapi/ncrp/templates/suspending, https://w3id.org/xapi/ncrp/templates/resuming ] Comment by Theodore_Wiegel: Is it OK to use a comma after a URL? Comment by Schubert, David A CTR (USA): This appears to be code… note the brackets before [ and after ], so commas are likely acceptable

https://w3id.org/xapi/ncrp/patterns/completion, https://w3id.org/xapi/ncrp/patterns/score, https://w3id.org/xapi/ncrp/patterns/outcome

https://w3id.org/xapi/ncrp/templates/passing, https://w3id.org/xapi/ncrp/templates/failing ] Comment by Theodore_Wiegel: Would the actual URL have a comma at the end? + use of brackets. Intent should be to show an example exactly as it should appear. Comment by Schubert, David A CTR (USA): As noted earlier, the brackets indicate to us this is code. Usual grammar rules do not necessarily apply.

Schoolhouse Extension

About this Extension The Schoolhouse Extension is intended to provide additional concepts, templates, and patterns that are specific to the learning environment of a Navy Schoolhouse and not covered in the distance-learning-focused core profile. Schoolhouses may, in the future, have more domain-specific extensions that can be used in conjunction with or in place of this Schoolhouse Extension. By definition, each extension is technically its own Profile, but is created with the intention to be used in conjunction with the Core Profile.

Metadata

“type”: “string”

“type”: “string”

Templates

http://adlnet.gov/expapi/verbs/passed, http://adlnet.gov/expapi/verbs/failed, http://adlnet.gov/expapi/verbs/completed, http://adlnet.gov/expapi/verbs/scored

The Schoolhouse Extension does not enforce any Patterns.

VRT Extension About this Extension The VRT Extension is intended to provide additional concepts, templates, and patterns for use with the VRT and DEP programs. Comment by Theodore_Wiegel: Define VRT and DEP abbreviations? Comment by Schubert, David A CTR (USA): Neither acronym is included in Appendix B (acronyms appendix) Metadata

Concepts Activity types “time” and “rank” -> vocabulary? Policy?

Verb “responded” already covers the meaning of VRT’s “answered”? Comment by Theodore_Wiegel: Why are we seeing question marks here? At this stage, all questions within the doc should have been resolved.

Need to add widget verbs & “widget” activity type?

Templates

This extension enforces no Patterns. Comment by Theodore_Wiegel: show example of the extension? “This” is a vague referent as used here. Comment by Schubert, David A CTR (USA): What extension is being referred to in this statement?

Future Systems Addendum

Where to Start Start by identifying the scope of the Profile extension. Will it record learning experiences for an entire rating? Or more detailed experience data from single simulation or part-task trainer? The narrower the scope, the more detailed information it can reasonably collect. Next, outline use cases and identify the experiences that will be most valuable to track. Take a look at the Core Profile verb list and the Navy xAPI Vocabulary Server (coming soon) and decide whether an existing verb covers each use case. If not, define a new verb using guidelines on xAPI.vocab.pub and the xAPI Profile spec. Repeat the process for Activity Types, Extensions, Document Resource Types, and Attachment Usage Types. Comment by Schubert, David A CTR (USA): This comment simply notes the need for additional data.

Guidelines for Authoring

· An Extension can include core Profile concepts, but it should not overwrite or supersede them (e.g. should not redefine “passed”).

· If the scope of the extension is a single system with a small and finite set of Activities, it is recommended to include Activities & their definitions in the Profile; otherwise include only Activity Types.

· If you choose to create Templates and/or Patterns, subject them to a technical review against the validation algorithms found in the Profile Communication spec.

What to include

· A brief summary of the purpose of the Profile

· Metadata (id, spec version, profile name, definition, link to the defining document, version ids, author)

· New and existing concepts relevant to the scope of the profile, but not overlapping the Core profile

· General Restrictions template

· Passing, Failing, Scoring, and Completing templates should be included in any extension that contains Activities or Activity Types to which these might apply.

· Other templates from the Core profile as necessary. Comment by Theodore_Wiegel: Remove periods if not complete sentences (check all items) Comment by Schubert, David A CTR (USA): This is a global comment.

· New templates if appropriate

· Patterns if appropriate

· Any other useful documentation about how and when to use the profile.