La première étape pour mettre en œuvre Handshake est de mettre en place un flux de données automatisé entre le système d’information étudiant(e) et Handshake.
Créer des comptes étudiants(es)
C’est l’étape la plus importante du processus de mise en œuvre. Cette étape est nécessaire pour configurer les étudiants(es) et c’est la partie du processus qui demande le plus de ressources d’un point de vue informatique.
Ce que cela implique:
- Vous importez manuellement une liste d’enregistrements à partir de votre système d’informations étudiant. Utilisez ces instructions pour créer votre fichier étudiant(e)
- Vous accédez à un outil appelé Importer pour télécharger le fichier CSV étudiant(e) initial. L'outil importer vous donnera des feedbacks dans le dossier. Vous devriez résoudre tous les avertissements ou erreurs qui vous sont fournis par l'outil Importer avant de continuer.
- Une fois que votre fichier est dans le bon format, vous pouvez automatiser le téléchargement de ce profil. En général, ce fichier devrait être configuré pour être traité chaque semaine, mais la cadence peut être définie par l’université.
Création du fichier de données
Handshake exige un fichier CSV pour créer et mettre à jour des comptes étudiants(es). Ce fichier devrait provenir du système d’informations étudiant(e) et inclure *toutes les étudiants(es) qui devraient avoir accès à la plateforme Handshake.
Pour compléter cela, nous vous suggérons généralement d’écrire un script qui sort du système d’informations étudiant(e) et crée un fichier dans le format spécifié ici.
Quelques choses à noter:
-
Handshake gère la vérification des changements, donc il n’est pas nécessaire de créer cette logique dans le script. Nous ne mettrons à jour que les comptes où quelque chose a changé depuis le dernier traitement
-
Dans la prochaine étape, nous automatiserons ce processus, donc écrire ce script pour qu'il soit réutilisable permettra de gagner du temps.
Une fois que vous avez un fichier que vous êtes prêt(e) à tester, vous aurez besoin d’accéder à l’outil Importer. Votre point de contact Handshake vous aidera à vous connecter à cet outil. Une fois que vous êtes connecté(e), vous serez en mesure de télécharger le fichier et d’obtenir un feedback sur toute erreur.
Une fois que le fichier est sans erreur, vous pouvez le soumettre pour examen final par l’équipe Handshake. En supposant que tout va bien, nous exécuterons ce fichier et créerons les comptes en production.
Automatiser la synchronisation des données
Une fois que l'Importer aura approuvé votre fichier, vous devriez automatiser le processus de téléchargement du fichier sur le panier AWS dédié de votre université. Quelques notes avant de continuer:
- Vous n’aurez que des autorisations d’écriture dans le dossier de votre université
- Ces répertoires S3 sont uniquement en écriture, donc toute tentative de GET/LIST de contenu entraînera des erreurs « Accès refusé ».
- Nous prenons en charge toutes les méthodes standard de téléchargement sur AWS S3 qui ne nécessitent que l’accès PUT demandé
- Nous ne prenons pas en charge FTP/SFTP en raison de l’accès LIST requise.
- La région doit être définie sur eu-central-1 pour que le téléchargement fonctionne.
- Note: pour les comptes existants qui ont configuré l’exécution automatique avant le 01/07/2023, la région peut toujours être définie à: eu-west-2.
Automatiser votre synchronisation: Étape A
Nous utiliserons les outils d’interface de ligne de commande d'Amazon (CLI). C’est le meilleur outil pour interagir avec AWS S3 pour automatiser votre téléchargement. Si vous n’avez pas déjà installé python, vous aurez besoin d’exécuter ce qui suit (plus d'informations sur l’installation de python ici)
pip install --Mise à niveau --user awscli
Si vous n’avez pas de python, vous pouvez l’installer en utilisant l’installation groupée ici
curl "https://s3.amazonaws.com/aws-cli/awscli-bundle.zip -o "awscli-bundle.zip"
unzip awscli-bundle.zip
# avec sudo
sudo./awscli-bundle/install -i/usr/local/AWS -b/usr/local/bin/AWS
# Sans sudo (suppose que ~/lbin est dans votre chemin d'accès)
./awscli-bundle/install -b ~/bin/AWS
Veuillez contacter l’équipe d’assistance de Handshake ici pour recevoir les informations d’identification AWS pour télécharger des données sur Handshake. À moins que l’équipe Handshake ne vous en informe autrement, vous devriez utiliser « eu-central-1 » comme région.
Ensuite, exécutez ce qui suit et entrez votre clé d’accès AWS et votre clé secrète :
Configuration de vos identifiants AWS
aws configure
Identifiant de clé d’ accès AWS [****************JRTA] :
Clé d’ accès secrète AWS [****************RZ7O] :
Nom de la région par défaut [eu -central -1] :
Format de sortie par défaut [None] :
Une fois que vous avez configuré ces informations, vous pouvez télécharger votre premier fichier en utilisant la syntaxe suivante:
Télécharger votre premier fichier
aws s3 cp [/path/your_local_file] s3://handshake-importer-uploads/[your folder]/
[yyyymmdd]_users.csv
Exemple de téléchargement et de réponse
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
L’API AWS S3 répondra avec l’identifiant du document si le fichier a été transféré avec succès, sinon il répondra avec une erreur. Vous pouvez également vérifier le code de sortie de commande pour déterminer qu’elle a réussi.
Si vous souhaitez effectuer un essai, envoyez simplement un fichier et notre équipe de données vérifiera qu’il est reçu et prêt pour la production.
Automatiser votre synchronisation: Étape C (Validez le fichier)
Connectez-vous à l'application Importer pour voir que votre fichier a été accepté par l'importer. L'importer vérifiera le fichier pour trouver les problèmes fréquents et vérifiera le formatage. Si le fichier ne s’affiche pas, vérifiez ces erreurs fréquentes :
* Le fichier n’est pas un vrai CSV: Vérifiez que le fichier que vous essayez de télécharger peut être téléchargé manuellement sur l'importer et traité avec succès
* Le script que vous exécutez ne télécharge pas avec succès le fichier sur votre panier s3: Vérifiez le chemin de votre script et assurez-vous qu’il revient avec succès et vous donne le chemin de l’objet téléchargé
Automatiser votre synchronisation: Étape D (planifier le téléchargement)
Après avoir validé que tout semble bon, nous vous recommandons d’utiliser cron pour planifier le téléchargement. Choisissez une date hebdomadaire, mensuelle ou semestrielle pour effectuer votre téléchargement, en général, le format est:
Exemple de format de calendrier
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
Tous les articles de cette série: