Gallwch ffurfweddu eich opsiynau integreiddio Instructure OneRoster ar bob lefel cysylltiad cleient.
Yn ystod eich cyfnod profi alffa integreiddio, bydd Instructure yn gweithio gyda chi i sefydlu gosodiadau ffurfweddu diofyn a argymhellir ar gyfer eich sefydliad.
Dysgu mwy amffurfweddiadau gwasanaeth rhestruaarferion gorau integreiddio rhestru.
Nodyn:Mae Instructure yn Ddefnyddiwr OneRoster. Am ddiffiniadau Defnyddiwr a Darparwr OneRoster, gweler yCyflwyniad i OneRoster.
Cydamseredd
Cydamseredd yw nifer y pwyntiau terfyn i'w llinynnu ar un adeg. Gyda chydamseredd o dri, ffurfweddwch hyd at dri phwynt terfyn cydamserol ar wahân. Er enghraifft, gallech ddefnyddio'rcaelTermau,caelAthrawon,caelDosbarthiadaupwyntiau terfyn ar yr un pryd.
Dysgu mwy am ffurfweddupwyntiau terfyn rhestru penodol i'r ysgoli ganiatáu cysoni data cofrestru ar yr un pryd.
Nodyn:Nid yw Instructure yn defnyddio cydamseredd i dudalennu. O ganlyniad, mae'r llwyth data mor araf â'r amser ymateb pwynt terfynol arafaf ynghyd â'r tudalennu ar un edau.
Trin Gwallau
Mae trin gwallau yn ymwneud â ffurfweddu codau gwall a ddangosir.
Dilynwch yr OneRostermanylebau trin gwallauYn ogystal, argymhellir eich bod yn cynnwys eich enw SIS ar ddechrau'rdisgrifiad_imsxMae hyn yn caniatáu i'r integreiddiad arddangos disgrifiadau gwall addysgiadol yn awtomatig ar gyfer defnyddwyr terfynol.
Pwyntiau Terfynol wedi'u heithrio
Pwyntiau terfyn sydd wedi'u heithrio yw'r pwyntiau terfyn nad ydynt wedi'u cynnwys mewn galwad API.
Os yw dau bwynt terfyn yn dychwelyd setiau data union yr un fath, eithriwch un set ddata i leihau nifer y galwadau API. Er enghraifft,caelPobSesiwnAcademaiddacaelPobTermgall ddarparu setiau data union yr un fath, felly dim ond cynnwys un yn eich ffurfweddiad pwynt terfynol.
Yn ystod eich cyfnod profi alffa integreiddio, rhowch wybod i Instructure am unrhyw bwyntiau terfyn sydd wedi'u heithrio.
Dysgu mwy am OneRosterffurfweddiadau pwynt terfyn.
Hidlo Ymholiadau
Hidlo'r data sydd wedi'i gynnwys mewn cysoni data gan ddefnyddio ymholiadau hidlo. Gallwch ffurfweddu ymholiadau hidlo fesul swydd, gan ganiatáu ar gyfer cysoni data swmp a chynyddrannol.
Yn ystod eich cyfnod profi alffa integreiddio, rhowch wybod i Instructure am eich ymholiadau hidlo wedi'u ffurfweddu ar gyfer OneRoster.
Dysgu mwy am OneRosterymholiadau hidloYn ogystal, dysgwch fwy amgofynion gweithredu cydamseru cynyddrannol.
Tudalennu
Gan y gall galwadau API i SIS ofyn am symiau mawr o ddata, mae tudalennu yn ychwanegu trefn at ganlyniadau eich ymholiad API. Er mwyn lleihau traffig HTTP a gwella amseru cydamseru, argymhellir eich bod yn ffurfweddu tudalennu i gefnogi hyd at derfyn o 1000 o gofnodion ar y tro.
Dysgu mwy am yr OneRostergofynion tudalennu.
Nodyn:Er nad yw'n cael ei argymell, gall Instructure gefnogi gweithrediadau lle mae'r holl ddata gofynnol wedi'i gynnwys mewn un alwad API os nad yw nifer yr amseroedd terfyn yn ormodol.
Ail-geisiau
Ailgeisiau yw nifer y troeon y mae'r integreiddiad yn ceisio galwad API. Mae'r integreiddiad Instructure OneRoster yn ceisio galwad API hyd at dair gwaith cyn cael gwall. Mae cyfnod oedi yn digwydd rhwng pob ymgais, ac mae lluosydd oedi yn cynyddu'r cyfnod oedi rhwng ailgeisiau.
Gyda'r Ffurfweddiad Enghreifftiol isod, bydd galwad API yn ceisio hyd at dair gwaith, gan aros 5 eiliad ar ôl y gwall cyntaf, yna aros 15 eiliad am yr ail wall olynol. Os bydd yr alwad yn methu am y drydedd dro, bydd y swydd integreiddio yn methu.
Enghraifft o Ffurfweddiad Ail-Geisio | Dehongliad |
|---|
“CeisiadauDiofyn”: 2
| 3 ymgais |
“OediDiofyn”: 5000
| 5 eiliad |
“LluosyddOediDiofyn”: 3
| 15 eiliad |
Amseroedd Terfyn
Mae terfynau amser yn digwydd pan fydd cais API i'r gweinydd gwe yn cymryd gormod o amser o'i gymharu ag amser aros gweinydd y wefan. Os oes angen, gallwch gynyddu amser aros gweinydd eich gwefan (e.e. 2+ munud). Fodd bynnag, lle bo modd, dylech addasu eich integreiddiad i'w wneud yn fwy ymatebol (e.e. llai nag ugain eiliad).