Notifiche¶
Una coda elaborata periodicamente con un cron impostato sul server in cui vengono accodate tutte le notifiche che devono essere spedite via email, via sms o altro.
La spedizione vera e propria viene elaborata con plugin specifici (per esempio per le email di Amazon AWS SES, o per gli sms...) non trattati in questa pagina.
Alcuni meta campi dell'oggetto Notifica contengone le informazioni che permettono alla Notifica di essere rischedulata, ripetuta ecc.
Se l'invio della Notifica non riesce per un motivo "temporaneo" viene impostato lo status errore e la stessa Notifica viene reimpostata per riprovare dopo 5 minuti (ridefinibile con la costante PANDORA_NOTIFICHE_ERROR_RETRY_TIME). Riprova per il numero di volte definito nel meta max_retry dopodiché la marca come fallita.
Esempi
Per inviare una Notificha nel futuro impostare Date alla data di invio.
Per impostare una Notificha che poi una volta inviata si ripeta impostare il recurring_period (ogni quanto ripetere l'invio) e il recurring_repetition (per quante volte ripetere)?
Cron
-
elaborazione coda (invio e rischedulazione): wp_cron in pandora/crons.php: ogni minuto chiama
pandora_notifiche_queue_worker()che elabora le notifiche da inviare -
rimozione notifiche spedite: wp_cron in pandora/crons.php: ogni mattina alle 7:00 rimuove le notifiche spedite / notificate più vecchie di un mese che hanno il custom_meta 'cancellabile' = 'true'
Promemoria¶
sono notifiche che vengono "inviate" alla barra header e che possono essere "impostate", "scadute", "completate". se viene opzionato anche "invia email alla sede", nel momento in cui il promemoria diviene "scaduto" viene inviata email alla sede col testo del promemoria. I promemoria sono "per sede" cioè possono essere visti, completati, cancellati da tutti gli operatori di una sede.
Permessi e cancellazioni:
// user può modificare notifica anche se è stata creata in una delle prorpie sedi // user può cancellare notifica anche se è stata creata in una delle proprie sedi // user non può modificare e cancellare una notifica che non ha "cancellabile" impostato // user non può cancellare una notifica "di sistema" ovvero che ha autore = 0 // user con manage_options può modificare e cancellare una notifica di sistema
Campi¶
Core¶
| Nome | slug | rest | note |
|---|---|---|---|
| Destinatario | title |
(Obbligatorio) Email oppure numero sms ecc. Solo un indirizzo per Notifica!. Se questo camo è vuoto la Notifica non viene accodata | |
| Messaggio | content |
Il corpo del messaggio che viene inviato. Può essere formattato in html | |
| Oggetto | excerp |
L'oggetto dell'email | |
| Riferimento | parent |
A quale oggetto si riferisce questa Notifica? (ID Segnalazione, ID Messaggio, ecc) | |
| Data invio | date |
La data in cui questa Notifica deve essere inviata. (imposta in una data futura per mandare successivamente a quando la accodi) | |
| Status | status |
Lo stato della notifica (vedi dattaglio degli status più sotto) |
Taxonomies¶
| Nome | slug | rest | note |
|---|---|---|---|
| Servizio di invio | servizio_notifica | quale plugin usare per l'invio: email, sms, slack, ecc |
Meta¶
| Nome | slug | rest | note |
|---|---|---|---|
| Esito invio | Esito |
Indica se è riuscito l'invio da BcOk. non dice nulla sull'esito finale (impostata dal plugin di invio) nel formato OK INVIO - sent_on: 2017-11-03T17:17:06+00:00 oppure ERRORE - failure sending on: 2017-11-03T17:17:06+00:00 |
|
| Feedback invio | Feedback |
Indica i feedback di consegna e ricezione (se previsti dal tipo di servizio). Possono essere presenti più Feedback per ogni Notifica. Nel formato OK - {dettagli feedback} - on: 2017-11-03T17:17:06+00:00 oppure ERRORE - {dettagli feedback} - on: 2017-11-03T17:17:06+00:00 |
|
| Numero tentativi di invio | max_retry |
Quante volte riprova a inviare in caso di errore. E' una costatnte che si imposta per ogni Notifica. Ad ogni tentativo scala il campo retry_again. De non specificato, Default è 3 (filtrabile) |
|
| Tentativi restanti | retry_again |
Quante altre volte riprovare a inviare in caso di errore. Parte da max_retry a scalare |
|
| Tipo notifica | tipo_notifica |
Uno slug univoco per queta tipologia di notifiche, usato per rintracciarle e raggupparle, soprattutto quando qualche evento deve rimuoverle. Per esempio negli Alert usiamo: alert_email_sede_segnalazione_gestita_15gg oppure alert_email_sede_dopo_segnalazione_36h |
|
| Nome Mittente | from_name |
Nume del mittente che compare nell'email inviata o come mittente del SMS | |
| Ricorrenza | recurring_period |
Ogni quanto deve essere reinviata questa notifica, dopo il primo invio. Una un formato compatibile con strtotime() (per esempio + 15 days). Se il campo non è presente, la Notifica è "one shot", ovvero non viene ripetuta; se il campo è presente, nel momento in cui questa Notifica viene registrata come inviata, una nuova Notifica viene schedulata dopo il periodo indicato. |
|
| Numero ricorrenze | recurring_repetition |
Per quante volte si ripete la Notifica. Ogni volta che viene schedulata una ripetizione, questo valore scala di 1. Per ripetere all'infinito inserire infinite |
|
| Si può cancellare? | cancellabile |
Se (string) 'true': la notifica "spedita" o "notificata" può essere cancellata dopo un certo periodo di tempo (attualmente 1 mese) | |
| Lo status prima di entrare in blacklist | status_pre_blacklist |
||
| ID univoco del messaggio inviato | _ses_message_id |
L'id univoco che il servizio di messaggistica (AWS SES, SMS, SLack) assegna a questo messaggio quando lo prende in consegna e lo invia | |
| A chi rispondere? | reply_to |
Un indirizzo email (o un numero di telefono) unico da impostare per le risposte |
Status:¶
| Nome | slug | note |
|---|---|---|
| In elaborazione | elaborazione |
il worker sta elaborando la Notifica. |
| Da spedire | da_spedire |
Accodata ma non processata |
| Spedire | spedita |
Processata senza errori, ma nessun feedback dal servizio di invio |
| Notificata | notificata |
Ricevuto feedback di corretta consegna/ricezione |
| In errore | errore |
Errore nel processamento. Riprova più tardi (PANDORA_NOTIFICHE_ERROR_RETRY_TIME) fino al massimo max_retry. Finiti i max_retry imposta lo stato della Notifica come fallita |
| Fallita | fallita |
Errore permanente. Non provaa più ad inviare nulla (ma rischedula) |
| Sospesa - in blacklist | blacklist |
Il destinatario è in blacklist. La notifica resta qui sospesa, ma se viene supreata la data di invio viene rimossa. Se il destinatario viene rimosso dalla Blacklist, la Notifica viene riportata allo status precedente. |
| Cancellata a mano | draft |
Fino a un certo punto le Notifiche cancellate "a mano" dal pulsante "cancella" in lista Notifiche, andavano in Bozza. Ora vanno nel centino |