Travailler avec l'API d'expérience (xapi)

Cette section décrit comment travailler avec la spécification elearning xapi. Cette API d'expérience, connue sous le nom xapi, permet aux développeurs de contenu de recueillir des données basées sur l'expérience d'apprentissage de leurs utilisateurs. La section comprend des informations sur la façon de publier avec les options de xapi et de comprendre les énoncés d'expérience xapi. Pour les dernières spécifications, les documents et les explications des termes, visitez le site Web de xapi officiel ( http://tincanapi.com/ ).

La publication avec les options de xapi

Vous devez publier xapi pour permettre aux relevés xapi automatisés et manuels. Suivez les étapes décrites dans Publishing à xapi pour préparer votre titre pour la publication à xapi.

La plupart des déclarations de xapi automatiques sont contrôlés par les options de publication lorsque vous publiez un titre à xapi. Ces options sont regroupées sur l' options xapi onglet après avoir cliqué sur Publish :

Niveau de conformité	Ce champ est désactivé.
Lancement de cours dans une fenêtre séparée de LRS	Sélectionnez cette option si vous souhaitez que le titre publié à lancer dans une nouvelle fenêtre. Lorsque cette option est sélectionnée, et l'utilisateur quitte le titre publié, la fenêtre se ferme, et l'utilisateur sera retourné aux LRS.
rapport de test / interaction des questions de sondage à LRS	Sélectionnez cette option pour enregistrer les données d'interaction pour les questions contenues dans le test classé soumis à la LRS. les données d'interaction comprend les informations suivantes pour chaque question notée: La réponse de l'utilisateur Que ce soit la réponse de l'utilisateur est correcte ou non Temps, la question a été répondue De temps l'utilisateur a passé sur la page contenant la réponse
Invite l'utilisateur à accéder à la dernière page consultée	Sélectionnez cette option pour activer la fonction de partage de signets automatique pour le titre publié. Lorsque cette option est sélectionnée, et l'utilisateur revient au titre publié dans les LRS, l'utilisateur aura la possibilité de passer à la page il consulté la dernière fois dans le titre publié.
ID d'activité	Spécifiez l'ID du cours comme il sera connu dans les LRS.
Nom de l'activité	Indiquez le titre du cours que vous voulez qu'il soit affiché dans les LRS.
Description de l'activité	Spécifiez la description du contenu du cours que vous voulez qu'il soit affiché dans les LRS.

Considérez ce qui suit lors de la sélection des options xapi options onglet:

Notez que l' ID d'activité , Nom de l' activité , et Description de l' activité pour le cours peuvent être réglés ici. Les options sont utilisées comme contexte pour d' autres déclarations. Lors de la création de l' ID d'activité , assurez - vous de suivre les règles d'une IRI (International Resource Identifier), par exemple en évitant des espaces et des caractères spéciaux.
L'option Append horodatage à l' interaction pour créer un identifiant unique est toujours désactivée de sorte qu'une question rapporte toujours des réponses avec le même ID d'activité.
Une déclaration d'activité tentative est envoyée automatiquement lorsque le cours est commencé. Il est envoyé pour l'activité spécifiée dans l' information Cours section (spécifié par ID d'activité , l' activité Nom et Description de l' activité ) des options de publication xapi.

Lorsque l'option invite l'utilisateur à accéder à la dernière page affichée est sélectionnée, votre cours publié peut signaler une déclaration xapi avec le verbe expérimenté pour chaque page visitée par un apprenant. L'activité dans c'est le nom de la page HTML et il est codé URI de sorte qu'il peut être utilisé pour lalectora en ligne Fonction de partage de signets.

Si vous voulez suivre les progrès dans le cours, ajouter ces deux actions au niveau du titre:

Le Show - xapi Déclaration - tentative - VAR (CurrentPageName)
Le Hide - terminé - - xapi Déclaration VAR (CurrentPageName)

Questions à l' intérieur d'un test ou d'une enquête seront communiqués lorsque répondu si l'option Rapport test / interaction question de l' enquête sur les LRS est sélectionné. Le texte de la question et la réponse sont énoncées dans la déclaration xapi.

Le test doit être classé, mais il n'a pas besoin d'être inclus dans la note globale.
De plus, le ActivityContext - Parent déclaration du paragraphe est définie à l'activité de son test.

Envoi d'états d'essai est conforme ou non

Est conforme ou non relevés xapi seront envoyés automatiquement pour les tests qui sont configurés pour être classés. Le score est réglé avec le verbe passé ou échoué . Le nom d'affichage de l' objet est le nom du test. L'ID est l'IRI de l'activité avec le nom du test ajouté. (Voir les exemples ci - dessous.)

Les propriétés score de résultat pour min à 0 et max à 100 sont tous à 0 par défaut. Le plus bas Score Passing (%) champ (situé sur l'essai Les résultats de l' onglet) doit être toujours inclus , même si elle est définie à 0 (en cas d'aucun correct).

Envoi, ordonnancées ou états d'activité Échec

Lorsque vous définissez la AICC_Lesson_Status variable une instruction xapi est envoyé. Les conditions suivantes détermineront quel type de déclaration est envoyé:

Vous pouvez utiliser une action variable modifier pour définir AICC_Lesson_Status à terminée , passé ou échoué . Si cela est fait, le cours envoie un correspondant Achevé ou Passed ou Failed déclaration.
Réglage AICC_Lesson_Status de passé ou terminé établira la déclaration de XAPI de result.completion à vrai et le result.success à vrai . Si AICC_Lesson_Status est terminée et le score est inférieur au score de maîtrise de l' UA, result.success sera faux .
Si AICC_Lesson_Status est réglé sur échec , la déclaration de XAPI de result.completion est réglé sur vrai et result.success est réglé sur faux .
Le score devrait être inclus dans la déclaration d'achèvement si elle existe si vous avez un étalonnée, inclus test ou si vous définissez manuellement AICC_Score .

Envoi d'une déclaration xapi

Vous pouvez envoyer une déclaration xapi en tout lieu au cours. Il sera par défaut les éléments de déclaration de xapi commune vous permettant de spécifier un verbe et un objet. Cela peut être déclenché sur l' un des nombreux déclencheurs disponibles pour les actions. Si vous avez besoin un contrôle total sur la déclaration et toutes ses valeurs voir Spécification des verbes et des objets ci - dessous.

Spécification des verbes et des objets

lectora en ligneADL utilise les définitions pour les verbes. En outre, un nom de verbe peut être saisi. Les noms de verbes saisis sont ajoutés à l'espace de noms ADL afin des verbes au futur ADL peuvent être utilisés, ou vous pouvez utiliser votre propre verbe unique. (Les LRS ne validerait pas le verbe et vous permettrait d'en faire rapport;. Permettant ainsi l'utilisation de cet espace de noms)

Pour plus d' informations sur les verbes, visitez http://www.adlnet.gov/expapi/verbs .

Pour la partie de l'objet de la déclaration, vous pouvez utiliser l'une des variables dynamiques à l'aide et les modifier avancées macros variables. Vous pouvez également utiliser du texte pour signaler toute activité. Ce champ d'objet sera l'identificateur d'activité. Pour ce faire est un IRI valide, un remplacement minimal de caractères se fait en utilisant cette expression:

ActivityID (L'emplacement de l'ID d'activité)

Envisagez d'utiliser des actions conditionnelles et des groupes d'action pour la capacité de faire des scénarios de suivi complexes.

Définition des valeurs des états supplémentaires

Les valeurs ActivityContext sont automatiquement réglées.

Envoi d'une déclaration xapi et la mise à jour dynamiquement l'instruction

Utilisation de l'exécuter une action Javascript, vous pouvez personnaliser et mettre à jour dynamiquement l'instruction xapi que vous passez par le titre avec votre apprenant en utilisant des variables définies dans votre titre. Cela vous permet de configurer facilement des modèles qui satisferont tous les cas d'utilisation.

Ci-dessous un exemple simple mais efficace de Javascript que vous pouvez exécuter en utilisant l'action .. Ce javascript créerez la déclaration, puis envoyer la déclaration que vous avez créé.

var stmt=
			
			{
			"Verbe": {
			"Id": VarxAPIVerbID.getValue (),
			"afficher": {
			"Und": VarxAPIVerbDisplay.getValue ()
			}
			},
			"objet": {
			"Définition": {
			"prénom": {
			"En-US": "xAPIandLODemo"
			}
			},
			"Id": "http://uniqueurl.com/xAPIandLoDemo",
			"ObjectType": "Activité"
			},
			"résultat": {
			"But": {
			"Réduite": (parseInt (Test_1_Score.getValue ()) / 100)
			},
			"Achèvement": true,
			"Succès": true
			}
			}

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

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

L'énoncé ci-dessus contient certains appels de fonction pour obtenir la valeur de lectora en ligneles variables. Celles-ci pourraient aussi être des valeurs de chaîne statiques, par exemple, si vous vouliez simplement spécifier le verbe et d'autres valeurs dans la déclaration.

Voici deux options pour la personnalisation de la déclaration xapi:

VarxAPIVerbID.getValue()

Celui - ci utilise la variable définie par l'utilisateur xAPIVerbID. Utilisez le même préfixe Var comme si vous référencez la variable dans toutes les autres actions. Vous pouvez définir cette variable à un verbe que vous voulez. Assurez - vous que vous faites à la fois l' ID et l' affichage .

Dans cet exemple, ID est une URI telle quehttp://adlnet.gov/expapi/verbs/answered

(Un exemple correspondant d' affichage est répondu .)

(parseInt(Test_1_Score.getValue()) / 100) Celui - ci utilise une variable réservée Test_1_Scorepour envoyer le score qu'ils ont reçu sur le test. (Cela ne veut pas le préfixe Var car il est pas une variable définie par l' utilisateur. De plus, le Var est automatiquement ajouté au début quand il est publié.)

Obtenir des informations supplémentaires

Pour plus d' informations sur les spécifications de déclaration xapi, visitez https://github.com/adlnet/xAPI-Spec/blob/master/xAPI.md . Pour plus d' informations sur le générateur d'états xapi et testeur, visitez http://tincanapi.com/statement-generator/ .

xapi Déclaration Exemples de sortie (à partir de nuage SCORM)

2014-11-05T04: 05: 36,259
			Joe King a passé 'http://www.uniqueurl.com/xAPI%20Template' avec un score de 50
			2014-11-05T04: 05: 36,256
			Joe King a répondu de manière incorrecte « Enquête Question 1 » Réponse « true »
			2014-11-05T04: 05: 36,254
			Joe King a répondu de manière incorrecte « Mon test Question 2 » avec une réponse « faux »
			2014-11-05T04: 05: 36,251
			Joe King correctement répondu 'Mon test Question 1' Réponse 'true'
			2014-11-05T04: 05: 34,803
			Joe King envoyé 'Custom-xapi-déclaration'
			2014-11-05T04: 05: 34,047
			Joe King a connu 'Actions xapi page'
			2014-11-05T04: 05: 31,994
			Joe King a connu « Après enquête page »
			2014-11-05T04: 05: 27,433
			Joe King expérimenté page la dernière enquête '
			2014-11-05T04: 05: 25,582
			Joe King expérimenté 'Test 1 Fail'
			2014-11-05T04: 05: 21,783
			Joe King n'a pas 'Test 1' avec un score de 50
			2014-11-05T04: 05: 17,391
			Joe King expérimenté page de dernier test '
			2014-11-05T04: 05: 12,855
			Joe King a connu 'Page 1'
			2014-11-05T04: 05: 10,555
			Joe King a connu 'Page 1'
			2014-11-05T04: 05: 09,837
		Joe King a tenté 'http://www.uniqueurl.com/xAPI%20Template'

Déclaration du cours Tentative (auto)

2014-11-05T04: 05: 09,837
			Joe King a tenté 'http://www.uniqueurl.com/xAPI%20Template'
			{
			"Id": "3d26bd57-0558-4a02-934d-501c7d85d3b7",
			"acteur": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"Name": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Verbe": {
			"Id": "http://adlnet.gov/expapi/verbs/attempted",
			"afficher": {
			"En-US": "tentions"
			}
			},
			"le contexte": {
			"Inscription": "61d426da-436a-4b2a-8daa-ce94f6082f2f",
			"contextActivities": {
			"Groupement": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"ObjectType": "Activité"
			}
			]
			}
			},
			"Horodatage": "2014-11-05T04: 05: 07.734Z",
			"Stockés": "2014-11-05T04: 05: 09.837Z",
			"Autorité": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"Name": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Version": "1.0.0",
			"objet": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"Définition": {
			"prénom": {},
			"la description": {}
			},
			"ObjectType": "Activité"
			}
			}

Déclaration du cours Tentative (auto)

			2014-11-05T04: 05: 10,555
			Joe King a connu 'Page 1'
			{
			"Id": "3ed638c0-a422-41e5-b7d7-42bf43e59b39",
			"acteur": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"Name": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Verbe": {
			"Id": "http://adlnet.gov/expapi/verbs/experienced",
			"afficher": {
			"En-US": "expérimentés"
			}
			},
			"le contexte": {
			"Inscription": "61d426da-436a-4b2a-8daa-ce94f6082f2f",
			"contextActivities": {
			"Groupement": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"ObjectType": "Activité"
			}
			],
			"parent": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"ObjectType": "Activité"
			}
			]
			}
			},
			"Horodatage": "2014-11-05T04: 05: 08.506Z",
			"Stockés": "2014-11-05T04: 05: 10.555Z",
			"Autorité": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"Name": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Version": "1.0.0",
			"objet": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template/a001_page_1.html",
			"Définition": {
			"prénom": {
			"En-US": "Page 1"
			}
			},
			"ObjectType": "Activité"
			}
		}

Passé / Echec Déclaration de test (auto)

2014-11-05T04: 05: 21,783
			Joe King n'a pas 'Test 1' avec un score de 50
			{
			"Id": "1820c7e8-6509-4c45-B672-af7ae301ec40",
			"acteur": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"Name": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Verbe": {
			"Id": "http://adlnet.gov/expapi/verbs/failed",
			"afficher": {
			"En-US": "a échoué"
			}
			},
			"résultat": {
			"But": {
			"Brut": 50,
			"Min": 0,
			"Max": 100
			},
			"Succès": false,
			"Achèvement": false
			},
			"le contexte": {
			"Inscription": "61d426da-436a-4b2a-8daa-ce94f6082f2f",
			"contextActivities": {
			"Groupement": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"ObjectType": "Activité"
			}
			],
			"parent": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"ObjectType": "Activité"
			}
			]
			}
			},
			"Horodatage": "2014-11-05T04: 05: 20.030Z",
			"Stockés": "2014-11-05T04: 05: 21.783Z",
			"Autorité": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"Name": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Version": "1.0.0",
			"objet": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template/Test%201",
			"Définition": {
			"prénom": {
			"En-US": "Test 1"
			}
			},
			"ObjectType": "Activité"
			}
		}

Question Déclaration Answered (auto)

2014-11-05T04: 05: 36,251
			Joe King correctement répondu 'Mon test Question 1' Réponse 'true'
			{
			"Id": "a8af22bf-8e38-447c-8e6a-500c3673f867",
			"acteur": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"Name": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Verbe": {
			"Id": "http://adlnet.gov/expapi/verbs/answered",
			"afficher": {
			"En-US": "répondu"
			}
			},
			"résultat": {
			"Succès": true,
			"Réponse": "true"
			},
			"le contexte": {
			"Inscription": "61d426da-436a-4b2a-8daa-ce94f6082f2f",
			"contextActivities": {
			"Groupement": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"ObjectType": "Activité"
			}
			],
			"parent": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"ObjectType": "Activité"
			}
			]
			}
			},
			"Horodatage": "2014-11-05T04: 05: 10.000Z",
			"Stockés": "2014-11-05T04: 05: 36.251Z",
			"Autorité": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"Name": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Version": "1.0.0",
			"objet": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template-Question_1_67_1415160320014",
			"Définition": {
			"la description": {
			"En-US": "Mon test Question 1"
			},
			"Type": "http://adlnet.gov/expapi/activities/cmi.interaction",
			"InteractionType": "vrai-faux",
			"CorrectResponsesPattern": [
			"vrai"
			]
			},
			"ObjectType": "Activité"
			}
			}

Déclaration de coutume xapi xapi Action Déclaration

2014-11-05T04: 05: 34,803
			Joe King envoyé 'Custom-xapi-déclaration'
			{
			"Id": "6a108ff9-1bcc-4bb0-9021-732fb7bad775",
			"acteur": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"Name": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Verbe": {
			"Id": "http://adlnet.gov/expapi/verbs/sent",
			"afficher": {
			"En-US": "envoyé"
			}
			},
			"résultat": {},
			"le contexte": {
			"Inscription": "61d426da-436a-4b2a-8daa-ce94f6082f2f",
			"contextActivities": {
			"Groupement": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"ObjectType": "Activité"
			}
			],
			"parent": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"ObjectType": "Activité"
			}
			]
			}
			},
			"Horodatage": "2014-11-05T04: 05: 32.376Z",
			"Stockés": "2014-11-05T04: 05: 34.803Z",
			"Autorité": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"Name": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Version": "1.0.0",
			"objet": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template/Custom-xAPI-Statement",
			"Définition": {
			"prénom": {
			"En-US": "Custom-xapi-déclaration"
			}
			},
			"ObjectType": "Activité"
			}
		}

Passé / Compld / Echec Déclaration du cours (auto)

2014-11-05T04: 05: 36,259
			Joe King a passé 'http://www.uniqueurl.com/xAPI%20Template' avec un score de 50
			{
			"Id": "6e8c000e-47d0-4b8c-842 ter-d9573422ce1b",
			"acteur": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"prénom": 
			"ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Verbe": {
			"Id": "http://adlnet.gov/expapi/verbs/passed",
			"afficher": {
			"En-US": "passé"
			}
			},
			"résultat": {
			"But": {
			"Brut": 50,
			"Min": 0,
			"Max": 100
			},
			"Succès": true,
			"Achèvement": true,
			"Durée": "PT25.97S"
			},
			"le contexte": {
			"Inscription": "61d426da-436a-4b2a-8daa-ce94f6082f2f",
			"contextActivities": {
			"Groupement": [
			{
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"ObjectType": "Activité"
			}
			]
			}
			},
			"Horodatage": "2014-11-05T04: 05: 33.714Z",
			"Stockés": "2014-11-05T04: 05: 36.259Z",
			"Autorité": {
			"Name": "Joe King",
			"Compte": {
			"HomePage": "http://cloud.scorm.com/",
			"Name": "ZUASCUHYVJ|wieloch@trivantisboca.com"
			},
			"ObjectType": "Agent"
			},
			"Version": "1.0.0",
			"objet": {
			"Id": "http://www.uniqueurl.com/xAPI%20Template",
			"ObjectType": "Activité"
			}
			}