Ajouter des variables avancées sur un document

Ajouter des variables avancées sur un document

Comme nous l’avons dit dans notre précédent article Ajouter des champs dynamiques sur un document, il est possible d’ajouter des champs dynamiques sur un document avant de l’ajouter sur Eurosign. Ces balises permettent de créer des modèles pour vos documents avant de les envoyer via l’application ou l’API. Ces champs dynamiques peuvent être constituées de variables, qui permettent une configuration poussée du document.

PS : pour info, cet article est notamment destiné aux développeurs qui utilisent l’API, afin de configurer les documents à envoyer via Eurosign 👨‍💻

Cet article est une explication simplifiée de l’utilisation des variables sur Eurosign. Pour en savoir plus, rendez-vous ici : https://app.eurosign.com/docs/tags-and-variables

✅ Types de champs

Toutes les balises sont entourées de deux accolades : {{description de mon champ}}

Dans ces accolades, il faut décrire premièrement le type de champ, suivi d’éventuels Attributs (que vous trouverez ci-dessous) pour le personnaliser. Ces attributs définissent le destinataire du champ, sa largeur, une valeur par défaut…). Les attributs sont de la forme :

nomAttribut="valeur"

Par exemple :

{{typeDeChamp unAttribut=''valeur de l’attribut''}}

Ici, le premier signataire aura un champ texte avec comme valeur par défaut « lu et approuvé » :

{{text s1 value="lu et approuvé"}}

Les attributs checked, readonly et required n’ont pas besoin de valeur.

Pour retrouver la liste des champs disponibles à l’insertion, rendez vous dans l’article Ajouter des champs dynamiques sur un document.

💻 Attributs

Selon le type de champ, certains attributs sont disponibles. La liste exhaustive des attributs disponibles par champ se trouve dans la partie suivante. Sont listés ici tous les attributs disponibles :

  • checked
    • Quelle que soit sa valeur, si cet attribut est mis dans un champ checkbox ou radio, la case sera cochée.
    • Formats courts : chk, chkd
  • hint
    • Un message d’indication qui s’affiche lorsque l’utilisateur survole le champ avec sa souris : 
    • Formats courts : ht
  • min
    • Définit la valeur minimum d’un input number/date ou le nombre de caractères minimum d’un input text
    • Formats courts : mn
  • max
    • Définit la valeur maximum d’un input number/date, ou le nombre de caractères maximum d’un input text
  • name
    • Le nom du champ (un identifiant). Utile principalement pour les inputs radio, où plusieurs boutons radio ont le même nom et chaque bouton a une valeur différente.
  • readonly
    • Avec cet attribut, le champ ne sera pas modifiable par l’utilisateur
    • Formats courts : !
  • required
    • Quelle que soit sa valeur, l’utilisateur devra obligatoirement remplir le champ (ou remplir la case si c’est une checkbox)
    • Formats courts : *
  • step
    • Pour un attribut number, c’est un nombre entier correspondant à l’écart entre deux valeurs possibles. Par exemple, pour un input number dont le step est défini à 5, les valeurs possibles seront …-5, 0, 5, 10, 15… Si le champ a une valeur par défaut, les valeurs possibles auront pour base cette valeur par défaut. Par exemple, si le champ a « 12 » comme valeur par défaut et un step à 5, les valeurs possibles du champ seront …7, 12, 17, 22…
  • to
    • Destinataire du champ
    • Format court : on peut écrire la valeur sans qu’elle soit précédée de « to ». Par exemple : {{text s1}}
    • Obligatoire pour tous les champs
  • value
    • La valeur par défaut du champ (par exemple : Lu et approuvé)
    • Formats courts : val, v
  • width
    • La largeur du champ. Si l’attribut n’est pas ajouté, la largeur du champ par défaut sera la largeur que prend la balise
    • Formats courts : w

👥 Comment définir un destinataire

L’attribut to permet de définir qui sera le destinataire du document qui pourra/devra remplir le champ concerné.

La valeur de l’attribut identifie la personne à qui le champ est destiné.

{{sign s1}} correspond par exemple à un champ de signature pour le premier signataire. Pour ajouter un champ de signature pour le deuxième signataire, il suffira de remplacer cette balise par {{sign s2}}, et ainsi de suite.

🚀 Variables

Les valeurs des champs peuvent être remplies dynamiquement au moyen de variables. Les utilisateurs de l’API peuvent définir leurs propres variables : https://app.eurosign.com/docs/api#operation/createSignatureRequest

Les variables sont toujours entre accolades : {maVariable}

Les variables sont particulièrement utiles avec l’attribut value. Elles permettent notamment de préremplir des champs avec des informations concernant les signataires. Par exemple, pour créer un champ non-modifiable dont la valeur est le prénom du premier signataire, on peut créer le tag :

{{text s1 value={s1.firstname} }}

Les variables existantes sont les suivantes : firstname, lastname, email

📍Prénom du signataire 1 : {s1.firstname}

📍Nom du signataire 1 : {s1.lastname}

📍Email du signataire 1 : {s1.email}

❓Exemples de variables

{{checkbox to="s1"}} ou {{chbx s1}} : une case que l’on peut cocher 
{{email to="signer1"}} ou {{em to=s1}} : un champ email 
{{radio to="s1" name="choix" value="1" required}} : Choix 1 
{{radio to="s1" name="choix" value="2"}} : Choix 2 

Ici, les deux boutons radio ont le même name, ce qui signifie qu’ils font partie du même groupe. Le fait de mettre l’attribut required à l’une des deux balises rend le groupe obligatoire : l’utilisateur DOIT choisir une option du groupe.

Conclusion

Pour commencer à envoyer des documents gratuitement et simplement via Eurosign, c’est par ici.

Essayez la signature électronique avec Eurosign pendant 14 jours, envoyez des documents pour signature en quelques secondes et restez informé de leur statut grâce à notre plateforme. Tous les documents signés ont une valeur juridique.

Pour suivre nos actualités et découvrir les dernières nouveautés de la signature électronique, suivez-nous sur LinkedIn !

🔥 Pour retrouver nos autres articles tutoriels, rendez-vous ici