Der erste Schritt zur Implementierung von Handshake ist die Einrichtung eines automatisierten Datenaustauschs zwischen dem Studentenformationssystem und Handshake.
Bereitstellung von Konten für Studierende
Dies ist der Wichtigste Schritt des Umsetzungsprozesses. Er ist erforderlich, um den Studierenden den Start zu ermöglichen und stellt aus IT-Sicht den ressourcenintensivsten Teil des Prozesses dar.
Was er beinhaltet:
- Sie werden manuell eine Liste von Datensätzen von Ihrem Studierendeninformationssystem hochladen. Verwenden Sie diese Anweisungen, um Ihre Studierendendatei zu erstellen
- Sie werden auf ein Tool namens Importer zugreifen, um die anfängliche Studierenden-CSV-Datei hochzuladen. Der Importer wird Ihnen Rückmeldung zu der Datei geben. Sie sollten sich mit allen Warnungen oder Fehlern auseinandersetzen, die Ihnen vom Importer mitgeteilt werden, bevor Sie fortfahren.
- Sobald Ihre Datei im richtigen Format ist, können Sie den Upload dieses Profils automatisieren. Im Allgemeinen sollte eingestellt sein, dass diese Datei wöchentlich aktualisiert wird, aber die Frequenz kann von der Hochschule festgelegt werden.
Erstellen der notwendigen Dateien
Handshake benötigt eine CSV-Datei, um Studierendenkonten zu erstellen und zu aktualisieren. Diese Datei sollte aus dem Studierende-Informationssystem gezogen werden und *alle Studierende enthalten, die Zugriff auf die Handshake-Plattform haben sollen.
Wir empfehlen, ein Skript zu schreiben, das die Daten aus dem Studierendeninformationssystem abruft und eine Datei im hier angegebenen Format erstellt.
Ein paar Dinge sind zu beachten:
-
Handshake kümmert sich um die Suche nach Änderungen, so dass Sie diese Logik nicht in das Skript einbauen müssen. Wir aktualisieren nur Konten, bei denen sich seit dem letzten Durchlauf etwas geändert hat.
-
Im nächsten Schritt werden wir diesen Prozess automatisieren, so dass das Skript wiederverwendbar ist, um Zeit zu sparen.
Sobald Sie eine Datei haben, die Sie testen können, benötigen Sie Zugriff auf das Importer-Tool. Ihr Handshake-Ansprechpartner wird Ihnen helfen, sich mit diesem Tool zu verbinden. Sobald Sie verbunden sind, können Sie die Datei hochladen, woraufhin Sie Rückmeldung über eventuelle Fehler erhalten.
Sobald die Datei fehlerfrei ist, können Sie sie zur endgültigen Überprüfung durch das Handshake-Team einreichen. Wenn alles in Ordnung ist, werden wir diese Datei ausführen und die Konten in der Produktion erstellen.
Automatisieren Sie die Datensynchronisierung
Sobald der Importer Ihre Datei genehmigt hat, sollten Sie den Prozess des Hochladens der Datei in den entsprechenden AWS-Bucket Ihrer Hochschule automatisieren. Bevor wir fortfahren, noch ein paar Hinweise:
- Sie haben nur Schreibrechte für den Ordner Ihrer Hochschule.
- Diese S3-Verzeichnisse sind lesegeschützt, so dass jeder Versuch, Inhalte zu GET/LISTen, zu "Access Denied"-Fehlern führen würde.
- Wir unterstützen alle Standardmethoden zum Hochladen auf AWS S3, die nur PUT-Zugriff erfordern.
- FTP/SFTP wird aufgrund des erforderlichen LIST-Zugriffs nicht unterstützt.
- Die Region muss auf Eu-central-1 eingestellt werden, damit der Upload funktioniert.
- Hinweis: Bei bestehenden Konten, die vor dem 01.07.2023 für die automatische Ausführung konfiguriert wurden, kann die Region immer noch auf: eu-west-2 eingestellt werden.
Automatisieren Sie Ihre Synchronisierung: Schritt A
Wir werden die Command Line Interface (CLI)-Tools von Amazon verwenden. Dies ist das beste Tool für die Interaktion mit AWS S3, um Ihren Upload zu automatisieren. Wenn Sie Python noch nicht installiert haben, müssen Sie Folgendes ausführen (weitere Details zur Installation von Python finden Sie hier).
pip install --upgrade --user awscli
Wenn Sie Python nicht installiert haben, können Sie das mitgelieferte Installationsprogramm hier verwenden.
curl "https://s3.amazonaws.com/aws-cli/awscli-bundle.zip" -o "awscli-bundle.zip"
unzip awscli-bundle.zip
# mit sudo
sudo ./awscli-bundle/install -i /usr/local/aws -b /usr/local/bin/aws
# ohne sudo (angenommen, dass ~/bin in Ihrem PATH ist)
./awscli-bundle/install -b ~/bin/aws
Bitte kontaktieren Sie das Support-Team von Handshake, um die Anmeldeinformationen für das Hochladen von Daten auf Handshake zu erhalten. Sofern Sie keine anderen Anweisungen vom Handshake-Team erhalten, sollten Sie „eu-central-1“ als Ihre Region verwenden.
Führen Sie als nächstes Folgendes aus und geben Sie Ihren AWS-Zugangsschlüssel und Ihren geheimen Schlüssel ein:
Konfigurieren Sie Ihre AWS-Anmeldeinformationen
aws configure
AWS Access Key ID [****************JRTA]:
AWS Secret Access Key [****************RZ7O]:
Default region name [eu-central-1]:
Default output format [None]:
Sobald Sie diese Anmeldeinformationen eingerichtet haben, können Sie Ihre erste Datei mit der folgenden Syntax hochladen:
Laden Sie Ihre erste Datei hoch
aws s3 cp [/path/your_local_file] s3://handshake-importer-uploads/[your folder]/
[yyyymmdd]_users.csv
Beispiel-Upload und Antwort
aws s3 cp /your/local/dir/test.csv s3://handshake-uk-importer-production-uploads/
importer-production-amaranta-ac-uk/test.csv
upload: to s3://handshake-uk-importer-production-uploads/
importer-production-amaranta-ac-uk/test.csv
Die AWS S3 API antwortet mit der Dokument-ID, wenn die Datei erfolgreich übertragen wurde, andernfalls mit einer Fehlermeldung. Sie können auch den Befehls-Exit-Code überprüfen, um festzustellen, ob die Übertragung erfolgreich war.
Wenn Sie einen Testlauf durchführen möchten, senden Sie einfach eine Datei, und unser Datenteam wird überprüfen, ob sie empfangen wurde und für die Produktion bereit ist.
Automatisieren Sie Ihre Synchronisierung: Schritt C (Bestätigen der Datei)
Melden Sie sich bei der Importer-Anwendung an, um zu sehen, ob Ihre Datei vom Importer akzeptiert wurde. Der Importer wird die Datei auf häufige Probleme überprüfen und die Formatierung kontrollieren. Wenn die Datei nicht angezeigt wird, suchen Sie nach diesen häufigen Fehlern:
* Die Datei ist keine echte CSV-Datei: Überprüfen Sie, ob die Datei, die Sie hochladen möchten, manuell auf den Importer hochgeladen und erfolgreich verarbeitet werden kann.
* Das Skript, das Sie ausführen, lädt die Datei nicht erfolgreich auf in Ihren S3-Bucket hoch: Überprüfen Sie den Pfad Ihres Skripts und stellen Sie sicher, dass es erfolgreich ausgeführt wird und Ihnen den Pfad des hochgeladenen Objekts angibt.
Automatisieren Sie Ihre Synchronisierung: Schritt D (Planung des Uploads)
Nachdem Sie überprüft haben, dass alles in Ordnung ist, empfehlen wir Ihnen, den Upload mit cron zu planen. Wählen Sie ein wöchentliches, monatliches oder halbjährliches Datum für den Upload, im Allgemeinen ist das Format:
SchedulingFormat Beispiel
5 8 * * Sat aws s3 cp users.csv s3://handshake-importer-uploads/
importer-production-hudson_university/`date +"%Y-%m-%d"`_users.csv >/dev/null 2>&1
Alle Artikel dieser Serie: