Differenze

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

--- documentazione_3di:docway4:manuali_altri_applicativi:pubblicazione_repertori [2017/01/16 10:59] – [Url per accesso diretto alla visualizzazione di un Repertorio] ncandelora
+++ documentazione_3di:docway4:manuali_altri_applicativi:pubblicazione_repertori [Data sconosciuta] (versione attuale) – eliminata - modifica esterna (Data sconosciuta) 127.0.0.1
@@ Linea 1: / Linea 1: @@
-====== Pubblicazione on-line dei repertori ======
-|  **Versione**  |  **Data**  |  **Redatto**  |  **Verificato**  |  **Motivazione**  |
-|01.00.00|28/11/2015|Nicola Candelora| | Prima stesura |
-|01.00.01|09/05/2016|Nicola Candelora| | Completamento stesura |
-|01.00.02|19/05/2016|Nicola Candelora| | Aggiunto paragrafo espressioni regolari |
-=====Introduzione=====
-L'obiettivo del documento è quello di fornire la indicazioni complete per l'utilizzo dell'applicazione di gestione della pubblicazione dei repertori collegato a DocWa4.
-L'applicazione è suddivisa in due diversi applicativi:
-  * **modulo WEB** dove vengono effettivamente pubblicati on-line i repertori e sono quindi a disposizione per la consultazione da parte di utenti esterni che possono accedervi senza autenticazione;
-  * **modulo ADMIN** dove l'utente amministratore configura la pubblicazione dei repertori, accedendovi tramite autenticazione.
-=====Contesto=====
-Prima di iniziare la parte manualistica è bene definire alcuni concetti utili a comprendere al meglio il funzionamento dell'applicazione.
-Il concetto di base dell'applicazione è costituito da un oggetto definito **pubblicazione**; la "pubblicazione" è sostanzialmente un record xml nel quale vengono salvate tutte le impostazioni e configurazioni relative alla pubblicazione di uno specifico repertorio che vengono definite dall'amministratore.
-Nell'applicazione il record della pubblicazione viene trattato alla stregua di un documento di Docway, pertanto si ha la possibilità di inserire/modificare i campi che lo descrivono; tali campi servono per definire le differenti configurazioni relativa alla pubblicazione come, ad esempio, il repertorio da pubblicare, i dati del repertorio da visualizzare, la presenza del diritto all'oblio e altri campi che vedremo in seguito più nel dettaglio.
-Questo tipo di record viene utilizzato per interfacciarsi con l'archivio documentale Docway per ritornare i dati dei repertori da pubblicare secondo quanto definito al suo interno.
-{{ :documentazione_3di:docway4:manuali_altri_applicativi:pubbrepertori.png?500 |}}
-=====Modulo ADMIN=====
-====Accesso al modulo====
-Il **modulo ADMIN** è raggiungibile da un indirizzo specifico.
-Una volta inserite le credenziali, viene visualizzata la home page dell'applicativo che presenta una maschera di ricerca per ricercare i record "pubblicazione" già inseriti.
-Sulla barra di sinistra dalla pagina sono presenti due pulsanti:
-  * **Ricerca pubblicazione**: riporta alla maschera di ricerca;
-  * **Nuova pubblicazione**: apre la maschera per l'inserimento di una nuova pubblicazione.
-====Inserimento nuova pubblicazione====
-La maschera di inserimento di una nuova pubblicazione è suddivisa nelle seguenti sezioni:
-  *"**Pubblicazioni**";
-  *"**Repertorio Docway**";
-  *"**Estensione ricerca**";
-  *"**Diritto all'oblio**";
-  *"**Elenco campi da pubblicare**".
-La prima sezione, **Pubblicazioni**, è costituita dai seguenti campi:
-  * //**Nome**// : definire una denominazione da assegnare alla pubblicazione;
-  * //**Pubblicato**//: se il check-box è selezionato (spuntato) il repertorio sarà visibile nel modulo WEB;
-  * //**Crea link (Vaschetta)**//: se il check-box è selezionato (spuntato), verrà creato un link per accedere direttamente alla visualizzazione dei repertori della pubblicazione nel modulo WEB.
-{{ :documentazione_3di:docway4:manuali_altri_applicativi:immagine1.png?direct |Sezione Pubblicazioni}}
-//Sezione Pubblicazioni//
-La seconde sezione, **Repertorio Docway**, consente di selezionare uno dei repertori configurati in Docway da associare alla pubblicazione. E' costituita da due campi:
-  * //**Repertorio Descrizione**//: menù a tendina che presenta tutti i nomi dei repertori configurati in Docway;
-  * //**Repertorio Codice**//: campo non editabile che viene valorizzato con il codice del repertorio selezionato nel campo precedente.
-{{ :documentazione_3di:docway4:manuali_altri_applicativi:immagine2.png?direct |Sezione Repertorio Docway}}
-//Sezione Repertorio Docway//
-La terza sezione, **Estensione ricerca**, è facoltativa e consente di applicare al repertorio un'estensione sulla ricerca per raffinare l'elenco dei repertori da pubblicare; ad esempio, se all'interno del repertorio delle delibere si vuole scremare solo le delibere di un certo tipo, in questa sezione posso definire su quale base identificare quelle specifiche delibere; ovviamente è necessario riferirsi ai campi del documento presenti in Docway e su quelli costruire l'estensione di ricerca. La sezione è costituita dai seguenti campi:
-  * //**Operazione**//: menù a tendina che consente di selezionare l'operatore booleano da applicare all'estensione (or / and);
-  * //**Espressione**//: campo dedicato all'inserimento dell'estensione di ricerca secondo la sintassi di eXtraWay.
-{{ :documentazione_3di:docway4:manuali_altri_applicativi:immagine3.png?direct |Sezione Estensione ricerca}}
-//Sezione Estensione ricerca//
-La quarta sezione, **Diritto all'oblio**, consente di definire un limite temporale alla pubblicazione in modo tale che oltre una data i repertori non vengano più visualizzati. E' costituita dai seguenti campi:
-  * //**Attivo**//: check-box che serve ad attivare la limitazione temporale sulla pubblicazione;
-  * //**Da**//: estremo cronologico a partire dal quale i repertori sono resi pubblici;
-  * //**A**//: estremo cronologico che definisce la data fino alla quale i repertori sono resi pubblici.
-{{ :documentazione_3di:docway4:manuali_altri_applicativi:immagine4.png?direct |Sezione Diritto all'oblio}}
-//Sezione Diritto all'oblio//
-La quinta sezione, "**Elenco campi da pubblicare**", presenta una tabella dove è possibile definire i campi del repertorio che costituiranno la visualizzazione tabellare del repertorio nel modulo WEB.
-====Definizione dei campi da pubblicare====
-La sezione propone già di default una insieme di campi già configurati:
-{{ :documentazione_3di:docway4:manuali_altri_applicativi:immagine5.png?direct |Sezione Campi da pubblicare}}
-//Sezione Campi da pubblicare//
-Questo insieme è composto dai campi: tipo di documento (arrivo, partenza, ecc.), numero di protocollo, data di protocollo, soggetto (mittente / destinatario), oggetto, nrecord e codice del repertorio.
-Tali campi possono essere mantenuti oppure eliminati nel caso non siano utili per la pubblicazione; ovviamente c'è sempre la possibilità di aggiungere ulteriori campi, tenendo presente che ogni campo rappresenta una colonna da visualizzare nel formato tabellare del modulo WEB.
-====Aggiungere un nuovo campo da pubblicare====
-Per aggiungere un nuovo campo è necessario conoscerne il path xml completo; tale path può essere individuato dall'analisi del record xml del repertorio di cui di seguito viene riportato un esempio:
-<WRAP prewrap 1000px>
-<code xml>
-<doc sensibile="no" anno="2016" num_prot="2016-ENTEUNO-0000004" tipo="interno" bozza="no" nrecord="00008325" cod_amm_aoo="ENTEUNO" data_prot="20160504" annullato="no">
-  <storia>
-    <creazione oper="Deliberatore Lucio" cod_oper="SOC" uff_oper="Ufficio Delibere" cod_uff_oper="UFFDEL" data="20160504" ora="15:06:34"/>
-    <responsabilita_minuta cod_persona="SOC" cod_uff="UFFDEL" nome_persona="Deliberatore Lucio" nome_uff="Ufficio Delibere" operatore="Deliberatore Lucio (Ufficio Delibere)" cod_operatore="SOC" data_visto="20160504" ora_visto="15:06:34" visto_da="Deliberatore Lucio (Ufficio Delibere)" data="20160504" ora="15:06:34"/>
-    <responsabilita cod_persona="SOC" cod_uff="UFFDEL" nome_persona="Deliberatore Lucio" nome_uff="Ufficio Delibere" operatore="Deliberatore Lucio (Ufficio Delibere)" cod_operatore="SOC" data_visto="20160504" ora_visto="15:06:34" visto_da="Deliberatore Lucio (Ufficio Delibere)" data="20160504" ora="15:06:34"/>
-  </storia>
-  <rif_interni>
-    <rif nome_persona="Deliberatore Lucio" nome_uff="Ufficio Delibere" cod_persona="SOC" cod_uff="UFFDEL" diritto="RPAM"/>
-    <rif nome_persona="Deliberatore Lucio" nome_uff="Ufficio Delibere" cod_persona="SOC" cod_uff="UFFDEL" diritto="RPA"/>
-  </rif_interni>
-  <files/>
-  <immagini/>
-  <scadenza tipo="nessuna"/>
-  <allegato xml:space="preserve">0 - nessun allegato</allegato>
-  <minuta>
-    <mittente nome_persona="Deliberatore Lucio" nome_uff="Ufficio Delibere"/>
-    <classif xml:space="preserve" cod="06/01">06/01 - Normativa di Riscossione</classif>
-  </minuta>
-  <extra>
-    <stato_pubblicazione xml:space="preserve">si</stato_pubblicazione>
-  </extra>
-  <oggetto xml:space="preserve">Prova delibera consiglio Asolo</oggetto>
-  <mezzo_trasmissione cod="Assicurata"/>
-  <repertorio numero="DxC^ENTEUNO-20160000001" cod="DxC">Delibere di Consiglio</repertorio>
-</doc>
-</code>
-</WRAP>
-La finestra per l'inserimento di un nuovo campo è accessibile cliccando sull'icona "**Aggiungi nuova riga**":
-{{ :documentazione_3di:docway4:manuali_altri_applicativi:immagine6.png?direct |}}
-Viene aperta una nuova finestra contenente i campi per la configurazione del nuovo campo da pubblicare:
-{{ :documentazione_3di:docway4:manuali_altri_applicativi:reppubbl3.png?500 |Configurazione nuovo campo}}
-//Configurazione nuovo campo//
-I campi evidenziati in azzurro sono obbligatori mentre gli altri sono facoltativi:
-  * **Id** : codice alfanumerico identificativo del campo <wrap danger>obbligatorio</wrap>;
-  * **Etichetta** : nome del campo che comparirà come testata della colonna <wrap danger>obbligatorio</wrap>;
-  * **xPath** : xpath del campo da pubblicare <wrap danger>obbligatorio</wrap>;
-  * **Template per titolo**: estensione da utilizzare per effettuare alcune elaborazioni sul valore del campo individuato (ad esempio per l'aggiunta di alcuni separatori che vengono interpretati dall'applicativo in una determinata maniera);
-  * **Tipo** : tipologia del campo da pubblicare; le opzioni sono le seguenti <wrap danger>obbligatorio</wrap>:
-    *//text// - campo testuale
-    *//number// - campo numerico
-    *//date// - campo di tipo data
-    *//media// - campo di tipo file
-  * **Ordinabile**: check-box per definire se la colonna del campo può essere ordinato in sede di visualizzazione;
-  * **Larghezza**: definizione della larghezza della colonna;
-  * **Regola di ord. Cres.**: definizione della regola di ordinamento crescente secondo la sintassi eXtraWay;
-  * **Regola di ord. Desc.**: definizione della regola di ordinamento decrescente secondo la sintassi eXtraWay.
-In coda alla maschera di inserimento c'è una sezione **Espressioni regolari** che consente di inserire delle regular expression per migliorare o cambiare il render del valore del campo individuato tramite i parametri precedenti.
-La sezione presenta due elementi:
-{{ :documentazione_3di:docway4:manuali_altri_applicativi:reppubbl4.png?400 |}}
-  * **Espressione**: per inserire la regular expression da applicare al valore del campo
-  * **Sostituzione**: per configurare la rappresentazione del valore del campo in seguito all'applicazione della regular expression tramite la funzione di replace
-Di seguito alcuni esempi di regular expression:
-  * Nel campo file, per visualizzare solo file con una specifica estensione (nell'esempio file pdf)
-<WRAP prewrap 250px>
-<code php>
-//Espressione
-/(.*?\.pdf)/i
-//Sostituzione
-\1
-</code>
-</WRAP>
-  * Nel campo Numero di repertorio per visualizzare il numero come stringa "Delibera di Giunta n. XXX del ANNO"
-<WRAP prewrap 500px>
-<code php>
-//Espressione
-/(.*?)-(\d{4})(0*)(\d+)/i
-//Sostituzione
-<center>Delibera di Giunta n. <b>\4</b>-\2</center>
-</code>
-</WRAP>
-=====Modulo WEB=====
-Il modulo WEB è raggiungibile da uno specifico indirizzo normalmente pubblico.
-L'accesso a questo modulo è privo di autenticazione. Qui vengono visualizzati i repertori così come sono stati configurati nella parte ADMIN.
-La home-page presenta una suddivisione in due parti; sulla sinistra ci sono i link per accedere direttamente alla visualizzazione dei repertori pubblicati (vaschette) mentre nella parte centrale è disponibile una maschera effettuare una ricerca sui repertori resi pubblici.
-{{ :documentazione_3di:docway4:manuali_altri_applicativi:immagine7.png?direct |}}
-====Url per accesso diretto alla visualizzazione di un Repertorio====
-Esiste al possibilità di costruire una URL che consenta l'accesso diretto alla visualizzazione di un Repertorio. L'URL è composto da diverse componenti:
-  - Indirizzo web del sito
-  - query https://www.base64encode.org
-  - identificativo pubblicazione
-===1 - Indirizzo web del sito===
-E' il nome del sito web di pubblicazione dei repertori; ad esempio http://repertori.mottadilivenza.net
-===2 - Query===
-Questa componente contiene la query eXtraWay che viene eseguita sul repertorio; la query completa la si può trovare nel modulo ADMIN in visualizzazione del record di pubblicazione, alla sezione **Risultato**:
-{{:documentazione_3di:docway4:manuali_altri_applicativi:istantanea_2017-01-16_10-13-07.png?800|Query completa}}
-Nell'immagine sopra riportata la query completa è la seguente:
-<code>
-(([DOC_REPERTORIOCOD]="DxG") and ([/doc/extra/stato_pubblicazione/]="si"))
-</code>
-Alla query deve essere aggiunta anche la definizione dell'ordinamento; di default i repertori vengono visualizzati dal più vecchio al più recente. Se si aggiunge la stringa //[?REVSORT]// l'ordinamento di default viene invertito, proponendo ad inizio elenco i repertori più recenti:
-<code>
-(([DOC_REPERTORIOCOD]="DxG") and ([/doc/extra/stato_pubblicazione/]="si"))[?REVSORT]
-</code>
-La query per essere aggiunta nella composizione dell'URL deve essere convertita in BASE64 tramite uno strumento on line come ad esempio questo [[https://www.base64encode.org|encoder/decoder]]. Una volta ottenuta la conversione, questa va aggiunta preceduta dalla stringa //?query=B64//:
-<code>
-?query=B64KChbRE9DX1JFUEVSVE9SSU9DT0RdPSJEeEciKSBhbmQgKFsvZG9jL2V4dHJhL3N0YXRvX3B1YmJsaWNhemlvbmUvXT0ic2kiKSlbP1JFVlNPUlRd
-</code>
-===3 - Identificativo della pubblicazione===
-In coda all'URL va specificato il codice identificativo del record di pubblicazione che abbiamo creato nel modulo ADMIN. L'identificativo è visibile nella fase di visualizzazione dei titoli:
-{{:documentazione_3di:docway4:manuali_altri_applicativi:istantanea_2017-01-16_10-34-56.png?800|Identificativo della pubblicazione}}
-Un volta ottenuto il codice, questo va aggiunto al link preceduto dalla stringa //&fPubbId=//:
-<code>
-&fPubbId=0004
-</code>
-<WRAP round tip>
-**L'URL completo si presenterà quindi in questo modo:**
-<code>
-http://repertori.comune.asolo.tv.it?query=B64KChbRE9DX1JFUEVSVE9SSU9DT0RdPSJEeEciKSBhbmQgKFsvZG9jL2V4dHJhL3N0YXRvX3B1YmJsaWNhemlvbmUvXT0ic2kiKSlbP1JFVlNPUlRd&fPubbId=0004
-</code>
-</WRAP>