Differenze
Queste sono le differenze tra la revisione selezionata e la versione attuale della pagina.
| Entrambe le parti precedenti la revisione Revisione precedente Prossima revisione | Revisione precedente | ||
|
gwusermanual:gwobjects:start [2023/01/16 15:50] mariasole.angelucci [Eventi] |
gwusermanual:gwobjects:start [2023/01/16 16:57] (versione attuale) mariasole.angelucci [Eventi] |
||
|---|---|---|---|
| Linea 399: | Linea 399: | ||
| ===== Eventi ===== | ===== Eventi ===== | ||
| Dalla versione 4.6.x del framework è stato introdotto il concetto di evento. | Dalla versione 4.6.x del framework è stato introdotto il concetto di evento. | ||
| + | |||
| L'evento (chiamato GeowEvent) è un oggetto interno a Geoweb che ha lo scopo di registrare un'azione svolta dall'utente oppure eseguita automaticamente dal sistema. Questa azione, ovviamente, deve essere in qualche modo importante da registrare: questo vuol dire che potrebbe essere visualizzata dall'utente in uno storico degli eventi e potrebbe essere notificata all'utente o a più utenti tramite un sistema di notifiche. | L'evento (chiamato GeowEvent) è un oggetto interno a Geoweb che ha lo scopo di registrare un'azione svolta dall'utente oppure eseguita automaticamente dal sistema. Questa azione, ovviamente, deve essere in qualche modo importante da registrare: questo vuol dire che potrebbe essere visualizzata dall'utente in uno storico degli eventi e potrebbe essere notificata all'utente o a più utenti tramite un sistema di notifiche. | ||
| - | L'oggetto GeowEvent contiene diversi campi necessari alla registrazione dell'azione che è stata svolta, memorizzando al contempo le informazioni riguardanti l'oggetto sul quale è stata effettuata l'azione. | + | L'oggetto GeowEvent contiene diversi campi necessari alla registrazione dell'azione che è stata svolta, memorizzando al contempo le informazioni riguardanti l'oggetto sul quale è stata effettuata l'azione. Di fondamentale importanza sono i campi che categorizzano l'evento, cioè **eventCategory** ed **eventSubcategory**; questi campi vanno compilati in modo coerente (eventi con categoria uguale devono avere il campo eventCategory compilato allo stesso modo). |
| + | |||
| + | Di seguito viene riportato il codice groovy necessario alla creazione dell'oggetto evento e alla sua registrazione tramite il servizio eventManagementService. Nell'esempio sono riportati, con il loro commento, tutti i campi che compongono l'evento. Si ricorda che **codSolution** e **codModule** sono obbligatori! | ||
| + | |||
| + | <code Groovy GeowEvent.groovy> | ||
| + | import com.geowebframework.transfer.objects.event.GeowEvent; | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | GeowEvent event = new GeowEvent(); | ||
| + | event.setEventOrigin("user"); //STRINGA - Origine dell'evento: può assumere solo 2 valori 'user' oppure 'system' | ||
| + | event.setEventUser("esc"); //STRINGA - Utente che crea l'evento. Deve essere valorizzato solo se eventOrigin=user | ||
| + | event.setEventNotes("Questa e' una nota dell'evento. "); //STRINGA - Note a corredo dell'evento (max 4000) | ||
| + | |||
| + | |||
| + | event.setEventClassnameObject("cde_deliverable"); /*STRINGA - Nome della classe dell'oggetto su cui si è verificato | ||
| + | l'evento*/ | ||
| + | event.setEventPkObject(3619269); /*INTERO - Chiave dell'oggetto (cioè del record) su cui si è | ||
| + | verificato l'evento*/ | ||
| + | event.setEventCodObjectKey("cod_deliverable_full"); /*STRINGA - Nome del campo/attributo della classe dell'oggetto, | ||
| + | (campo) che contiene il codice dell'oggetto su cui si è | ||
| + | verificato l'evento*/ | ||
| + | event.setEventCodObjectValue("PRE-001.01_000008_00"); /*STRINGA - Valore del campo/attributo codice dell'oggetto*/ | ||
| + | event.setEventDescrObject("Questa è una descrizione."); /*STRINGA - Descrizione dell'oggetto su cui si è verificato | ||
| + | l'evento*/ | ||
| + | event.setEventTypeObjectKey(null); /*STRINGA - Nome del campo/attributo della classe dell'oggetto, | ||
| + | (campo) che contiene il tipo dell'oggetto. Il tipo dell'oggetto | ||
| + | è utile solo nel caso in cui oggetti della stessa classe ma di | ||
| + | tipo diverso debbano avere diverse notifiche o diversi destinatari | ||
| + | di notifica*/ | ||
| + | event.setEventTypeObjectValue(null); /*STRINGA - Valore del campo/attributo tipo dell'oggetto*/ | ||
| + | |||
| + | |||
| + | event.setCodSolution("S01"); /*STRINGA - Campo obbligatorio!! Codice della soluzione, recuperabile dalla tabella | ||
| + | gwa_solution*/ | ||
| + | event.setCodModule("LLPP_PPM"); //STRINGA - Campo obbligatorio!! Codice del modulo, recuperabile dalla tabella gwa_module | ||
| + | event.setScopeObject(""); //STRINGA - Variabile di progetto in sessione | ||
| + | event.setEventCategory("CAMBIO STATO"); //STRINGA - Categoria dell'evento. Va sempre valorizzato!! | ||
| + | event.setEventSubcategory("PUBBLICAZIONE"); /*STRINGA - Sottocategoria dell'evento. Potrebbe essere nullo se l'evento | ||
| + | può essere descritto solo dalle categorie*/ | ||
| + | event.setEventTitle("Cambio stato - pubblicazione"); /*STRINGA - Titolo dell'evento. Se è nullo appare come | ||
| + | concatenazione di categoria e sottocategoria*/ | ||
| + | event.setEventDescription("Questo elaborato ha cambiato stato: ora e' pubblicato. "); /*STRINGA - Eventuale descrizione | ||
| + | dell'evento*/ | ||
| + | event.setEventMessage("L'elaborato con nome {{nome}} e' stato pubblicato dall'utente {{user}}."); /*STRINGA - Messaggio | ||
| + | legato all'evento e alla sua (futura) notifica. Se e' valorizzato, in fase | ||
| + | di notifica, l'utente vedrà il messaggio salvato su questo campo. Eventuali | ||
| + | variabili dinamiche possono essere inserite all'interno della stringa con | ||
| + | la notazione doppia graffa: {{nome_variabile}}. */ | ||
| + | | ||
| + | def map = [:]; | ||
| + | map.user = "esc"; | ||
| + | map.nome = "Elaborato di test PRE-001" | ||
| + | |||
| + | event.setEventFields(map); /*MAP(STRING,OBJECT) - Mappa che contiene le variabili dinamiche che sono state inserite | ||
| + | nel messaggio. Il messaggio può contenere uno dei campi dell'evento compilati sopra oppure | ||
| + | altri campi aggiuntivi. In questo ultimo caso i campi aggiuntivi vanno inseriti in questa | ||
| + | mappa (con nomi diversi rispetto ai campi sopraelencati) */ | ||
| + | |||
| + | |||
| + | services.eventManagementService.recordEvent(event); | ||
| + | |||
| + | |||
| + | </code> | ||
| + | Per abilitare il salvataggio degli eventi sul gestore di dati NoSql ElasticSearch, vanno aggiunte le seguenti proprietà al configuration.properties: | ||
| + | <code> | ||
| + | ###################################################################### | ||
| + | # E L A S T I C S E A R C H | ||
| + | ###################################################################### | ||
| + | elastic.search.url=http://elastic.k8s.gwcloud.it/ | ||
| + | elastic.search.user=geoweb | ||
| + | elastic.search.password=<password> | ||
| + | elastic.search.index.name=test | ||
| + | </code> | ||