(fr) Fichier de configuration

Aperçu

Vous découvrirez dans cet article comment importer le fichier de configuration.
Voici l'explication de la structure du fichier de configuration utilisé pour définir le comportement du moteur d'import.

Ce fichier peut être considéré comme un recueil. Ne lisez pas le fichier du début à la fin, mais utilisez-le plutôt pour trouver les informations nécessaires.

Prérequis

  • Connaissance de base ou avancée de la syntaxe JSON ;
  • Un contact dans Splio pour recevoir et valider votre fichier de configuration ;
  • Un éditeur de texte ou de code

Utilisez votre éditeur de texte ou de code préféré pour créer et modifier des fichiers de configuration.
On recommande un éditeur compatible JSON pour aider à détecter les erreurs les plus élémentaires, telles que les virgules, les guillemets ou les crochets manquants. Si vous ne connaissez pas de plateforme de ce type, vous pouvez utiliser JSON Editor Online, qui est une plateforme gratuite.

Définition du fichier de configuration

Le fichier de configuration est un fichier texte conforme au format JSON (JavaScript Object Notation).

  • Nom du fichier _imports_config.json
  • Encodage UTF-8
  • Format JSON

Les noms sont placés entre crochets ("<>") dans l’exemple suivant doivent être remplacés par des valeurs réelles. Les pièces optionnelles sont placées entre crochets (“ []"). Les points de suspension ("...") Remplacent les répétitions.

{
   "<universe>":{
     "<scope1>":{
       "<sub-sequence1>":{
         "<configoption11>":"<value11>"[,
         "<configoption12>":"<value12>"[, . . . ] ]
       }[,
       "<sub-sequence2>":{
         "<configoption21>":"<value21>"[,
         "<configoption22>":"<value22>"[, . . . ] ]
       }[, . . . ] ]
     }[,
     "<scope2>":{
       "<sub-sequence3>":{
         "<configoption31>":"<value31>"[, 
         "<configoption32>":"<value32>"[, . . . ] ]
       }[,
       "<sub-sequence4>":{
         "<configoption41>":"<value41>"[,
         "<configoption42>":"<value42>"[, . . . ] ]
       }[, . . . ] ]
     }[, . . . ] ]
   }
 }

Univers

Le fichier doit contenir exactement un objet "". Le nom de cet objet est le nom de votre univers Splio et doit faire partie du nom de fichier.

Scope

L'univers doit contenir au moins un objet "". Les scopes représentent les types de données qui peuvent être importés dans la base de données Splio.

Les scopes suivants sont disponibles :

  • Contacts
  • Products
  • Stores
  • Orders
  • Abandoned carts
  • Orders items
  • Master Reward, Reward, Burn Reward (les rewards font partie de programmes Loyalty)
  • Credit points
  • Events
  • Delete contacts
  • Card code (abonnement Loyalty)
  • Tier change (changement de statut)

Seuls les contacts peuvent être supprimés via le Datahub.

Sous-séquence

Chaque scope doit contenir un ou plusieurs objets "". Les sous-séquences sont utilisées pour définir les fichiers d'import, qui appartiennent toujours à une sous-séquence spécifique dans un scope. Les sous-séquences représentent diverses sources de données (par exemple, des bases externes) ou des imports dans le même scope, qui sont effectuées pour différentes raisons.

Toutes les options de configuration sont définies dans des sous-séquences.

Scopes et option de configuration

Voici toutes les options de configuration disponibles dans chaque scope.

Contacts

Les options de configuration suivantes sont disponibles pour les contacts :

Option de configurationObligatoireType de valeurNotice d'utilisation
report recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir le rapport une fois l'import terminé.
alert recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir des alertes lors de l'import.
overwrite with empty valuesNon0 (non, par défaut) / 1 (oui)S'il est défini sur "1" (oui), les valeurs existantes seront remplacées par NULL lorsqu'un enregistrement est mis à jour à partir du fichier et que le champ du fichier est vide.
default cellphone prefixOuiNumériqueUn préfixe (code de pays) à ajouter à tous les numéros de téléphones portables locaux trouvés dans le fichier. Il ne sera pas ajouté aux numéros déjà présents avec un code de pays.
init listsOuiListe de valeurs numériquesUne liste qui doit inclure les identifiants numériques de toutes les listes Splio qui doivent être initialisées (c'est-à-dire vidées) avant l'import.
create contactsNon0 (non) / 1 (oui, par défaut)Permet de créer de nouveaux contacts lors de l'import. Activé par défaut. En le désactivant, vous pouvez empêcher un fichier d'import donné de créer de nouveaux contacts.
update contactsNon0 (non) / 1 (oui, par défaut)Permet de mettre à jour les contacts existants sur la base du fichier d'import. Activé par défaut. En le désactivant, vous pouvez vous assurer qu'aucun enregistrement de contacts ne sera mis à jour lors de l'import de ce fichier. Vous pouvez l'utiliser pour abonner automatiquement des contacts à des listes.

HAstuce : si vous ne souhaitez pas effacer (initialiser) des listes, fournissez une liste vide comme valeur : "init lists" : [ ].

Produits

Les produits représentent diverses marchandises qui peuvent être achetées par les contacts. Les options de configuration suivantes sont disponibles pour les produits :

Option de configurationObligatoireType de valeurNotice d'utilisation
report recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir le rapport une fois l'import terminé.
alert recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir des alertes lors de l'import.
overwrite with empty valuesNon0 (non, par défaut) / 1 (oui)S'il est défini sur "1" (oui), les valeurs existantes seront remplacées par NULL lorsqu'un enregistrement est mis à jour à partir du fichier et que le champ du fichier est vide.
create productsNon0 (non) / 1 (oui, par défaut)Permet de créer de nouveaux produits lors de l'import. Activé par défaut. En le désactivant, vous pouvez empêcher un fichier d'import donné de créer de nouveaux produits.
update productsNon0 (non) / 1 (oui, par défaut)Permet de mettre à jour les produits existants sur la base du fichier d'import. Activé par défaut. En le désactivant, vous pouvez empêcher la mise à jour des enregistrements de produits lors de l'import.

Magasins

Les magasins peuvent être des magasins physiques ou en ligne.

Les options de configuration suivantes sont disponibles pour les magasins :

Option de configurationObligatoireType de valeurNotice d'utilisation
report recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir le rapport une fois l'import terminé.
alert recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir des alertes lors de l'import.
overwrite with empty valuesNon0 (non, par défaut) / 1 (oui)Si le paramètre est à "1" (oui), les valeurs existantes seront remplacées par NULL lorsqu'un enregistrement est mis à jour à partir du fichier et que le champ du fichier est vide.
create storesNon0 (non) / 1 (oui, par défaut)Permet de créer de nouveaux magasins lors de l'import. Activé par défaut. En le désactivant, vous pouvez empêcher un fichier d'import donné de créer de nouveaux magasins.
update storesNo0 (non) / 1 (oui, par défaut)Permet de mettre à jour les magasins existants sur la base du fichier d'import. Activé par défaut. En le désactivant, vous pouvez empêcher la mise à jour des enregistrements des magasins lors de l'import.

Tickets (Orders)

Les tickets représentent les achats effectués par les contacts.

Les options de configuration suivantes sont disponibles pour les tickets :

Option de configurationObligatoireType de valeurNotice d'utilisation
report recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir le rapport une fois l'import terminée.
alert recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir des alertes lors de l'import.
overwrite with empty valuesNon0 (non, par défaut) / 1 (oui)S'il est défini sur "1" (oui), les valeurs existantes seront remplacées par NULL lorsqu'un enregistrement est mis à jour à partir du fichier et que le champ du fichier est vide.
create ordersNon0 (non) / 1 (oui, par défaut)Permet de créer de nouveaux enregistrements de tickets lors de l'import. Activé par défaut. En le désactivant, vous pouvez empêcher un fichier d'import donné de créer de nouvelles commandes.
update ordersNon0 (non) / 1 (oui, par défaut)Permet de mettre à jour les tickets existants sur la base du fichier d'import. Activé par défaut. En le désactivant, vous pouvez empêcher la mise à jour des enregistrements de commandes lors de l'import.
generate loyalty eventsNon0 (non, par défaut) / 1 (oui)Permet aux orders d'être traités comme des évènements par le moteur Loyalty, pour déclencher des règles comme conditions. Sans ce paramètre, aucun résultat ne sera obtenu par les règles qui ont les achats dans leurs conditions. Compatible avec le même paramètre dans les orders items.
only ordersNon0 (non, par défaut) / 1 (oui)Permet au moteur Loyalty de traiter les orders sans les orders items pour les règles Loyalty. Cette option doit être activée sur les orders ou les orders items pour que les règles Loyalty avec achat puissent attribuer des résultats (jamais sur les deux).

Paniers abandonnés

Les paniers abandonnés représentent les achats qui n'ont pas été terminés sur le site ecommerce.

Les options de configuration suivantes sont disponibles pour les paniers abandonnés :

Option de configurationObligatoireType de valeurNotice d'utilisation
report recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir le rapport une fois l'import terminée
alert recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir des alertes lors de l'import.
overwrite with empty valuesNon0 (non, par défaut) / 1 (oui)S'il est défini sur "1" (oui), les valeurs existantes seront remplacées par NULL lorsqu'un enregistrement est mis à jour à partir du fichier et que le champ du fichier est vide.
create abandonedcartsNon0 (non) / 1 (oui, par défaut)Permet de créer de nouveaux paniers abandonnés lors de l'importation (Activé par défaut). En le désactivant, vous pouvez empêcher un fichier d'importation donné de créer de nouveaux abandons.
update abandonedcartsNon0 (non) / 1 (oui, par défaut)Permet de mettre à jour les paniers abandonnés existants sur la base du fichier d'importation (Activé par défaut). En le désactivant, vous pouvez empêcher la mise à jour des enregistrements de paniers abandonnés lors de l'importation.

Ordersitems

Les Ordersitems représentent des produits individuels dans un ticket (order) ou dans un panier abandonné (abandoned cart).

Notez bien que les items dans cette table ne peuvent pas être mis à jour via import mais seront supprimés quand un order correspondant sera importé ou mis à jour.

Option de configurationObligatoireType de valeurNotice d'utilisation
report recipientsOuiliste d'adresses emailLes adresses email de tous les destinataires pour recevoir le rapport une fois qu'il est terminé.
alert recipientsOuiliste d'adresses emailLes adresses email de tous les destinataires pour recevoir le rapport une fois qu'il est terminé.
overwrite with empty valuesNon0 (non, par défault) / 1 (oui)S'il est défini sur "1" (oui), les valeurs existantes seront remplacées par NULL lorsqu'un enregistrement est mis à jour à partir du fichier et que le champ du fichier est vide.
generate loyalty eventsNon0 (non, par défault) / 1 (oui)Permet aux orders items d'être traités comme des évènements par le moteur Loyalty, pour déclencher des règles comme conditions. Sans ce paramètre, aucun résultat ne sera obtenu par les règles qui ont les achats avec produits dans leurs conditions. Compatible avec le même paramètre dans les orders.
only ordersNon0 (non, par défault) / 1 (oui)Permet au moteur Loyalty de traiter les order items sans les orders pour les règles Loyalty. Cette option doit être activée sur les orders ou les orders items pour que les règles Loyalty avec achat puissent attribuer des résultats (jamais sur les deux).

Loyalty subscriptions (cardcode)

Ce scope utilise le même ensemble d'options de configuration que les orders ci-dessus.

Tier change

Option de configurationObligatoireType de valeurNotice d'utilisation
force_pointsNon1 si vous souhaitez l'activerCe paramètre attribuera la quantité manquante de points qualifiants pour atteindre le statut que vous avez précisé dans le corps. Si vous ne l'utilisez pas, le membre sera inclus dans le statut sans la quantité de points qualifiants nécessaire et sera déclassé lors du prochain calcul de déclassement de statut.

Credit points (creditpoints), Events (events), Delete contacts (supprimer les contacts)

Ce groupe de scopes d'import partage le même ensemble de deux options de configuration.

Option de configurationObligatoireType de valeurNotice d'utilisation
report recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir le rapport une fois l'import terminée.
alert recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir des alertes lors de l'import.

Loyalty Rewards (masterreward, earnreward, burnreward)

L'import des scopes liés aux récompenses est décrite dans l'article sur les récompenses Loyalty.

Option de configurationObligatoireType de valeurNotice d'utilisation
report recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir le rapport une fois l'import terminé.
alert recipientsOuiListe d'adresses emailAdresses e-mail de tous les destinataires pour recevoir des alertes lors de l'import.
overwrite with empty valuesNon0 (non, par défaut) / 1 (oui)Pour les "masterrewards" uniquement
Si la valeur est fixée à "1" (oui), les valeurs existantes seront remplacées par NULL lorsqu'un enregistrement est mis à jour à partir du fichier et que le champ dans le fichier est vide.
⚠️ Cette option ne doit pas être utilisée pour les champs "earnreward" et "burnreward".