Een CSV Gateway is een methode om het importeren van CSV-bestanden in Canvas te automatiseren. Bestanden worden overgedragen via Secure File Transfer Protocol (SFTP). De CSV Gateway kan met name handig zijn als uw SIS geen directe API-integratieverbinding met Canvas heeft.
Als u geïnteresseerd bent in het opzetten van een CSV Gateway/SFTP voor data-aanlevering of het exporteren van cijfers, neem dan contact op met uw Instructure Customer Success Manager (CSM).
Wat je moet weten
- CSV-bestanden moeten voldoen aan de richtlijnen voor het Canvas CSV-formaat. Meer informatie over de Canvas CSV-opmaak vindt u in [link].onze gids.
- De standaard CSV-regels zijn van toepassing:
- De eerste regel wordt geïnterpreteerd als de koptekst en is verplicht.
- Alle tekst in het bestand moet UTF-8 gecodeerd zijn.
- Alle tijdstempels moeten voldoen aan de ISO 8601-standaard. Alle tijdstempels worden standaard in UTC weergegeven, tenzij een tijdzone-offset is opgegeven.
- Importen vinden niet in realtime plaats. Synchronisatietaken worden ingepland. De frequentie is afhankelijk van uw dataset en kan verder worden besproken met uw Instructure-consultant. De meest voorkomende geplande synchronisaties zijn één of twee keer per dag.
- Een optioneleRapport over het exporteren van cijferskan zo worden ingesteld dat deze eenmaal per dag in de gateway wordt geplaatst.
- A DiffingDe directory kan op verzoek worden geconfigureerd. Bij het importeren van verschillen worden de aangeleverde bestanden gecontroleerd op wijzigingen en wordt actie ondernomen voor ontbrekende records. Als u deze configuratie wilt, kan uw Instructure-consultant u hierover meer informatie geven.
- Nadat de SFTP-server is geconfigureerd en gesynchroniseerd met de productieomgeving, dient de klant contact op te nemen met de supportafdeling voor het oplossen van problemen en/of het wijzigen van de SFTP-configuratie.
Hoe begin ik?
Allereerst moet de klant bepalen wie de SFTP-server gaat hosten. Er zijn twee opties voor het hosten van de SFTP-server.
- Instructure kan de server hosten.
- De client host de SFTP-server.
De klant is verantwoordelijk voor het genereren van de CSV-bestanden voor hun data, conform de Canvas CSV-specificaties, en het aanleveren van deze bestanden aan de SFTP-server. Instructure verwerkt de aangeleverde bestanden vervolgens op basis van geplande taken.
De CSV Gateway wordt in eerste instantie verbonden met de Canvas Beta-omgeving van de klant voor de eerste tests. De verbinding wordt pas overgeschakeld naar de Canvas Productie-omgeving van de klant nadat de klant schriftelijk aan zijn Instructure-consultant heeft bevestigd dat de tests zijn afgerond.
Instructure-gehoste server
Als Instructure de SFTP-server host, moet de klant een SSH-sleutelpaar genereren. De publieke sleutel wordt naar uw Instructure-consultant gestuurd.
De privésleutel mag niet worden gedeeld. Indien de privésleutel toch wordt gedeeld, zal Instructure een nieuw sleutelpaar aanvragen.
Houd bij het genereren van het SSH-sleutelpaar rekening met het volgende:
- Instructure vereist een minimale sleutellengte van 2048 bits.
- Openbare sleutels hebben doorgaans een van de volgende extensies: .pub of .pem.
- Sommige sleutelformaten bevatten zowel de privésleutel als de publieke sleutel. Stuur ons alleen de publieke sleutel, anders moet het sleutelpaar opnieuw worden gegenereerd.
Nadat de publieke sleutel met de Instructure-consultant is gedeeld en naar de SFTP-server is geüpload, ontvangt de klant de volgende informatie:
- Server
- Haven
- Gebruikersnaam
- Directory
- Synchroniseer schema
Door de klant gehoste server
Als de klant ervoor kiest om de SFTP-server zelf te hosten, moet Instructure de verbindingsgegevens ontvangen.
Verstuur deze informatie niet per e-mail.
Uw Instructure-consultant zal u een beveiligde link verstrekken waarmee u een .txt-bestand met de volgende informatie kunt uploaden:
- Server
- Haven
- Gebruikersnaam
- Authenticatie
- Map/Directory
Naast het verstrekken van de gevraagde informatie aan uw Instructure-consultant, kan het nodig zijn dat de klant de IP-adressen van Instructure toevoegt aan een whitelist. Uw Instructure-consultant zal u de gevraagde informatie verstrekken. Mogelijk zijn aanvullende configuraties/aanpassingen nodig op de server van de klant als Instructure geen verbinding kan maken met de externe SFTP-server.