Entrambe le parti precedenti la revisioneRevisione precedenteProssima revisione | Revisione precedente |
documentazione_3di_riservata:docway4:procedimenti-api-dw4 [2020/04/03 15:22] – mbernardini | documentazione_3di_riservata:docway4:procedimenti-api-dw4 [Data sconosciuta] (versione attuale) – eliminata - modifica esterna (Data sconosciuta) 127.0.0.1 |
---|
====== Procedimenti/Riconciliazione API - DocWay4 ====== | |
| |
Avvio di procedimenti agganciati a protocolli di DocWay4. Funzionalità sviluppate per CRV (Consiglio Regionale del Veneto), per maggiori informazioni consultare EasyProject: | |
* [[https://3dinformatica.easyproject.com/issues/19484|Task #19484 - Avvio workflow su documenti protocollati]] | |
* [[https://3dinformatica.easyproject.com/issues/19486|Task #19486 - Riconciliazione]] | |
* [[https://3dinformatica.easyproject.com/projects/942|CRV - Mev]] | |
| |
===== Procedimenti ===== | |
| |
==== Attivazione/Configurazione ==== | |
| |
Per abilitare la gestione dei procedimento occorre attivare la property '**enableGestioneProcedimentiApi**' all'interno del file //it.highwaytech.apps.xdocway.properties// (attenzione, di default la property non è presente, così come tutto il blocco di gestione dei procedimenti - in caso di attivazione deve essere aggiunta al file sul configuratore). | |
| |
Di seguito è riportato il blocco completo di properties di xdocway per la gestione dei procedimenti: | |
| |
<code> | |
#### Procedimenti API - Integrazioni CRV #### | |
| |
# Abilitazione della gestione dei procedimenti (integrazione con API). ('si', 'no' - Default = 'no') | |
enableGestioneProcedimentiApi=no | |
| |
# Definizione dell'URL di endpoint dei WebServices di Workflow di API | |
#procedimentiApi.wsWorkflow.endpoint=http://192.168.42.33:7080/axis/services/WSWorkflow | |
procedimentiApi.wsWorkflow.endpoint= | |
| |
# Query da utilizzare per il recupero dei procedimenti per i quali deve essere tentato l'avvio del workflow su API. Se non specificata, di default | |
# vengono tentati gli avvii su tutti i procedimenti nuovi (in attesa di invio) e su quelli per i quali era stato riscontrato un errore. | |
#procedimentiApi.wsWorkflow.query=([xml,/doc/extra/procedimenti/procedimento/@wf]=wait or error) | |
procedimentiApi.wsWorkflow.query= | |
| |
# Parametri aggiuntivi necessari all'avvio del workflow (possono non essere settati se i valori di default non variano) | |
#procedimentiApi.wsWorkflow.nomeIter=ATTIVITA_ISTITUZIONALE | |
#procedimentiApi.wsWorkflow.applicazione=CRVPRO | |
#procedimentiApi.wsWorkflow.utente=ws | |
| |
############################################# | |
</code> | |
| |
Sempre all'interno del file //it.highwaytech.apps.xdocway.properties// occorre configurare la property '**procedimentiApi.wsWorkflow.endpoint**' se si vuole abilitare l'avvio di workflow su API in caso di procredimenti avviati su documenti protocollati. Nel caso in cui la property non venga configurata l'avvio di workflow non sarà mai tentato. | |
| |
Le altre property indicate sono invece facoltative e devono essere configurate solo nel caso in cui sia necessario variare i valori di default previsti. | |
| |
**N.B.**: Oltre alla configurazione del file di properties xdocway occorre procedere con le seguenti altre configurazioni al fine di abilitare correttamente tutte le funzionalità legate ai procedimenti: | |
* Configurazione delle legislature gestite su DocWay; | |
* Configurazione delle tipologie di documenti; | |
* Import su eXtraWay dei tipi di procedimento che possono essere avviati sui documenti. | |
| |
=== Configurazione Legislature === | |
| |
Il file di configurazione delle legislature è lo stesso utilizzato per la gestione dei repertori per legislatura. | |
| |
Si tratta di un file xml (**legislature.xml**) presente all'interno della directory //DocWay4-service/application/xdocway//. Di seguito viene mostrato il contenuto di default: | |
| |
<code> | |
<?xml version="1.0" encoding="UTF-8"?> | |
<listof_legislatura> | |
<legislatura numero="1" dataInizio="19700707" dataFine="19750614"> | |
<descrizione>I Legislatura</descrizione> | |
</legislatura> | |
<legislatura numero="2" dataInizio="19750715" dataFine="19800607"> | |
<descrizione>II Legislatura</descrizione> | |
</legislatura> | |
<legislatura numero="3" dataInizio="19800608" dataFine="19850511"> | |
<descrizione>III Legislatura</descrizione> | |
</legislatura> | |
<legislatura numero="4" dataInizio="19850617" dataFine="19900515"> | |
<descrizione>IV Legislatura</descrizione> | |
</legislatura> | |
<legislatura numero="5" dataInizio="19900506" dataFine="19950422"> | |
<descrizione>V Legislatura</descrizione> | |
</legislatura> | |
<legislatura numero="6" dataInizio="19950423" dataFine="20000416"> | |
<descrizione>VI Legislatura</descrizione> | |
</legislatura> | |
<legislatura numero="7" dataInizio="20000417" dataFine="20050402"> | |
<descrizione>VII Legislatura</descrizione> | |
</legislatura> | |
<legislatura numero="8" dataInizio="20050403" dataFine="20100327"> | |
<descrizione>VIII Legislatura</descrizione> | |
</legislatura> | |
<legislatura numero="9" dataInizio="20100328" dataFine="20150612"> | |
<descrizione>IX Legislatura</descrizione> | |
</legislatura> | |
<legislatura numero="10" dataInizio="20150616" dataFine="20200616"> | |
<descrizione>X Legislatura</descrizione> | |
</legislatura> | |
</listof_legislatura> | |
</code> | |
| |
L'elenco di legislature di default è stato generato a partire da un export dal DB Oracle attualmente utilizzato dal CRV. La procedura di generazione del file è descritta (e disponibile) sul progetto __//DocWay4-service/test/resources/readme.txt//__. Allo stato attuale l'esecuzione della procedura richiede un ambiente di sviluppo configurato. | |
| |
Nel caso in cui sia necessario aggiornare il file, la copia aggiornata di esso deve essere caricata all'interno della directory del configuratore (es. /opt/3di.it/conf/DocWay4-service/application/xdocway). | |
| |
Dalla sezione '//Strumenti di amministrazione//' di DocWay (menù sull'header > Altre Funzioni > Amministrazione) è possibile scaricare la versione corrente del file di legislature e successivamente aggiornarla attraverso la funzione di upload. In questo caso sarà direttamente DocWay ad aggiornare la versione di legislature.xml presente all'interno della directory del configuratore. | |
| |
=== Configurazione Tipi di Documenti === | |
| |
Il file xml di configurazione delle tipologie di documenti è il seguente: | |
* **DocWay4-service/application/xdocway/procedimenti_api/tipologie.xml** | |
| |
Così come per il file delle legislature, il set di tipi di default è stato generato a partire da un export dal DB Oracle attualmente utilizzato dal CRV. Anche in questo caso per maggiori informazioni sulla procedura adottata consulare il file __//DocWay4-service/test/resources/readme.txt//__. | |
| |
Di seguito viene mostrata una porzione del file di default: | |
| |
<code> | |
<?xml version="1.0" encoding="UTF-8"?> | |
<listof_tipologie> | |
<tipologia id="6" enabled="true"> | |
<description>Albo fornitori</description> | |
</tipologia> | |
<tipologia id="111" enabled="true"> | |
<description>Allegato per pubblicazione web</description> | |
</tipologia> | |
<tipologia id="123" enabled="true"> | |
<description>Allegato specifico</description> | |
</tipologia> | |
<tipologia id="74" enabled="true"> | |
<description>Atto ispettivo</description> | |
</tipologia> | |
<tipologia id="146" enabled="true"> | |
<description>Bilancio società controllata</description> | |
</tipologia> | |
<tipologia id="7" enabled="true"> | |
<description>Convocazione Consiglio regionale</description> | |
</tipologia> | |
<tipologia id="8" enabled="true"> | |
<description>Convocazione Organo interno</description> | |
</tipologia> | |
<tipologia id="103" enabled="true"> | |
<description>Convocazioni/o.d.g.</description> | |
</tipologia> | |
... | |
<tipologia id="145" enabled="false"> | |
<description>Verifica è funzionale</description> | |
</tipologia> | |
<tipologia id="107" enabled="true"> | |
<description>Visti contabili</description> | |
</tipologia> | |
<tipologia id="44" enabled="true"> | |
<description>Visto o rinvio</description> | |
</tipologia> | |
</listof_tipologie> | |
</code> | |
| |
=== Import Tipi di Procedimenti === | |
| |
Per la gestione dei tipi di procedimento è stata definita una nuova UDType su eXtraWay(**tipoprocedimento**). | |
| |
La struttura XML del record è la seguente: | |
| |
<code> | |
<tipoprocedimento nrecord="." tipo="PDLS" categoria="L" startwf="false"> | |
<uffici> | |
<ufficio cod="00003" /> | |
<ufficio cod="SI000010" /> | |
</uffici> | |
</tipoprocedimento> | |
</code> | |
| |
dove: | |
* //nrecord// corrisponde all'identificativo del tipo di procedimento su eXtraWay | |
* //tipo// corrisponde al nome del procedimento | |
* //categoria// può assumere 2 valore: A (numerazione del procedimento per anno) o L (numerazione del procedimento per legislatura) | |
* //startws// è un booleano che definisce se occorre avviare o meno il workflow su API nel caso di nuovo procedimento | |
* //uffici// contiene l'elenco di uffici per i quali è abilitato l'avvio del procedimento su un documento | |
| |
Attualmente non è prevista alcuna interfaccia di gestione dei tipi di procedimento. L'importazione su eXtraWay deve essere fatta attraverso **watchdoc** e qualsiasi modifica ad un tipo di procedimento deve avvenire attraverso la **console** di eXtraWay. | |
| |
Così come per i precedenti casi, anche per questo è stata predisposta una procedura sul progetto DocWay4-service (DocWay4-service/test/resources/readme.txt) per convertire i tipi di procedimenti ottenuti da un export CSV dal DB Oracle in un XML supportato dal processo di import di watchdoc. | |
| |
===== Riconciliazione ===== | |