https://xapi.ly/docs/assets/statements.html.6b7c0566.js

1import{_ as i,r as a,o as d,c as u,a as t,d as e,b as n,w as s,f as l}from"./app.19fab6f8.js";const h={},c=t("h1",{id:"statements",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#statements","aria-hidden":"true"},"#"),e(" Statements")],-1),p=t("strong",null,"Statement",-1),_={href:"https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#statements",target:"_blank",rel:"noopener noreferrer"},g=l('<p>The minimum needed here is the <strong>verb</strong> - all other fields are optional.</p><h2 id="add-a-statement" tabindex="-1"><a class="header-anchor" href="#add-a-statement" aria-hidden="true">#</a> Add a Statement</h2><ul><li>Select your <strong>Project</strong></li><li>To the right of your Activity, select <strong>+ New Statement</strong></li><li>The default mode is <strong>Guided Mode</strong><ul><li>This takes you through the form step-by-step</li><li>If you&#39;re familiar with the process or prefer to view the whole form, you can toggle to <strong>Open Mode</strong></li></ul></li></ul><h3 id="fields" tabindex="-1"><a class="header-anchor" href="#fields" aria-hidden="true">#</a> Fields</h3><h4 id="step-1-choose-a-verb" tabindex="-1"><a class="header-anchor" href="#step-1-choose-a-verb" aria-hidden="true">#</a> Step 1 (Choose a Verb)</h4><table><thead><tr><th><strong>Field</strong></th><th><strong>Description</strong></th><th><strong>Required</strong></th></tr></thead><tbody><tr><td>Verb</td><td>Pre-populated list of verbs</td><td>Required</td></tr></tbody></table>',6),m={class:"custom-container tip"},b=t("p",{class:"custom-container-title"},"TIP",-1),f=t("a",{href:"mailto:[email protected]"},"Contact us",-1),y={href:"https://profiles.adlnet.gov/",target:"_blank",rel:"noopener noreferrer"},x={href:"https://registry.tincanapi.com/#home/verbs",target:"_blank",rel:"noopener noreferrer"},v=t("h4",{id:"step-2-add-result",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#step-2-add-result","aria-hidden":"true"},"#"),e(" Step 2 (Add Result)")],-1),S={href:"https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#result",target:"_blank",rel:"noopener noreferrer"},A=t("div",{class:"custom-container tip"},[t("p",{class:"custom-container-title"},"TIP"),t("p",null,"All of these fields can be entered directly or toggled to use an authoring tool variable value.")],-1),R=t("thead",null,[t("tr",null,[t("th",null,[t("strong",null,"Field")]),t("th",null,[t("strong",null,"Type")]),t("th",null,[t("strong",null,"Description")]),t("th",null,[t("strong",null,"Required")])])],-1),I=t("tr",null,[t("td",null,"Response"),t("td",null,"String"),t("td",null,"Typically used to represent a user response (text input, answer)"),t("td",null,"Optional")],-1),T=t("tr",null,[t("td",null,"Raw Score"),t("td",null,"Number"),t("td",null,"User score"),t("td",null,"Optional")],-1),P=t("tr",null,[t("td",null,"Minimum Score"),t("td",null,"Number"),t("td",null,[e("Must be smaller than "),t("strong",null,"Raw"),e(" and "),t("strong",null,"Max"),e(" Scores")]),t("td",null,"Optional")],-1),k=t("tr",null,[t("td",null,"Maximum Score"),t("td",null,"Number"),t("td",null,[e("Must be larger than "),t("strong",null,"Raw"),e(" and "),t("strong",null,"Min"),e(" Scores")]),t("td",null,"Optional")],-1),w={href:"https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#Score",target:"_blank",rel:"noopener noreferrer"},C=t("td",null,"Number",-1),O=t("td",null,[e("User score as a decimal value between -1 and 1"),t("br"),e("(Generally "),t("strong",null,"Raw"),e(" / "),t("strong",null,"Max"),e(")")],-1),D=t("td",null,"Optional",-1),N=t("tr",null,[t("td",null,"Success"),t("td",null,"Boolean"),t("td"),t("td",null,"Optional")],-1),M=t("tr",null,[t("td",null,"Completion"),t("td",null,"Boolean"),t("td"),t("td",null,"Optional")],-1),q=t("h4",{id:"step-3-add-context-activities",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#step-3-add-context-activities","aria-hidden":"true"},"#"),e(" Step 3 (Add Context Activities)")],-1),E={href:"https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#2462-contextactivities-property",target:"_blank",rel:"noopener noreferrer"},V=l('<table><thead><tr><th>

1<strong>Field</strong></th><th><strong>Description</strong></th><th><strong>Required</strong></th></tr></thead><tbody><tr><td>Parent</td><td>This activity has a direct relation to this statement <br> Generally there is only one sensible parent</td><td>Optional</td></tr><tr><td>Grouping</td><td>This activity has an indirect relation to the statement <br> There can be multiple related grouping activities</td><td>Optional</td></tr><tr><td>Category</td><td>This activity can categorize the statement like a tag</td><td>Optional</td></tr><tr><td>Other</td><td>This activity doesn&#39;t fit any of the other Context Activity types</td><td>Optional</td></tr></tbody></table><h4 id="step-4-add-extensions" tabindex="-1"><a class="header-anchor" href="#step-4-add-extensions" aria-hidden="true">#</a> Step 4 (Add Extensions)</h4>',2),F={href:"https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#41-extensions",target:"_blank",rel:"noopener noreferrer"},L=l("<p>Each extension can be added to:</p><ul><li><strong>Context</strong><ul><li>The core statement overall</li></ul></li><li><strong>Activity</strong><ul><li>Additional info to define an activity</li></ul></li><li><strong>Result</strong><ul><li>Related to an outcome</li></ul></li></ul>",2),B=t("thead",null,[t("tr",null,[t("th",null,[t("strong",null,"Field")]),t("th",null,[t("strong",null,"Description")]),t("th",null,[t("strong",null,"Required")])])],-1),G=t("tr",null,[t("td",null,"Location"),t("td",null,"Context, Activity or Result"),t("td",null,"Required")],-1),J=t("td",null,"ID",-1),U=t("br",null,null,-1),Y=t("br",null,null,-1),j=t("td",null,"Required",-1),z=t("tr",null,[t("td",null,"Value"),t("td",null,"Your extension value"),t("td",null,"Required")],-1),H=t("tr",null,[t("td",null,"Notes"),t("td",null,"This is for your internal use, and doesn't appear in statement data"),t("td",null,"Optional")],-1),K=t("h2",{id:"copy-code-snippet",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#copy-code-snippet","aria-hidden":"true"},"#"),e(" Copy Code Snippet")],-1),Q=t("p",null,[e("From the "),t("strong",null,"Output"),e(" panel on the right of the form, select "),t("strong",null,"Copy code"),e(" and paste the results into the JavaScript trigger/action in your authoring tool.")],-1);function W(X,Z){const o=a("ExternalLinkIcon"),r=a("RouterLink");return d(),u("div",null,[c,t("p",null,[e("A xapi.ly "),p,e(" is the core of what you'll be creating to copy/paste into your authoring tool. The data entered in the Statement form is used to generate a full "),t("a",_,[e("xAPI Statement"),n(o)]),e(" when the JavaScript is triggered in the course.")]),g,t("div",m,[b,t("p",null,[f,e(" if you feel a verb should be added to the list, preferably from a published location like "),t("a",y,[e("ADL's Profile Server"),n(o)]),e(" or Rustici's older "),t("a",x,[e("Tin Can Registry"),n(o)]),e(".")])]),v,t("p",null,[t("a",S,[e("Results"),n(o)]),e(" measure an outcome.")]),A,t("table",null,[R,t("tbody",null,[I,T,P,k,t("tr",null,[t("td",null,[t("a",w,[e("Scaled Score"),n(o)])]),C,O,D]),N,M])]),q,t("p",null,[t("a",E,[e("Context Activities"),n(o)]),e(" can be added to statements to show relation to other activities.")]),t("p",null,[e("In xapi.ly, they are structurally identical to primary "),n(r,{to:"/building/activities.html"},{default:s(()=>[e("Activities")]),_:1}),e(".")]),V,t("p",null,[t("a",F,[e("Extensions"),n(o)]),e(" can add additional metadata to statements.")]),L,t("table",null,[B,t("tbody",null,[G,t("tr",null,[J,t("td",null,[e("This can be a full IRI (standard) or a simple string (custom, that will be converted to an IRI)."),U,Y,e("You can optionally define the root IRI for a simple string extension in "),n(r,{to:"/publishing/configuration.html"},{default:s(()=>[e("Publish > Configuration Options > Extension Root ID")]),_:1}),e(".")]),j]),z,H])]),K,Q])}const tt=i(h,[["render",W],["__file","statements.html.vue"]]);export{tt as default};