LIS-omzettingsprogramma's zijn een manier om LIS-aanvragen om te zetten in generieke IPSIS-aanvragen. Hierdoor kan IPSIS altijd een gemeenschappelijke taal gebruiken om te communiceren met Brightspace® in plaats van dat LIS (en andere standaarden en bedrijfseigen oplossingen) rechtstreeks met Brightspace® communiceren. Hierdoor is ook één set handlers mogelijk die ongeacht de SIS-integratieoplossing (LIS, SIF, Proprietary) kunnen worden gebruikt.
In de meeste gevallen wordt een verzameling omzettingsprogramma's samen gebruikt (ook wel configuratielijst genoemd), die elk hun steentje bijdragen aan het voltooien van een taak. Omdat elk omzettingsprogramma een klein deel doet, kunnen deze eenvoudig op verschillende manieren worden geconfigureerd om een zeer flexibel aanbod van alternatieven te bieden, afhankelijk van de zakelijke behoeften van een specifieke instelling.
Omzettingsprogramma's worden geïmplementeerd met behulp van LIS-omzettingsconventies, die organisaties helpen inzicht te krijgen in de vele beschikbare omzettingsopties.
De LIS-adapter definieert een verzameling omzettingsinterfaces die specifiek zijn voor de typen objecten die vanuit het studentinformatiesysteem worden verzonden via LIS-aanvragen. Elke interface heeft een set omzettingsprogramma's die de interface implementeren om een specifieke regel voor omzetting/toewijzing toe te passen. In de meeste gevallen zijn er niet veel omzettingsprogramma's om uit te kiezen omdat de toewijzingsregels generiek en herbruikbaar zijn (bijvoorbeeld de startdatum van de cursus). In andere gevallen zijn er echter veel omzettingsprogramma's omdat het LIS-bericht veel velden bevat die geschikt kunnen zijn om aan een veld in Brightspace® toe te wijzen (bijvoorbeeld Cursustitel).
De omzettingsinterfaces worden gedefinieerd binnen de LIS-adapter en worden gebruikt door de individuele LIS-services. Elk van hen heeft zijn eigen documentatie met beschrijvingen van de beschikbare omzettingsprogramma's voor de interface, evenals een aantal sjabloonconfiguratielijsten voor de omzettingsprogramma's die algemene configuratiescenario's vertegenwoordigen.
Naamgevingsconventies voor LIS-omzettingsprogramma's
Namen van omzettingsprogramma's moeten beschrijvend zijn en voldoende details bevatten om aan te geven welke velden worden omgezet, en of het omzettingsprogramma verplicht of optioneel is. In de meeste gevallen verrichten de omzettingsprogramma's een zo gering mogelijke hoeveelheid werk, zodat ze zo herbruikbaar mogelijk zijn.
Slechts één van de volgende termen wordt gebruikt in de naam van een omzettingsprogramma:
- Gebruik Basis in de naam om aan te geven dat het gaat om een basisomzettingsprogramma (impliceert ook dat dit programma of een alternatief basisomzettingsprogramma vereist is)
- Gebruik Vereist in de naam voor vereiste velden
- Gebruik Optioneel in de naam voor optionele velden
De algemene structuur van de naam van een omzettingsprogramma is als volgt:
<request name><toegewezen aan (soms gebruikt)><fields translated><base, required of optional>Translator
Voorbeelden
- CourseSectionRequestBaseTranslator:
- Dit is voor een CourseSectionRequest.
- Dit is het basisomzettingsprogramma.
- CourseSectionRequestDepartmentRequiredTranslator:
- Dit is voor een CourseSectionRequest.
- Dit omzettingsprogramma zal proberen het veld Afdeling op te halen uit de LIS-aanvraag.
- Dit is een vereist omzettingsprogramma (er wordt een uitzondering gemaakt als het veld Afdeling niet is ingevuld in de LIS-aanvraag).
- CourseSectionRequestSemesterOptionalTranslator:
- Dit is voor een CourseSectionRequest.
- Dit omzettingsprogramma zal proberen om het veld Semester op te halen uit de LIS-aanvraag.
- Dit is een optioneel omzettingsprogramma (er wordt geen uitzondering gemaakt als het veld Semester niet is ingevuld in de LIS-aanvraag).
- CourseOfferingRequestDepOrgNameOptionalTranslator:
- Dit is voor een CourseOfferingRequest.
- Dit omzettingsprogramma zal proberen het veld Organisatienaam op te halen uit de LIS-aanvraag en dit toe te wijzen aan het veld Afdeling in IPSIS.
- Dit is een optioneel omzettingsprogramma (er wordt geen uitzondering gemaakt als het veld Semester niet is ingevuld in de LIS-aanvraag).
Conventies voor ontwerppatronen voor LIS-omzettingsprogramma's
LIS-omzettingsprogramma's volgen een eenvoudig ontwerppatroon van scheiding van problemen. Elk omzettingsprogramma mag uitsluitend het gewenste veld toewijzen. Een omzettingsprogramma dat namen toewijst, mag niet ook adressen toewijzen. De meeste aanvragen zullen een reeks omzettingsprogramma's hebben die na elkaar worden uitgevoerd, waarbij elk een ander gebied van velden toewijst. Het eerste omzettingsprogramma in de reeks is een basisomzettingsprogramma dat het vertaalde resultaatobject initialiseert en dit vult met basiselementen van de aanvraag.
De volgende omzettingsprogramma's moeten Vereist of Optioneel zijn. Dit geeft aan of het omzettingsprogramma een fout genereert als er een veld ontbreekt. De CourseSectionRequestDepartment RequiredTranslator retourneert bijvoorbeeld een fout als er geen afdeling in de aanvraag wordt doorgegeven. Aan de andere kant blijft de CourseSectionRequestSemesterOptionalTranslator0 gewoon doorwerken als er geen semester wordt doorgegeven in de aanvraag (het veld op het resultaat blijft niet geïnitialiseerd).