Arbeta med Experience API (xapi)

Detta avsnitt beskriver hur man arbetar med xapi eLearning specifikation. Denna erfarenhet API, som kallas xapi tillåter innehållsutvecklare att samla data baserat på lärandet av sina användare. Avsnittet innehåller information om att publicera med xapi alternativ och förstå xapi erfarenhet uttalanden. För de senaste specifikationerna, dokument och förklaringar av termer, besök den officiella xapi webbplats ( http://tincanapi.com/ ).

Publicera med xapi alternativ

Du måste publicera till xapi att göra det möjligt för automatiska och manuella xapi uttalanden. Följ stegen som beskrivs i Publishing till xapi att förbereda din titel för publicering till xapi.

De flesta av de automatiska xapi uttalanden styrs genom publiceringsalternativ när du publicerar en titel till xapi. Dessa alternativ är grupperade tillsammans på xapi Alternativ fliken när du klickar på Publicera :

överensstämmelse Nivå	Detta fält är inaktiverad.
Starta kurs i separat fönster från LRS	Välj detta alternativ om du vill att publiceras titel att lanseras i ett nytt fönster. När detta alternativ väljs, och användaren avslutar publicerade titel, kommer fönstret stängs, och användaren kommer att återlämnas till LRS.
Provningsrapporten / enkätfrågan interaktion LRS	Välj detta för att spela in interaktionsdata för frågorna i det graderade test som lämnas till LRS. Interaktion data inkluderar följande information för varje graderad fråga: Användar svar Huruvida användarens svar är korrekt eller inte Tid frågan besvarades Tid användaren spenderas på den sida som innehåller svaret
Uppmana användaren att navigera till den senast visade sidan	Välj detta för att aktivera automatisk bookmarking funktionen för den publicerade titeln. När detta är valt, och användaren återvänder till den publicerade titeln inom LRS, kommer användaren har möjlighet att gå till sidan han eller hon senast visade i den publicerade titeln.
aktivitet ID	Ange ID för kursen som det kommer att vara känt inom LRS.
aktivitet Namn	Ange titeln på kursen som du vill att det ska visas inom LRS.
aktivitets~~POS=TRUNC	Ange beskrivning av kursens innehåll som du vill att det ska visas inom LRS.

Tänk på följande när du fyller alternativen på xapi alternativ flik:

Observera att aktivitets ID , aktivitet namn , och Aktivitet Beskrivning för kursen kan ställas in här. Alternativen används som sammanhanget för andra uttalanden. När du skapar aktivitets ID , vara noga med att följa reglerna för en IRI (International Resource Identifier), som undviker mellanslag och specialtecken.
En försök aktivitet uttalande skickas automatiskt när kursen startar. Det skickas för verksamhet som anges i kursinformation sektionen (anges av Activity ID , aktivitet namn , och Aktivitet Beskrivning ) av xapi publiceringsalternativ.

När alternativet Uppmana användaren att navigera till den senast visade sidan väljs kan publicerade kurs rapportera ett xapi uttalande med verbet upplevt för varje sida besöks av en elev. Aktiviteten i detta är HTML-sidan namn och det är URI-kodad så att den kan användas för den bookmarking funktionen Lectora.

Om du vill spåra framsteg genom kursen, lägga till dessa två åtgärder per titel:

På Visa - xapi Statement - försökte - VAR (CurrentPageName)
På Hide - xapi Statement - klar - VAR (CurrentPageName)

Frågor inne i ett test eller undersökning kommer att redovisas när besvaras om alternativet Rapport test / enkätfrågan interaktion till LRS väljs. Frågan text och svaret framgår av xapi uttalande.

Testet måste klassificeras, men det behöver inte ingå i den totala poängen.
Dessutom ActivityContext - moderbolaget är uttalande mom inställd på dess test verksamhet.

Skicka Godkänd eller missade testet Uttalanden

Godkänd eller underkänd xapi uttalanden kommer automatiskt att skickas till tester som är inställda på att betygsättas. Poängen ligger längs med verbet gått eller misslyckades . Objektet visningsnamn är namnet på testet. ID är IRI av aktiviteten med namnet på testet läggas till. (Se exempel nedan.)

De resultat poäng egenskaper för min till 0 och max till 100 är redo att 0 som standard. Den lägsta godkända Score (%) fält (på testets resultat fliken) bör alltid tas med, även om den är satt till 0 (vid ingen korrekt).

Sända besvarade, Godkänd, eller Underkänd verksamhetsförklaringar

När du ställer in AICC_Lesson_Status variabeln är en xapi uttalande skickas. Följande villkor kommer att avgöra vilken typ av uttalande skickas:

Du kan använda en ändra variabel last för att ställa AICC_Lesson_Status till färdig , passerade , eller misslyckades . Om detta görs, kommer kursen att skicka en motsvarande Genomförd eller Godkänd eller misslyckades uttalande.
Ställa AICC_Lesson_Status till passerat eller avslutat kommer att sätta xapi satsens result.completion till true och result.success till sann . Om AICC_Lesson_Status är avslutad och poängen är mindre än AU behärskning poäng, result.success blir falsk .
Om AICC_Lesson_Status är inställd på misslyckades , den xapi satsens result.completion är inställd på true och result.success är inställd på false .
Poängen bör ingå i slutförandet uttalande om det föreligger om du har en graderad ingår testet eller om du manuellt AICC_Score .

Skicka ett xapi Statement

Du kan skicka ett xapi uttalande från vilken plats som helst i kursen. Det går automatiskt till de gemensamma xapi uttalande element så att du kan ange ett verb och ett objekt. Detta kan utlösas på en av de många triggers som åtgärder. Om du behöver full kontroll över uttalandet och alla dess värden se Specificera verb och objekt nedan.

Specificera verb och objekt

Lectora Inspireanvänder ADL definitioner för verb. Dessutom kan alla verb namn anges. Slagna verb namn läggs till ADL namespace så eventuella framtida ADL verb kan användas eller så kan du använda din egen unika verb. (LRS skulle inte validera verbet och gör att du kan rapportera om detta,. Därför tillåta användning av det namespace)

För mer information om verb, besök http://www.adlnet.gov/expapi/verbs .

För objektet del av meddelandet, kan du använda någon av de dynamiska variabler med hjälp av avancerad redigera och de variabla makron. Du kan också använda text att rapportera om någon aktivitet. Detta objekt område kommer att vara aktivitets identifierare. För att säkerställa detta är ett giltigt IRI, är en minimal ersättning av tecken görs med detta uttryck:

ActivityID (Platsen för aktivitets ID: n)

Överväga att använda villkorliga åtgärder och aktionsgrupper för förmågan att göra komplicerade spårning scenarier.

Specificera ytterligare uttalande värden

ActivityContext värden ställs in automatiskt.

Sända ett xapi uttalande och dynamiskt uppdatera uttalande

Använda köra Javascript åtgärden, kan du anpassa och dynamiskt uppdatera xapi uttalande när du går igenom titeln med din elev genom att använda variabler som definierats i din titel. Detta gör det möjligt att enkelt skapa mallar som kommer att tillfredsställa alla användningsfall.

Nedan är en enkel men effektiv exempel på Javascript som du kan utföra med hjälp av åtgärden .. Denna JavaScript kommer att skapa ett uttalande och sedan skicka meddelandet som du har skapat.

var stmt=
			
			{
			"Verb": {
			"Id" VarxAPIVerbID.getValue (),
			"Display": {
			"Und": VarxAPIVerbDisplay.getValue ()
			}
			}
			"Objekt": {
			"Definition": {
			"namn": {
			"En-US": "xAPIandLODemo"
			}
			}
			"Id": "http://uniqueurl.com/xAPIandLoDemo"
			"Object": "Activity"
			}
			"resultat": {
			"Poäng": {
			"Skalas" (parseInt (Test_1_Score.getValue ()) / 100)
			}
			"Avslutad": true,
			"Framgång": true
			}
			}

			var tcAPI = window.parent.frames [ 'titlemgrframe'];
			var tc_driver = tcAPI.tc_driver;

		tcAPI.TinCanSendStatement (tc_driver, stmt, funktion (XHR) {});

Ovanstående uttalande innehåller en del funktionsanrop för att få värdet av Lectoravariabler. Dessa kan också vara statiska strängvärden, till exempel om du ville bara att ange verb och andra värden i ett uttalande.

Nedan finns två alternativ för att anpassa xapi uttalande:

VarxAPIVerbID.getValue()

Detta använder den användardefinierade variabeln xAPIVerbID. Använd samma Var prefix som om du refererar till variabeln i alla andra åtgärder. Du kan ställa in denna variabel till varje verb du vill. Se till att du gör både ID och Display .

I det här exemplet, ID är en URI såsomhttp://adlnet.gov/expapi/verbs/answered

(Ett exempel motsvarande Display är besvarade .)

(parseInt(Test_1_Score.getValue()) / 100) Detta använder en reserverad variabel av Test_1_Scoreatt skicka betyget som de mottog på testet. (Detta gäller inte har Var prefixet eftersom det inte är en användardefinierad variabel. Dessutom är Var automatiskt läggs till i början när den publiceras.)

Att få ytterligare information

För mer information om xapi uttalande specifikation, besök https://github.com/adlnet/xAPI-Spec/blob/master/xAPI.md . För mer information om xapi uttalande generator och testare, besök http://tincanapi.com/statement-generator/ .

xapi Uttalande Utdataexempel (från SCORM Cloud)

2014-11-05T04: 05: 36,259
			Joe kungen passerade "http://www.uniqueurl.com/xAPI%20Template" med poängen 50
			2014-11-05T04: 05: 36,256
			Joe kungen svarade felaktigt "Survey Fråga 1" med svar "sant"
			2014-11-05T04: 05: 36,254
			Joe kungen svarade felaktigt "Min testfråga 2" med svar "falska"
			2014-11-05T04: 05: 36,251
			Joe Kung korrekt besvarade "My testfråga 1" med svar "sant"
			2014-11-05T04: 05: 34,803
			Joe kungen skickade "Custom-xapi-Statement"
			2014-11-05T04: 05: 34,047
			Joe Kung upplevt 'xapi Aktiviteter sida'
			2014-11-05T04: 05: 31,994
			Joe kungen upplevde "Efter Survey sida"
			2014-11-05T04: 05: 27,433
			Joe kungen upplevde "Sista undersökning sida"
			2014-11-05T04: 05: 25,582
			Joe kungen upplevde "Test 1 underkänd"
			2014-11-05T04: 05: 21,783
			Joe kungen misslyckades "Test 1" med poängen 50
			2014-11-05T04: 05: 17,391
			Joe kungen upplevde "Sista testsida"
			2014-11-05T04: 05: 12,855
			Joe kungen upplevde "Page 1"
			2014-11-05T04: 05: 10,555
			Joe kungen upplevde "Page 1"
			2014-11-05T04: 05: 09,837
		Joe Kung försökt 'http://www.uniqueurl.com/xAPI%20Template'

Försök Kurs Statement (auto)

2014-11-05T04: 05: 09,837
			Joe Kung försökt 'http://www.uniqueurl.com/xAPI%20Template'
			{
			"Id": "3d26bd57-0558-4a02-934d-501c7d85d3b7"
			"Skådespelare": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"Namn": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Verb": {
			"Id": "http://adlnet.gov/expapi/verbs/attempted"
			"Display": {
			"En-US": "försök"
			}
			}
			"Context": {
			"Registrering": "61d426da-436a-4b2a-8daa-ce94f6082f2f"
			"contextActivities": {
			"Gruppering": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Object": "Activity"
			}
			]
			}
			}
			"Tidsstämpel": "2014-11-05T04: 05: 07.734Z"
			"Lagrad": "2014-11-05T04: 05: 09.837Z"
			"auktoritet": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"Namn": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Version": "1.0.0",
			"Objekt": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Definition": {
			"namn": {},
			"Beskrivning": {}
			}
			"Object": "Activity"
			}
			}

Försök Kurs Statement (auto)

			2014-11-05T04: 05: 10,555
			Joe kungen upplevde "Page 1"
			{
			"Id": "3ed638c0-a422-41e5-b7d7-42bf43e59b39"
			"Skådespelare": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"Namn": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Verb": {
			"Id": "http://adlnet.gov/expapi/verbs/experienced"
			"Display": {
			"En-US": "upplevt"
			}
			}
			"Context": {
			"Registrering": "61d426da-436a-4b2a-8daa-ce94f6082f2f"
			"contextActivities": {
			"Gruppering": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Object": "Activity"
			}
			],
			"Förälder": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Object": "Activity"
			}
			]
			}
			}
			"Tidsstämpel": "2014-11-05T04: 05: 08.506Z"
			"Lagrad": "2014-11-05T04: 05: 10.555Z"
			"auktoritet": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"Namn": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Version": "1.0.0",
			"Objekt": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template/a001_page_1.html"
			"Definition": {
			"namn": {
			"En-US" "Page 1"
			}
			}
			"Object": "Activity"
			}
		}

Godkänd / missade testet Statement (auto)

2014-11-05T04: 05: 21,783
			Joe kungen misslyckades "Test 1" med poängen 50
			{
			"Id": "1820c7e8-6509-4c45-b672-af7ae301ec40"
			"Skådespelare": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"Namn": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Verb": {
			"Id": "http://adlnet.gov/expapi/verbs/failed"
			"Display": {
			"En-US": "misslyckades"
			}
			}
			"resultat": {
			"Poäng": {
			"Rå": 50,
			"Min": 0,
			"Max": 100
			}
			"Framgång" falsk,
			"Avslutad" falsk
			}
			"Context": {
			"Registrering": "61d426da-436a-4b2a-8daa-ce94f6082f2f"
			"contextActivities": {
			"Gruppering": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Object": "Activity"
			}
			],
			"Förälder": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Object": "Activity"
			}
			]
			}
			}
			"Tidsstämpel": "2014-11-05T04: 05: 20.030Z"
			"Lagrad": "2014-11-05T04: 05: 21.783Z"
			"auktoritet": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"Namn": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Version": "1.0.0",
			"Objekt": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template/Test%201"
			"Definition": {
			"namn": {
			"En-US": "Test 1"
			}
			}
			"Object": "Activity"
			}
		}

Fråga besvaras Statement (auto)

2014-11-05T04: 05: 36,251
			Joe Kung korrekt besvarade "My testfråga 1" med svar "sant"
			{
			"Id": "a8af22bf-8e38-447c-8e6a-500c3673f867"
			"Skådespelare": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"Namn": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Verb": {
			"Id": "http://adlnet.gov/expapi/verbs/answered"
			"Display": {
			"En-US": "svarade"
			}
			}
			"resultat": {
			"Framgång": true,
			"Svar": "true"
			}
			"Context": {
			"Registrering": "61d426da-436a-4b2a-8daa-ce94f6082f2f"
			"contextActivities": {
			"Gruppering": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Object": "Activity"
			}
			],
			"Förälder": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Object": "Activity"
			}
			]
			}
			}
			"Tidsstämpel": "2014-11-05T04: 05: 10.000Z"
			"Lagrad": "2014-11-05T04: 05: 36.251Z"
			"auktoritet": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"Namn": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Version": "1.0.0",
			"Objekt": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template-Question_1_67_1415160320014"
			"Definition": {
			"Beskrivning": {
			"En-US": "Min testfråga 1"
			}
			"Typ": "http://adlnet.gov/expapi/activities/cmi.interaction"
			"InteractionType": "sant-falskt",
			"CorrectResponsesPattern": [
			"sann"
			]
			}
			"Object": "Activity"
			}
			}

Custom xapi Uttalande från xapi Statement Action

2014-11-05T04: 05: 34,803
			Joe kungen skickade "Custom-xapi-Statement"
			{
			"Id": "6a108ff9-1bcc-4bb0-9021-732fb7bad775"
			"Skådespelare": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"Namn": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Verb": {
			"Id": "http://adlnet.gov/expapi/verbs/sent"
			"Display": {
			"En-US": "skickas"
			}
			}
			"resultat": {},
			"Context": {
			"Registrering": "61d426da-436a-4b2a-8daa-ce94f6082f2f"
			"contextActivities": {
			"Gruppering": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Object": "Activity"
			}
			],
			"Förälder": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Object": "Activity"
			}
			]
			}
			}
			"Tidsstämpel": "2014-11-05T04: 05: 32.376Z"
			"Lagrad": "2014-11-05T04: 05: 34.803Z"
			"auktoritet": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"Namn": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Version": "1.0.0",
			"Objekt": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template/Custom-xAPI-Statement"
			"Definition": {
			"namn": {
			"En-US": "Custom-xapi-Statement"
			}
			}
			"Object": "Activity"
			}
		}

Godkänd / Compld / Misslyckades Kurs Statement (auto)

2014-11-05T04: 05: 36,259
			Joe kungen passerade "http://www.uniqueurl.com/xAPI%20Template" med poängen 50
			{
			"Id": "6e8c000e-47d0-4b8c-842b-d9573422ce1b"
			"Skådespelare": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"namn": 
			"ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Verb": {
			"Id": "http://adlnet.gov/expapi/verbs/passed"
			"Display": {
			"En-US": "passerade"
			}
			}
			"resultat": {
			"Poäng": {
			"Rå": 50,
			"Min": 0,
			"Max": 100
			}
			"Framgång": true,
			"Avslutad": true,
			"Varaktighet": "PT25.97S"
			}
			"Context": {
			"Registrering": "61d426da-436a-4b2a-8daa-ce94f6082f2f"
			"contextActivities": {
			"Gruppering": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Object": "Activity"
			}
			]
			}
			}
			"Tidsstämpel": "2014-11-05T04: 05: 33.714Z"
			"Lagrad": "2014-11-05T04: 05: 36.259Z"
			"auktoritet": {
			"Namn": "Joe King",
			"konto": {
			"Hemsida": "http://cloud.scorm.com/"
			"Namn": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			}
			"Object": "Agent"
			}
			"Version": "1.0.0",
			"Objekt": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template"
			"Object": "Activity"
			}
			}