L’application dispose d’une fonctionnalité de “shortcode” qui sont des éléments qui seront interprétés par le système au moment de l’affichage d’une page, que ce soit au niveau d’une zone de texte, d’un message email, ou dans certains cas, d’une traduction.
Les shortcodes se présentent sous le format “[nom_du_shortcode]” et qui peuvent être utilisés dans l’éditeur, mais également dans les traductions, et les zones de texte sans éditeur.
On peut regrouper les short codes selon leur catégories:
Sur l'organisation
Les informations récupérées dans les shortcodes proviennent des informations saisies dans l'organisation.
[organisation_host]
Renvoie le domaine de l'organisation.
[organisation_logo]
Affiche le l’image d'entête de l’organisation.
[organisation_postfinance]
Affiche le numéro postfinance de l'organisation.
[organisation_ics]
Affiche le numéro ICS de l'organisation.
[organisation_lsv]
Affiche le numéro LSV de l'organisation.
[organisation_directdebit]
Affiche le numéro Direct Debit de l'organisation.
[organisation_name]
Affiche le nom de l’organisation.
[organisation_address]
Affiche l’adresse de l’organisation.
[organisation_email]
Affiche l’adresse e-mail de l’organisation.
[organisation_phone]
Affiche le téléphone de l’organisation.
[organisation_analytics]
Affiche le code analytics, s'il est renseigné.
[organisation_gtm]
Affiche le code GTM s'il est renseigné.
[organisation_automation]
Affiche le code sendinblue s'il est renseigné.
[organisation_receipt_object]
Affiche l'objet du reçu fiscal, si l'option reçu fiscal est activée.
[organisation_receipt_status]
Affiche le statut affiché sur le reçu, si l'option reçu fiscal est activée.
[organisation_iban]
Affiche l’IBAN de l’organisation, s'il est renseigné.
[organisation_bic]
Affiche le BIC de l’organisation, s'il est renseigné.
[organisation_siret]
Affiche le n° Siret de l'organisation s'il est renseigné
Sur les transactions
Ces short code sont utilisable suite à une transaction.
[order_id]
Affiche l’identifiant de commande Givexpert.
[order_validated]
Affiche le statut de la transaction :
- Y pour validé
- N pour refusé
- A pour Attente ou Abandon
[order_purpose]
Retourne le type de soutien de la transaction :
- D pour une transaction basée sur un don
- R pour une transaction basée sur une réservation
- P pour une transaction basée sur un parrainage
[order_type]
Retourne le type de transaction :
- S pour une transaction ponctuel
- M pour une initialisation de transaction régulière
- R pour une transaction régulière
[order_means]
Retourne le type de moyen de paiement de transaction :
- CB => paiement en ligne
- SE => paiement SEPA
- PS => paiement Suisse
- PA => paiement papier
[order_aff_code]
Retourne le code de l’affectation associée à la transaction.
[order_date]
Date de la transaction au format US. accepte un attribut optionnel :
format, pour le format de la date, basé sur PHP : https://www.php.net/manual/fr/datetime.format.php
Exemple d’utilisation : [order_date] Affiche la date de la transaction au format US, AAAA-MM-JJ.[order_date format=”d-m-Y”] Affiche la date de la transaction au format JJ-MM-AAAA.[order_date format=”d/m/y”]
Affiche la date de la transaction au format JJ/MM/AA.
[order_trans_id]
Affiche l’identifiant de transaction du TPE, s'il existe.
[order_amount]
Donne le montant de la transaction, le format est en fonction de la langue du formulaire.
[order_amount] accepte deux groupements d’attributs optionnels :Le premier groupement permet de modifier l’affichage avec trois attributs : • decimals => nombre de chiffre après la virgule
- decimal_separator => séparateur des décimales
- thousands_separator => séparateur des milliers
Le deuxième groupement avec un attribut :
- limit_purpose => limite le montant en fonction du purpose des produits (D pour un don, R pour une réservation, P pour un parrainage) Exemple :
[order_amount] Affiche le montant total de la transaction au format de la langue du formulaire. [order_amount decimals="2" decimal_separator="." thousands_separator=""] Affiche le montant total de la transaction au format séparateur de décimal “.”, deux décimales, pas de séparateur de millier
[order_amount decimals="2" decimal_separator="." thousands_separator="" limit_purpose="R"]Affiche le montant total de la transaction au format séparateur de décimal “.”, deux décimales, pas de séparateur de millier, limité aux produits réservation
[order_amount decimals="2" decimal_separator="." thousands_separator=" " limit_purpose="D"]Affiche le montant total de la transaction au format séparateur de décimal “.”, deux décimales, séparateur de millier “ ”, limité aux produits don
[order_currency]
Affiche le symbole de la devise du formulaire.
[order_iban]
Affiche l’IBAN du donateur
Suite à une transaction avec le Terminal de paiement Givexpert SMS si le ‘means’ est SE
[order_bic]
Affiche le BIC du donateur
Suite à une transaction avec le Terminal de paiement Givexpert SMS si le ‘means’ est SE
[order.pa.url]
Affiche l'url d’un lien, qui selon les cas permet d'afficher le document pdf pour :
- chèque/RIB
- LSV/.BVR
- Mandat SEPA
Suite à une transaction avec un ‘means’ PA, PS ou SE
[order_items]
Affiche un tableau contenant les articles, leurs quantités et leurs montant.
[order_items_pdf]
Affiche un tableau contenant les articles, leurs quantités et leurs montants pour une utilisation dans un pdf (style css limité)
[order_date_table]
Affiche la date au format JJ/MM/AAAA dans un tableau.
[order_engagement]
Affiche “don_simple”, “parrainage” ou “don_regulier” suivant le purpose et le type de transaction.
[order_type_sent]
Affiche la traduction de ponctualPayment ou monthlyPayment suivant le type de la transaction.
[receipt_id]
Affiche l’identifiant du reçu, si la fonctionnalité des reçus est activée.
[order_receipt_id_url]
Affiche l’url de téléchargement du reçu,si la fonctionnalité des reçus est activée.
[order_code_segment]
Affiche le code segment s'il est renseigné dans le formulaire
Sur le donateur
Ces short codes sont utilisables suite a une transaction.
[donor_first_name]
Affiche le prénom du donateur.
[donor_last_name]
Affiche le nom de famille du donateur.
[donor_email]
Affiche l'
E-mail du donateur.
[donor_title]
Affiche la civilité du donateur.
[donor_address1]
Affiche l'adresse du donateur, si le donateur à cocher “Je souhaite obtenir mon attestation fiscale” ou que l’adresse postal n’est pas optionnel.
[donor_address2]
affiche la ligne "complément d'adresse", optionnel.
[donor_zipcode]
Affiche le code postal du donateur, optionnel.
[donor_city]
Affiche la ville du donateur, optionnel.
[donor_country]
Affiche le code ISO Alpha 2 du pays du donateur, optionnel.
[donor_birthday]
Affiche la date anniversaire du donateur, au format us.
accepte un attribut optionnel :
format, pour le format de la date, basé sur PHP : https://www.php.net/manual/fr/datetime.format.php
Exemple d’utilisation : [donor_birthday] Affiche la date au format US, AAAA-MM-JJ.[donor_birthday format=”d-m-Y”] Affiche la date au format JJ-MM-AAAA.[donor_birthday format=”d/m/y”]
Affiche la date de la transaction au format JJ/MM/AA.
[donor_phone]
Affiche le numéro de téléphone du donateur.
c’est le numéro demandé dans la partie “coordonnées”, alors que le [donor_cell] est celui demandé pour la validation du Givexpert SMS
[donor_cell]
Affiche le numéro de téléphone du donateur, généralement un mobile
Si le moyen de paiement est E-sepa Givexpert
[donor_has_newsletter]
Si l’option newsletter est active, alors affiche:
1 si le donateur a coché la case “Je souhaite recevoir la newsletter” sinon 0
[donor_organism]
Si la case "Je représente une organisation ou une société" est coché alors affiche le nom saisie par le donateur.
[donor_siren]
Si la case "Je représente une organisation ou une société" est coché alors affiche le numéro Siren renseigné par le donateur
[donor_legal_status]
Si la case "Je représente une organisation ou une société" est coché alors affiche la forme juridique renseignée par le donateur
Sur le collecteur
[template.collector.url]
Affiche l’url de la page collecteur.
Si le formulaire de don est affiché suite au clique sur le bouton de don de la page d’un collecteur, ou que le texte est affiché sur une page collecteur ou un email rattaché à un collecteur.
[template.collector.admin.url]
Affiche l’url de la page d'administration du collecteur.
Si le formulaire de don est affiché suite au clique sur le bouton de don de la page d’un collecteur, ou que le texte est affiché sur une page collecteur ou un email rattaché à un collecteur.
[template_collector_photo_url]
Affiche l’url de la photo du collecteur.
[template_collector_name]
Affiche le nom de la page du collecteur.
[collector_first_name]
Affiche le prénom du collecteur.
[collector_last_name]
Affiche le nom du collecteur.
[collector_email]
Affiche l’adresse email du collecteur.
[collector_title]
Affiche la civilité du collecteur du collecteur.
Sur le template
[template.url]
Affiche l’url du formulaire ou de la page.
[template_code]
Affiche le code du formulaire ou de la page.
[template_single_min_amount]
Affiche le montant minimum pour un don simple.
[template_multi_min_amount]
Affiche le montant minimum pour un don régulier.
[template_sponsor_min_amount]
Affiche le montant minimum pour un parrainage.
[template_currency]
Affiche le symbole de la devise du formulaire.
[template_currency_alpha]
affiche le code alpha 3 de la devise du formulaire.
[template_name]
Affiche le nom du formulaire/page
[template_has_newsletter]
Affiche 1 si l’option newsletter est activée 0 sinon
Boucle et conditionnel
Il est possible d'utiliser des boucles et des conditionnels
Boucle
Le short code se présente sous la forme :[foreach_order_items] [endforeach][foreach_order_items] [endforeach] permet de faire une boucle sur les produits, il est possible d’utiliser des shortcodes spécifiques à l’intérieur de cette boucle :
- Le shortcode spécifique [item_id] Identifiant du produit
- Le shortcode spécifique [item_name] Nom du produit
- Le shortcode spécifique [item_code] Code du produit
- Le shortcode spécifique [item_quantity] Quantité du produit
- Le shortcode spécifique [item_amount] Montant du produit, partage le premier groupement d’attribut avec le shortcode [order_amount], à savoir :
decimals => nombre de chiffre après la virguledecimal_separator => séparateur des décimalesthousands_separator => séparateur des milliersExemple d’utilisation :
[item_amount]Affiche le montant du produit au format de la langue du formulaire.
[item_amount decimals="2" decimal_separator="." thousands_separator=""]Affiche le montant du produit au format séparateur de décimal “.”, deux décimales, pas de séparateur de millier
Conditionnel
Ce short se présente sous la forme :
[if] [else] [endif]
Le shortcode [if] indique le début de la condition, toute condition débuté avec [if] doit se terminer par [endif]
[if] indique le début de la condition, il prend trois attributs obligatoires qui sont :
- subject : texte ou un shortcode
- operator : valeurs prédéfini correspondant au type de comparaison :
- superiorTo
- inferiorTo
- equalTo
- value : texte ou un shortcode
[else] permet de définir le comportement si la condition n’est pas respectée.
Exemple:
[if subject="[order_amount]" operator="superiorTo" value="100"] Plus de 100 [endif]
Affichera si le montant de la transaction est supérieur à 100 : Plus de 100
[if subject="[order_amount]" operator="superiorTo" value="100"] Plus de 100 [else] Moins de 100[endif]
Affichera si le montant de la transaction est supérieur à 100 : Plus de 100Affichera si le montant de la transaction est inférieur ou égal à 100 : Moins de 100
Il est possible d’imbriquer le shortcode conditionnel jusqu’à 5 niveaux, par exemple :
[if subject="[order_amount]" operator="superiorTo" value="100"] Don [if subject="[order_type]" operator="equalTo" value="S"]ponctuel[else]régulier[endif] de plus de 100 [else] Don [if subject="[order_type]" operator="equalTo" value="S"]ponctuel[else]régulier[endif] de moins de 100 [endif] Permettra d’afficher :
Don ponctuel de plus de 100 Don régulier de plus de 100 Don ponctuel de moins de 100 Don régulier de moins de 100
Short Code UTM
Lorsque vous utilisez la fonctionnalité de pré remplissage d'un formulaire, vous passez a travers l'url un certain nombre de variable.
Il est possible de passer des variables UTM dans une url, et de récupérer ces UTM depuis des short-codes, il en existe 5:
- [order_utm_source]
- [order_utm_medium]
- [order_utm_term]
- [order_utm_content]
- [order_utm_campaign]
2 variables supplémentaires sont disponibles et récupéré par des short code :
- [order_external_id] correspondant a externalId dans l'url
- [order_media_code] correspondant a mediaCode dasn l'url