SFTP importeren en exporteren instellen
- Lango: Language and translation manager
Moeilijkheidsgraad: expert
Leerdoelen
Na het lezen van dit artikel zul je in staat zijn om:
Wat SFTP is en wanneer het te gebruiken
Verbinding met SFTP-server instellen in WPM
SSH-sleutelpaarauthenticatie configureren
Wat is SFTP / wanneer gebruik je SFTP?
SFTP staat voor SSH File Transfer Protocol. Dit is een methode om bestanden over te dragen tussen twee entiteiten. Het is letterlijk niets anders dan dat de ene entiteit (systeem of gebruiker) een bestand overbrengt naar een server, dat op zijn beurt kan worden opgehaald door een andere entiteit (systeem of gebruiker). Of om het nog eenvoudiger te maken: stel je voor dat je een bestand in een map op je bureaublad zet, dat vervolgens door een andere gebruiker wordt opgehaald. Zo eenvoudig is het.
SFTP wordt meestal gebruikt in de volgende scenario's:
Gegevens moeten worden gedeeld in een gemeenschappelijk bestandsformaat. Als het bestand op een server wordt geplaatst, worden meestal bestanden zoals CSV of XML gebruikt. Maar ook PDF-, Word- of afbeeldingsbestanden worden vaak gebruikt. Omdat dit gemeenschappelijke bestanden zijn, kunnen gebruikers er gemakkelijker mee werken en begrijpen wat er gebeurt.
Debuggen moet eenvoudig zijn. Aangezien er twee acties zijn (entiteit > server, server > entiteit), is het vrij eenvoudig om te debuggen waar de fout optreedt. Als een verwacht bestand niet op de server staat, weet je dat de aanleverende partij een fout heeft gemaakt. Als het bestand wel op de server staat, maar niet (correct) wordt opgehaald door de ontvangende entiteit, dan weet je dat er iets mis gaat bij het ophalen.
Grote datasets moeten worden gedeeld. Een webservice wordt meestal gebruikt voor korte transacties. Grote datasets zijn niet geschikt om rechtstreeks tussen systemen te worden overgedragen, omdat er time-outs kunnen optreden. Deze beperkingen zijn minder voor SFTP. Dus als een grote gegevensoverdracht nodig is, is SFTP de betere optie.
Overwegingen
Houd rekening met de volgende overwegingen met betrekking tot SFTP:
Naast SFTP ondersteunt Workplace ook FTP. Gebruik dit niet, tenzij er geen andere optie is. De ondersteuning voor FTP's wordt steeds slechter in de industrie, dus de ondersteuning zal ook afnemen. Als FTPs wordt gebruikt, zijn de andere stappen vergelijkbaar, hoewel je misschien het soort FTPs moet specificeren in FileZilla (raadpleeg de documentatie online om dit in te stellen).
Workplace accepteert geen zelfondertekende certificaten. Dit is voor onze eigen veiligheid en die van de klant.
Workplace ondersteunt certificaatverificatie. Deze mogelijkheid is nog in ontwikkeling en dient alleen te worden uitgevoerd onder begeleiding van een Spacewell consultant. Om die reden valt het (voorlopig) buiten het bereik van deze pagina.
Zoals bij elke server het geval is, kunnen er firewalls aanwezig zijn (dit geldt alleen als de server niet door Spacewell wordt gehost). Dit kan betekenen dat zowel het IP-adres van uw kantoor als dat van Workplace moet worden gewhitelist.
U kunt het IP-adres van uw kantoor vinden door op Google te zoeken naar "wat is mijn IP".
Neem contact op met uw Spacewell-adviseur om het SOURCE NAT ip aan te vragen.
Importeren kan slechts eenmaal per 15 minuten. Als je een hogere frequentie instelt, wordt dit genegeerd.
Een automatische SFTP-import instellen
Toepassingsgebied
In de onderstaande voorbeelden gebruiken we de standaard importconnectoren van Workplace Management. Het automatiseren van eigen import (en export) is ook mogelijk. Als dit nodig is, moeten er aangepaste import/export mappings worden gemaakt waarvoor diepgaande kennis van het Workplace objectmodel nodig is. Neem contact op met uw Spacewell contactpersoon om de mogelijkheden te bespreken.
Stappen
Klik in het navigatiemenu op "Configuratie" > klik op "Importeren" (of gebruik de knop "Standaard importeren" op je startbord).
Open de importen waarvoor je een automatische import wilt instellen.
Als je geen sjabloonbestand hebt ontvangen, gebruik dan "Genereer importsjabloon" om een sjabloon te krijgen voor het importeren van gegevens. Als je het importbestand al hebt, kun je deze stap overslaan.
Navigeer naar het tabblad 'Details'.
Er zijn verplichte en optionele velden. Onderaan de lijst vind je beide velden. Volg deze voor het instellen.
De SFTP-verbinding moet actief zijn na het invullen van alle verplichte velden.
Het is gebruikelijk om 'Actief = ja' in te stellen na het invullen van alle andere verplichte velden.
De verbinding is nu actief en wordt uitgevoerd op de eerst geplande datum.
Verplichte instellingen
Veld | Waarde | Opmerking |
|---|---|---|
Naam | Kies een herkenbare naam | Niet per se verplicht, maar wel een aanrader om in te vullen. |
Type | Standaard: SFTP | Kies FTP's als dat van toepassing is, zie "Overwegingen". |
|
|
|
Server | Adres server | Dit moet zijn ontvangen van de klant |
Haven | Poortadres (alleen cijfers) | Dit moet zijn ontvangen van de klant |
Gebruikersnaam | Gebruikersnaam die toegang heeft gekregen tot SFTP | Dit moet zijn ontvangen van de klant |
Wachtwoord | Wachtwoord voor opgegeven gebruikersnaam | Dit moet zijn ontvangen van de klant |
Bestandsnaam | Naam van het bestand dat moet worden opgehaald | Zorg ervoor dat je dit bespreekt met de klant. Bij voorkeur is dit altijd hetzelfde om problemen te voorkomen. |
Verwijder | Standaard: ja | Verander dit in "no" als je niet wilt dat het bestand wordt verwijderd zodra Workplace het bestand heeft geïmporteerd. Bij voorkeur voor debuggen |
|
|
|
Actief | Standaard: nee | Wordt gebruikt om de import in/uit te schakelen. Stel dit in op 'ja' om de verbinding te activeren. |
Start | Datum tijd waarde | Startdatum en -tijd waarop de import moet worden gestart |
Fiets |
| Stel het interval in waarmee gegevens moeten worden verzameld. Het laagste minimum is 15 minuten, alles daarboven is een geldige waarde. |
|
|
|
Neem contact op met | Contact op de werkplek | Stel de contactpersoon in die de import/export uitvoert. Deze contactpersoon moet de juiste toegangsrechten hebben. Meestal wordt hier een systeembeheerder geselecteerd. |
Optionele instellingen
Veld | Waarde | Opmerking |
|---|---|---|
Directory | Tekst die de locatie van het bestand op de SFTP-server aangeeft. | Kan elke map op de SFTP-server zijn, gedeeld door / (bijv. facturen/geïmporteerd) |
Wachtwoord zippen | Wachtwoord voor de zip | Als de client een zipbestand met een wachtwoord gebruikt, kan het wachtwoord hier worden toegevoegd |
Tekenset | Standaard: leeg | Als er fouten optreden met betrekking tot tekstkarakters, kan dit te maken hebben met de codering van het bestand. Stel de codering van het bestand in (u kunt dit controleren met kladblok) |
|
|
|
Fouten | Werkplek gebruikersgroep opgeven | Als er fouten optreden, ontvangt de groep die hier is ingevuld een e-mail met de fouten |
Melding | Werkplek gebruikersgroep opgeven | Wanneer het importeren klaar is, krijgt de notificatiegroep een melding via e-mail |
Bericht | Tekst | Hier kan een bericht worden toegevoegd voor de melding |
Planning |
|
|
Dag in de maand | Zie opmerking | Als je een specifieke dag in de maand wilt om het bestand te importeren |
Dag | Zie opmerking | Als u een relatieve dag in de maand wilt opgeven om het bestand te importeren |
Volgende connector | Selecteer de volgende connector | In sommige gevallen wil je meerdere imports na elkaar uitvoeren, dan kun je de imports aan elkaar koppelen. Je kunt hier de volgende connector selecteren. Houd er rekening mee dat als de eerste connector mislukt, de volgende niet wordt gestart. |
|
|
|
Sjabloon definitie | Sjabloondefinitie over hoe om te gaan met gegevens | Dit is alleen van toepassing als het geïmporteerde bestand voldoet aan een specifiek sjabloon dat afwijkt van CSV of XML op één niveau. Neem contact op met Spacewell als er meer nodig is |
Tijdsverschil | Standaard: 120, voorgesteld: 0 | Met deze waarde wordt gecontroleerd of het vorige bestand dat is geïmporteerd anders is dan het nieuwste bestand. Dit is in seconden. Met 0 wordt de controle overgeslagen.
Let op: deze waarde is ook belangrijk voor het vergrendelen van bestanden. Raadpleeg de helptekst van het veld voor meer informatie. |
Log | Standaard: ja | Zorgt ervoor dat fouten worden gelogd |
Correct | Standaard: nee | Hierdoor kan de import sommige waarden overschrijven. In de meeste gevallen is dit niet nodig. Wijzig dit alleen in overleg met Spacewell |
Documenten opslaan | Standaard: ja | Met deze instelling worden geïmporteerde bestanden opgeslagen in Werkplekbeheer. Dit is wenselijk voor debugging. Als er gevoelige gegevens in de geïmporteerde bestanden staan, zet deze waarde dan op "nee". Documenten worden gedurende een bepaald aantal maanden bewaard, wat kan worden ingesteld in de clientinstellingen |
Waarschuwingen opslaan | Standaard: ja | Slaat waarschuwingen op als bestanden. Gebruikt voor foutopsporing. Stel in op "no" als debuggen niet nodig is. |
Toegangscontrole | Standaard: leeg | In sommige gevallen kan de prestatie een probleem zijn. Deze waarde kan worden ingesteld op "vereenvoudigd" om intensieve controle van toegangsrechten te voorkomen. |
SSH-sleutelpaarverificatie (voor WPM)
Workplace Management ondersteunt authenticatie door middel van SSH Key Pair authenticatie.
RSA-sleutels worden gebruikt
OPENSSH-sleutels worden momenteel (d.d. mei 2023) niet geaccepteerd en kunnen niet automatisch worden geconverteerd. Als je OPENSSH-sleutels hebt, converteer deze dan eerst naar RSA.
Als dit de eerste import of export connector is waarvoor je SSH Key Pair authenticatie inschakelt, voer dan eerst deze stappen uit:
Open je eigen gebruiker door rechtsboven op je naam te klikken > profiel
Klik op de knop 'Groep toewijzen
Zoek naar de groep 'Licentie-editor' en voeg deze toe aan je gebruiker. Deze groep is nodig om de authenticatie te configureren
Opmerking: als u deze groep niet kunt toevoegen, neem dan contact op met uw Spacewell-contactpersoon.
Om SSH Key Pair authenticatie te configureren voor een import/export connector:
Open de export- of importconnector
Scroll naar beneden naar de include 'Trust relations'. Als de include ontbreekt, moet je de include "FtpConnectorObjectTrustRelationList" toevoegen.)
klik op 'Nieuwe RSA-sleutel toewijzen'.
Klik op 'Nieuw' om een nieuwe vertrouwensrelatie aan te maken
Vul de velden in:
Naam = geef een naam
Beschrijving = geef een beschrijving
Type = RSA-sleutelpaar
Overerving = samenvoegen
Klik op 'Sleutel genereren
Kopieer de RSA persoonlijke sleutel en het wachtwoord (helemaal onderaan) uit het veld 'Public certificate'.
Opmerking: doe dit onmiddellijk. Als u de vertrouwensrelatiepagina vernieuwt (of verlaat en terugkomt) en terugnavigeert naar deze pagina, wordt de openbare sleutel wordt in plaats daarvan weergegeven.
Als je bent vergeten de privésleutel te kopiëren, kun je klikken op 'Geheime sleutel weergeven' > vul het wachtwoord in van de gebruiker waarmee je bent ingelogd (niet het wachtwoord van de client!).
Klik nu op 'Ok' om terug te gaan naar het vorige scherm
Selecteer de vertrouwensrelatie die u zojuist hebt aangemaakt > klik op bevestigen rechtsboven op de pagina
Na het bevestigen wordt het tabblad 'Details' van de connector geopend. Als je nu naar beneden scrollt naar het onderdeel 'Vertrouwensrelatie' zie je dat de vertrouwensrelatie is gekoppeld.
Vergeet niet om de import/export-connector zoals gebruikelijk te configureren. Dus voeg de: server, poortnummer, directory, enz. toe.
Na het opzetten van de verbinding aan de kant van de client, kun je beginnen met testen.
Controlelijst voor probleemoplossing
Samenvatting
Oefening
Zoek op