SFTP – Einrichtungsanleitung

INHALTSVERZEICHNIS

• SFTP – Einrichtungsanleitung
  • Hosting und Authentifizierung
  • Konfiguration
  • Häufigkeit und Zeitplanung
  • Berichte und Fehlerbehandlung
    • Verwandte FAQs
  • So erstellen Sie einen öffentlichen SSH-Schlüssel für den SFTP-Server
    • Format
    • Muster
    • SSH-Schlüssel erstellen 
    • Beispielschlüssel
  • Anleitungen für bestimmte Datensatzarten

Hosting und Authentifizierung

Ihr SFTP-Ordner wird auf einem eigenen SFTP-Server (über AWS) bereitgestellt. Jeder Kunde erhält ein eigenes Benutzerkonto mit direktem Zugriff auf seinen individuellen SFTP-Ordner. Unterstützt wird die schlüsselbasierte Authentifizierung. Daher müssen Sie ein Schlüsselpaar (öffentlich/privat) erstellen und den öffentlichen Schlüssel im Public Key Feld beim Einrichten Ihres Ordners hinterlegen. Der Schlüssel muss im openSSH RSA Format vorliegen. Wie Sie die Schlüssel erzeugen, erfahren Sie unter So erstellen Sie einen öffentlichen SSH-Schlüssel für den SFTP-Server weiter unten.

Konfiguration

1. Tragen Sie den von Ihnen erstellten öffentlichen Schlüssel in das Feld Public Key ein. Optional können Sie den Benutzernamen anpassen. Der Wert im Feld Benutzername muss mit einem Buchstaben, einer Zahl oder einem Unterstrich beginnen und zwischen 3 und 100 Zeichen lang sein. Zulässig sind Buchstaben, Zahlen, Unterstriche, @-Zeichen, Punkte und Bindestriche.

2. Kopieren Sie die Werte für Benutzername, Spotnana-Domain-URLund Portnummer in einen sicheren Speicherort. Diese Angaben benötigt das Team in Ihrem Unternehmen, das den Versand von Dateien an den neu eingerichteten Ordner konfiguriert. 
   Hinweis: Sobald der SFTP-Ordner eingerichtet ist, können Sie diese Werte jederzeit im Bereich Verwaltenwieder einsehen.

3. Geben Sie die E-Mail-Adresse(n) an, an die Sie Berichte zu Ihren Datei-Uploads erhalten möchten, im Feld SFTP-E-Mail-Benachrichtigung . Weitere Informationen finden Sie unter Berichte und Fehlerbehandlung weiter unten.

4. Klicken Sie auf Verbinden.

Sobald ein öffentlicher Schlüssel hinterlegt wurde, wird der Anfangsstatus auf Unbestätigtgesetzt. Dieser Status wird im OBT angezeigt, bis eine Datei im Ordner eingegangen ist. Dies kann eine beliebige Testdatei oder eine echte HR-Feed- oder Custom-Field-Datei sein (es werden nur unterstützte Dateiformate verarbeitet). Wird der öffentliche Schlüssel nachträglich geändert, wird der Status erneut auf Unbestätigt gesetzt, bis wieder eine Datei empfangen wurde.

Um Ihren SFTP-Ordner zu entfernen, klicken Sie auf Trennen. Dadurch wird der SFTP-Ordner gelöscht. Wenn Sie ihn später erneut einrichten möchten, müssen Sie alle oben genannten Informationen erneut eingeben.

Häufigkeit und Zeitplanung

Sie bestimmen selbst, wann und wie oft Sie Dateien hochladen. Die Verarbeitung startet automatisch, sobald Sie eine Datei auf Ihren SFTP-Ordner hochladen. Unser System erkennt den neuen Dateieintrag und beginnt direkt mit der Verarbeitung. 

Empfehlungen zur Häufigkeit und Planung für die einzelnen Datensatzarten (z. B. Benutzer, benutzerdefinierte Felder, juristische Personen) finden Sie im Abschnitt Häufigkeit und Zeitplanung in den SFTP-Anleitungen für die jeweilige Datensatzart.

Berichte und Fehlerbehandlung

Wir erfassen Daten zu Ihren Datei-Uploads und erstellen nach jedem Upload einen internen Bericht. Dieser Bericht wird an die E-Mail-Adresse(n) gesendet, die Sie im Feld SFTP-E-Mail-Benachrichtigung während der Einrichtung angegeben haben. Für jede hochgeladene Datei enthält der Bericht: 

• alle Gründe, warum ein Datei-Upload fehlgeschlagen ist (z. B. falsches Format, fehlende Spaltennamen usw.).

• alle Gründe, warum eine einzelne Zeile in einer Datei nicht übernommen werden konnte. Es werden keine Teil-Updates durchgeführt – tritt ein Fehler in einer bestimmten Spalte auf oder fehlt ein Pflichtfeld, wird die gesamte Zeile abgelehnt. 

• den Status des Uploads (ausstehend, erfolgreich, fehlgeschlagen).

Sie können diesen Bericht nutzen, um Fehler zu analysieren. Sollten Sie das Problem nicht selbst beheben können, wenden Sie sich bitte an den technischen Support. 

Verwandte FAQs

1. Akzeptieren wir eine inkrementelle Datei, die nur die zu aktualisierenden oder neu anzulegenden Datensätze enthält?

   • Ja

2. Müssen optionale Spalten in der hochgeladenen Datei enthalten sein (egal ob SFTP oder manueller Upload), auch wenn Sie diese nicht nutzen?

   • Nein

So erstellen Sie einen öffentlichen SSH-Schlüssel für den SFTP-Server

Folgen Sie der untenstehenden Anleitung, um den öffentlichen SSH-Schlüssel zu erzeugen, den Sie uns bereitstellen.

Format

• Typ: Zeichenkette

• Längenbeschränkung: Maximal 2048 Zeichen.

Muster

 ^ssh-rsa\s+[A-Za-z0-9+/]+[=]{0,3}(\s+.+)?\s*$

SSH-Schlüssel erstellen 

Um SSH-Schlüssel zu erstellen, führen Sie diesen Befehl in der Windows-Eingabeaufforderung oder im Terminal auf macOS, Linux oder UNIX aus:

ssh-keygen -t rsa -b 4096 -f key_name

Wobei 

• -t den Verschlüsselungstyp angibt

• -b die Schlüssellänge (in Bit) festlegt

• -f den Schlüsselnamen definiert

Beispielschlüssel

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDDJB9oBRPrBegMDPEQo+HmNDb/jKUJL6q2kQpNNMDjNps9mhhwJ1dP/lOavMitBPAndeXlwaNEm2XbGaSrZtD/tbQTX1HQjP6pacy+Alf8kYBm5QFfl/Z6lGC8qHys10fpRXgYE7UhdSv6VyRqt1gELGFQwVBZ2kJJuBGJF1IRywwvG/h68B8iWU1+6KEWYQoUcT45r3j3otnx4NhhzpTiNgDbMk0ix+kar4/IstobRLcb7rt7FoUerTLNrVDi69DqbsGY5LN+NM8jVx0sPQLRC/ruil8pTHP3k4rDCc7a80+sH4sUTW+mHc7MTqbi/CcyyFAD8h7p6WqxEydOaJjMnvqAbE17BOj0TSxv3HMohTf3skzE7PbzVcjIfHTpFPGxmJkghAYAMi5l9VvAs91IpVylxjqPss3xQQJIZEmQdG2k7zk/UpsUFlmaOj6lCHRicFKCixKekzzm3nFuJvDEklurtydOQjZ8WkPzTSJfZBdKMuMUi0SQ9m9ZAw99t0=

Anleitungen für bestimmte Datensatzarten

Für detaillierte Hinweise zum Hochladen bestimmter Datensatzarten per SFTP lesen Sie bitte die folgenden themenspezifischen Abschnitte:

• HR-Feeds (Benutzer)
• Rollen
• Benutzerdefinierte Felder
• Büros
• Juristische Personen