Documentazione delle risorse

Oltre alla visualizzazione delle risorse, potrebbe essere necessario documentare le applicazioni che si stanno creando. WebSphere Integration Developer fornisce uno strumento per generare la documentazione per le risorse nei moduli, nei moduli di mediazione e nelle librerie.

Iniziare la generazione della documentazione richiamando una procedura guidata. E' possibile personalizzare il contenuto della documentazione selezionando più risorse da uno o più moduli e librerie, in modo che tutte le informazioni siano scritte in un report unico, ovvero un file PDF. Inoltre, è possibile specificare il layout e i font dell'output. Per istruzioni dettagliate sulla generazione della documentazione, consultare le attività correlate.

Documentazione delle risorse

L'utilità di generazione della documentazione produce le seguenti informazioni per le risorse di seguito riportate:

Altre risorse non verranno documentate dall'utilità di generazione della documentazione.

File di riferimento

Inoltre, l'utilità di generazione della documentazione può produrre la documentazione per le risorse selezionate e le risorse cui si fa riferimento. Ad esempio, nella procedura guidata Generazione della documentazione, è possibile selezionare il processo business e l'opzione Includi file di riferimento. Come risultato, il report PDF generato dispone anche delle informazioni per le risorse (quali le interfacce richiamate dalle relative attività) cui fa riferimento il processo.

Struttura della documentazione

Il report PDF generato dispone della seguente struttura:

  • Pagina del Titolo

    Dispone del titolo, del nome dell'autore e della data del report.

  • Indice

    Elenca i numeri di pagina e di sezione del report.

  • Sezioni della documentazione delle risorse

    Elenca le proprietà delle risorse. Escluso per il modulo e la libreria, tutte le risorse dispongono anche di immagini delle risorse aperte nella vista Editor.

  • Riferimento incrociato

    Elenca per ciascuna risorsa documentata la risorsa utilizzata (elenco Provider) e dove viene utilizzata (elenco Destinatari).

  • Appendice: Impostazioni di generazione della documentazione

    Elenca le impostazioni relative alla generazione della documentazione specificate nella procedura guidata Generazione della documentazione ed utilizzate per il report PDF.

Layout e stile della documentazione

Il layout e lo stile del report PDF generato può essere personalizzato con la procedura guidata Generazione della documentazione. Se si modificano le impostazioni di layout e di stile, tali modifiche vengono salvate per tutte le successive generazioni della documentazione, fino a quando non vengono di nuovo modificate.

E' possibile modificare le seguenti impostazioni di layout:

  • Dimensione carta

    Definisce la dimensione della carta della documentazione generata.

    Valore predefinito: Letter

  • Livello di indice

    Definisce il livello massimo degli argomenti da elencare nell'indice del report.

    Valore predefinito: 7

  • Font
    Definisce la famiglia di font, la dimensione e lo stile di font dell'output: Le impostazioni relative ai font predefinite sono:
    • Testo normale

      • Utilizzato per la descrizione e la documentazione di varie risorse. La famiglia di font del testo normale viene utilizzata anche per la pagina del titolo, per i paragrafi e le note a piè pagina.
      • Famiglia di font predefinita: Helvetica
      • Dimensione font predefinita: 10
      • Stile font predefinito: regolare
    • Titolo capitolo

      • Utilizzato per i paragrafi numerati, l'intestazione dell'indice e l'intestazione dell'appendice
      • Famiglia di font predefinita: Helvetica
      • Dimensione font predefinita: 14
      • Stile font predefinito: grassetto
    • Testo del codice sorgente

      • Utilizzato per la documentazione del codice sorgente, come ad esempio Java
      • Famiglia di font predefinita: Courier
      • Dimensione font predefinita: 10
      • Stile font predefinito: regolare
    • Testo titolo

      • Utilizzato per il titolo delle figure
      • Famiglia di font predefinita: Helvetica
      • Dimensione font predefinita: 10
      • Stile font predefinito: grassetto
    • Testo di definizione

      • Utilizzato per la documentazione delle coppie chiave-valore
      • Famiglia di font predefinita: Helvetica
      • Dimensione font predefinita: 10
      • Stile font predefinito: regolare
    • Testo intestazione

      • Utilizzato per i paragrafi numerati
      • Famiglia di font predefinita: Helvetica
      • Dimensione font predefinita: 11
      • Stile font predefinito: grassetto
    • Indice

      • Utilizzato per l'indice
      • Famiglia di font predefinita: Helvetica
      • Dimensione font predefinita: 9
      • Stile font predefinito: regolare

File master per salvare le impostazioni

Un file master è un profilo della risorsa che definisce il contenuto (non gli stili del font) da includere nella documentazione generata. Quando si utilizza la procedura guidata Generazione della documentazione, creare un file master per salvare le selezioni della risorsa e utilizzare, la volta successiva, la procedura guidata per generare lo stesso report, selezionando solo il file master.

Registra nuovi font

L'utilità di generazione della documentazione fornisce tre font predefiniti che è possibile utilizzare nella documentazione. Tali font sono Helvetica, Courier e Times con gli stili di font: regolare, corsivo, grassetto e corsivo grassetto.

E' possibile aggiungere un nuovo font, ovvero un file true type (.ttf) o un file di raccolta true type (.ttc) registrandolo. La registrazione dei font viene effettuata dalla procedura guidata Generazione della documentazione. Una volta registrato un font, può essere utilizzato per tutti i report fino a quando non viene rimosso. I font predefiniti non possono essere rimossi. Per istruzioni sul modo in cui effettuare attività con la procedura guidata Generazione della documentazione, consultare l'argomento "Generazione della documentazione" negli argomenti correlati.

Nota: Nella procedura guidata Generazione della documentazione, i nomi dei font registrati, compresi quelli dei font della serie di caratteri a due byte, vengono visualizzati solo in caratteri latini.

File di traccia

L'utilità di generazione della documentazione può scrivere messaggi di traccia relativi alla generazione della documentazione in un file di traccia. Nota: non attivare la funzione di traccia se non si è verificato un problema con l'utilità di generazione della documentazione, poiché la traccia ha un impatto sulle prestazioni del sistema e occupa molto spazio su disco. La traccia viene impostata nella finestra Preferenze e l'output viene scritto in un file di testo nella directory dei metadati (nome dello spazio di lavoro\.metadata\.plugins\com.ibm.wbit.reporting.infrastructure\trace\). Le voci di log vengono apposte e mai cancellate.

Concetti correlati
Moduli e librerie
Dipendenze di moduli e librerie
Capacità e ruoli Business integration
Cheat sheet di Business integration
Attività correlate
Creazione di un modulo per i servizi aziendali
Creazione di un modulo di mediazione
Modifica dello spazio dei nomi predefinito
Abilitazione delle capacità degli strumenti
Aggiunta di dipendenze ai moduli e alle librerie
Creazione della libreria
Generazione della documentazione

Informazioni correlate

Supporto didattico: Attività con i moduli e le librerie

Commenti
(C) Copyright IBM Corporation 2005, 2006. Tutti i diritti riservati.