Champs de fusion pdfMachine

Des exemples de dates formatées peuvent également être trouvés dans le profil « Test Profile - Word Template with formatting examples » qui s'installe avec pdfMachine merge.

Le filtre Liquid « date » peut être utilisé pour formater les dates dans les champs pdfMachine merge.

Formatage de la date et de l'heure

Les chaînes de format .NET pour le formatage des dates sont utilisées par pdfMachine merge ; les détails peuvent être trouvés ici.

Les formats de date couramment utilisés sont :

entrée	sortie
{{ invoice_date | date:"d MMM yyyy"}}	1 Jun 2015
{{ invoice_date | date: "dd MMMM yyyy"}}	01 June 2015
{{ invoice_date | date: "MM/dd/yy"}}	06/01/15
Le séparateur est indépendant de la culture, échappé par le caractère guillemet simple : {{ invoice_date | date: "MM'-'dd'-'yy"}}	06-01-15
{{ start_time | date: "h:mmtt"}}	9:00AM

Date et heure actuelles

En plus des filtres Liquid pour les dates, pdfMachine merge dispose également d'un champ de fusion spécial appelé datetimenow.
Un champ de fusion {{ datetimenow }} ne nécessite pas de colonne dans la source de données ; il insérera automatiquement la date et l'heure actuelles.

Ajouter ou soustraire des jours

Un filtre dateplusdays est disponible. Il affichera un nombre de jours avant ou après la date spécifiée.

Par exemple {{ datetimenow | dateplusdays : 30 }} prend l'heure actuelle, ajoute 30 jours et affiche la date.

Entrée	Sortie
{{ datetimenow | date : "d MMM yyyy"}}	8 Nov 2018
{{invoice_date | dateplusdays : 30| date : "d MMM yyyy"}}	8 Nov 2018

Des exemples de champs de devise formatés peuvent également être trouvés dans le profil « Test Profile - Word Template with formatting examples » qui s'installe avec pdfMachine merge.

Pour formater un champ de fusion numérique appelé « amount » en devise, vous pouvez utiliser le filtre « money » :

             {{ amount | money }}

             $25.00

Ou vous pouvez utiliser le filtre « money_no_cents » :

             {{ amount | money_no_cents }}

             $25

Ou vous pouvez formater le montant selon une devise particulière, en choisissant parmi une culture répertoriée ici — le chiffre après la lettre C indique le nombre de décimales qui seront affichées :

             {{ amt | number_culture : "C2","ja-JP" }}

            ¥25.00

             {{ amt | number_culture : "C0","en-US" }}

            $25

Par exemple, si amount est égal à 10.20
{{ amount | money_as_words }}

ten dollars and twenty cents

Pour formater un champ de fusion numérique, vous pouvez utiliser le filtre « number » qui formate un nombre selon le formatage numérique de csharp, à la fois les formats standard et les formats personnalisés. Vous pouvez également utiliser le filtre « number_culture » pour formater un nombre selon une culture répertoriée ici.

Pour formater différemment les nombres positifs, négatifs et zéro, vous pouvez utiliser le formatage conditionnel. Vous pouvez spécifier jusqu'à trois sections différentes de votre chaîne de format en même temps, en les séparant par des points-virgules. Si vous spécifiez deux sections de chaîne de format, la première est utilisée pour les valeurs positives et zéro tandis que la seconde est utilisée pour les valeurs négatives ; si vous utilisez trois sections, la première est utilisée pour les valeurs positives, la seconde pour les valeurs négatives, et la troisième pour les valeurs zéro.

Les formats numériques couramment utilisés sont :

entrée	sortie
{{ num | number :"N2"}}	1,152.00
{{ num | number :"N0"}}	1,152
{{ num | number_culture : "C0", "es-ES"}}	1 152,00
{{ num | | number_culture : "N0", "es-MX"}}	1 152
{{ num | number :"P0"}}	52%
{{ num | number :"P2"}}	52.00%
{{ num | number:"#0.00;(#0.00)"}}	52.00 pour les valeurs positives, (52.00) pour les valeurs négatives

Des exemples de champs numériques formatés peuvent également être trouvés dans le profil « Test Profile - Word Template with formatting examples » qui s'installe avec pdfMachine merge.

Préfixe de texte

Utilisez le filtre « prepend_if » pour insérer du texte avant le champ de fusion lorsque celui-ci n'est pas vide.

Entrée	Sorties possibles
{{item1}}{{item2 | prepend_if: ", "}}{{item3 | prepend_if: ", "}}	oranges oranges, apples oranges, apples, bananas

Éviter les lignes vides

Les modèles Word affichent tous les caractères qui ne sont pas dans un champ de fusion « tel quel ». Parfois, cela génère des lignes vides supplémentaires. Si vous avez un champ de fusion suivi d'un caractère de nouvelle ligne ou de paragraphe, il est possible que vous souhaitiez que cette nouvelle ligne n'apparaisse que lorsque le champ de fusion contient quelque chose.

Le bloc d'adresse en est un bon exemple. Le contenu des lignes d'un bloc d'adresse est parfois vide, par exemple pour une adresse de appartement ou un nom d'immeuble. Il est préférable de ne pas avoir de ligne vide.

Dans l'exemple suivant, les champs de fusion du bloc d'adresse doivent chacun occuper une ligne. Certains champs de fusion seront vides, par exemple address_1. Une nouvelle ligne n'est nécessaire que lorsque le champ de fusion est présent.

Adresse complète	Adresses avec un « address_1 » vide
Joe Smith Unit 1 5 Railway Ave Georgeton, ZA 59680 USA	Joe Smith 5 Railway Ave Georgeton, ZA 59680 USA	Joe Smith 5 Railway Ave Georgeton, ZA 59680 USA

Pour éviter la ligne vide, utilisez le filtre WordNewLine à la place des sauts de ligne Word.

Entrée	Sortie
{{Salutation}} {{first name}} {{last_name}} {{address_1|WordNewLine}}{{address_2|WordNewLine}}{{city}} {{state}} {{postcode}}{{State}} {{postcode}} {{country}}	Mr Joe Smith 5 Railway St Mentone VIC 3965 Australia

Des exemples d'utilisation du filtre WordNewLine peuvent également être trouvés dans le profil « Test Profile - Word Template with formatting examples » qui s'installe avec pdfMachine merge.

$page et $maxpage sont des variables spéciales utilisées avec les modèles HTML. Elles sont converties en « page courante » et en « nombre maximum de pages » dans le document PDF. Par exemple, vous pouvez créer un fichier de papier à en-tête HTML avec le texte « $page sur $maxpage ».

Entrée	Sortie
Page $page of $maxpage	Page 2 of 5

Si vous utilisez un champ de fusion dans une URL, vous devrez peut-être utiliser le filtre « uri_encode » pour encoder les composants saisis par l'utilisateur afin qu'ils ne soient pas mal interprétés par le serveur.

Par exemple, si vous utilisez une URL telle que https://broadgun.com/test?names={{names|uri_encode}} avec un champ de fusion « names » égal à « Jack & Jill », vous aurez besoin du composant uri_encode pour forcer l'encodage du champ de fusion et qu'il soit correctement interprété par le serveur.

Le filtre insert_image vous permet d'insérer une image spécifique — définie par un champ de fusion — dans un modèle Word. Cela donnera une image personnalisée dans chaque pièce jointe. Vous devez spécifier la largeur de l'image en points. La hauteur sera mise à l'échelle de manière appropriée. Ce filtre ne doit être utilisé que dans les modèles Word.

L'image peut provenir d'un fichier ou d'une URL. Vous pouvez utiliser le chemin entier dans le champ de fusion ou seulement une partie du chemin avec le filtre prepend.

Vous pouvez utiliser ce filtre pour insérer des codes-barres générés depuis votre générateur de codes-barres préféré ; cependant, si vous êtes satisfait d'utiliser le serveur de codes-barres Broadgun Software, le filtre barcode est plus simple.

 Un court tutoriel vidéo est disponible. Notez que la source de l'image est un chemin dans la source de données. Il aurait pu tout aussi bien s'agir d'une portion du chemin dans la source de données ou d'une URL. Regarder ici.

Entrée : {{imagePath|insert_image: 144}}
Sortie :

Entrée : {{imageFile | prepend: "c:\images\" |insert_image: 144}}
Sortie :

Entrée : {{imagepath | insert_image: 144, imagelink}}
Sortie :

Entrée : {{ webaddress | uri_encode | prepend: "https://broadgun.com/barcode/?bcid=qrcode&text=" | insert_image: 50 }}
Sortie :

Le filtre barcode vous permet d'insérer un code-barres personnalisé — défini par un champ de fusion — dans un modèle Word. Cela donnera un code-barres personnalisé dans chaque pièce jointe. Vous devez d'abord spécifier le type de code-barres puis la largeur de l'image en points. Vous pouvez éventuellement spécifier la hauteur de l'image en points. Si elle n'est pas spécifiée, la hauteur sera égale à la largeur par défaut.

Si le contenu du champ de fusion est une URL, cette URL sera un hyperlien sur l'image dans le PDF. Vous pouvez également spécifier (facultativement) une URL comme paramètre supplémentaire. Dans ce cas, vous devez d'abord renseigner les paramètres de largeur et de hauteur. Lorsque vous spécifiez une URL comme paramètre, votre code-barres utilisera le contenu du champ de fusion comme texte lors du scan du code-barres, mais lorsque le code-barres est cliqué, la navigation ira vers l'URL spécifiée. Par exemple, vous pouvez avoir un code-barres avec le numéro de série comme texte et l'URL du magasin comme hyperlien.

Le contenu du champ de fusion sera le texte utilisé pour générer le code-barres. Ce filtre ne doit être utilisé que dans les modèles Word.

Le filtre barcode génère le code-barres depuis le serveur de codes-barres Broadgun Software. Vous pouvez utiliser le filtre insert_image pour générer des codes-barres depuis un autre serveur de codes-barres. Le filtre barcode utilise le filtre insert_image avec l'URL du serveur de codes-barres Broadgun Software (comme indiqué dans l'exemple ci-dessous).

 Un court tutoriel vidéo est disponible. Regarder ici.

Entrée : {{webaddress |barcode: "qrcode", 50 }}
Sortie :

Entrée : {{item_number |barcode: "code128", 200, 50 }}
Sortie :

Entrée : {{item_number |barcode: "ean13", 106, 79, webaddress }}
Sortie :

• Placez le filtre sign_here dans un document modèle. Ex. : {{ name | sign_here }}
  Cela donnera lieu à l'insertion d'un champ de capture de signature à cette position dans le document, « name » étant le champ de fusion contenant le nom ou le rôle de la personne qui doit signer le document.
• Le filtre sign_here déclenche le téléchargement du PDF généré sur le site pdfMachine sign here.
• Le PDF téléchargé est chiffré et enregistré sur le site pdfMachine sign here, avec un champ de capture de signature.
• Un lien vers le document téléchargé est placé dans le corps de l'e-mail, à l'aide de la balise Liquid personnalisée {% sign_here_list %}.
• Lorsqu'un destinataire de l'e-mail clique sur le lien dans le corps de l'e-mail, il peut lire et signer le document.
• Lorsqu'un document est signé, vous êtes éventuellement notifié par e-mail avec un lien vers le document signé.

Utilisation de sign_here

sign_here: email, timestampFormat, languageCode

où :

• email
  Facultatif. Une chaîne contenant l'adresse e-mail qui recevra des notifications lorsqu'un document est signé.
• timestampFormat
  Facultatif. Une chaîne définissant l'apparence de l'horodatage sous la signature. La valeur par défaut est « YYYY-MM-DD HH:mm:ss ». Si une chaîne vide est fournie, aucun horodatage visuel n'apparaîtra sur le document PDF résultant.
• languageCode
  Facultatif. Une chaîne de deux caractères définissant la langue que le site pdfMachine sign here utilisera. La valeur par défaut est l'anglais. Les langues prises en charge sont :
  Anglais - « en », Espagnol - « es », Français - « fr », Italien - « it », Allemand - « de », Russe - « ru »

Exemple d'utilisation

Dans le document modèle :

Dans le corps de l'e-mail :

L'e-mail réellement envoyé ressemble à ceci : Lorsque le destinataire de l'e-mail clique sur le lien, il voit une page web qui ressemble à :


Lorsque le destinataire signe, il peut télécharger le PDF signé. Un lien vers le PDF signé est envoyé par e-mail à « [email protected] ». Le PDF signé ressemble à :

Ce filtre fonctionne sur des tableaux d'objets. Il prend un nom de propriété comme paramètre. Tous les objets ayant la même valeur pour ce nom de propriété sont regroupés dans un tableau. Le résultat est un tableau de tableaux.

Exemple :

            Entrée :

                {% assign groups = _rows | group_by: "cid" %}
                {% for group in groups %}
                    {{group[0].cid}}  {{group[0].name}}
                {% endfor %}

            Sortie :
                    1   Apples
                    2   Apples