Le déclencheur Symplify Batch permet aux organisations d'envoyer automatiquement un déclencheur spécifique en fonction des destinataires transférés dans un fichier texte.
Voici un scénario qui explique les bases du déclencheur Symplify Batch :
Si votre entreprise a besoin d'envoyer régulièrement des e-mails ou des SMS à un groupe spécifique de destinataires, vous pouvez utiliser Symplify Batch transactionnel pour envoyer ces messages.
Les transactions Batch peuvent être utilisées à la fois par transfert de fichiers FTP (à la suite) et par service web (l'API REST).
Lorsqu'un fichier est envoyé à Symplify, un travail enverra automatiquement des messages aux destinataires du fichier.
La solution contient le support de la gestion des versions qui rend vraiment facile la mise à jour de la livraison qui sera envoyée.
Vue d'ensemble de la configuration
La configuration d'un déclencheur Symplify Batch se compose de cinq parties.
- Symplify fournit un compte FTP ou sFTP1 et des informations de connexion.
- Un administrateur de compte Symplify fournit des informations de connexion d'utilisateur à Symplify.
- Créez un déclencheur dans Symplify pour un email ou un SMS. Cela se fait sur Transactionnel > Créer un nouveau. Les informations sur les différentes étapes se trouvent ici.
- Créez un fichier selon les spécifications de format de fichier décrites dans ce document.
- Configurer un job planifié qui connecte un nom de fichier spécifique avec un déclencheur spécifique et qui gère également la planification sur la fréquence à laquelle le système recherchera un nouveau fichier.
Veuillez lire cet article sur la sélection des champs à inclure dans le fichier.
Format de fichier
Les données téléchargées dans Symplify pour l'importation doivent être conformes aux spécifications suivantes :
- Les données doivent être envoyées sous forme de fichier texte brut non formaté.
- Vous ne devez pas entourer les champs de données de guillemets ou de doubles guillemets.
- La première ligne du fichier sera utilisée comme matrice de mappage pour insérer les données du fichier dans la propriété* correcte de Symplify.
- La nouvelle ligne doit être représentée par des caractères compatibles ASCII (c.-à-d. LF, CR ou CR+LF). **
- Les seuls caractères de contrôle ASCII autorisés sont la tabulation horizontale, l'espace, le retour chariot et le saut de ligne.
- Les noms des en-têtes de colonnes ne peuvent contenir que des caractères alphanumériques ASCII (A-Z a-z 0-9), par exemple pas d'espace ou de soulignement.
- Les numéros de mobile doivent commencer par 00 [indicatif de pays] ou + [indicatif de pays], par exemple 0046 ou +46 (où 46 est l'indicatif de pays pour la Suède).
- Les extensions de fichier autorisées sont .txt et .csv (+.zip si compressé).
- Le codage du fichier doit être UTF-8
- Le fichier doit être structuré dans un format de table de sorte que chaque ligne représente une ligne de table avec des champs séparés par un délimiteur de tabulation.
- Le fichier ne doit pas inclure de marque d'ordre d'octet (BOM).
* Pour mapper l'en-tête de colonne correct dans le fichier vers une propriété dans Symplify, veillez à ce que les informations correctes soient entrées dans le mappage déposé dans Symplify. Vous pouvez obtenir un aperçu des propriétés et des en-têtes de fichiers pour vos propriétés existantes dans Symplify sur Paramètres de compte > (Audience) Attributs du destinataire.
** Chaque ligne du fichier génère un message.
Champs de date et heure
Les valeurs de la date et de l'heure sont organisées de la plus significative à la moins significative : année, mois, jour, heure, minute, seconde et fraction de seconde.
Chaque valeur de date et d'heure a un nombre fixe de chiffres qui doivent être complétés par des zéros de tête.
Les représentations peuvent être faites dans l'un des deux formats suivants : un format de base avec un nombre minimal de séparateurs ou un format étendu avec des séparateurs ajoutés pour améliorer la lisibilité humaine. Le séparateur utilisé entre les valeurs de date (année, mois et jour) est le trait d'union, tandis que les deux points sont utilisés comme séparateur entre les valeurs de temps (heures, minutes et secondes).
Le fuseau horaire utilisé dans Symplify est l'heure de l'Europe centrale (CET).
Dates du calendrier
Symplify utilise la notation de données entièrement numérique [aaaa]-[MM]-[jj]. Une année à quatre chiffres [yyyy] est utilisée pour éviter le problème de l'an 2000. [MM] indique un mois de l'année à deux chiffres, de 01 à 12. Le [jj] indique un jour à deux chiffres de ce mois, de 01 à 31.
Par exemple, " le 5 avril 2014 " est représenté par " 2014-04-05 ".
Heure
Symplify utilise le système d'horloge de 24 heures. Le format accepté est [hh] : [mm] : [ss].
Il est acceptable d'omettre les éléments de temps d'ordre inférieur pour une précision réduite.
Exemples de date et d'heure
2013-04-05 13:37
2014-12-11 20:00:00
Exemple de mise en page
Voici un exemple simple de fichier avec trois colonnes (id, nom et adresse email). La première ligne est une ligne d'en-tête et indique comment le fichier est organisé. Le délimiteur choisi pour cette disposition est la tabulation.
OriginalID<tab>firstname<tab>emailaddress
001<tab>paul<tab>paul.simon@example.com
002<tab>aretha<tab>a.franklin@example.com
003<tab>bruce<tab>the_boss@example.com
004<tab>madonna<tab>queen@example.com
Détails du serveur
Vous pouvez utiliser les protocoles sFTP et FTP sur leurs ports standard avec les références obtenues auprès du support Symplify. Le nom d'hôte Internet de notre serveur de fichiers est storage.carmamail.com
Si vous avez des questions concernant les différentes méthodes de transfert de fichiers, veuillez contacter le support Symplify.
Nous recommandons à nos clients d'utiliser sFTP, car il permet de crypter les données lors de leur transfert vers Symplify.
Configuration de l'importation dans Symplify
Pour faire fonctionner le travail de déclenchement, vous devez, dans Symplify, entrer des informations sur le déclenchement, quand Symplify doit chercher un nouveau fichier et où le fichier doit être trouvé. Ce paramètre s'appelle Scheduled job.
Veuillez noter que le courriel de déclenchement doit être créé avant que vous puissiez terminer votre tâche planifiée.
Création de tâches programmées
Les paramètres des tâches de déclenchement se trouvent dans Symplify : Paramètres de compte > (Intégrations) Tâches planifiées.
Vous obtiendrez alors un aperçu de tous vos jobs planifiés actuels. Pour créer un nouveau job, cliquez sur le bouton Créer un nouveau trigger job en haut à droite.
Entrez le nom que vous souhaitez donner au job spécifique. Le déclencheur que vous sélectionnez est celui qui sera envoyé lorsque le job planifié sera exécuté.
Horaire
Dans la liste déroulante, vous pouvez choisir le moment précis où vous souhaitez que le job soit exécuté ou si vous souhaitez que le job soit exécuté dans un intervalle spécifique. Vous pouvez définir une plage horaire (par exemple, entre 12 h et 14 h tous les jours) ou un intervalle (par exemple, toutes les 30 minutes).
Si vous souhaitez que Symplify recherche un fichier à des jours spécifiques, vous sélectionnez les jours où vous souhaitez que la tâche planifiée soit exécutée*. Il est également possible de voir les cinq prochains événements en cliquant sur la flèche par prochaines exécutions.
* Si aucun jour n'est sélectionné, la tâche de planification sera exécutée tous les jours.
VEUILLEZ NOTER qu'un seul fichier sera traité par tâche planifiée.
Paramètres de fichier
Le dernier paramètre que vous devez entrer est l'endroit où Schedule job trouvera le fichier : chemin d'accès, nom d'utilisateur et mot de passe du FTP.
Le nom du fichier doit être un nom de correctif, par exemple welcomemailSE.csv. Entrez le nom et le chemin d'accès dans le champ "Format du nom de fichier". Si vous enregistrez le fichier à la racine de votre compte FTP, vous n'avez pas besoin de saisir d'autre chemin que le nom du fichier. Si vous enregistrez le fichier dans un sous-dossier, entrez le chemin exact du fichier : welcometrigger/welcomemailSE.csv.
Utilisez les identifiants de connexion fournis pour vous connecter au serveur et téléchargez le fichier à la racine de votre dossier d'accueil. Les caractères autorisés pour les noms de fichiers sont "A-Z 0-9 - _".
Dès qu'un travail de planification est lancé, il renommera le fichier en nom de fichier .archive.timestamp (le timestamp est la date de lancement du travail), exemple welcomemailSE.csv.archive.[timestamp].
Vous pouvez maintenant vérifier la progression de votre job.
Aperçu de la configuration pour le transfert de fichiers API
On suppose que les lecteurs ont une certaine familiarité avec l'interface graphique de Symplify et une expérience de l'API REST. Si ce n'est pas le cas, veuillez lire cet article pour un aperçu de l'API.
Workflow
Pour commencer un travail, vous devrez préparer quelques éléments dans Symplify.
Un transactionnel doit être créé. Il est recommandé d'envoyer cette livraison à une liste de test manuellement pour vérifier la délivrabilité avant de lancer tout Jobs.
Une liste de type Normal doit exister.
Vous devez également préparer vos données de destinataire. Veuillez lire la section Importation de listes dans la documentation principale de l'API REST et vous familiariser avec la façon dont les importations sont gérées par Symplify.
Pour démarrer un nouveau Job, une demande POST avec des détails spécifiant la livraison et la liste des Jobs est envoyée.
POST <server>/rest/<customerId>/jobs/generation/fixed
{
"type": "TRIGGER",
"id": 234
}
Les valeurs de type valides sont :
- TRIGGER
L'objet Id the JSON sera interprété comme l'un des types de livraison ci-dessus.
Symplify traitera votre demande et vous répondra en vous confirmant qu'un nouveau Job a été créé. La réponse ressemblera à ceci.
{
"id":7202,
"campaignId":336858,(the ID of the active delivery in the trigger)
"listId":22265, (the ID of the list connected to the trigger)
"contentUploaded":false,
"feedback":[
{
"feedback":"WAITING_FOR_CONTENT",
"severity":"SEVERITY_INFO",
"timestamp":1441374310577
}]
}
Il est maintenant temps de télécharger les données de vos destinataires. Pour construire l'URL de cette requête, vous aurez besoin de la valeur Id de la réponse précédente.
POST <server>/rest/<customerId>/jobs/generation/fixed/<id>/recipients/automapping
La demande doit être envoyée avec le destinataire spécifié comme text/csv, tabulation séparée avec la première ligne contenant les en-têtes de colonne. Il est fortement recommandé qu'avant d'envoyer des données à Symplify, des mappages soient préparés et examinés dans la partie Attributs du destinataire de l'interface web de Symplify.
OriginalID<tab>firstname<tab>emailaddress
001<tab>paul<tab>paul.simon@example.com
002<tab>aretha<tab>a.franklin@example.com
003<tab>bruce<tab>the_boss@example.com
004<tab>madonna<tab>queen@example.com
Une fois cette requête terminée, la génération des messages est automatiquement lancée. L'avancement de la tâche est indiqué dans la partie de la réponse consacrée au feedback. Pour vous aider à suivre l'avancement d'un job, vous pouvez faire appel aux recours suivants Il répondra avec une collection d'entrées de feedback de la même manière que les demandes précédentes.
GET <server>/rest/<customerId>/jobs/generation/fixed/<id>
Exemples HTTP bruts
Requête 1
POST http://<server>/rest/487/jobs/generation/fixed HTTP/1.1
Host: test.carmamail.com
Content-Length: 59
Authorization: Basic XXXX
Accept: application/json
{
"type": "TRIGGER",
"id": 234
}
Réponse 1
HTTP/1.1 200 OK
Content-Type: application/json
Server: Microsoft-IIS/7.5
X-Powered-By: ARR/2.5
X-Powered-By: ASP.NET
Date: Fri, 04 Sep 2015 13:45:10 GMT
Content-Length: 171
{"id":7202,"campaignId":336858,"listId":22265,"contentUploaded":false,"feedback":[{"feedback":"WAITING_FOR_CONTENT","severity":"SEVERITY_INFO","timestamp":1441374310577}]}
Requête 2
POST http://<server>/rest/487/jobs/generation/fixed/7202/recipients HTTP/1.1
Host: test.carmamail.com
Authorization: Basic XXX
Content-Type: text/csv;charset=UTF-8
Content-Length: 103
email originalid firstname
paul@example.com 1 paul
a.franklin@example.com 2 aretha
theboss@example.com 3 bruce
Réponse 2
HTTP/1.1 200 OK
Content-Type: application/json
Server: Microsoft-IIS/7.5
X-Powered-By: ARR/2.5
X-Powered-By: ASP.NET
Date: Fri, 04 Sep 2015 13:57:47 GMT
Content-Length: 1124
{"id":7202,"campaignId":336858,"listId":22265,"contentUploaded":false,"feedback":[{"feedback":"WAITING_FOR_CONTENT","severity":"SEVERITY_INFO","timestamp":1441374310577},{"feedback":"UPLOADING_CONTENT","severity":"SEVERITY_INFO","timestamp":1441375034573},{"feedback":"UPLOADED_CONTENT","severity":"SEVERITY_INFO","timestamp":1441375034620},{"feedback":"STARTED_IMPORT","severity":"SEVERITY_INFO","timestamp":1441375067147}]}
Vérifier l'avancement d'un travail planifié
Pour voir si votre processus de travail planifié est réussi, vous pouvez cliquer sur Feedback.
Dans Feedback, il est possible de suivre les différentes étapes et donc de voir si votre travail s'exécute avec succès ou s'il échoue, et si oui, à quelle étape le travail a échoué.
Statut du destinataire
Les destinataires du fichier seront définis comme actifs dans la liste actuelle lorsque le travail sera terminé.
Les destinataires désabonnés resteront désabonnés et ne recevront donc pas de courriels.
Si un destinataire a un statut "hard bounced", aucun email ne sera envoyé.
Vérification des données
Une fois l'installation terminée, vous êtes responsable de vérifier que vos données sont correctement représentées dans Symplify. Cela peut être facilement fait en exportant toutes les valeurs de propriétés de la liste dans Symplify et en les analysant.