Einrichtung von SFTP-Import und -Export
- Lango: Language and translation manager
Schwierigkeitsgrad: Experte
Lernziele
Nach der Lektüre dieses Artikels werden Sie in der Lage sein:
Was ist SFTP und wann wird es verwendet?
Verbindung zum SFTP-Server in WPM einrichten
Konfigurieren Sie die SSH-Schlüsselpaar-Authentifizierung
Was ist SFTP / wann sollte man SFTP verwenden?
SFTP steht für SSH File Transfer Protocol. Dies ist eine Methode zur Übertragung von Dateien zwischen zwei Einheiten. Es ist buchstäblich nichts anderes, als dass eine Einheit (System oder Benutzer) eine Datei an einen Server überträgt, die wiederum von einer anderen Einheit (System oder Benutzer) abgeholt werden kann. Oder um es noch einfacher zu machen: Stellen Sie sich vor, Sie würden eine Datei in einem Ordner auf Ihrem Desktop ablegen, die dann von einem anderen Benutzer abgeholt wird. So einfach ist das.
SFTP wird am häufigsten in den folgenden Szenarien verwendet:
Die Daten sollten in einem gemeinsamen Dateiformat ausgetauscht werden. Da die Datei auf einem Server abgelegt wird, werden in der Regel Dateien wie CSV oder XML verwendet. Aber auch PDF, Word oder Bilddateien werden häufig verwendet. Da es sich um gängige Dateien handelt, können die Benutzer leichter mit ihnen interagieren und verstehen, was vor sich geht.
Die Fehlersuche muss einfach sein. Da es zwei Aktionen gibt (Entität > Server, Server > Entität), ist es recht einfach, den Fehler zu beheben. Wenn sich eine erwartete Datei nicht auf dem Server befindet, weiß man, dass die übermittelnde Partei einen Fehler gemacht hat. Wenn die Datei auf dem Server ist, aber von der empfangenden Entität nicht (korrekt) abgeholt wird, wissen Sie, dass bei der Abholung etwas schief läuft.
Große Datensätze müssen gemeinsam genutzt werden. Ein Webservice wird in der Regel für kurze Transaktionen verwendet. Große Datenmengen eignen sich nicht für die direkte Übertragung zwischen Systemen, da es zu Zeitüberschreitungen kommen kann. Diese Einschränkungen sind bei SFTP geringer. Wenn also eine große Datenmenge übertragen werden muss, ist SFTP die bessere Wahl.
Überlegungen
Bitte beachten Sie die folgenden Hinweise zum Thema SFTP:
Neben SFTP bietet Workplace auch Unterstützung für FTP. Bitte verwenden Sie dies nicht, es sei denn, es gibt keine andere Möglichkeit. Der Support für FTPs wird in der Branche immer schlechter, so dass auch der Support zurückgehen wird. Wenn FTPs verwendet wird, sind die anderen Schritte ähnlich, obwohl Sie möglicherweise die Art von FTPs in FileZilla angeben müssen (bitte lesen Sie die Online-Dokumentation, um dies einzurichten).
Workplace akzeptiert keine selbstsignierten Zertifikate. Dies dient unserer eigenen Sicherheit und der des Kunden.
Workplace unterstützt die Zertifikatsauthentifizierung. Diese Möglichkeit befindet sich noch in einem frühen Entwicklungsstadium und sollte nur unter der Anleitung eines Spacewell-Beraters durchgeführt werden. Aus diesem Grund fällt sie (vorerst) nicht in den Rahmen dieser Seite.
Wie bei jedem Server können auch hier Firewalls vorhanden sein (dies gilt nur, wenn der Server nicht von Spacewell gehostet wird). Das kann bedeuten, dass sowohl die IP-Adresse Ihres Büros als auch die von Workplace auf eine Whitelist gesetzt werden muss.
Sie können die IP-Adresse Ihres Büros herausfinden, wenn Sie bei Google nach "what is my IP" suchen
Kontaktieren Sie Ihren Spacewell-Berater, um die SOURCE NAT ip anzufragen
Der Import kann nur einmal alle 15 Minuten durchgeführt werden. Wenn Sie eine höhere Frequenz einstellen, wird dies ignoriert.
Einrichten eines automatischen SFTP-Imports
Umfang
In den folgenden Beispielen werden wir die Standard-Importkonnektoren von Workplace Management verwenden. Die Automatisierung von benutzerdefinierten Importen (und Exporten) ist ebenfalls möglich. Wenn dies erforderlich ist, müssen benutzerdefinierte Import-/Export-Mappings erstellt werden, für die tiefgreifende Kenntnisse des Workplace-Objektmodells erforderlich sind. Bitte kontaktieren Sie Ihren Spacewell-Ansprechpartner, um die Möglichkeiten zu besprechen.
Schritte
Klicken Sie im Navigationsmenü auf "Konfiguration" > klicken Sie auf "Importieren" (oder verwenden Sie die Schaltfläche "Standardimport" auf Ihrem StartBoard).
Öffnen Sie die Importe, für die Sie einen automatischen Import einrichten möchten.
Wenn Sie keine Vorlagendatei erhalten haben, verwenden Sie bitte "Importvorlage generieren", um eine Vorlage für den Datenimport zu erhalten. Wenn Sie die Importdatei bereits haben, können Sie diesen Schritt überspringen.
Wechseln Sie zur Registerkarte "Details".
Es gibt ein obligatorisches und ein optionales Feld. Unterhalb der Liste finden Sie beide Felder. Bitte beachten Sie diese für die Einrichtung.
Die SFTP-Verbindung sollte aktiv sein, nachdem alle Pflichtfelder ausgefüllt wurden.
Es ist gängige Praxis, nach dem Ausfüllen aller anderen Pflichtfelder "Aktiv = ja" zu setzen.
Die Verbindung ist nun aktiv und wird zum ersten geplanten Termin ausgeführt.
Obligatorische Einstellungen
Feld | Wert | Bemerkung |
|---|---|---|
Name | Wählen Sie einen erkennbaren Namen | Das Ausfüllen ist zwar nicht obligatorisch, wird aber dringend empfohlen. |
Typ | Standard: SFTP | Wählen Sie FTPs, wenn dies zutrifft, siehe "Überlegungen". |
|
|
|
Server | Server-Adresse | Diese sollte vom Kunden erhalten worden sein |
Hafen | Hafenadresse (nur Ziffern) | Diese sollte vom Kunden erhalten worden sein |
Benutzername | Benutzername, dem der Zugriff auf das SFTP-System gewährt wurde | Diese sollte vom Kunden erhalten worden sein |
Passwort | Passwort für den angegebenen Benutzernamen | Diese sollte vom Kunden erhalten worden sein |
Dateiname | Name der zu sammelnden Datei | Besprechen Sie dies unbedingt mit dem Kunden. Am besten ist es, wenn dies immer gleich ist, um Probleme zu vermeiden. |
Löschen | Voreinstellung: ja | Ändern Sie dies in "no", wenn Sie nicht möchten, dass die Datei gelöscht wird, nachdem Workplace die Datei importiert hat. Bevorzugt für die Fehlersuche |
|
|
|
Aktiv | Standard: nein | Dient zur Aktivierung/Deaktivierung des Imports. Setzen Sie dies auf "ja", um die Verbindung zu aktivieren. |
Start | Datum Zeitwert | Startdatum und -uhrzeit für den Beginn des Imports |
Zyklus |
| Legen Sie das Intervall fest, in dem Daten gesammelt werden sollen. Das niedrigste Minimum sind 15 Minuten, alles darüber ist ein gültiger Wert |
|
|
|
Kontakt | Kontakt am Workplace | Legen Sie den Kontakt fest, der den Import/Export durchführt. Dieser Kontakt sollte über die entsprechenden Zugriffsrechte verfügen. Normalerweise wird hier ein Systemadministrator ausgewählt. |
Optionale Einstellungen
Feld | Wert | Bemerkung |
|---|---|---|
Verzeichnis | Text, der den Ort angibt, an dem sich die Datei auf dem SFTP-Server befindet | Kann ein beliebiges Verzeichnis auf dem SFTP-Server sein, geteilt durch / (z. B. invoices/imported) |
Zip-Passwort | Kennwort für die Zip-Datei | Wenn der Kunde eine Zip-Datei mit einem Passwort verwendet, kann das Passwort hier hinzugefügt werden |
Zeichensatz | Standard: leer | Wenn Fehler in Bezug auf Textzeichen auftreten, könnte dies an der Kodierung der Datei liegen. Stellen Sie die Kodierung der Datei ein (Sie können dies mit Notepad überprüfen) |
|
|
|
Fehler | Workplace-Benutzergruppe angeben | Wenn Fehler auftreten, erhält die hier eingetragene Gruppe eine E-Mail mit den Fehlern |
Benachrichtigung | Workplace-Benutzergruppe angeben | Wenn der Import abgeschlossen ist, wird die Benachrichtigungsgruppe per E-Mail benachrichtigt |
Nachricht | Text | Hier kann eine Nachricht für die Benachrichtigung hinzugefügt werden |
Terminplanung |
|
|
Tag im Monat | Siehe Bemerkung | Wenn Sie die Datei an einem bestimmten Tag im Monat importieren möchten |
Tag | Siehe Bemerkung | Wenn Sie einen relativen Tag im Monat angeben möchten, um die Datei zu importieren |
Nächster Anschluss | Wählen Sie den nächsten Anschluss | Wenn Sie mehrere Importe nacheinander durchführen möchten, können Sie die Importe verketten. Hier können Sie den nächsten Verbinder auswählen. Beachten Sie, dass bei einem Ausfall des ersten Verbinders der nächste nicht gestartet wird |
|
|
|
Definition der Vorlage | Definition von Vorlagen für den Umgang mit Daten | Dies gilt nur, wenn die importierte Datei einer bestimmten Vorlage entspricht, die von CSV oder einstufigem XML abweicht. Bitte kontaktieren Sie Spacewell, wenn mehr erforderlich ist |
Zeitversatz | Standard: 120, vorgeschlagen: 0 | Mit diesem Wert wird geprüft, ob sich die vorhergehende Datei, die importiert wurde, von der neuesten Datei unterscheidet. Die Angabe erfolgt in Sekunden. Bei 0 wird die Prüfung übersprungen.
Achtung: Dieser Wert ist auch für die Dateisperre wichtig. Weitere Informationen finden Sie im Hilfetext zu diesem Feld |
Protokoll | Standard: ja | Sorgt dafür, dass Fehler protokolliert werden |
Richtig | Standard: nein | Dadurch können beim Import einige Werte überschrieben werden. In den meisten Fällen ist dies nicht erforderlich. Ändern Sie dies nur in Absprache mit dem Spacewell-Kontakt |
Dokumente speichern | Standard: ja | Mit dieser Einstellung werden importierte Dateien im Workplace Management gespeichert. Dies ist für die Fehlersuche wünschenswert. Wenn die importierten Dateien sensible Daten enthalten, setzen Sie diesen Wert auf "nein". Die Dokumente werden für eine bestimmte Anzahl von Monaten aufbewahrt, die in den Client-Einstellungen festgelegt werden kann |
Warnungen speichern | Voreinstellung: ja | Speichert Warnungen als Dateien. Wird für die Fehlersuche verwendet. Setzen Sie auf "no", wenn Debugging nicht notwendig ist. |
Zugriffsrechtsprüfung | Standard: leer | In einigen Fällen kann die Leistung ein Problem darstellen. Dieser Wert kann auf "vereinfacht" gesetzt werden, um eine intensive Überprüfung der Zugriffsrechte zu verhindern. |
SSH-Schlüsselpaar-Authentifizierung (für WPM)
Workplace Management unterstützt die Authentifizierung mittels SSH-Schlüsselpaar-Authentifizierung.
RSA-Schlüssel werden verwendet
OPENSSH-Schlüssel werden derzeit (Stand: Mai 2023) nicht akzeptiert und können nicht automatisch konvertiert werden. Wenn Sie einen OPENSSH-Schlüssel haben, konvertieren Sie diesen bitte zuerst in RSA.
Wenn dies der erste Import- oder Export-Connector ist, für den Sie die SSH-Schlüsselpaar-Authentifizierung aktivieren, führen Sie zunächst diese Schritte aus:
Öffnen Sie Ihren eigenen Benutzer, indem Sie auf Ihren Namen oben rechts auf dem Bildschirm klicken > Profil
Klicken Sie auf die Schaltfläche 'Gruppe zuweisen'.
Suchen Sie nach der Gruppe 'Lizenzeditor' und fügen Sie diese zu Ihrem Benutzer hinzu. Diese Gruppe wird benötigt, um die Authentifizierung zu konfigurieren
Hinweis: Wenn Sie diese Gruppe nicht hinzufügen können, wenden Sie sich bitte an Ihren Spacewell-Kontakt.
So konfigurieren Sie die SSH-Schlüsselpaar-Authentifizierung für einen Import/Export-Anschluss:
Öffnen Sie den Export- oder Importanschluss
Blättern Sie nach unten zum Include "Vertrauensbeziehungen". Wenn das Include fehlt, müssen Sie das Include "FtpConnectorObjectTrustRelationList" hinzufügen)
Klicken Sie auf 'Neuen RSA-Schlüssel zuweisen'.
Klicken Sie auf "Neu", um eine neue Vertrauensbeziehung zu erstellen
Füllen Sie die Felder aus:
Name = einen Namen geben
Beschreibung = eine Beschreibung geben
Typ = RSA-Schlüsselpaar
Vererbung = Verschmelzung
Klicken Sie auf 'Schlüssel generieren'.
Kopieren Sie die RSA privater Schlüssel und das Passwort (ganz unten) aus dem Feld "Öffentliches Zertifikat".
Hinweis: Führen Sie diesen Vorgang unauffällig durch. Wenn Sie die Seite mit den Vertrauensbeziehungen aktualisieren (oder sie verlassen und zurückkommen) und zu dieser Seite zurückkehren, wird die öffentlicher Schlüssel wird stattdessen angezeigt.
Wenn Sie vergessen haben, den privaten Schlüssel zu kopieren, können Sie auf "Geheimen Schlüssel aufdecken" klicken > geben Sie das Passwort des Benutzers ein, mit dem Sie angemeldet sind (nicht das Client-Passwort!)
Klicken Sie nun auf "Ok", um zum vorherigen Bildschirm zurückzukehren.
Wählen Sie die soeben erstellte Vertrauensbeziehung aus > klicken Sie oben rechts auf der Seite auf Bestätigen
Nach dem Bestätigen wird die Registerkarte "Details" des Verbinders geöffnet. Wenn Sie nun nach unten zum Eintrag "Vertrauensbeziehung" blättern, sehen Sie, dass die Vertrauensbeziehung verknüpft ist.
Vergessen Sie nicht, den Import/Export-Connector wie üblich zu konfigurieren. Fügen Sie also Folgendes hinzu: Server, Portnummer, Verzeichnis usw.
Nachdem Sie die Verbindung auf der Client-Seite eingerichtet haben, können Sie mit den Tests beginnen.
Checkliste zur Fehlersuche
Zusammenfassung
Übung
Suche