Periscorp — Documentation

Les étapes « Annuaire » des automatisations

Une automatisation peut lire et modifier directement les fiches de l'annuaire : les personnes et les sociétés du Répertoire, avec leurs emails, leurs téléphones, leurs adresses et les liens entre une personne et sa société.

Où les trouver

Dans l'éditeur d'une automatisation, ajoutez une étape : sous « Que se passe-t-il ensuite ? », ouvrez Annuaire. Douze étapes y sont proposées :

ÉtapeCe qu'elle fait
Récupérer une ficheLit une fiche avec ses emails, ses téléphones, ses adresses, ses domaines et ses rattachements.
Créer une ficheCrée une fiche, sauf si elle existe déjà.
Mettre à jour une ficheModifie les champs d'une fiche existante.
Créer ou mettre à jour une ficheMet à jour la fiche si elle existe, sinon la crée.
Ajouter ou modifier un emailAjoute un email à une fiche, ou modifie celui qui y est déjà.
Retirer un emailRetire un email d'une fiche.
Ajouter ou modifier un téléphoneAjoute un numéro de téléphone à une fiche, ou modifie celui qui y est déjà.
Retirer un téléphoneRetire un numéro de téléphone d'une fiche.
Ajouter ou modifier une adresseAjoute une adresse à une fiche, ou modifie celle qui porte le même libellé.
Retirer une adresseRetire une adresse d'une fiche.
Rattacher une personne à une sociétéLie une personne à une société avec son rôle, ou met à jour ce rôle.
Détacher une personne d'une sociétéSupprime le lien entre une personne et une société.

Choisir la fiche

Les étapes de fiche, d'email, de téléphone et d'adresse demandent d'abord le type de fiche : personne ou société. Les champs proposés ensuite suivent ce choix.

Hors création, la fiche est retrouvée par son identifiant, s'il est renseigné (par exemple celui renvoyé par une étape précédente). Sinon, ou s'il ne correspond à aucune fiche, elle est cherchée par ses clés :

  • une société par son identifiant légal (SIREN/SIRET, BCE…), son numéro de TVA ou l'un de ses domaines ;
  • une personne par son email.

Si aucune fiche ne correspond, l'étape suit sa sortie Party not found (Person or organization not found pour les rattachements) quand une étape y est reliée. Sinon, l'exécution s'arrête en erreur, avec le message du champ Exception s'il est renseigné.

Créer une fiche sans doublon

Créer une fiche vérifie d'abord qu'aucune fiche existante ne lui ressemble (même identifiant, même TVA, même email, même domaine ou même nom), comme le fait l'annuaire. Si c'est le cas, rien n'est créé : l'étape suit sa sortie Duplicate found et renvoie la fiche existante complète, que les étapes suivantes peuvent utiliser.

Créer ou mettre à jour une fiche propose deux options, actives par défaut : Create if missing (créer la fiche si elle est absente) et Update if exists (modifier la fiche si elle existe). L'étape suit sa sortie Party created ou Party updated selon le cas, et Party not found si la fiche est absente et la création désactivée.

Les champs d'une fiche

Selon le type de fiche : civilité, prénom, nom et date de naissance pour une personne ; raison sociale, forme juridique, identifiant légal, numéro de TVA et domaines pour une société. Dans les deux cas : pays, statut client (prospect, client ou aucun) et fournisseur.

La civilité se choisit dans une liste : Mr (monsieur) ou Mrs (madame). Toute autre valeur fait échouer l'étape.

Une mise à jour ne modifie que les champs renseignés. Elle ne touche ni aux emails, ni aux téléphones, ni aux adresses : utilisez pour cela les étapes dédiées.

  • Ajouter ou modifier un email : si l'email figure déjà sur la fiche, son libellé et son statut principal sont mis à jour (un libellé vide garde l'ancien) ; sinon il est ajouté.
  • Ajouter ou modifier un téléphone : le numéro est mis au format international (06 12 34 56 78 devient +33612345678) ; sans indicatif, il est lu dans le pays de la fiche, en France à défaut. Un numéro invalide arrête l'étape en erreur. S'il figure déjà sur la fiche avec le même poste, son type, son libellé et son statut principal sont mis à jour (un type ou un libellé vide garde l'ancien) ; sinon il est ajouté, avec un type déduit du numéro (mobile ou fixe) si aucun n'est choisi.
  • Retirer un téléphone : le numéro, saisi dans n'importe quel format, est retiré avec le poste indiqué. Retirer le numéro principal fait du premier numéro restant le principal.
  • Ajouter ou modifier une adresse : l'adresse qui porte le même libellé (par exemple « Siège ») est mise à jour ; sans libellé, une nouvelle adresse est toujours ajoutée.
  • Retirer une adresse : par son identifiant ou, à défaut, par son libellé.
  • Rattacher une personne à une société : la personne est retrouvée par son identifiant ou son email, la société par son identifiant ou ses clés. Un rôle vide garde le rôle existant.

Les fiches alimentées par une synchronisation peuvent aussi être modifiées par ces étapes.

Réutiliser la fiche dans les étapes suivantes

Toute étape qui renvoie une fiche de l'annuaire met ses informations à disposition des étapes suivantes, par exemple pour écrire un email ou remplir un champ. En plus de la liste complète des emails, la variable email donne directement l'adresse principale de la fiche — vide si aucune adresse n'est marquée comme principale :

{{Récupérer une fiche.email}}
{{Récupérer une fiche.display_name}}

La civilité se décline en trois variables, pour éviter d'écrire « mr » dans un email :

VariableContenu
civility.codemr ou mrs
civility.short_labelM. ou Mme
civility.long_labelMonsieur ou Madame
Bonjour {{Récupérer une fiche.civility.long_label}} {{Récupérer une fiche.last_name}},

Les trois sont vides quand la fiche n'a pas de civilité : écrivez le texte qui précède de façon à rester correct dans ce cas.

Passer d'une fiche de module à l'annuaire

Les fiches des modules (contacts, entreprises…) peuvent être rattachées à une personne ou à une société de l'annuaire. Les étapes qui lisent une fiche de module proposent pour cela la variable _directory : l'identifiant, le type (personne ou société) et le nom de la partie rattachée. Elle est vide si la fiche n'est rattachée à aucune partie de l'annuaire, ou si cette partie a été supprimée.

Reportez son identifiant dans le champ Party ID d'une étape Récupérer une fiche de la rubrique Annuaire pour enchaîner sur toutes les informations de l'annuaire :

{{<étape qui lit la fiche>._directory.id}}

Sur cette page