De voorbeelden geven de compositie van TERM-gegevensfeeds weer terwijl ze aan verschillende praktijkvoorbeelden voldoen. Deze voorbeelden gebruiken de eenvoudigste invoer van gegevensfeeds die nodig is om aan het praktijkvoorbeeld te voldoen. Er zijn meer TERM-invoerheaders om te gebruiken bij het maken van lidmaatschaprecords. Analyses van het informatiesysteem van je instelling en registratievereisten en planning helpen om het niveau van de gegevens te bepalen die nodig zijn om Learn op de juiste manier te vullen waarbij er aan je doelen voor gegevens en de levensduur van TERM (en de betrokken cursus/organisatie) wordt voldaan.
De voorbeelden zijn gebaseerd op standaardinstellingen van Learn die zichtbaar zijn in de integratieconfiguratie van de UI. Als je deze configuratie-elementen wijzigt, worden de resultaten van het voorbeeld gewijzigd. Uitleg van deze instellingen is beschikbaar in Overzicht van SIS Framework. Het wordt ook aangenomen, indien anders aangegeven, dat de integratie geconfigureerd is om dezelfde gegevensbron te gebruiken voor alle inkomende gegevens.
Het TERM-object
Het TERM-object biedt een andere handig manier voor het organiseren en controleren van toegang tot cursussen en organisaties. Wanneer je een TERM-object gebruikt om toegang tot cursussen te regelen, overschrijven de instellingen die door de TERM gespecificeerd zijn de instellingen die door de cursusgegevens zijn opgegeven. Dit betekent dat als je begin- of einddatums opgeeft en de duur op het cursusniveau dan worden deze vervangen door de instellingen in de bijbehorende TERM.
Dit onderwerp beschrijft het gebruik van een Momentopname-bestand om TERM-objecten te maken en samen te voegen en geeft een voorbeeld van het gebruik van het TERM-object in een gegevensfeed van een cursus.
Beheer van Momentopname-bestand
Het SIS Framework ondersteunt gegevensfeeduploads van Momentopname-bestanden via een UI-feedupload en via een set URL's die door het Learn-systeem worden aangeboden.
Open HTTP-gegevens en Invoerbestand uploaden via het integratiemenu in de Gegevensintegratie van de Systeembeheerder voor UI-integraties voor Studenteninformatiesystemen.
In beide gevallen wordt het gedrag van de gegevensbewerking aangestuurd door de configuratie van de integratie en het geselecteerde type bewerking. Het geselecteerde type gegevensbewerking bepaalt hoe de gegevens in de feed 'geïnterpreteerd' worden en elke URL geeft een ander resultaat om te voldoen aan de gewenste doelen van de integratie.
De voorbeelden gebruiken de Momentopname Framework UI-functie voor het uploaden van invoerbestanden. Voor meer informatie over het automatiseren of het gebruik van opdrachtregel-/ programmatische taken, raadpleeg je Automatisering van Momentopname-bestand.
Taken
Er kunnen gegevens worden verstrekt aan Learn en daarna worden bijgewerkt, verwijderd of gewijzigd. Je kunt dus beginnen met de eenvoudigste gegevensset en je kunt deze uitbreiden als de gegevensvereisten van de instelling veranderen.
De volgende taken zijn beschikbaar via de UI en HTTP:
| Bewerking | Beschrijving |
|---|---|
| Opslaan | Je kunt een opgegeven record opslaan of bijwerken per integratieconfiguratie. Wanneer je dit type taak gebruikt, dan worden gegevens die deel uitmaken van het bestand opgeslagen of bijgewerkt (per configuratie-instellingen) voor alle gegevensbronnen die eigendom zijn van de integratie. Bekijk voor meer informatie over ‘eigendom’ het Overzicht van SIS Framework. Bekijk voor meer informatie over gegevensbronsleutels het Overzicht van gegevensbronsleutels. |
| Vernieuwen | Je kunt een record opslaan, bijwerken, ofuitschakelen die aanwezig is in de Feed of Learn. Met deze taak worden gegevens opgeslagen of bijgewerkt die deel uitmaken van de gegevensfeed tijdens het uitschakelen van gegevens die niet zijn opgenomen in de gegevensfeed die is gekoppeld aan de integratie in alle gegevensbronnen. |
| Verwijderen | Opgegeven record uitschakelen. Deze taak schakelt per integratie-instellingen de records uit in de gegevensfeed die gekoppeld is aan de integratie in alle gegevensbronnen. |
De objecten die zijn gekoppeld aan TERM-taken zijn:
| TERM | Store, Complete Refresh, Delete, Complete Refresh by Data Source |
De opgegeven voorbeelden worden weergegeven met behulp van de Momentopname Framework UI-functie voor het uploaden van invoerbestanden. Voor meer informatie over het automatiseren of het gebruik maken van opdrachtregel-/ programmatische taken, raadpleeg je Automatisering van Momentopname-bestand.
Een herinnering over gegevensbronsleutels
Alle gegevensobjecten ondersteunen de mogelijkheid om de gegevensbronsleutel te wijzigen voor de groepering van die gegevensset en kan gebruikt worden om de bijbehorende gegevensbron te wijzigen. Opmerking: dit veld is niet vereist in gegevensfeeds op basis van Framework en tenzij de volgende voorbeelden worden vermeld, wordt ervan uitgegaan dat de integratie is geconfigureerd voor het gebruik van één gegevensbron. Bekijk Overzicht van gegevensbronsleutels.
Een opmerking over veldtoewijzing
Veldtoewijzing biedt de mogelijkheid om inkomende gegevens te wijzigen voordat deze in Learn worden opgeslagen. Op deze manier heb je controle over de opgeslagen gegevens en kun je voldoen aan de specifieke regels voor Learn wanneer de SIS-gegevens die je hebt opgegeven onvoldoende zijn (bijvoorbeeld het aanmaken van een gebruikerswachtwoord wanneer een wachtwoord niet wordt opgegeven in de gegevensfeed).
Wanneer dit wordt toegepast op een veld van het Term-object, wordt het bijbehorende script uitgevoerd per object, door de gegevens te wijzigen of in te leveren voordat het wordt opgeslagen in Learn. Er wordt een volledige uitleg over veldtoewijzing gegeven in Veldtoewijzing voor tekstbestanden zonder opmaak van Momentopname.
Term-voorbeelden
Je kunt op een hoog niveau drie gegevensfeedpatronen van SIS-integratie vaststellen die toegepast kunnen worden op alle taken voor TERM-gegevens en de selectie van het patroon is afhankelijk van de gegevens die je kunt opgeven.
- Als je een enkel invoerbestand gebruikt, kun je de records opslaan en bijwerken (Store) om een afzonderlijk proces te gebruiken voor het uitschakelen (Delete) van records
- Als je een enkel invoerbestand gebruikt, kun je records opslaan, bijwerken en uitschakelen (vernieuwen)
- Als je een combinatie van bestanden gebruikt, kun je met één opslaan en met een tweede uitschakelen.
Tot slot kun je ook, en dit is niet een SIS-invoerpatroon maar wel noemenswaardig, uitschakelen en verwijderen op basis van alleen gegevensbronsleutels waarbij er gebruik wordt gemaakt van de Gegevensbronbeheertool die beschikbaar is in de UI. Je moet uiterst zorgvuldig zijn met de SIS-gegevens die je op deze manier verkrijgt. Dit is erg handig bij het opschonen van gegevens die nooit werden of niet meer worden aangeboden via het SIS of het resultaat van de uitvoering van testen.
Alleen de basis: TERM
Voor alle TERM-object is een basisset van informatie vereist om vast te stellen. Deze informatie wordt beschreven in Gegevensindeling van Momentopname-bestand en Header-beschrijvingen van Momentopname-bestand.
Gegevens in het kort
De minimale gegevensset of headers die vereist zijn voor het maken van een lidmaatschapaccount in Learn bestaat uit:
- EXTERNAL_TERM_KEY - een unieke ID voor deze cursusrecord.
- DATA_SOURCE_KEY - een unieke ID voor de gegevensset van deze record. Opmerking: dit wordt aangeboden in de feed of via de integratieconfiguratie
- NAME - de naam die aan de TERM is gekoppeld. Opmerking: dit is wat er gezocht wordt wanneer je zoekt naar TERM-records. Het is handig om een naamgevingsconventie te gebruiken waardoor het eenvoudiger wordt om TERM's in verloop van tijd te onderscheiden. Bijvoorbeeld: gebruik 'Faculteit Kunst en Wetenschappen najaar 2013' in plaats van 'najaar'
Het SIS Framework biedt per integratieconfiguratie standaardwaarden voor de niet-verplichte velden, of negeert deze. Drie handige gegevenspunten die niet vereist zijn voor een TERM-feed zijn DESCRIPTION, AVAILABLE_IND en ROW_STATUS. Deze werken op dezelfde manier als met andere Learn-objecten. Als je het TERM-object wilt gebruiken om de toegang tot cursussen te regelen, dan gebruik je de gegevenspunten START_DATE en END_DATE. Deze worden besproken in het onderstaande praktijkvoorbeeld.
Elk van deze headers wordt volledig beschreven in Header-beschrijvingen van Momentopname-bestanden.
TERM-objecten toevoegen
Als je het TERM-object wilt gebruiken om de beschikbaarheid van een cursus te regelen, dan moet je het TERM-object eerst maken.
Er zijn twee voorbeelden voor het toevoegen van TERM-informatie. De eerste is om lidmaatschapinformatie additief op te slaan waardoor het toevoegen of bijwerken van de records wordt weergegeven in de gegevensfeed. De tweede is om de TERM-informatie te vernieuwen die al aanwezig is in Learn, waardoor nieuwe of bestaande records worden toegevoegd zoals weergegeven in het gegevensbestand. Bestaande Learn-records worden uitgeschakeld die niet aanwezig zijn in het TERM-gegevensbestand.
Voorbeelden store-taak
Voorbeeld nr. 1: TERM's maken
Je wilt TERM's toevoegen voor het academische jaar van 2013-2014 zonder dat de bestaande records van LEARN beïnvloed worden. Je hebt verschillende TERM's nodig voor de Faculteit Geneeskunde en de Faculteit Kunst en Wetenschap.
Je hebt de integratie geconfigureerd om dezelfde gegevensbron voor alle inkomende gegevens te gebruiken.
Vereiste
Geen.
Minimale vereisten voor gegevensfeed
EXTERNAL_TERM_KEY
NAME
Oplossing
Maak een terms.txt-gegevensbestand met de vereiste kopteksten en de bijbehorende gegevens per TERM die je wilt toevoegen aan het systeem. Bijvoorbeeld:
EXTERNAL_TERM_KEY|NAME
EXTERNAL_TERM_KEY|NAMEAS_FA.2013|Arts and Sciences Fall 2013
AS_WI.2014|Arts and Sciences Winter 2014
AS_SP.2014|Arts and Sciences Spring 2014
AS_SU.2014|Arts and Sciences Summer 2014
MED_T1.2013|School of Medicine Term 1 2013
MED_T2.2014|School of Medicine Term 2 2013
MED_T3.2014|School of Medicine Term 3 2013
Gebruik de UI om dit bestand te uploaden met de via het gegevenstype van de TERM met behulp van de STORE-taak. De TERM-records worden gemaakt en je kunt ze vinden via de Term-tools van de systeembeheerder.
Voorwaarde achteraf
Er worden Term-objecten gemaakt voor beide scholen: 4 voor Kunst en Wetenschap en 3 voor Geneeskunde.
Voorbeeld nr. 2: TERM's bijwerken
Je wilt TERM's toevoegen en bijwerken voor het academische jaar van 2013-2014 zonder dat de bestaande records beïnvloed worden. Daarnaast wil je de beschikbaarheid en ingeschakelde status van de TERM-records expliciet controleren. De Faculteit Kunst en Wetenschap heeft verschillende begin- en einddata per termijn. Je moet dus de begin- en einddata voor elke termijn van de school instellen om de zichtbaarheid van bijbehorende cursussen te regelen.
Je hebt de integratie geconfigureerd om dezelfde gegevensbron voor alle inkomende gegevens te gebruiken.
Vereiste
Geen.
Minimale vereisten voor gegevensfeed
EXTERNAL_TERM_KEY
NAME
AVAILABILITY_IND
DURATION
END_DATE
ROW_STATUS
START_DATE
Oplossing
Maak een terms.txt-gegevensbestand met de vereiste kopteksten en de bijbehorende gegevens per TERM die je wilt toevoegen aan, of wilt bijwerken in, het systeem.
Om START_DATE en END_DATE op de juiste manier te kunnen gebruiken, moet DURATION ook gespecificeerd (RANGE) worden. Bijvoorbeeld:
EXTERNAL_TERM_KEY|NAME|START_DATE|END_DATE|DURATION|AVAILABLE_IND|ROW_STATUS
AS_FA.2013|Arts and Sciences Fall 2013|20130915|20131205|RANGE|Y|ENABLED
AS_WI.2014|Arts and Sciences Winter 2014|20140103|20140418|RANGE|Y|ENABLED
AS_SP.2014|Arts and Sciences Spring 2014|20140420|20140520|RANGE|Y|ENABLED
AS_SU.2014|Arts and Sciences Summer 2014|20140608|20140820|RANGE|Y|ENABLED
MED_T1.2013|School of Medicine Term 1 2013|20130801|20131215|RANGE|Y|ENABLED
MED_T2.2014|School of Medicine Term 2 2014|20140110|20140602|RANGE|Y|ENABLED
MED_T3.2014|School of Medicine Term 3 2014|20140603|20140818|RANGE|Y|ENABLED
Voorwaarde achteraf
TERM-objecten worden gemaakt of bijgewerkt, waarbij de beschikbaarheid van de TERM-record en het begin en einde van elke term expliciet worden ingesteld. Als deze is gekoppeld aan een cursus, bepaalt de term die wordt weergegeven de zichtbaarheid van de cursus.
Voorbeelden refresh-taken
Voorbeeld: TERM's maken of uitschakelen
Je wilt TERM's toevoegen en bijwerken voor het academische jaar van 2013-2014 waarbij records die niet meer nodig zijn, uitgeschakeld worden. Daarnaast wil je de beschikbaarheid en ingeschakelde status van de TERM-records expliciet controleren. De Faculteit Kunst en Wetenschap heeft verschillende begin- en einddata per termijn. Je moet dus de begin- en einddata voor elke termijn van de school instellen om de zichtbaarheid van bijbehorende cursussen te regelen.
Je hebt de integratie geconfigureerd om dezelfde gegevensbron voor alle inkomende gegevens te gebruiken.
Vereiste
Geen.
Minimale vereisten voor gegevensfeed
EXTERNAL_TERM_KEY
NAME
AVAILABILITY_IND
DURATION
END_DATE
ROW_STATUS
START_DATE
Oplossing
Maak een terms.txt-gegevensbestand met de vereiste kopteksten en de bijbehorende gegevens per TERM die je wilt toevoegen aan, of wilt bijwerken in, het systeem.
Om START_DATE en END_DATE op de juiste manier te kunnen gebruiken, moet DURATION ook gespecificeerd (RANGE) worden. Bijvoorbeeld:
EXTERNAL_TERM_KEY|NAME|START_DATE|END_DATE|DURATION|AVAILABLE_IND|ROW_STATUS
AS_FA.2013|Arts and Sciences Fall 2013|20130915|20131205|RANGE|Y|ENABLED
AS_WI.2014|Arts and Sciences Winter 2014|20140103|20140418|RANGE|Y|ENABLED
AS_SP.2014|Arts and Sciences Spring 2014|20140420|20140520|RANGE|Y|ENABLED
AS_SU.2014|Arts and Sciences Summer 2014|20140608|20140820|RANGE|Y|ENABLED
MED_T1.2013|School of Medicine Term 1 2013|20130801|20131215|RANGE|Y|ENABLED
MED_T2.2014|School of Medicine Term 2 2014|20140110|20140602|RANGE|Y|ENABLED
MED_T3.2014|School of Medicine Term 3 2014|20140603|20140818|RANGE|Y|ENABLED
Voorwaarde achteraf
COMPLETE_REFRESH
Term-records in het gegevensbestand worden gemaakt of bijgewerkt. De beschikbaarheid van de term-record expliciet wordt ingesteld, waardoor de variërende beschikbaarheid van de cursussen die aan die termen zijn gekoppeld, beschikbaar worden (start_date) en wanneer ze niet-beschikbaar worden (end_date). Net als bij alle COMPLETE_REFRESH-taken worden alle records die niet zijn opgenomen in de verzonden gegevensset uitgeschakeld (gegevensfeed: ROW_STATUS=DISABLED, database: ROWSTATUS=0).
COMPLETE_REFRESH_BY_DATA_SOURCE
Term-records in het gegevensbestand worden gemaakt of bijgewerkt. De beschikbaarheid van de term-record expliciet wordt ingesteld, waardoor de variërende beschikbaarheid van de cursussen die aan die termen zijn gekoppeld, beschikbaar worden (start_date) en wanneer ze niet-beschikbaar worden (end_date). Net als bij alle COMPLETE_REFRESH_BY_DATA_SOURCE-taken worden alle records die niet zijn opgenomen in de verzonden gegevensset EN die een gegevensbronsleutel hebben die overeenkomt met de geconfigureerde gegevensbron voor integratie uitgeschakeld (gegevensfeed: ROW_STATUS=DISABLED, database: ROWSTATUS = 0). TERM-records die niet zijn gekoppeld aan de geconfigureerde gegevensbron voor integratie worden niet beïnvloed.
TERM gebruiken in cursusfeeds
Organisaties en cursussen delen dezelfde patronen voor TERM-beheer. De gegeven voorbeelden behouden een focus op het gebruik van TERM-objecten voor cursussen.
Hoewel het mogelijk is om de beschikbaarheid van cursussen te regelen door middel van duur, data, beschikbaarheid en rijstatus, zorgt het gebruik van TERM-objecten ervoor dat dezelfde instellingen worden toegepast op groepen cursussen die gekoppeld zijn aan een TERM-object. TERM is een optioneel gegevenselement in cursusfeeds.
Normale operationele resultaten moeten worden verwacht op basis van de gekozen taak om de gegevens naar Learn te verzenden.
Voorbeeld: Beschikbaarheid beheren
In het voorbeeld heb je TERM-objecten gemaakt voor ieder termijn in 2014 voor Kunst en Wetenschap en nu wil Geneeskunde de beschikbaarheid van een aantal cursussen van iedere school beheren met behulp van die TERM-objecten.
Vereiste
Je hebt TERM-objecten gemaakt waaraan je je cursussen wilt koppelen. Er zijn geen voorwaarden: cursussen worden gemaakt en gekoppeld aan de opgegeven TERM of ze worden bijgewerkt met de gekoppelde TERM zoals aangegeven door het type DURATION van de TERM.
Minimale vereisten voor gegevensfeed
EXTERNAL_COURSE_KEY
COURSE_ID
COURSE_NAME
DURATION
TERM_KEY
Oplossing
Maak een termmanagedcourses.txt-gegevensbestand met de vereiste kopteksten en de bijbehorende gegevens per cursus die je wilt toevoegen aan, of wilt bijwerken in, het systeem.
Om START_DATE en END_DATE op de juiste manier te gebruiken, moet DURATION ook gespecificeerd worden (RANGE). Bijvoorbeeld:
EXTERNAL_COURSE_KEY|COURSE_ID|COURSE_NAME|DURATION|TERM_KEY
AHIST.101-01.03.FA2013|AHIST.101-01.03.FA2013|Art History 101|TERM|AS_FA.2013
AHIST.101-01.03.WI2013|AHIST.101-01.03.WI2013|Art History 101|TERM|AS_WI.2014
AHIST.101-01.03.SP2013|AHIST.101-01.03.SP2013|Art History 101|TERM|AS_SP.2014
AHIST.101-01.03.SU2013|AHIST.101-01.03.SU2013|Art History 101|TERM|AS_SU.2014
ANAT.100-01.T1|ANAT.100-01.T1|Basic Anatomy|TERM|MED_T1.2013
ANAT.100-01.T2|ANAT.200-01.T2|Intermediate Anatomy|TERM|MED_T2.2014
ANAT.100-01.T3|ANAT.300-01.T3|Advanced Anatomy|TERM|MED_T3.2014
Voorwaarde achteraf
De cursussen in de gegevensfed worden gemaakt of bijgewerkt en zijn zichtbaar voor gebruikers zoals bepaald door de parameters voor de TERM die aan elke cursus is gekoppeld. Effect op andere systeemgegevens wordt bepaald door de taak die wordt gebruikt om gegevens in Learn te laden:
STORE
Wanneer je store gebruikt, heeft dit geen invloed op andere gegevens, alleen de gegevens in het gegevensfeedbestand worden toegevoegd of bijgewerkt.
COMPLETE REFRESH
Wanneer je complete refresh gebruikt, worden de gegevens in het bestand toegevoegd of bijgewerkt. Alle andere gegevens die beheerd worden door deze gegevensbron zijn uitgeschakeld doordat ze niet aanwezig zijn in het gegevensbestand ongeacht de gegevensbron.
COMPLETE REFRESH by DATA SOURCE
Wanneer je complete refresh by data source gebruikt, worden de gegevens in het bestand toegevoegd of bijgewerkt. Alle andere gegevens die beheerd worden door deze gegevensbron en gekoppeld zijn aan geconfigureerde gegevensbron voor integratie, zijn uitgeschakeld. Gegevens die niet aanwezig zijn in het invoerbestand en niet gekoppeld zijn aan de integratie van de gegevensbron, worden niet beïnvloed.
Meer informatie
Header-beschrijvingen van Momentopname-bestand
