Deze documentatie bevat instructies voor het gebruik van de nieuwe API voor het toewijzen van migratiedomeinen. Deze workflow maakt migratie mogelijk van een of meer 1.1-link-URL's naar een ander 1.3-registratiedomein, waardoor de exacte lacune in de domeinmatchingvereiste wordt opgevuld.
Wat het kan doen
Met deze API voor het toewijzen van migratiedomeinen kan u migreren van een of meer Legacy Link-URL's naar een ander Advantage-registratiedomein. Gebruiksvoorbeelden zijn onder meer het toevoegen, verwijderen of bijwerken van verouderde domeinen en het migreren van meerdere verouderde link-URL's naar een ander advantage-registratiedomein. Nadat deze toewijzing is voltooid, kunnen migraties worden voltooid via de normale migratieprocessen van natuurlijk kopiëren, importeren of handmatig met de Trekken knoop.
Bijvoorbeeld links met de volgende URL's van verouderde koppelingen:
- Domain1.example.com, en
- Domain2.example2.com
Kan worden gemigreerd naar het volgende registratiedomein:
Tabel 1: Voorbeelden van migratie die beschikbaar zijn via de API voor het toewijzen van migratiedomeinen.
Voorbeeld van een user case | URL van oude link | Voordeel Registratie Domein | In kaart gebracht domein | Link-URL na migratie |
|---|
Wijziging van subdomein | subdomain1.primary.com/path1 | domain3.com | domain1.com | domain3.com/path1 |
Subdomein | subdomain1.domain2.com/path1 | domain3.com | domain2.com | domain3.com/path1 |
Subdomein verwijderen en Domein wijzigen | domain2.com/path1 | domain3.com | domain2.com | domain3.com/path1 |
URL-toewijzing van meerdere verouderde links | domain2.com; subdomain1.domain2.com | domain3.com | domain2.com | domain3.com |
Wat het niet kan doen
Met deze extra migratiefunctionaliteit kan het pad niet worden bijgewerkt of kunnen aangepaste parameters niet worden bijgewerkt tijdens het migratieproces. Zoals in de bovenstaande tabel wordt weergegeven, wordt het pad van de URL van de oude link na de migratie doorgevoerd naar de URL van de link. Deze extra API vult alleen het exacte gat in de domeinmatching; alle andere beperkingen en gebruiksscenario's die worden beschreven in de Documentatie over LTI-migratieen Veelgestelde vragen over migratie nog steeds van toepassing zijn.
De migratie-API (waarbij één link tegelijk wordt gemigreerd) werkt niet met toegewezen verouderde domeinen.
Hoe het werkt
De URL van de oude link is te vinden op cursusniveau. Navigeer naar Cursus Admin >Externe leermiddelen > Toolkoppelingen beheren (verouderd) en selecteer je link.
Afbeelding: Een voorbeeld van een LTI 1.1 Legacy Link-URL.
Als u het Advantage-registratiedomein wilt bekijken, navigeert u naar Hulpmiddelen voor beheerders > Uitbreidbaarheid beheren > LTI-voordeel en selecteer uw registratie.
Cijfer: Een voorbeeld van een LTI 1.3 Advantage Registration Domain in de LTI-testtool bewerken tweespraak.
Er wordt alleen geprobeerd te migreren wanneer implementaties worden gedeeld. Mogelijk moet u de regels voor delen controleren voor een implementatie. De klant moet de juiste context bieden voor waar migratie nodig is.
Van de LTI-voordeel tabblad, klik op Voordeel Tool Registratieen navigeer naar Implementaties bekijken.
Selecteer uw implementatie en zorg ervoor dat deze wordt gedeeld met de migratiebestemming door organisatie-eenheden toe te voegen in het vak Tool ter beschikking stellen aan afdeling. Koppelingen automatisch migreren moet zijn ingeschakeld.
Figuur: De Tool ter beschikking stellen aan afdeling
De link-URL na de migratie is te vinden op cursusniveau. Navigeer naar Cursus Admin > Externe leermiddelen > LTI-voordeel en selecteer je link.
Figuur: De AGS-link met datums bewerken dialoogvenster waar u de link-URL na de migratie kunt vinden.
Nadat verouderde domeinen in kaart zijn gebracht, kunnen migraties worden voltooid via bestaande migratieprocessen, uiteraard kopiëren, importeren of handmatig met behulp van de Trekken knop op het cursusniveau Toolkoppelingen beheren (verouderd) bladzijde.
Stappen om uit te voeren
1. Controleer of exacte domeinmatching de enige beperking is. Het pad en eventuele aangepaste parameters kunnen niet worden bijgewerkt. De Registraties van LTI Advantage Tool beheren Toestemming is vereist.
2. Gebruik met Postman of een andere API-testtool de GET API om alle registraties voor de instantie te vinden. Kopieer vervolgens de ClientID voor het gewenste Advantage-registratiedomein dat eerder werd geblokkeerd door de exacte domeinmatchingvereiste. Dit is het LTI Advantage Registration Domain.
GET /d2l/api/le/(versie)/ltiadvantage/registration/ <br/>
3. Gebruik de nieuwe Mapping Get API om beschikbare registraties voor die ClientId op te halen:
GET/d2l/api/le/{version}/ltiadvantage/registration/{clientId}/legacydomains/
Deze API retourneert een JSON-array van verouderde domeinreeksen die zijn geconfigureerd voor een bepaalde LTI Advantage-registratie. Dit eerste verzoek zou een leeg resultaat moeten opleveren.
4. Gebruik de POST API om een Legacy Link-URL toe te wijzen aan een Advantage-registratiedomein. Dit is de oude link-URL-kolom die eerder werd geblokkeerd door de exacte domeinovereenkomstbeperking, houd er rekening mee dat er https:// nodig is. Deze API kan meerdere keren worden uitgevoerd om toe te voegen aan de bestaande lijst.
POST/d2l/api/le/{version}/ltiadvantage/registration/{clientId}/legacydomains/
Afbeelding: Gebruik de POST-API om de URL van de verouderde link toe te wijzen aan een Advantage-registratiedomein.
5. Als u meer dan één Legacy Link-URL wilt toewijzen aan een 1.3-registratie, gebruikt u de PUT-API. De PUT-API vervangt de bestaande lijst met toegewezen URL's.
PUT/d2l/api/le/{version}/ltiadvantage/registration/{clientId}/legacydomains/
Afbeelding: Gebruik de PUT-API om meerdere Legacy Link-URL's toe te wijzen aan een 1.3-registratie.
Alle toekomstige migratiegebeurtenissen proberen nu een migratie uit te voeren van de Legacy Link-URL's die zijn toegewezen aan de 1.3-domeinregistratie. Migratie kan worden geïnitieerd door API, cursuskopie, import of handmatig op cursusniveau.
De link-URL die na de migratie is gelabeld, heeft het pad van de oude link-URL.
Mislukte migratietaken worden geïdentificeerd in de tabel in het migratielogboek met vermeldingen in de Geen domeinovereenkomst kolom.
Figuur: De Geen domeinovereenkomst kolom geeft aan of er migratietaken zijn mislukt als gevolg van overeenkomstproblemen.
De API voor het toewijzen van migratiedomeinen stoppen
Om dit proces te stoppen, vraagt u de PUT-API aan met een lege tekenreeks, hierdoor worden de eerder toegewezen legacy-domeinen verwijderd.
Als u het migratieproces onmiddellijk wilt stoppen, schakelt u de Koppelingen automatisch migreren Schakel bij de implementatie of verwijder alle regels voor delen waar migratie niet gewenst is. De integratie kan ook op elk moment worden uitgeschakeld, maar dit zorgt er ook voor dat de hele integratie niet werkt, in plaats van alleen de migratie.
