Configurazione dei servizi

Configurazione di un servizio di notifica IO

Prerequisiti

Per configurare un nuovo servizio di notifica, è necessario soddisfare i seguenti prerequisiti:

1. Aver configurato l'organizzazione ed il servizio su GovRegistry.

2. Aver registrato il servizio sul Backoffice IO e ottenuto la chiave di sottoscrizione (Subscription Key) per la spedizione dei messaggi.

Per maggiori informazioni sul secondo punto, si rimanda alla documentazione ufficiale di IO: https://docs.pagopa.it/io-guida-tecnica/funzionalita/pubblicare-un-servizio

Configurazione del modello

Un modello, o template, permette di definire il contenuto del messaggio che verrà inviato al cittadino, utilizzando parti variabili, o segnaposto, che verranno sostituite con i dati forniti in fase di pianificazione delle spedizioni.

GovNotify integra il template engine Apache Freemarker con cui definire il modello del messaggio. Il testo del messaggio risultante sarà interpretato come Markdown.

A titolo di esempio, consideriamo un messaggio per la scadenza della Carta di Identità Elettronica:

Gentile ${full_name},

si ricorda che in data ${due_date.date} scadrà la sua carta di identità n. ${identity_card_number} rilasciata il ${release_date}.

È possibile prenotare un appuntamento per il rinnovo del suo documento sul sito dell'agenda ministeriale oppure, se avesse bisogno di assistenza, recandosi presso le sedi URP del comune. Per maggiori informazioni consultare il sito del Ministero dell'Interno

Il messaggio risultante dall'applicazione del modello deve essere lungo tra 80 e 10000 caratteri, mentre l'oggetto tra 10 e 120.

Il modello contiene quattro segnaposto: full_name, due_date, identity_card_number e release_date. A eccezione di due_date che è già previsto come valore di default nei modelli, gli altri segnaposto sono specifici per questo servizio e devono essere configurati.

Di seguito, viene illustrata la configurazione del servizio corrispondente:

Definizione dei segnaposto

Ciascun segnaposto, o placeholder, ha associata una tipologia che ne determina la validazione sintattica quando acquisito e l'uso in fase di sostituzione nel messaggio. Per le stringhe può essere configurata un'espressione regolare di validazione, consigliata per verificare sia il contenuto del testo fornito che la lunghezza.

Di seguito sono indicate le tipologie supportate e l'uso che ne può esser fatto nel messaggio.

Date

Nome	Descrizione	Esempio
${nome_parametro}	Default	03/12/2027 10:15
${nome_parametro_date}	Data senza orario	03/12/2027
${nome_parametro_date_verbose}	Data con giorno senza orario	Mercoledì 03/12/2027
${nome_parametro_verbose}	Data con giorno e orario	Mercoledì 03/12/2027 alle ore 10:15
${nome_parametro_time}	Orario senza data	10:15

Stringhe

Nome	Descrizione	Esempio
${nome_parametro}	Default	Lorem Ipsum
${nome_parametro_lower}	Convertito in lowercase	lorem ipsum
${nome_parametro_upper}	Convertito in uppercase	LOREM IPSUM

Numeri

Nome	Descrizione	Esempio
${nome_parametro}	Default	123456
${nome_parametro_currency}	Serializzato come importo	1.234,56

Booleani

Nome	Descrizione	Esempio
${nome_parametro}	Default	True o False