Mae Canvas yn caniatáu i chi greu defnyddwyr, cyfrifon, tymhorau, cyrsiau, adrannau, ymrestriadau a mewngofnodiadau eich hun mewn swp drwy'r rhyngwyneb Gweinyddwr.
Mae'r ddogfen hon yn cynnwys tudalen API Fformat CSV Mewngludo SIS (SIS Import CSV Format API), lle mae'r rhan fwyaf o wybodaeth CSV wedi'i lleoli. Mae pob ffeil CSV yn symbiotig ag un arall ac yn dweud wrth Canvas sut mae rheoli holl wybodaeth y cyfrif. Gallwch weld diagram perthynas SIS.
Mae pob cam yn y wers hon yn darparu ffeiliau CSV enghreifftiol sydd â disgrifiadau o bob maes dewisol a gofynnol. Hefyd, fe welwch chi ddolen i lwytho pob ffeil i lawr os ydych chi am edrych yn fanylach ar y fformatio. Llwythwch becyn wedi’i sipio i lawr sy’n cynnwys pob ffeil enghreifftiol. Os nad yw dolenni CSV yn llwytho i lawr, rhowch gynnig ar agor y ddolen mewn ta newydd.
Dylech ymarfer mewngludo data yn eich amgylchedd prawf Canvas cyn mewngludo unrhyw gynnwys i’ch amgylchedd cynhyrchu.
Fformat Ffeil CSV
Er mwyn llwytho data i fyny i Canvas mewn swp, rhaid i chi greu un neu ragor o ffeiliau testun CSV. Gellir defnyddio sawl rhaglen i greu ffeiliau CSV. Yn aml iawn, mae gan Systemau Gwybodaeth am Fyfyriwr (SIS) ffordd o lunio adroddiadau mewn fformat CSV mae modd ei addasu i’r fformat mae Canvas yn gofyn amdano. Os dydych chi ddim yn gwybod sut mae cadw ffeil ar fformat CSV, edrychwch yn nogfennau'r rhaglen rydych chi’n ei defnyddio i greu eich ffeil CSV (e.e. Excel).
Wrth ddefnyddio’r fformat Instructure i fewngludo ffeiliau yn y dudalen Mewngludo SIS, gallwch fewngludo un ffeil testun CSV neu gallwch gywasgu mwy nag un ffeil i un ffeil ZIP i fewngludo data mewn swp. Os ydych chi’n llwytho ffeiliau unigol i fyny eich hun, rhaid eu llwytho yn y drefn a ddangosir yn y wers hon.
Fformatio Maes CSV
Rhaid i res gyntaf eich ffeil CSV (pennyn) gynnwys enw maes cyflawn pob ffeil. Dydy trefn y colofnau ddim yn bwysig ond mae’n bwysig bod y rhesi mewn trefn briodol ar gyfer ffeiliau fel accounts.csv.
Meysydd Gludiog
Yn ddiofyn, dydy newidiadau penodol sy’n cael eu gwneud yn rhyngwyneb y defnyddiwr ddim yn cael eu disodli gan brosesau mewngludo SIS yn y dyfodol, a bydd y rhain yn cael eu nodi fel rhai gludiog. Mae pob maes gludiog yn cael eu nodi yn y ddogfen hon. Gallwch chi ddisodli'r meysydd hyn drwy osod override_sis_stickiness yn yr API neu drwy roi tic ym mlwch ticio Diystyru newidiadau i ryngwyneb y defnyddiwr (Override UI changes) ar dudalen Mewngludo SIS (SIS Import).
Dogfennau API
Dim ond set benodol o feysydd sydd mewn ffeiliau CSV. Mae Canvas yn cynnwys gwerthoedd ychwanegol sydd ar gael drwy bob API unigol. Ar ôl rhedeg y ffeiliau CSV ar gyfer eich sefydliad, yr hyn mae'r rhan fwyaf o sefydliadau’n ei wneud fel arfer yw llwytho pob ffeil CSV SIS i fyny ac wedyn defnyddio API Canvas i ddiweddaru priodoleddau llawn cyfrifon a chyrsiau. I gael rhagor o wybodaeth, darllenwch Dogfennau API Canvas ar gyfer Defnyddwyr, Cyfrifon, Tymhorau, Cyrsiau, Adrannau, Ymrestriadau, a Grwpiau. Mae modd rheoli nodwedd Mewngludo SIS hefyd drwy ddefnyddio API Mewngludo SIS (SIS Imports API).
Pobl sydd â chyfrifon defnyddiwr mewn sefydliad yw defnyddwyr. Mae users.csv yn ychwanegu pobl i’r system fel defnyddwyr generig. Bydd enrollments.csv yn neilltuo rôl (athro, myfyriwr, ayb.) i’r defnyddwyr hyn. Pan fydd cyfrif defnyddiwr yn cael ei ddileu, bydd pob un o’u hymrestriadau yn cael eu dileu hefyd, a fyddan nhw ddim yn gallu mewngofnodi i’w cyfrif Canvas. Os ydych chi dal am i’r defnyddiwr allu mewngofnodi ond ddim cymryd rhan neu os ydych chi am eu dileu o gwrs penodol, dylech adael eu cyfrif defnyddiwr fel rhai gweithredol a newid eu hymrestriad (yn yr enrollments.csv) i rai sydd wedi’u cwblhau neu eu dileu, yn y drefn honno.
Llwythwch ffeil enghreifftiol users.csv i lawr sydd â 10 cyfrif defnyddiwr Canvas.
Maes gofynnol* | Maes Gludiog^
Mae Canvas yn adnabod defnyddwyr yn ôl cyfeiriadau e-bost. Pan gaiff myfyrwyr eu hychwanegu i gwrs, bydd Canvas yn ceisio cysoni unrhyw wrthdaro rhwng cyfeiriadau e-bost pan fydd y defnyddiwr yn mewngofnodi i’r cwrs am y tro cyntaf.
Fel arfer, mae cyfeiriadau e-bost yn unigryw i bob myfyriwr. Weithiau, efallai bod sawl myfyriwr yn rhannu un cyfeiriad e-bost. Wrth ychwanegu myfyrwyr i gyrsiau drwy’r nodwedd Mewngludo SIS, bydd Canvas yn gwybod pan fydd cyfeiriad e-bost wedi'i neilltuo i fwy nag un myfyriwr.
Uned sefydliad yn Canvas yw cyfrif (e.e., cyfrif rhiant y sefydliad). Gall pob cyfrif gynnwys hierarchaeth o isgyfrifon, fel creu cyfrifon ar gyfer colegau unigol o fewn sefydliad, neu ar gyfer ysgolion unigol mewn ardal. Gall isgyfrifon fod â sawl isgyfrif hefyd, er enghraifft pan fydd coleg yn rhannu’n adrannau neu’n rhaglenni, neu ysgol yn rhannu'n lefelau gradd neu’n bynciau.
Llwythwch ffeil enghreifftiol accounts.csv i lawr sydd â’r isgyfrifon canlynol:
Maes gofynnol* | Maes Gludiog^
Mae tymor yn darparu set ddiofyn o ddyddiadau cychwyn a gorffen i unrhyw gwrs sydd wedi’i neilltuo i'r tymor hwnnw. Mae modd rheoli dyddiadau tymor ar gyfer cyrsiau ar lefel y cwrs heb ffeil mewngludo. Ond, mae rhoi term_id i sawl cwrs gwahanol yn sicrhau bod pob cwrs yn y tymor hwnnw yn cychwyn/gorffen yr un pryd. Bydd dyddiadau tymor sy’n cael eu llwytho i fyny yn eich helpu hefyd i ddidoli a rhoi trefn ar gyrsiau wrth edrych ar ddata ac adroddiadau yn y rhyngwyneb Gweinyddwr.
Llwythwch ffeil enghreifftiol terms.csv i lawr sydd â 10 tymor.
Maes gofynnol* | Maes Gludiog^
Cyflwyniad trefnus ar bwnc penodol yw cwrs. Weithiau, gall cwrs gynnwys cyfres o gyrsiau. Mae cyrsiau’n cael eu rhoi mewn tymhorau i greu dyddiadau cychwyn a gorffen diofyn. Ond, os yw cwrs yn cynnwys dyddiadau cwrs penodol, bydd y dyddiadau hyn yn disodli dyddiadau mynediad y myfyriwr yn y tymor, sydd wedi'i nodi gan term_id (os yw hyn wedi'i gynnwys.) Yr hyn sy’n dda wrth roi term_id yw eich bod yn gallu didoli a rhoi trefn ar y cyrsiau wrth edrych ar ddata ac adroddiadau yn y rhyngwyneb Gweinyddwr. Mae’n hawdd rhoi term_id wrth nifer o wahanol gyrsiau sy’n cychwyn/gorffen yr un pryd. Os na fyddwch chi’n cysylltu cwrs i dymor, bydd y cwrs yn cael ei gysylltu â’r tymor a elwir yn Dymor Diofyn (Default Term).
Os yw eich sefydliad wedi galluogi Cyrsiau Glasbrint, gallwch ddefnyddio courses.csv i ychwanegu cyrsiau cysylltiedig i gwrs glasbrint. Rhaid creu a galluogi'r cwrs glasbrint fel cwrs glasbrint cyn bod modd ychwanegu cyrsiau cysylltiedig.
Llwythwch ffeil enghreifftiol courses.csv i lawr sydd â 10 cwrs; maen nhw i'w gweld yn eu hisgyfrifon priodol mewn tymor penodol.
Maes gofynnol* | Maes Gludiog^
Mae adran yn rhannu myfyrwyr mewn cwrs. Hefyd, mae modd traws-restru mwy nag un adran mewn un cwrs, yn enwedig os yw pob adran myfyriwr yn dysgu'r un deunydd cwrs. Mae modd gosod mwy nag un adran mewn un cwrs, ond does dim modd i adran gynnwys mwy nag un adran. Bydd adrannau’n etifeddu dyddiadau’r cwrs fel sydd wedi’i osod yn y tymor. Ond, os yw adran yn cynnwys dyddiadau cwrs penodol, bydd y dyddiadau hyn yn disodli dyddiadau mynediad y myfyriwr ar gyfer y cwrs a dyddiadau cychwyn a/neu ddyddiadau gorffen y tymor.
Os ydych chi’n ceisio dileu cwrs a bod y defnyddwyr wedi’u cysylltu ag adrannau, bydd angen i chi gynnwys paramedr section_id yn y broses mewngludo CSV yn ogystal ag ID SIS yr adran.
Llwythwch ffeil enghreifftiol sections.csv i lawr sydd â’r adrannau canlynol:
Mae'r ffeil hon yn cymryd yn ganiataol bod gennych chi fwy nag un adran mewn un cwrs. Mae llawer o sefydliadau’n mewngludo adrannau cwrs fel cyrsiau ar wahân. Mae modd gwneud hyn drwy (1) greu cwrs Canvas ar gyfer pob adran yn eich courses.csv, wedyn (2) creu un adran ym mhob un o'r cyrsiau hyn. Yn y bôn, mae modd i chi ddefnyddio’r un data ar gyfer y cwrs a’r adran gan gynnwys yr ID SIS, a fydd yr un peth ar gyfer yr course_id a’r section_id.
Maes gofynnol* | Maes Gludiog^
Ymrestriad yw defnyddiwr sydd wedi ymrestru ar gwrs o dan rôl benodol. Mae enrollments.csv yn gadael i chi neilltuo rolau i ddefnyddwyr a’u gosod ar gyrsiau priodol. Pan fydd statws ymrestru unrhyw ddefnyddiwr wedi’i farcio fel wedi'i gwblhau byddan nhw’n cael eu cyfyngu i gael mynediad darllen-yn-unig ar gyfer y cwrs hwnnw.
Llwythwch ffeil enghreifftiol enrollments.csv i lawr sydd â’r ymrestriadau canlynol:
Maes gofynnol*
Mae categorïau grŵp yn caniatáu i chi drefnu grwpiau yn Canvas. Mae group_categories.csv yn gadael i chi greu categorïau grŵp ar lefel y cyfrif neu ar lefel y cwrs. Yn rhyngwyneb y defnyddiwr, gelwir categorïau grŵp yn setiau grwpiau.
Llwythwch ffeil enghreifftiol group_categories.csv i lawr sydd â’r categorïau grŵp canlynol:
Maes gofynnol* | Maes Gludiog^
Mae modd defnyddio grŵp i gynnig cyfleoedd cydweithio i fyfyrwyr, addysgwyr, gweinyddwyr, neu ddefnyddwyr eraill. Mae groups.csv yn gadael i chi greu grwpiau ar lefel y cyfrif ac ar lefel y cwrs. Dim ond drwy SIS mae modd diweddaru neu ddileu grwpiau sydd wedi’u llwytho i fyny drwy SIS.
Llwythwch ffeil enghreifftiol groups.csv i lawr sydd â’r grwpiau canlynol:
Maes gofynnol* | Maes Gludiog^
Mae bod yn aelod o grŵp yn caniatáu i ddefnyddwyr gydweithio ar weithgareddau yn Canvas. Mae groups_membership.csv yn gadael i chi ychwanegu pobl mewn swp i grŵp rydych chi wedi'i greu drwy groups.csv, neu eu tynnu o’r grŵp hwnnw.
Llwythwch ffeil enghreifftiol groups_membership.csv i lawr sydd â’r aelodaeth grŵp canlynol:
Maes gofynnol*
Mae traws-restru’n caniatáu i chi symud adrannau i gwrs arall. Mae ffeil xlist.csv yn gadael i chi draws-restru adrannau mewn cyrsiau sy’n bodoli’n barod a chreu hierarchaeth adrannau.
Disgwylir bod id adrannau’n bodoli’n barod ac yn cyfeirio’n barod at id cyrsiau eraill. Os bydd id adran yn cael ei roi, bydd yn cael ei symud o’i id cwrs sy’n bodoli’n barod i id cwrs newydd, felly os bydd y cwrs newydd hwnnw’n cael ei dynnu neu os bydd y traws-restru’n cael ei dynnu, bydd yr adran yn newid yn ôl i’r id cwrs blaenorol. Os na fydd xlist_course_id yn cyfeirio at gwrs sy’n bodoli’n barod, bydd hyn yn cael ei greu. Os ydych chi am roi rhagor o wybodaeth am y cwrs sydd wedi'i draws-restru, gwnewch hynny yn courses.csv.
Llwythwch ffeil enghreifftiol xlists.csv i lawr sydd â’r cyrsiau a’r adrannau canlynol:
Maes gofynnol*
Mae modd defnyddio’r rôl arsyllwr i ymrestru rhieni a’u cysylltu â myfyriwr, gan adael iddyn nhw weld graddau eu myfyrwyr a’r ffordd maen nhw’n rhyngweithio â chwrs. Mae user_observers.csv yn gadael i chi ymrestru a chysylltu arsyllwyr ag ymrestriadau pob myfyriwr penodedig.
Llwythwch ffeil enghreifftiol user_observers.csv i lawr sydd â’r ymrestriadau canlynol:
Maes gofynnol*
Mae logins.csv yn gadael i chi greu neu ddiweddaru manylion mewngofnodi defnyddwyr. Dim ond at ddefnyddwyr sy'n bodoli'n barod y mae modd ychwanegu mewngofnodiadau. Gellir tynnu mewngofnodiadau gan ddefnyddio users.csv.
Llwythwch ffeil enghreifftiol logins.csv gyda'r tri mewngofnod defnyddiwr.
Maes gofynnol* | Maes Gludiog^
Nodiadau:
Mae gweinyddwyr yn rheoli gosodiadau cyfrif cyfan neu isgyfrif. Mae admins.csv yn gadael i chi ddynodi defnyddwyr yn Canvas yn weinyddwyr cyfrif neu rolau personol eraill mewn cyfrif neu isgyfrif.
Llwythwch ffeil enghreifftiol admins.csv i lawr sydd â’r gweinyddwyr canlynol:
Maes gofynnol*
Mae ID SIS yn ddynodydd unigryw ar gyfer gwrthrych yn Canvas. Mae change_sis_id.csv yn gadael i chi newid ID SIS mewn swp ar gyfer cyfrifon, tymhorau, cyrsiau, adrannau, grwpiau, neu ddefnyddwyr sy’n bodoli’n barod.
Llwythwch ffeil enghreifftiol change_sis_id.csv i lawr sydd â’r newidiadau ID SIS canlynol:
Maes gofynnol*