Differenze

Queste sono le differenze tra la revisione selezionata e la versione attuale della pagina.

--- documentazione_3di_riservata:equitalia:procedura_equinotifier [2016/07/05 16:18] – [Procedura EquiNotifier] ncandelora
+++ documentazione_3di_riservata:equitalia:procedura_equinotifier [Data sconosciuta] (versione attuale) – eliminata - modifica esterna (Data sconosciuta) 127.0.0.1
@@ Linea 1: / Linea 1: @@
-=====Manuale per la configurazione della procedura di interrelazione Docway-XML - CRM=====
-====Descrizione della procedura====
-La procedura sviluppata consente di inviare, automaticamente e a intervalli di tempo prefissati, alle caselle di posta dei relativi punti di gestione ticket, e-mail generate tramite i dati dei documenti protocollati in arrivo di pertinenza CRM, complete degli allegati inseriti in fase di registrazione del documento.\\
-Per la gestione del flusso documentale relativo alle richieste dei contribuenti è necessario inserire delle strutture fittizie in ACL per  identificare i punti di accesso dei ticket; per ognuna di queste strutture sono stati creati dei responsabili, anch'essi fittizi, a cui sono stati associati gli indirizzi e-mail di destinazione corrispondenti ai punti di accesso al sistema di CRM.\\
-In questo modo sarà possibile configurare delle voci di indice, una per ogni punto di accesso al CRM, con classificazione, RPA del documento e oggetto preimpostato per facilitare il protocollista nella operazioni di registrazione del documento e indirizzare il documento alla corretta destinazione.\\
-In fase di protocollazione in arrivo del documento di pertinenza CRM, il protocollatore dovrà inserire la voce di indice corrispondente, avendo cura di completare l'oggetto con i dati necessari alla gestione della richiesta. L'attribuzione della corretta voce di indice al documento in arrivo è l'unico modo per identificare i dati da inviare al CRM da procedura automatica.\\
-Qualora la voce di indice preposta fosse apposta, erroneamente, su un documento non interessato all'invio a CRM, l'e-mail verrebbe comunque inviata. \\
-Sarà, inoltre, cura del protocollatore deselezionare il check box "invio email di notifica", subito sotto la sezione "Responsabilità" della scheda di registrazione documenti, altrimenti verrà    inviata anche l'email di notifica standard del protocollo. \\
-A intervalli di tempo prefissati, la procedura ricercherà, tra i documenti protocollati in arrivo, quelli di pertinenza CRM, registrati o modificati dopo l'ultima esecuzione della procedura, effettuando, per ciascun documento, le seguenti operazioni:
-  *composizione del testo dell'e-mail da inviare, recuperando i dati presenti nel documento protocollato;
-  *inserimento, nell'e-mail da inviare, degli allegati registrati sul documento protocollato (gli allegati non subiranno alcuna trasformazione e manterranno lo stesso formato e lo stesso numero così come sono stati inseriti nel protocollo);
-  *invio dell'e-mail composta alla casella di posta indicata nel campo RPA del documento protocollato.
-La procedura terrà inoltre traccia, su un file di log posizionato su file system, di eventuali errori nell'invio; è possibile anche attivare un'opzione che inoltri il report degli errori ad uno specifico indirizzo e-mail.
-====Configurazione della procedura====
-La configurazione della procedura si articola nelle seguenti fasi:
-  *creazione delle strutture e dei responsabili fittizi;
-  *creazione delle voci di indice;
-  *registrazione del documento;
-  *avvio della procedura.
-===Creazione strutture e persone in ACL===
-La prima fase consiste nella composizione del responsabile a cui sarà associata la casella di posta elettronica funzionale e che sarà l'assegnatario (RPA) dei documenti che dovranno transitare per la procedura di interrelazione.\\
-Per la creazione della struttura interna occorre accedere in ACL e creare una nuova struttura interna; sarebbe opportuno creare una struttura gerarchica con una macrostruttura padre che contiene le strutture funzionali.\\
-Per ogni struttura funzionale è necessario inserire una persona interna che sia responsabile della struttura stessa. La nuova persona interna è una persona fittizia e può avere lo stesso nominativo della persona che effettivamente dovrebbe essere l'RPA del documento.\\
-Al responsabile appena creato deve essere associata la casella di posta elettronica funzionale a cui inviare le mail per la gestione nel sistema di CRM.\\
-Per concludere al responsabile reale, e agli operatori che dovranno essere coinvolti nella gestione delle pratiche di CRM, deve essere assegnata la visibilità sui documenti della UOR appena creata nella procedura tramite il diritto "Altre UOR".
-===Creazione/modifica voci di indice===
-Siccome ogni mail funzionale è associata ad un RPA, è necessario creare una voce di indice per  ogni mail CRM.\\
-La creazione e la modifica delle voci di indice vengono effettuate collegandosi al modulo **Archivio procedimenti**.\\
-Da qui è possibile effettuare una ricerca sulle voci di indice già inserite ed eventualmente procedere alla modifica.
-===Registrazione del documento===
-Nella registrazione del documento occorre prestare attenzione ad effettuare le seguenti operazioni:
-  - individuazione della voce di indice (compilazione automatica dei campi oggetto, classificazione, UOR/RPA);
-  - aggiustamento dell'oggetto sulla base delle indicazioni rilasciate da Equitalia;
-  - eliminazione della spunta sul check-box "Invio mail di notifica".
-===Avvio della procedura===
-L'avvio della procedura viene gestita tramite schedulazione programmata nel manager del server.
-====Procedura EquiNotifier====
-=== Struttura dell'installazione ===
-La directory di installazione della procedura EquiNotifier è la seguente:
-<color green>../docway_extra/EquiNotifier</color>((tale percorso è valido solo per la nuova infrastruttura in vigore dal 1° luglio 2016; per le infrastrutture precedenti i percorsi di installazione sono molto variegati))
-Può essere installate un'unica procedura oppure più procedure in parallelo; in quest'ultimo caso, ogni cartella **EquiNotifier** avrà una diversa denominazione.\\
-La cartella standard **EquiNotifier** è strutturata nel seguente modo:
-{{ :documentazione_3di_riservata:equitalia:equinotifier.png?direct |}}
-  * <color green>**bin**</color>: contiene i file eseguibili
-  * <color green>**classes**</color>: contiene i file di configurazione
-  * <color green>**lib**</color>: contiene le librerie java per l'esecuzione della procedura
-  * <color green>**logs**</color>: contiene i file di log della procedura.
-=== File di configurazione ===
-La directory <color green>**bin**</color> contiene l'eseguibile per l'avvio della procedura, <wrap em>equi-notifier.bat</wrap>.
-<WRAP center round important centeralign 100%>
-\\
-All'interno di questo file devono essere impostati i parametri di connessione a eXtraWay (**-host**, **-port**, **-db**) e i parametri di connessione al server smtp (**-stmpHost**, **-smtpPort**)
-</WRAP>
-<code winbatch>
-SET java_command=java
-SET CWD=%CD%
-REM Trucchetto per ottenere il path assoluto della directory superiore ed impostarlo
-REM come INSTDIR.
-pushd ..
-SET inst=%CD%
-popd
-SET jl=%inst%\lib
-SET CLASSPATH=%jl%/indexLib.jar;%jl%/xdocway.jar;%jl%/common.jar;%jl%/commons-codec-1.3.jar;%jl%/code.jar;%jl%/hj.jar;%jl%/dom4j-full.jar;%jl%/saxpath.jar;%jl%/jaxen-full.jar;%jl%/log4j-1.2.8.jar;%jl%/mail.jar;%jl%/activation.jar;%inst%/classes
-SET PARAMETERS=-host=10.55.240.107 -port=4859 -db=xdocwaydoc -smtpHost=smtp.equitaliaservizi.org -smtpPort=25
-cd %inst%\classes
-%java_command% -classpath %CLASSPATH% it.highwaytech.apps.xdocway.EquiNotifier %PARAMETERS%
-cd %CWD%
-</code>
-La directory <color green>**classes**</color> ha la seguente struttura:
-{{ :documentazione_3di_riservata:equitalia:equinotifier2.png?direct |}}
-Il file <wrap em>equi-notifier.properties</wrap> contiene i parametri principali per la configurazione della procedura:
-  * Parametro per configurare gli eventuali dati di accesso al server di posta per l'invio delle mail e il protocollo da utilizzare:
-<code bash>
-# Dati di autenticazione per il server SMTP
-smtpUser=
-smtpPwd=
-# Protocollo SMTP da usare. Valori: smtp|smtps (default: smtp)
-smtpProtocol=smtp
-</code>
-  * parametro per impostare i dati (nome e indirizzo mail) che si vuole che compaiano nel mittente della mail:
-<code bash>
-# Sender per email di notifica
-emailSender=Agent Notifiche Equitalia - Docway
-emailSenderAddr=docway@domain.name
-</code>
-  * parametro per configurare la composizione dell'oggetto della mail; la stringa è composta secondo la sintassi eXtraWay
-<code bash>
-#Oggetto della mail
-emailSubject=[xml,/doc/rif_esterni/rif/nome]: [xml,/doc/oggetto]
-</code>
-  * parametro per impostare la costruzione dell'url di accesso diretto al documento su Docway-XML; l'url è composto da due parametri: un host che normalmente è costituito dall'hostname del server dove risiede Docway-XML
-<code bash>
-# Web server, Web server secondario e uri -> per costruire url per invio email
-emailWebServerHost=http://localhost:8080
-emailWebServerUri=/xway/application/xdocway/engine/xdocway.jsp
-emailWebServerSecondaryHost=https://localhost:8080
-</code>
-  * parametro per configurare la frase di ricerca con cui individuare e recuperare i documenti da inviare al CRM; la frase di ricerca va espressa secondo la sintassi eXtraWay;
-<code bash>
-#Frase di ricerca per identificare i documenti da notificare
-query=([/doc/classif/@cod/]="01/01")
-</code>
-  * parametro per configurare l'estensione della frase di ricerca al fine di recuperare solo i documenti creati e/o modificati dopo l'ultimo passaggio della procedura
-<code bash>
-#Frase di ricerca per l'individuazione dei nuovi documenti da notificare (timestamp compare)
-tsQuery=(([/doc/storia/creazione/@data]>$lastDate OR ([/doc/storia/creazione/@data]=$lastDate AND [/doc/storia/creazione/@ora]>$lastTime)) OR ([/doc/storia/ultima_modifica/@data]>$lastDate OR ([/doc/storia/ultima_modifica/@data]=$lastDate AND [/doc/storia/ultima_modifica/@ora]>$lastTime))
-</code>
-  * parametro per disabilitare l'invio dei file del documento in allegato alla mail (se il parametro è true la mail sarà composta solo con i metadati di protocollo);
-<code bash>
-#Per disabilitare l'invio degli allegati alle email di notifica
-disableAttachments=true
-</code>
-  * parametro per impostare un indirizzo di posta elettronica fisso come indirizzo di destinazione: se attivo, la procedura non invia le mail all'indirizzo di posta del RPA ma le invia all'indirizzo qui configurato
-<code bash>
-#Serve per impostare un destinatario fisso (al posto dell'RPA del documento)
-#emailRecipient=prova@3di.it
-</code>
-  * parametro per impostare l'indirizzo di posta eletronica a cui inviare il report degli errori riscontrati durante l'esecuzione della procedura
-<code bash>
-#Email di amministratore a cui viene recapitato un messaggio in caso di errori in invio notifiche
-adminRecipient=administrator@3di.it
-</code>
-Il file <wrap em>it.highwaytech.broker.properties</wrap> gestisce i parametri di connessione con il server eXtraWay e normalmente non viene mai modificato.
-Il file <wrap em>log4j.properties</wrap> invece serve a configurare il logging della procedura; esso viene impostato al momento dell'installazione della procedura e raramente viene modificato in seguito.
-Il file <wrap em>lastTS.txt</wrap> contiene il timestamp dell'ultima procedura effettuata; è utilizzato per comporre l'estensione della query in modo da evitare il recuperare dei documenti già passati nella procedura. Questo file viene aggiornato automaticamente; solo in casi particolari può essere modificato manualmente.
-=== Analisi dei log===
-Ogni istanza di EquiNotifier ha i suoi logs specifici; il patch di salvataggio del file di log è configurato nel log4j.properties.\\
-Nel log vengono registrate le operazioni di invio di ogni singolo record che può essere identificato nel log tramite **nrecord**. Pertanto per effettuare le verifiche dell'invio di un determinato documento è necessario procurarsi prima l'nrecord del documento e poi ricercalo all'interno del log, \\
-Se l'nrecord __non è presente__ significa che la procedura non ha individuato il documento; pertanto è necessario verificare perché la query impostata non lo ha trovato (di solito succede che il documento è privo della voce di indice).\\
-Se l'nrecord __è presente__ potrebbe essersi verificato un qualche problema nell'invio; il più frequente è che la dimensione dei file allegati al documento superano la dimensione massima consentita dal server di posta. Questo tipo di casi vengono però gestiti internamente da Equitalia per cui ci si può limitare a segnalare loro che il documento non è stato inviato perché gli allegati sono troppo pesanti.