Variabili nei template delle notifiche
Le email e gli SMS che Riseact invia (ringraziamenti, ricevute, link di pagamento, istruzioni) sono template in cui si inseriscono variabili tra doppie graffe. Al momento dell'invio ogni variabile viene sostituita con il dato reale:
Ciao {{ supporter.first_name }}, grazie per la tua donazione di {{ donation.amount }} euro.
I template usano la sintassi Jinja: oltre alle variabili si possono usare condizioni e filtri.
Due sintassi, entrambe valide
Le variabili esistono in due forme:
| Versione | Esempio | Uso |
|---|---|---|
| Unificata (v2) | {{ supporter.first_name }} | Sintassi consigliata, usata dall'editor e dai template di default. |
| Legacy (v1) | {{ supporter_first_name }} | Sintassi storica, ancora presente in molti template salvati. |
Ogni notifica riceve sempre entrambe le forme, quindi un template continua a funzionare in qualunque delle due sintassi sia scritto, anche se le mescola. Per i template nuovi conviene usare solo la versione unificata: è quella proposta dall'editor e quella su cui verranno convertiti i template esistenti.
Una variabile che non esiste produce una stringa vuota, senza errori: se un dato non compare nell'email, il primo controllo è il nome della variabile.
Variabili disponibili
Sempre disponibili
| Variabile | Contenuto |
|---|---|
date.today | Data odierna, gg/mm/aaaa |
date.current_year | Anno corrente |
date.previous_year | Anno precedente |
organization.name | Nome dell'organizzazione |
organization.legal_name | Ragione sociale |
organization.email | Email di contatto |
organization.phone | Telefono di contatto |
organization.website | Sito web |
organization.logo_url | URL del logo |
organization.address, organization.address_2 | Indirizzo |
organization.city, organization.state, organization.postal_code, organization.country | Città, provincia, CAP, paese |
organization.vat | Partita IVA |
organization.tax_id | Codice fiscale |
Sostenitore
Disponibili in tutte le notifiche destinate a un sostenitore.
| Variabile | Contenuto |
|---|---|
supporter.first_name, supporter.last_name, supporter.full_name | Nome, cognome, nome completo |
supporter.business_name | Ragione sociale, per i sostenitori azienda |
supporter.email, supporter.phone, supporter.mobile | Contatti |
supporter.address, supporter.address_2, supporter.city, supporter.locality, supporter.postal_code, supporter.country | Indirizzo |
supporter.ssn | Codice fiscale |
supporter.vat | Partita IVA |
supporter.type | Tipo di sostenitore |
supporter.certificate_url | Link all'attestato delle donazioni |
Donazione
Disponibili nelle notifiche che riguardano una donazione già creata.
| Variabile | Contenuto |
|---|---|
donation.code | Codice della donazione |
donation.amount | Importo |
donation.date | Data di creazione |
donation.frequency | Frequenza (una tantum, mensile, ...) |
donation.campaign | Nome della campagna |
donation.payment_method | Metodo di pagamento |
donation.state | Stato |
donation.receipt_url | Link alla ricevuta |
donation.fundraiser_name | Nome del fundraiser, per le donazioni a una raccolta peer-to-peer (vuoto altrimenti) |
donation.last_payment_date | Data dell'ultimo pagamento, presente solo se la donazione ne ha almeno uno |
Checkout
Disponibili nelle notifiche che riguardano una donazione non ancora completata.
| Variabile | Contenuto |
|---|---|
checkout.url | Link per completare la donazione |
checkout.amount | Importo |
checkout.date | Data di creazione |
checkout.frequency | Frequenza |
checkout.campaign | Nome della campagna |
checkout.payment_method | Metodo di pagamento scelto |
checkout.payment_instructions | Istruzioni del metodo di pagamento manuale |
checkout.fundraiser_name | Nome del fundraiser (vuoto se non c'è) |
Le istruzioni di pagamento possono andare a capo: per mantenere gli a capo in un'email si usa il filtro linebreaksbr, {{ checkout.payment_instructions|linebreaksbr }}.
Campagna
Disponibili nella notifica "Conferma lead", inviata a chi lascia i propri dati su una campagna lead. Una lead non ha donazione: le variabili donation.* restano vuote.
| Variabile | Contenuto |
|---|---|
campaign.title | Nome della campagna |
campaign.url | Link alla pagina della campagna, o alla raccolta peer-to-peer se la lead arriva da lì |
Altre variabili
| Variabile | Contenuto |
|---|---|
authentication.url | Link di accesso all'area sostenitore, solo nella notifica "Login Sostenitore" |
staff.name | Nome del membro dello staff, solo quando l'invio parte da un'azione dello staff nel back-office |
customfields['chiave'] | Valore di un custom field del sostenitore o della donazione, vedi Custom Field |
Variabili per notifica
L'organizzazione e la data sono sempre presenti. Il resto dipende dalla notifica:
| Notifica | Sostenitore | Donazione | Checkout | Campagna |
|---|---|---|---|---|
| Donazione ricevuta (e mail di ringraziamento della campagna) | sì | sì | no | no |
| Donazione rimborsata | sì | sì | no | no |
| Donazione abbandonata | sì | no | sì | no |
| Istruzioni per la donazione | sì | no | sì | no |
| Invio link checkout | sì | no | sì | no |
| Attestato fiscale | sì | no | no | no |
| Conferma lead (e email di conferma della campagna lead) | sì | no | no | sì |
| Login Sostenitore | no | no | no | no |
Una variabile di un gruppo non disponibile produce una stringa vuota: per esempio {{ donation.amount }} nella notifica "Donazione abbandonata" resta vuota, lì l'importo è {{ checkout.amount }}.
Condizioni
Per mostrare un testo solo quando un dato è presente:
{% if supporter.first_name %}Ciao {{ supporter.first_name }},{% else %}Ciao,{% endif %}
Corrispondenza con la sintassi legacy
Per leggere o aggiornare un template scritto con i nomi legacy:
| Legacy (v1) | Unificata (v2) |
|---|---|
current_year, last_year, today_date | date.current_year, date.previous_year, date.today |
organization_name, organization_email, ... | organization.name, organization.email, ... |
organization_ssn | organization.tax_id |
supporter_first_name, supporter_last_name, ... | supporter.first_name, supporter.last_name, ... |
first_name, last_name | supporter.first_name, supporter.last_name |
supporter_name, supporter_full_name | supporter.full_name |
donation_amount, donation_date, ... nelle notifiche di donazione | donation.amount, donation.date, ... |
donation_amount, donation_date, ... nelle notifiche di checkout | checkout.amount, checkout.date, ... |
donation_receipt_url | donation.receipt_url |
donation_last_payment_date | donation.last_payment_date |
donation_url | checkout.url |
payment_method_instructions | checkout.payment_instructions |
fundraiser_name | donation.fundraiser_name o checkout.fundraiser_name |
staff_name | staff.name |
authentication_url | authentication.url |
customfield_chiave | customfields['chiave'] |
campaign_title, campaign_url | campaign.title, campaign.url |