utenti:docway:docway4:manuale_amministratore:console_amministrazione_extraway []

Questa pagina è in sola lettura. Puoi visualizzare il sorgente, ma non puoi modificarlo. Contatta l'amministratore se pensi che ci sia un errore.
====== DocWay4 - Console di amministrazione eXtraWay ======

====== [ eXtraWay Tools ] ======

===== Scopo del presente manuale =====

Il presente manuale non intende essere una guida esaustiva della console amministrativa e di tutte le funzionalità rese disponibili tramite la stessa; scopo del presente manuale è semplicemente fornire al tecnico informatico una guida di riferimento utile per svolgere alcune operazioni di verifica e manutenzione.

=====ACCESSO AL SISTEMA=====

L'accesso alla console amministrativa è consentito solo agli utenti accreditati a compiere operazioni sullo stesso e cioè agli utenti a cui sono state fornite le credenziali di accesso.

La "url" di accesso all'applicazione è la seguente:

<code>http://host:port/console/engine/console.jsp</code>

Tipicamente in risposta a quanto richiesto, l'utente viene invitato a specificare le proprie credenziali (Nome utente e Password). Se le credenziali fornite sono corrette viene presentata la prima pagina o pagina "**database...**".

{{:documentazione_3di:extraway_os:manuali:console1.png?800|}}

La composizione della pagina (e di conseguenza le scelte che l'utente può effettuare) variano a seconda del tipo di accesso configurato (per quell'utente).

=====ASPETTI DI STANDARDIZZAZIONE DELL'APPLICAZIONE=====

Le pagine della console amministrativa presentano una suddivisione funzionale e cioè la pagina viene suddivisa in tre zone facilmente distinguibili: "**Intestazione**", "**Bottoni**" e "**Principale**".

{{:documentazione_3di:manuale_amministratore_titulus3:schema_console.jpg|}}

Nella zona "**Intestazione**" viene visualizzato il numero di release della console amministrativa;  l'informazione viene resa disponibile sotto forma di ancora/collegamento ipertestuale e consente in qualsiasi momento di tornare alla prima pagina o pagina "**database...**".

Nella zona "**Bottoni**" vengono presentati appunto i "macro bottoni" e cioè una sorta di menu che consente di richiamare nella zona "**Principale**" tutti i comandi specifici della tipologia richiesta; i bottoni "esposti" (ed i comandi presentati nella zona .quot;**Principale**") variano a seconda del "profilo" dell'utente che ha effettuato il login.

Sinteticamente sono presenti:

|  **Bottone**  |  **Descrizione**  |
|database...|Insieme di comandi specifici per la gestione del database:(riapertura archivi, creazione di nuovi archivi, compattamento, rigenerazione titoli, etc etc.)|
|record...|Insieme di comandi specifici per la gestione del singolo record del database: cerca e visualizza, modifica, cancella, calcolo impronta, etc etc.|
|index...|Insieme di comandi specifici per la gestione degli indici del database:  aggiorna, ricostruisci, compatta, controlla, etc etc|
|thesaurus...|Insieme di comandi specifici per la gestione dei tesauri del database: importa, esporta, visualizza|
|connection...|Insieme di comandi specifici per la gestione dell'ambiente: lista dei processi, lista delle connessioni, informazioni sul server, etc etc|

Nella zona "**Principale**" viene rappresentata la "//maschera/form//" atta a soddisfare/consentire la corretta interazione con l'utente.

Tipicamente la zona "**Principale**" presenta nella prima parte della maschera i "**parametri generici di connessione**" e cioè quell'insieme di informazioni minime/comuni a tutti i comandi.

Sinteticamente sono presenti:

|  **Nome**  |  **Descrizione**  |
|Host|Indica l'indirizzo IP logico o fisico della macchina ove viene eseguito il server eXtraWay; in assenza di tale parametro tipicamente viene utilizzato quello specificato nella url .|
|Port|Indica il numero di porta socket da utilizzare(per la comunicazione (se diverso dal default configurato).|
|//Username e Password//|//Sistema di autenticazione applicato solo nelle prime versioni di eXtraway ed attualmente inutilizzato.//|
|Db (logical)|Indicazione del nome logico del database su cui si verranno lanciati i successivi comandi; tale informazione è obbligatoria (non è possibile proseguire ed eseguire determinati comandi senza aver specificato un DB).|\\

=====PERCORSI APPLICATIVI=====

L'amministratore di un Database accede alla console quando deve:

  *effettuare specifiche operazioni sui dati di un database (punto [[#8.1.Database|8.1 Database]])
  *effettuare verifiche sul contenuto degli indici o effettuare ricerche particolari non ottenibili con l'interfaccia applicativa realizzata per il detto Database (punto [[#8.2.Record|8.2 Record]])
  *effettuare specifiche operazioni sugli indici di un Database (punto [[#8.3.Index|8.3 Index]])
  *effettuare operazioni di manutenzione del tesauro di un Database (punto [[#8.4.Thesaurus|8.4 Thesaurus]])

=====Database=====

Tramite il "macro bottone" **Database** si richiamano nella zona "**Principale**" tutti i comandi specifici per la gestione "generica" di una base dati.

Come precedentemente descritto vengono presentati nella prima parte della maschera i "**parametri generici di connessione**" e subito dopo i bottoni per il richiamo delle funzionalità specifiche.

<wrap important>La compilazione dei campi //host// e //port// è facoltativa. Il loro valore di default consente di collegarsi all'istanza di eXtraWay Server installata in locale, che è solitamente la condizione di default.\\ Indicando un diverso host o una porta diversa da quella di default (4859) si può accedere a qualsiasi altro server eXtraWay quindi si prega di prestare la massima attenzione a quale sia il server con il quale si opera.</wrap>

L'indicazione del nome logico del Database è obbligatoria. Il nome logico è il nome associato ad un Database((Ogni Database può avere più //alias//). Esso può essere configurato esplicitamente per un Database o derivato dal suo nome((Un Database collocato nella directory standard in una cartella avente lo stesso nome del Database verrà reperito per mezzo di tale nome indipendentemente dalla configurazione del server eXtraWay)).

====Renew cache====

A seguito di operazioni effettuate direttamente sulla base dati (tramite la console amministrativa) o a seguito di operazioni eseguite direttamente sul file system può essere necessario rigenerare il titolo (cache) associato ad ogni singolo record (secondo le indicazioni contenute nel file <nomearchivio>.conf.xml). Questo genere di operazione avviene in maniera asincrona e si ha immediatamente una risposta di attività completata seppure essa ci indica semplicemente che il processo //batch// è stato avviato. Richiesta la ricostruzione della cache il servizio è comunque funzionante (la cache non ancora ricalcolata verrà calcolata dal server a richiesta) ma potrebbe avere prestazioni più modeste.

====Reopen====

Se si compiono modifiche al file di configurazione dell'archivio in esame (solo modifiche che non intacchino catalogo ed indici) e si vuole che i server ne prendano visione immediatamente (altrimenti si renderanno conto di tali modifiche solo alla prossima effettiva apertura di quest'archivio) si può eseguire questo comando. Dopo aver eseguito tale comando, se l'operazione di riapertura ha avuto esito positivo, viene data opportuna notifica (come da figura sotto riportata).

====Compact====

<wrap alert>Obsoleto</wrap>\\ 
Alcune operazioni effettuate sulle //unità informative// (di un Database) non hanno necessariamente un effetto diretto in termine di occupazione sul //file system//: i files xml (in cui sono organizzate le //unità informative//) vengono solitamente parzialmente riscritti lasciando all'interno degli stessi files delle zone di "sfrido" (utilizzabili successivamente). Per effettuare quindi il pieno recupero dello spazio occupato sul file system eliminando contestualmente alche tutti i riferimenti ai files obsoleti (perché mossi in altra locazione o cancellati) occorre utilizzare il comando "compact".

Quando il comando viene recepito viene presentata una pagina che mostra uno stato di avanzamento. È possibile proseguire monitorando lo stato di avanzamento dell'operazione con il bottone "**watch...**" o decidere di tornare alla prima pagina o pagina "**database...**" tramite l'ancora/collegamento ipertestuale presente nell'intestazione.

Se si decide di proseguire per monitorare lo stato di avanzamento dell'operazione richiesta viene presentata una nuova pagina. La nuova pagina viene "rinfrescata" automaticamente per consentire la visualizzazione delle informazioni sullo stato di avanzamento delle operazioni richieste. Al termine dell'operazione richiesta viene presentato un sunto di quanto è stato effettuato.

====Relocate====

<wrap alert>Obsoleto</wrap>\\ 
La piattaforma eXtraWay è uno strumento XML Nativo: l'XML è eletto ad un ruolo centrale, come forma di rappresentazione e soprattutto di conservazione delle unità elementari di informazione o //unità informative// e cioè le //unità// //informative// sono direttamente disponibili su //file// //system// sotto forma di files XML. Inoltre, per favorire nel tempo una conservazione del dato, le //unità informative// vengono raggruppate/agglomerate in cartelle e sotto cartelle per soddisfare specifici criteri logici. Nel file <nomearchivio>.conf.xml (specifico per ogni archivio) può quindi essere presente e opportunamente configurato un elemento "nile_location" atto a stabilire la distribuzione delle //unità informative// su //file// //system//. Le modifiche apportate alla regola di distribuzione non hanno effetto "retroattivo" sulle //unità informative// già presenti. Per applicare immediatamente tali modifiche occorre utilizzare il comando "Relocate". Quando il comando viene recepito viene presentata una nuova pagina (come da figura sotto riportata).

A questo punto è possibile proseguire monitorando lo stato di avanzamento dell'operazione con il bottone "**watch...**" o decidere di tornare alla prima pagina o pagina "**database...**" tramite l'ancora/collegamento ipertestuale presente nell'intestazione.

Se si decide di proseguire per monitorare lo stato di avanzamento dell'operazione richiesta viene presentata una nuova pagina. La nuova pagina viene "rinfrescata" automaticamente per consentire la visualizzazione delle informazioni sullo stato di avanzamento delle operazioni richieste. Al termine dell'operazione richiesta viene presentato un sunto di quanto è stato effettuato (come da figura sotto riportata).

==== Mappa degli archivi ====

Quando un archivio viene creato per la prima volta ovvero quando necessiti di una manutenzione straordinaria ed di una ricostruzione integrale, si procede al rifacimento della Mappa dell'archivio.
Essa genera un archivio nuovo((Nel caso di archivio nuovo viene applicato un file di configurazione di default che guidi gli operatori a compilare quello definitivo)) (a patto che si sia indicato un nome logico non assegnato ad alcun altro archivio) ovvero distrugge la Mappa di un archivio esistente (mantenendo inalterati tutti i suoi contenuti così da poterlo ricostruire).

La ricostruzione della Mappa degli archivi si effettua nella pagina che appare cliccando sul tasto "Database...":
\\
{{:documentazione_3di:extraway_os:manuali:console2.png?800|Console - Database}}
\\
\\
\\
E' suddivisa in due fasi:

  * Creazione dell'archivio ex-novo, ovvero cancellazione della Mappa dell'archivio esistente
  * Ricostruzione della Mappa, seguita da ricostruzione degli indici e dei titoli (cache)
Per garantire un corretto funzionamento del database è importante controllare che entrambe le operazioni vadano a buon fine.
\\
\\
\\
Operazioni da eseguire:
  * <color darkblue>Inserire il nome dell'archivio nel campo "db (logical)".</color>
  * <color darkblue>Inserire il percorso completo del nome che avranno tutti i file dell'archivio estensione esclusa a fianco di "Create".</color>
  * <color darkblue>Premere il tasto "Create".</color>
  * <color darkblue>Attendere la risposta "Done!" e premere indietro sul browser.</color>
  * <color darkblue>Inserire il percorso della cartella dell'archivio in cui sono collocati i file XML da analizzare nel campo di testo a fianco di "Map".\\ Tipicamente i due valori sono identici, ma quest'ultimo va completato con una barra di separazione directory in coda.</color>
  * <color darkblue>Premere il tasto "Map".</color>
\\
<wrap important>ATTENZIONE: salvo specifiche indicazioni da parte di 3D Informatica, lasciare le spunte delle caselle sottostanti inalterate</wrap>
\\
E' possibile tenere sotto osservazione lo(svolgimento della ricostruzione della Mappa dell'archivio tramite la pagina watch:
\\
<code>http://<nome_macchina>:8080/console/engine/watch.jsp</code>
\\
  * <color darkblue>Selezionare una o tutte le procedure che si desidera tenere sotto osservazione.</color>
\\
\\
<color #505050>//ATTENZIONE: non spegnere i servizi tomcat o extraway durante la ricostruzione di Mappa ed Indici ed in generale di tutte le attività interattive in cui il server comunica, man mano, uno stato di avanzamento, altrimenti il processo verrà interrotto e sarà necessario eseguirlo nuovamente.//</color>

=====Record=====

====Search and view====

Tramite questo comando è possibile accedere al **viewer**. \\
Il **viewer** è uno strumento che consente l'accesso ad un archivio, la consultazione dei suoi vocabolari, l'esecuzione di selezioni e la visualizzazione dei risultati ottenuti (sotto forma di titolo o di record).

Prima di eseguire il comando "Search and view" è necessario valorizzare il campo Db (logical) per indicare l'archivio sul quale agire.

Quando si esegue il comando "Search and view"  viene presentata una nuova pagina all'interno della quale sostanzialmente troviamo:

  *versione del viewer (ad esempio Extraway Viewer 1.1.8)
  *elenco dei canali di ricerca
  *form per la formulazione della frase di ricerca
  *comandi per eseguire un'esportazione della selezione ottenuta

{{ :documentazione_3di:extraway_os:manuali:extrawayviewer.png |}}

L'elenco composto da tutti i canali di ricerca rilevati dal server nella fase di costituzione degli indici viene tipicamente presentato ordinato in maniera crescente (alfabetica) per nome di canale.\\
Ad ogni canale è associata una descrizione delle sue caratteristiche (identificativo alias, identificativo tesauro, tipo di indicizzazione, etc etc):

  /doc/@anno/ DOC_ANNO

Selezionando (singolo click) la voce corrispondente al nome del canale si accede alla visualizzazione del suo vocabolario.

{{ :documentazione_3di:extraway_os:manuali:vocabolario1.png |Vocabolario canale /doc/@anno}}

E' possibile selezionare uno o più termini utilizzando il controllo di tipo check box posto lateralmente al termine presentato e poi utilizzare il pulsante "torna" per riportare tutti i termini selezionati all'interno della form per la formulazione della frase di ricerca.

  Esempio di frase di ricerca: ([/doc/@anno/]="2012" OR "2013")

Una volta riportati i termini è possibile utilizzare il bottone "cerca" per avviare la ricerca.

L'esito della ricerca viene mostrato in una nuova finestra e se positivo (se sono stati selezionati dei record) viene mostrato sotto sotto forma di "titoli", rappresentativi dei record selezionati (per la composizione dei titoli si rimanda all'apposita [[http://wiki.3di.it/doku.php?id=documentazione_3di:extraway_os:manuali:arcprofile#configurazione_titoli|sezione]]).

{{ :documentazione_3di:extraway_os:manuali:titoliconsole.png |}}

Dal titolo è poi possibile passare alla visualizzazione del record esteso facendo click sull'ancora/collegamento ipertestuale. Si tratta della visualizzazione del documento in formato xml, esattamente come viene conservato da eXtraWay.

{{ :documentazione_3di:extraway_os:manuali:docxml.png |}}

Il pulsante **Esporta selezione** consente di esportare, in formato xml, i risultati dell'ultima ricerca effettuata (infatti finché non viene effettuata una ricerca, il pulsante non risulta attivo). \\
Al momento dell'esecuzione del comando, il sistema chiede all'utente di inserire il nome del file contenente l'esportazione per poterlo recuperare più facilmente al termine dell'esportazione.

{{ :documentazione_3di:extraway_os:manuali:nomefile.png |Inserimento del nome del file contente l'esportazione}}

Al termine dell'operazione il file sarà presente nella directory dei [[http://wiki.3di.it/doku.php?id=en:documentazione_3di:extraway_os:overview#directory_tmp|file temporanei di eXtraWay]].\\ Il file risultante dall'esportazione avrà una struttura simile alla seguente. Nel nostro esempio si avrà un elemento denominato **<list_of_doc>**, che funge da //primary node container element// che contiente i singoli documenti identificati dall'elemento **<doc>**, che nel nostro esempio è il //primary node element// ovvero l'elemento che consente di identificare, e quindi racchiude in se, il record.

<code>
<?xml version="1.0" encoding="iso-8859-1"?>
  <!-- 
  <!DOCTYPE xw_export SYSTEM "http://www.3di.it/extraway/xexport_20060517.dtd">
  -->
  <list_of_doc  xmlns:xw="http://www.3di.it/ns/xw-200303121136">
  <!-- 
  <global_info type="archive" value="/opt/3di.it/extraway/xw/db/xdocwaydoc/xdocwaydoc"/>
  <global_info type="selefile" value="3se01~14~0120b5535fbbb42ad01"/>
  <global_info type="document.first" value="1"/>
  <global_info type="document.last" value="173"/>
  -->
    <doc>...</doc>
    <doc>...</doc>
    <doc>...</doc>
    <doc>...</doc>
  </list_of_doc>
</code>

====Hash====

<wrap alert>Obsoleto</wrap>\\ 
Tramite questo comando è possibile ricalcolare l'impronta degli allegati associati ad un documento di un determinata selezione.
La selezione può comprendere una o più unità.
Va inserita una frasi di ricerca (in sintassi ExtraWay) come da figura. 

{{:documentazione_3di:manuale_amministratore_titulus3:hash.png|}}

Cliccando sul bottone a fianco (hash) si attiva la procedura di ricalcolo dell'impronta degli allegati.

E' possibile monitarare l'andamento della progressione del ricalcolo della impronta mediante la pagina proposta.

=====Index=====

Il macro comando ''Index'' consente l'esecuzione di diversi comandi che agiscono sugli indici di un archivio.
{{:documentazione_3di:extraway_os:manuali:console3.png?800|}}
====Update====
<wrap important>eXtraWay Standard Edition Only</wrap>\\ 
Per archivi privi di indici o parzialmente indicizzati, consente di completare gli indici esistenti con quelli mancanti. Da usare solo se necessario, altrimenti va favorito il ''Rebuild'' (Vds.).

====Rebuild====

Il comando di "ricostruzione indici" è un comando composto: in primo luogo effettua un azzeramento completo degli indici (comando "delete") e poi successivamente procede ad una rigenerazione degli stessi (comando "update").

Quando il comando viene recepito viene presentata una nuova pagina (come da figura sotto riportata).

A questo punto è possibile proseguire monitorando lo stato di avanzamento dell'operazione con il(bottone "**watch...**" o decidere di tornare alla prima pagina o pagina "**database...**" tramite l'ancora/collegamento ipertestuale presente nell'intestazione.

Se si decide di proseguire per monitorare lo stato di avanzamento dell'operazione richiesta viene presentata una nuova pagina.
La nuova pagina viene "rinfrescata" automaticamente per consentire la visualizzazione delle informazioni sullo stato di avanzamento delle operazioni richieste. Essa presenta in prima battuta il numero di record elaborati rispetto al totale ed in seguito l'avanzamento in percentuale della fase finale di combinazione degli indici calcolati nei passi precedenti.

Al termine dell'operazione richiesta viene presentato un sunto di quanto è stato effettuato.

====Compact====

Comando che si utilizza solo in rari casi, quando ad esempio l'archivio divenga statico o sia destinato a supporti di sola lettura.

====Check====
Compie il controllo del vocabolario ed indica se esso abbia o meno riscontrato errori, con un sistema sostanzialmente analogo agli altri stat di avanzamento.\\ 
<wrap info>eXtraWay Enterprise Edition only</wrap>: al termine delle operazioni, nella cartella <nomearchivio>pwa, sarà presente il file di log con i rilevamenti e le statistiche compiuti in questa sede.

====Delete====
Cancella il vocabolario (indici) dell'archivio

====List/Compare====

<wrap alert>Obsoleti</wrap>

=====Thesaurus=====

Come abbiamo precedentemente accennato al punto 8.2.1 del presente manuale, alcuni canali hanno tra le loro caratteristiche l'abbinamento ad un "thesaurus". I comandi esposti qui di seguito consentono di effettuare operazioni di manutenzione sulla lista di termini (e relazioni) degli specifici tesauri.

====List====

Il comando consente (dato un archivio ed un nome di canale valido) di visualizzare l'elenco dei termini previsti per il canale stesso. Supponendo quindi di voler visualizzare la lista dei termini previsti per il canale  (dell'archivio ) occorre inserire le informazioni relativamente al nome del canale ("field") e successivamente utilizzare il pulsante "submit" per inviare le informazioni specificate.

Quando il comando viene recepito viene presentata una nuova pagina (come da figura sotto riportata).

====Export====

Analogamente alle operazioni effettuate per visualizzare la lista dei termini costituenti il "thesaurus" di un singolo canale è possibile richielere l'esportazione in formato testuale tramite il comando "export".

Dopo aver imputato le informazioni necessarie (nome del canale/campo o elenco canali/campi) è possibile utilizzare il bottone "esegui" per avviare il processo.

Il processo termina con la creazione del file contenente quanto richiesto ("thesaurus.txt") e dando la possibilità all'utente che ne ha fatto richiesta di effettuarne lo scaricamento..

Se si utilizza un editor per aprire il file ci si rende immediatamente conto che il formato di esportazione ha una strutturazione molto simile a quella vista in fase di visualizzazione con il comando "list".

====Import====

Il comando "Import" consente appunto di importare nuovi termini ill'interno di un "thesaurus" di un archivio per uno specifico "canale". Il formato di importazione accettato è esattamente quello prodotto dal comando "Export". L'importazione avviene in forma esclusivamente incrementale e cioè è prevista solo l'aggiunta di termini (non è possibile effettuare la cancellazione o l'aggiornamento di termini presenti). Se all'interno(del file di importazione vengono specificati termini già presenti l'operazione prosegue senza dare segnalazioni di sorta e senza produrre duplicazioni dei termini.

Dopo aver specificato manualmente il nome del file (comprensivo di path) da importare (oppure in alternativa utilizzare il bottone "Sfoglia") è possibile avviare il processo di importazione con il bottone "Invia query". Quando il comando viene recepito viene presentata una nuova pagina (come da figura sotto riportata).

A questo punto è possibile proseguire monitorando lo stato di avanzamento dell'operazione con il bottone "**watch...**" o decidere di tornare alla prima pagina o pagina "**database...**" tramite l'ancora/collegamento ipertestuale presente nell'intestazione.

Se si decide di proseguire per monitorare lo stato di avanzamento dell'operazione richiesta viene presentata una nuova pagina.

La nuova pagina viene "rinfrescata" automaticamente per consentire la visualizzazione delle informazioni sullo stato di avanzamento delle operazioni richieste. Al termine dell'operazione richiesta viene presentato un sunto di quanto è stato effettuato (come da figura sotto riportata).

=====Connection=====

Racchiude informazioni più generiche sul server, non richiede la compilazione del campo ''db (logical)''
{{:documentazione_3di:extraway_os:manuali:console4.png?800|}}

====Watch====

Consente di riprendere la visione dei processi in corso che prevedano stato di avanzamento. In questo modo, anche se si torna in un secondo momento a verificare lo stato di avanzamento di un'attività richiesta, si può osservare se sia terminata ed in che modo.

====List====

Presenta un elenco delle connessioni attualmente presenti (è lo strato Java di comunicazione con eXtraWay a risponderci, non eXtraWay Server). Per ciascuna indica il nome logico dell'archivio attualmente in uso, il numero di porta, l'host di riferimento ed altre informazioni utili.

====Server Info====

Riporta le principali informazioni sul server eXtraWay (necessita di host e port se non ci si riferisce a quello locale).
{{:documentazione_3di:extraway_os:manuali:console6.png?800|}}

====Get mail/Send mail====

<wrap alert>Obsoleti</wrap>

====Headers/Properties====

<wrap info>In via di documentazione</wrap>