Skip to main content

Gegevensindeling voor snapshot-flatbestanden

Als je bekend bent met de oude variant van momentopnamen, zul je zien dat het type Momentopname-bestand van het SIS Framework een ongewijzigde indeling heeft, afgezien van de toevoeging van headers voor de nieuwe ondersteunde gegevensobjecten en het feit dat enkele eerder optionele velden nu vereist zijn.

Voor Momentopname-bestanden gelden dezelfde volgorderegels als voor de oude variant van momentopnamen: de invoer mislukt tenzij aan alle afhankelijkheden is voldaan. Een invoerbestand met lidmaatschappen werkt bijvoorbeeld alleen als zowel het invoerbestand met gebruikers als het bestand met cursussen met de objecten voor lidmaatschap is verwerkt. Een ander voorbeeld is dat een onderliggende cursus pas wordt gekoppeld aan een bovenliggende cursus nadat de hoofdcursus (bovenliggende cursus) is gemaakt. Deze logica geldt ook voor perioden en knooppunten.

Bovendien kan het systeemgedrag voor de verwerking van gegevens die naar eindpunten zijn gepost, worden aangepast via de pagina voor het bewerken van de integratie.

Tip

Zie Momentopname-bestand voor een volledige beschrijving van URL's en hun functie.

ANGEL-klanten stappen over op Blackboard

Er zijn verschillen tussen Blackboard- en ANGEL-gegevensfeedindelingen. Deze verschillen worden genoemd in het kennispad ANGEL to BLACKBOARD data mapping.

Acceptabele tekenset voor integratiegegevens

Dit is de tekenset die zonder problemen kan worden gebruikt met de belangrijkste gegevensvelden:

A-Z a-z 0-9 . ' , " : ! ? $ @ [ ] { } - _ *

Het wachtwoord en externe sleutels mogen ook nog deze tekens bevatten:

% & # < > = \ + /

Voorbeelden met een minimum aan gegevensvelden

In deze voorbeelden wordt de minimale hoeveelheid gegevens aangeboden. Er kunnen aanvullende objecten worden afgeleid voor elk invoerbestand via SIS Framework - Momentopname-bestand - Geavanceerde configuratie - Aangepaste kopteksten. De vereiste aard van een veld kan worden afgeleid via de optie Veldtoewijzing. Aan het einde van dit document vind je een volledig overzicht met beschrijvingen, voorbeelden van standaardwaarden en acceptabele waarden voor elk object. Volledige URL's zoals die worden gebruikt voor de installatie kun je opvragen via de beheerinterface voor het SIS Framework, onder HTTP-configuratie. Zie Momentopname-bestand voor meer informatie.

In de onderstaande voorbeelden wordt het sluisteken ('|') gebruikt als het scheidingsteken. Je kunt tijdens het configureren van de implementatie aangeven welk scheidingsteken moet worden gebruikt.

Zie Voorbeelden van snapshot-flatbestanden voor complexere voorbeelden van gegevensgebruik.

Gebruikers

Taak: Gebruikers (personen) aanmaken/bijwerken

URL: Persoon opslaan of vernieuwen

Monster:

external_person_key|user_id|passwd|firstname|lastname|system_role

testPerson1|aanderson_test|changeme|Alpha|Anderson|none

testPerson2|bbrown_test|changeme|Beta|Brown|none

testPerson3|ccharlie_test|changeme|Chi|Charlie|none

testPerson4|ddavis_test|changeme|Delta|Davis|none

testPerson5|eedwards_test|changeme|Epsilon|Edwards|none

Opmerking

Hoewel e-mail geen verplicht veld is voor het maken van een gebruiker, betekent het weglaten van deze informatie dat sommige voorzieningen van het systeem worden beperkt, zoals het mailen van cursusmededelingen, enzovoort.

Taak: Gebruikers verwijderen/uitschakelen (personen)

URL: Persoon verwijderen

Monster:

external_person_key

testPerson1

Taak: Persoon Secundaire Instelling Rol Feed

URL: Rollenarchief/Vernieuwen /Verwijderen

Monster:

external_person_key|role_id

testPerson1|ALUMNI

testPerson1|PROSPECTIVE_STUDENT

testPerson1|ALUMNI

Taak: Van persoon tot waarnemer Association Feed

URL: Associatie Store/Vernieuwen /Verwijderen

Monster:

external_observer_key|external_user_key

testPerson6|testPerson1

Cursussen

Taak: Nieuwe cursussen maken/bijwerken

URL: Cursus opslaan of vernieuwen

Monster:

external_course_key|course_id|course_name

testCourse1|TEST_COURSE_1|Test Course 1

testCourse2|TEST_COURSE_2|Test Course 2

testCourse3|TEST_COURSE_3|Test Course 3

Taak: Cursusweergave bepalen

URL: Cursus opslaan of vernieuwen

Monster:

external_course_key|course_id|course_name|course_experience

testCourse1|TEST_COURSE_1|Test Course 1|Original

testCourse2|TEST_COURSE_2|Test Course 2|Ultra

testCourse3|TEST_COURSE_3|Test Course 3|Instructor choice

Ondersteunde waarden zijn: Origineel, Ultra of Keuze van de docent. Deze waarden kunnen alleen worden ingevoegd en kunnen niet worden bijgewerkt via het SIS Framework.

Taak: Nieuwe cursussen verwijderen/uitschakelen

URL: Cursus verwijderen

Monster:

external_course_key

testcursus1

Voeg het veld template_course_key toe aan het cursusfeedbestand als je wilt dat een nieuwe cursus wordt gevuld met de inhoud van een hoofdcursus. Dit is handig als bijvoorbeeld alle nieuwe wiskundecursussen in eerste instantie het materiaal uit een hoofdcursus Wiskunde moeten bevatten.

Organisaties

Taak: Nieuwe organisaties maken/updaten

URL: Organisaties opslaan of vernieuwen

Monster:

external_organization_key|organization_id|organization_name

testOrg1|TEST_ORG_1|Test Org 1

testOrg2|TEST_ORG_2|Test Org 2

testOrg3|TEST_ORG_3|Test Org 3

Taak: Nieuwe organisaties uitschakelen

URL: Organisaties verwijderen

Monster:

external_organization_key

testOrg1

Lidmaatschappen

Taak: Cursuslidmaatschappen maken/bijwerken

URL: Cursuslidmaatschap opslaan of vernieuwen

Monster:

external_person_key|external_course_key|role

testPerson1|testCourse1|instructor

testPerson1|testCourse2|student

testPerson2|testCourse1|student

testPerson3|testCourse1|student

testPerson4|testCourse2|instructor

testPerson5|testCourse3|student

Taak: Cursuslidmaatschappen uitschakelen

URL: Cursuslidmaatschap verwijderen

Monster:

external_person_key|external_course_key

testPerson1|testCourse1

Taak: Lidmaatschappen van organisaties maken/bijwerken

URL: Lidmaatschap van organisatie opslaan of vernieuwen

Monster:

external_person_key|external_organization_key|role

testPerson1|testOrg1|instructor

testPerson1|testOrg2|student

testPerson2|testOrg1|student

testPerson3|testOrg1|student

testPerson4|testOrg2|instructor

testPerson5|testOrg3|student

Taak: Lidmaatschappen van organisaties uitschakelen

URL: Lidmaatschap van organisatie opslaan of vernieuwen

Monster:

external_person_key|external_organization_key|role

testPerson1|testOrg1|instructor

Semester

Taak: Semesters maken/bijwerken

URL: Term opslaan of vernieuwen

Monster:

external_term_key|name

testTerm1|Test Term 1

Taak: Een term uitschakelen

URL: Term URL verwijderen

Monster:

external_term_key

testTerm1

Knooppunten

Taak: knooppunten maken/bijwerken

URL: Knooppunt opslaan of vernieuwen

Monster:

external_node_key|name

testNode1|Test Node 1

testNode2|Test Node 2

Taak: Termen uitschakelen

URL: Knooppunt verwijderen

Monster:

external_node_key

testNode1

Knooppunten vereniging

Taak: Cursus maken/bijwerken /uitschakelen voor knooppuntassociatie

URL: Cursusvereniging Store/Refresh /delete

Monster:

external_association_key|external_course_key|external_node_key

testCourseAssociation1|testCourse1|testNode1

testCourseAssociation2|testCourse2|testNode2

Taak: Gebruiker aanmaken/bijwerken /uitschakelen naar knooppuntkoppeling

URL: Gebruikersvereniging opslaan/vernieuwen /verwijderen

Monster:

external_association_key|external_user_key|external_node_key

testUserAssociation1|testPerson1|testNode1

testUserAssociation2|testPerson2|testNode1

testUserAssociation3|testPerson1|testNode2

Taak: Organisatie maken/bijwerken /uitschakelen voor knooppuntkoppelingsfeed

URL: Organisatie Vereniging Store/Refresh /Delete

Monster:

external_association_key|external_organization_key|external_node_key

testOrgAssociation1|testOrg1|testNode1

testOrgAssociation2|testOrg2|testNode2

Categorieondersteuning

Taak: Feed voor cursuscategorieën maken/bijwerken/uitschakelen

URL: Cursuscategorie opslaan/vernieuwen /verwijderen

Monster:

external_category_key|title

testCourseCategory1|Course Category 1

testCourseCategory2|Course Category 2

Taak: Categoriefeed voor organisaties maken/bijwerken/uitschakelen

URL: Organisaties Categorie Opslaan/Vernieuwen /Verwijderen

Monster:

external_category_key|title

testOrgCategorie1|Org Categorie 1

testOrgCategorie2|Org Categorie 2

Taak: Lidmaatschapsfeed voor cursuscategorieën maken/bijwerken/uitschakelen

URL: Cursuscategorie Lidmaatschap Store/Refresh /Delete

Monster:

external_course_key|external_category_key|available_ind

testCursus1|testCursusCategorie1|Y

testCourse2|testCourseCategory2|Y

testCursus3|testCursusCategorie1|Y

Taak: Lidmaatschapsfeed voor organisatiecategorieën maken/bijwerken/uitschakelen

URL: Organisatie Categorie Lidmaatschap Store/Refresh /Delete

Monster:

external_organization_key|external_category_key|available_ind

testOrg1|testOrgCategorie1|Y

testOrg2|testOrgCategorie2|Y

testOrg3|testOrgCategorie1|Y

Ouder Kind Ondersteuning

Voeg het veld 'master_course_key' toe aan een invoerbestand voor cursussen als een relatie bovenliggend:onderliggend is gewenst.

Opmerking

Je moet bovenliggende cursussen maken voordat je een relatie met een onderliggende cursus kunt opzetten.

Taak: Een bovenliggende onderliggende relatie tussen cursussen maken

URL: Cursus opslaan/vernieuwen

Monster:

external_course_key|course_id|course_name|master_course_key

testCourse1|TEST_COURSE_1|Test Course 1|

testCourse2|TEST_COURSE_2|Test Course 2|testCourse1

testCourse3|TEST_COURSE_3|Test Course 3|testCourse1

testCourse4|TEST_COURSE_4|Test Course 4|

testCourse5|TEST_COURSE_5|Test Course 5|testCourse4

In dit voorbeeld zijn TEST_COURSE_2 en TEST_COURSE_3 onderliggende cursussen van de bovenliggende cursus TEST_COURSE_1 maar dit geldt niet voor TEST_COURSE_4. Je kunt ook een afzonderlijk invoerbestand voor onderliggende cursussen uitvoeren, dus los van de invoer van cursussen, waarbij alle cursussen een vermelding bevatten voor de juiste master_course_key. Gebruik Course Store voor deze bewerking om eerder opgeslagen cursussen te behouden.

Cursus kopiëren/sjabloon

Voeg het veld 'template_course_key' toe aan het invoerbestand voor cursussen als je een nieuwe cursus wilt vullen met de inhoud van een hoofdcursus. Bijv.: alle nieuwe wiskundecursussen moeten in eerste instantie de materialen van een mastercursus wiskunde bevatten.

Monster:

external_course_key|course_id|course_name|master_course_key|template_course_key

testCourse1|TEST_COURSE_1|Test Course 1||test_course_template1

testCourse2|TEST_COURSE_2|Test Course 2|testCourse1|

testCourse3|TEST_COURSE_3|Test Course 3|testCourse1|

testCourse4|TEST_COURSE_4|Test Course 4||test_course_template1

Tip

Meer informatie over het kopiëren van cursussen en cursussjablonen vind je in Cursussen maken door bestaande cursussen te kopiëren.

Meer informatie