Paigaldamine

Learning Pixel teenuse paigaldamiseks lisatakse veebirakenduse <head> elemendi sisse järgnev koodilõik analoogselt Google Analytics jt teenustele.

<script>
!function(e,t,n,a,p,s,i,u,c){e[p]||((i=e[p]=function(){i.process?i.process.apply(i,arguments):i.queue.push(arguments)}).queue=[],i.t=1*new Date,(u=t.createElement(n)).async=1,u.src="https://pixel.harid.ee/v1/openpixel.js?t="+864e5*Math.ceil(new Date/864e5),(c=t.getElementsByTagName(n)[0]).parentNode.insertBefore(u,c))}(window,document,"script",0,"edux"),edux("init","ID-XXXXXXXX"),edux("event","pageload");
</script>

Eelnevas näites toodud koodi paigaldades tuleb ID-XXXXXXXX asendada teenusepakkuja poolt väljastatud rakenduse identifikaatoriga. Koodid ID-00000001 - ID-00000999 on reserveeritud Harno poolt hallatud rakendustele.

Google Tag Manager'i kasutajad saavad koodi lisada lisades uue tag'i mille liigiks on "Custom HTML" ja kopeerida koodilõigu sinna sisse.

NB. Single-page rakenduste (Single Page Application (SPA)) puhul tuleb kasutaja õpiraja läbimise kohta kasutada sündmuseid. Vaata kuidas toimub Google Tag Manager'i kaudu õpiraja teenuse SPA-le lisamine.

Sündmused

Paigaldatuna õppematerjalile toetab õpiraja korjamise teenus (Learning Pixel) automaatselt järgnevat kahte sündmust:

  • pageload sündmus saadetakse digitaalse õppematerjali veebilehe laadimisel,
  • pageclose sündmus saadetakse siis kui veebileht suletakse või sellelt navigeeritakse eemale.

Need sündmused teisendatakse xAPI lauseteks automaatselt. 

Samas võimaldab Learning Pixel teenus õppematerjali kasutamise kohta edastada täiendavaid sündmuseid, kus on määratud xAPI verb ja mis samuti teisendatakse automaatselt õpikogemuse xAPI lauseteks kasutades veebilehel olevat avalikku metainfo õppematerjali kohta.

edux('event', 'http://adlnet.gov/expapi/verbs/completed')

Lisaks saab sündmusele anda kaasa kolmanda parameetrina täiendavad detailid õpikogemuse objekti (vajalik juhul kui see erineb aktiivsest URList) ja registreeritud kasutaja kohta JSON'is. Nende täpne kasutus on kirjeldatud järgevates sektsioonides.

edux('event', 'http://adlnet.gov/expapi/verbs/completed', {actor: '17', object: 'https://e-koolikott.ee/materjal/20179-materjal#video'})

Õpiraja teenuse kaudu õppija pseudonüümi edastamine

Selleks, et võimaldada kasutajapõhist haridusrakenduste kasutamise analüütikat üle eri rakenduste, selleks saab kasutaja tunnuse edastada õpiraja teenusele järgnevalt

edux('event', EVENT, {actor: USER_ID})

kus EVENT on sündmuse identifikaator ja USER_ID kasutaja pseudonüüm, nt

edux('event', 'http://activitystrea.ms/schema/1.0/consume', {actor: '203223'})

Tähelepanu: USER_ID väärtus peaks olema unikaalne, kestev (persistent) ja isiku tuvastamist mittevõimaldav kasutaja identifikaator, mis esitab külastajat või kasutajat eri seadmetes.

Õpiraja teenuse kaudu õppevara metainfo lisamine

Juhtudel, kus õppevara metainfot ei saa vahetult seostada õppevaraga (IoT seadmed; dünaamiliselt loodud õppevara, mille eluiga on lühike, ...) või pole õppevara kirjeldus avalik (nt eksamiülesanded), saab metainfo edastada õpiraja teenuse kaudu. Sel juhul luuakse xAPI lause õppetöös kasutatud rakenduses ja edastatakse järgnevalt 

edux('event', 'http://activitystrea.ms/schema/1.0/consume', {
  "actor": {
    "objectType": "Agent",
    "account": {
      "homePage": "https://opiq.ee",
      "name": "203223"
    }
  },
  "verb": {
    "id": "http://activitystrea.ms/schema/1.0/consume",
    "display": {
      "et-EE": "luges"
    }
  },
  "context": {
    "platform": "Opiq",
    "extensions": {
      "https://schema.edu.ee/seotudAinevaldkond": "https://schema.edu.ee/ainevaldkond/sots",
      "https://schema.edu.ee/seotudOppeaine": "https://schema.edu.ee/oppeaine/A",
      "https://schema.edu.ee/kooliaste": "https://schema.edu.ee/kooliaste/III",
      "https://schema.edu.ee/klass": "8",
      "https://schema.edu.ee/seotudTeema": "https://schema.edu.ee/teema/estcore/50148",
      "https://schema.edu.ee/seotudTeema": "https://schema.edu.ee/teema/estcore/30175:41803",
      "https://schema.edu.ee/seotudOpivaljund": "https://oppekava.edu.ee/a/Kirjeldab_Saksa_rahvusriigi_loomist",
      "https://schema.edu.ee/seotudOpivaljund": "https://oppekava.edu.ee/a/Kirjeldab_Vene_tsaaririigi_poliitikat_Balti_kubermangudes",
      "https://schema.edu.ee/seotudOpivaljund": "https://oppekava.edu.ee/a/Teab_venestusaja_m%C3%B5ju_Eesti_elule_19._sajandi_l%C3%B5pus"
    }
  },
  "object": {
    "id": "https://www.opiq.ee/kit/37/chapter/1712",
    "definition": {
      "name": {
        "et-EE": "Euroopa uusaja hakul"
      },
      "type": "http://id.tincanapi.com/activitytype/resource"
    }
  }
})

Teenuse poolt korjatud andmed

Õpiraja teenus edastab järgnevaid andmeid:

ParameeterNäidisSelgitus
idID-00001998Selle veebirakenduse identifikaator, kust õpiraja teenus välja kutsutakse
uid1-u3n3ygu1-k0279f1hAnonüümse kasutaja unikaalne identifikaator
evpageloadKasutaja tegevusega seotud sündmus, millest õpiraja teenust teavitatakse, vaikimisi lehe laadimine või lehe sulgemine
ed{"verb": { "id": "http://adlnet.gov/expapi/verbs/experienced", "display": { "en-US": "experienced" }}}valikulised andmed, millest rakendus (teenusepakkuja soovil) õpiraja teenust teavitab, nt xAPI väljend (vt nt https://xapi.com/statements-101/)
v2.1Õpiraja teenuse versiooni number
dlhttps://e-koolikott.ee/kogumik/19709-1-4-AsustusVeebileht, kust õpiraja teenus välja kutsuti
rlhttps://google.comVeebileht, kust liiguti lehele, kust omakorda õpiraja teenus välja kutsuti
ts1461175033655Ajatempel kasutaja arvutis
deUTF-8Selle veebilehe kodeering, kust õpiraja teenus välja kutsuti
sr1680x1050Kasutaja seadme ekraani resolutsioon
vp1680x295Rakenduse vaateava suurus kasutaja ekraanil (i.k. viewport)
cd24Bittide arv, mida kasutakse üksiku piksli värvi kodeerimiseks kasutaja seadmes
dt1.4. AsustusSelle veebilehe pealkiri, kust õpiraja teenus välja kutsuti
bnChrome 79Kasutaja brauseri nimi
mdfalseKas tegemist on mobiilse seadmega (true / false)
uaMozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.79 Safari/537.36Kasutaja agent
tz240Ajatsooni nihe kasutaja seadmes
utm_source
Kampaania allika tunnus  (teenusepakkuja soovil)
utm_medium
Kampaania meediumi tunnus  (teenusepakkuja soovil)
utm_term
Kampaania termin (teenusepakkuja soovil)
utm_content
Kampaania sisu tunnus (teenusepakkuja soovil)
utm_campaign
Kampaania nimi (teenusepakkuja soovil)

Lisaks korjab teenus järgnevaid teenuse kasutamise andmeid

NäidisSelgitus
193.40.194.227

Teenuse kasutaja IP address

[17/Dec/2019:10:39:23 +0200]

Teenuse väljakutsumise ajatempel

1-ewxz2os9-k14pr1v3

Anonüümse kasutaja unikaalne tunnus (vt __edux_uid Haridusrakenduste küpsiste detailid)


Teenuse väljakutsumiseks kulunud aeg

405

Kas teenuse väljakutsumise õnnestus (HTTP staatus)

559

Teenuse kasutamise käigus edastatud andmete maht

d5c917d6-8a41-4d23-ad4d-54de132dbf91

HarID'i kasutaja unikaalne tunnus (vt pixel_uuid Haridusrakenduste küpsiste detailid)


TODO: EstCORE 2 raames on vaja täpsustada JSON skeem ja sündmuste nomenklatuur ja nende teisendused xAPI lauseteks. 

  • No labels

2 Comments

  1. pixel_uuid küpsise kohta: rakendus võib küll edastada vaid pseudonüümse kasutaja tunnuse (actor: USER_ID), aga kui päringuga koos saadetakse automaatselt HarID pixel_uuid väärtus (kuna piksli-teenus on HarID-ga samal domeenil), saab HarID andmed ikkagi konkreetse kontoga seotult ehk isikustatult.

    Et analüütika kogumine oleks suurema garantiiga päriselt mitte-isikustatav, peaks kõik piksliga seonduva liigutama eraldi domeenile (à la analyytika.edu.ee), mis ei ole kuidagi autentimisega seotud, sidudes analüütika kogumise nii tehniliselt kui kontseptuaalselt HarID-st lahti.

    1. (Küsimus/probleem suunatud eelkõige Peep Küngas-ele)