Allyn API:n integrointi ulkoiseen raportointityökaluun

Ulkoisilla raportointityökaluilla on lukuisia etuja, kuten parannettu tietojen visualisointi, mukautusvaihtoehdot ja automatisoidut raportointiprosessit. Oppilaitokset voivat analysoida monimutkaisia tietojoukkoja helposti käyttämällä erilaisia kaaviotyyppejä, graafisia esityksiä ja koontinäyttöjä. Ne voivat räätälöidä raportteja erityistarpeisiinsa mukauttamalla näytettäviä tietoelementtejä. Automaattinen raportointi säästää käyttäjien arvokasta aikaa ja resursseja sekä tehostaa raporttien luomista.

Oppilaitokset voivat hyödyntää tietoja ja tehdä entistä helpommin tietoon perustuvia päätöksiä, kun Allyn API:n tietojen noudon ominaisuudet yhdistetään suosittujen raportointityökalujen kehittyneisiin visualisointi- ja analyysiominaisuuksiin.

Päätepisteiden asianmukaisesta määrittämisestä ja mukauttamisesta kerrotaan raportoinnin API-päätepisteiden teknisessä dokumentaatiossa.

Ennen aloittamista

Jotta voit integroida Allyn API:n haluamaasi raportointityökaluun, tarvitset seuraavat:

• ulkoinen raportointityökalu, kuten Power BI, Tableau, Microsoft Excel tai SAP Analytics
• Allyn institutionaalisen raportin käyttöoikeus (vain järjestelmänvalvoja)
• API-valtuutustunniste (saatavilla institutionaalisesta raportista)
• päätepisteen URL-osoite (saatavilla tältä ohjesivulta)
• Ally-asiakastunnuksesi (ota yhteyttä asiakastukeemme, jos sinulla ei ole tätä tunnusta)

Tarvittavien määritysten tekeminen edellyttää tämän ohjesivun, institutionaalisen raportin ja ulkoisen raportointityökalun käyttämistä vuorotellen. 

Allyn API:n integrointi ulkoiseen raportointityökaluun

• Avaa oppilaitosraportti. Lue, miten voit avata institutionaalisen raportin.
• Valitse Yleiskatsaus-välilehden oikeasta reunasta Vie-painike.
• Valitse Yhdistä ulkoinen työkalu.
    

• Näkyviin tulee modaalinen ikkuna, jossa on automaattisesti luotu tunniste. Valitse Kopioi tunniste.

API-tunnisteet vanhenevat vuoden kuluttua. Voit hankkia uuden tunnisteen määrittämällä ulkoisen raportointityökalun uudelleen tämän oppaan avulla.    

• Siirry haluamaasi ulkoiseen raportointityökaluun. Tässä esimerkissä näytämme, miten Allyn API määritetään Power BI:n avulla.
   

Muilla ulkoisilla raportointityökaluilla on erilaiset käyttöliittymät, mutta niissä kaikissa suoritetaan samankaltaiset vaiheet kuin alla. Raportointityökalun dokumentaatiosta saat tarvittaessa apua tietolähteen määrittämiseen.  
 

• Avaa Power BI Desktop.
• Valitse Home-välilehden vaihtoehdoista Get Data. 
• Valitse näytettävästä luettelosta Verkko .&rkl; &rkl;
    

• Valitse modaalisesta From web -ikkunasta Advanced-vaihtoehto. 
• Kirjoita HTTP request header parameter -kenttään Authorization.
• Kirjoita oikealla olevaan tekstiruutuun Bearer, lisää välilyönti ja liitä tunniste institutionaalisesta raportista.
• Kopioi jompikumpi seuraavista päätepiste-URL-osoitteista:
  • https://[Alue]/api/v2/clients/Ally-asiakastunnus]/reports/overall
  • https://[Alue]/api/v2/clients/[Ally-asiakastunnus]/reports/issues 

Allyn raporttitiedot voidaan jakaa Overview- ja Issues-luokkiin. Molemmat koskevat kaikkia oppilaitoksesi kursseja. Valitse haluamasi päätepiste-URL-osoite.  

• Liitä päätepisteen URL-osoite Power BI:n From Web -ikkunan URL-polkujen kenttään.
• Korvaa [Ally-asiakastunnus] omalla Ally-tunnuksellasi.

Jos sinulla ei ole tätä tunnusta, ota yhteyttä asiakastukeemme. Kyseessä on siis Ally-asiakastunnus, ei LMS-tunnus.

• Korvaa [Alue] sen mukaan, millä alueella oppilaitoksesi Ally-ympäristöä isännöidään:
  • Yhdysvaltain palvelinkeskus: prod.ally.ac
  • Kanadan palvelinkeskus: prod-ca-central-1.ally.ac
  • Euroopan palvelinkeskus: prod-eu-central-1.ally.ac
  • Singaporen palvelinkeskus: prod-ap-southeast-1.ally.ac
  • Australian palvelinkeskus: prod-ap-southeast-2.ally.ac
• Kun nämä vaiheet on suoritettu, Power BI:n modaalisen From Web -ikkunan pitäisi näyttää tältä: 

• Jos haluat aloittaa kyselyn annettujen tietojen perusteella, valitse OK.

Tietuejoukko saattaa vaatia valmisteluaikaa sen mukaan, kuinka paljon tietueita on. Ally vastaa "tilalla", joka ilmoittaa käyttäjälle, jos tietojen käsittely on kesken. Power BI:ssä tämän tilan voi nähdä valitsemalla Expanded metadata ja etsimällä sen sarakkeesta metadata.status:

Kun tilana on Processing, on odotettava tietojen valmistumista. Valitsemalla ylänauhan Refresh preview -painikkeen voit kutsua ohjelmointirajapintaa uudelleen ja katsoa, ovatko tiedot valmiina, Jos tietojoukko on valmis, kaikki tietueet ovat näkyvissä ja sarakkeessa metadata.status näkyy tila Successful.

• Valitse lopuksi Close & Apply vasemmassa yläkulmassa.

Tietojen päivitysaika 
Päätepisteiden lähdetiedot päivittyvät sisäisesti 15 minuutin välein. Ota tämä huomioon, kun kutsut päätepistettä raporttien tietojen noutamiseksi. 

Vastausraja
Muista, että päätepistekutsun vastausraja on 10 000 tietuetta. Jos osa tietueista ei näy 10 000 ensimmäisen tietueen joukossa, sinun on käytettävä suodatus- tai lajitteluvaihtoehtoja.