Legami di documentazione
La funzione di gestione dei legami di documentazione permette di associare, ad una determinata documentazione, dei legami verso elementi del dizionario. Questi elementi sono utilizzati, a complemento delle informazioni trovate nel dizionario, per generare automaticamente i paragrafi ed il loro contenuto, soprattutto nelle sezioni prerequisiti e le sezioni allegati finali.
Legami secondo i tipi di documetazione
L'elenco dei legami esistenti ed il modo in cui sono utilizzati secondo il tipo di documentazione d'origine, viene fornito in seguito. Si trovano in questi riquadri una colonna Compl.
Questa colonna indica, quando è a Si, che i legami descritti da questo codice vadano a complemento dei legami trovati nel dizionario. Così, quando si genera una documentazione funzionale, le finestre, le tabelle, gli oggetti a lui associati sono analizzati per ritrovare i codice attività associati, ma è possibile che un codice attività non collegato direttamente alla funzione influisca sul suo funzionamento. Si aggiungerà allora questo codice attività tramite un legame.
Quando la colonna Compl è a No, nessun altra informazione del dizionario permette di definire il legame in questione. E' quindi obbligatorio indicare questo tipo di legame se si vuole che questa informazione figuri nella documentazione generata. Bisogna notare che in alcuni casi (tabelle diverse, menù locali), si potrebbero trovare legami di questo tipo, ma in maniera poco affidabile (in questo caso interessano solo le tabelle diverse ed i menù locali la cui parametrizzazione è un prerequisito della funzione).
Funzioni
Le documentazioni delle funzioni (codici AFC) possono essere arricchite da legami del seguente riquadro.
Legame | Significato | Utilizzo in fase di generazione della documentazione | Compl |
ACV | Codice attività | Elenco dei codici attività coinvolti nei prerequisiti. | Sì |
ADP | Parametro | Parametri relativi ai prerequisiti. | No |
ANM | Contatori | Elenco dei contatori associati alla funzione nei prerequisiti. | No |
GAU | Movimenti automatici | Elenco dei movimenti automatici associati alla funzione nei prerequisiti. | No |
CDE | Codici sezione | Elenco dei codici sezione associati alla funzione nei prerequisiti. | No |
TRS | Transazioni | Elenco delle funzioni che permettono di definire delle transazioni per la funzione documentata. | No |
ADI | Tabelle diverse | Elenco delle tabelle diverse nei prerequisiti funzione. | No |
AML | Menù locali | Elenco dei menù locali da parametrizzare nei prerequisiti. | No |
ARP | Stampe | Stampe lanciate dalla funzione. | Sì |
ABT | Job batch | Allegato delle job batch che permettono di lanciare la funzione. | Sì |
ATB | Tabelle | Tabelle utilizzate nella funzione. | Sì |
Osservazione : la ricerca dei codici attività a partire dalle funzioni nel dizionario è molto esaustiva, ed è in grado di restituire alcuni codici attività la cui presenza non è necessariamente desiderata. Per tamponare tale comportamento, basta creare un legame verso il codice attività FAL (sempre falso). Dal momento in cui è inserito un legame di questo tipo, solo gli altri codici attività presenti nell'elenco dei legami vengono restituiti.
Parametri
Le documentazioni delle funzioni (codici ADP) possono essere arricchite dai legami del seguente riquadro.
Legame | Significato | Utilizzo in fase di generazione della documentazione | Compl |
AFC | Funzione | Elenco delle funzioni interessate nell'help che descrive il parametro. | No |
ACV | Codice attività | Elenco dei codici attività associati. | Sì |
AOE | Modelli import/export | Elenco dei modelli di import export che utilizzano questo parametro. Questo legame è utilizzato solo in maniera reciproca (per ottenere i parametri associati ai modelli nelle documentazioni in questione). | No |
AT2 | Tabelle prerequisiti | Elenco delle tabelle da indicare nei prerequisiti. | No |
Variabili di dimensionamento
Le documentazioni delle funzioni (codici ADM) possono essere arricchite dai legami del seguente riquadro.
Legame | Significato | Utilizzo in fase di generazione della documentazione | Compl |
ATB | Tabelle dimensionate | Elenco delle tabelle dimensionate dalla variabile. | Sì |
Modelli import/export
Le documentazioni dei modelli import/export (codici AOE) possono essere arricchite dai legami del seguente riquadro.
Legame | Significato | Utilizzo in fase di generazione della documentazione | Compl |
ADP | Parametri interessati | Elenco dei parametri che influiscono sul funzionamento del modello. Si noti che sono analizzati anche i legami reciproci. | No |
AT2 | Tabelle prerequisiti | Elenco delle tabelle menzionate nei prerequisiti di utilizzo. | No |
ATB | Tabelle aggiornate | Elenco delle tabelle aggiornate | Sì |
Stampe
Le documentazioni dei modelli di stampe (codici ARP) possono essere arricchite dai legami del seguente riquadro.
Legame | Significato | Utilizzo in fase di generazione della documentazione | Compl |
ATB | Tabelle stampate | Elenco delle tabelle il cui contenuto alimenta la stampa | Sì |
Eventi di Workflow
Le documentazioni degli eventi di Workflow (codici AWA) possono essere arricchite dai legami del seguente riquadro.
Legame | Significato | Utilizzo in fase di generazione della documentazione | Compl |
ATB | Tabelle del contesto | Elenco delle tabelle il cui contenuto fa parte del contesto di attivazione | Sì |
Azioni
Le documentazioni delle funzioni (codici ACT) possono essere arricchite dai legami del seguente riquadro.
Legame | Significato | Utilizzo in fase di generazione della documentazione | Compl |
ACT | Azioni collegate | Azioni collegate alla precedente | Sì |
Attivatori statistici
Le documentazioni degli attivatori statistici (codici PS1) possono essere arricchite dai legami del seguente riquadro.
Legame | Significato | Utilizzo in fase di generazione della documentazione | Compl |
ATB | Tabelle | Tabelle utilizzate nel contesto di attivazione | Sì |
Caso particolare degli entry point
Gli entry point si basano in maniera un pò particolare sui legami. Infatti:
- l'elemento del dizionario che viene documentato è il programma nel dizionario dei programmi
- ogni entry point è definito da un legame verso il tipo APE ed il codice associato è il nome dell'entry point. I legami che seguono (fino al prossimo legame APE) caratterizzano questo entry point. Se esistono delle caratteristiche comuni prima del primo legame APE, si suppone che siano valide di default per tutti gli entry point.
- i legami ATB et AT2 sono utilizzati per definire le tabelle aperte (rispettivamente con un contenuto significativo o non significativo)
- il legame TRS permette di definire se vi è una transazione in corso (valore 2) o meno (valore 1)
- il legame TRA permette di definire se vi è un file traccia aperto (valore 2) o meno (valore 1)
Così, se si ha il seguente riquadro di legami:
| TRS | 1 |
| TRA | 2 |
| ATB | TABELLA1 |
| AT2 | TABELLA2 |
| APE | POINT1 |
| ATB | TABELLA3 |
| APE | POINT2 |
| TRA | 1 |
| APE | POINT3 |
| AT2 | TABELLA4 |
Il programma dispone di 3 entry point POINT1, POINT2, POINT3:
- L'entry point POINT1 non ha transazioni aperte, gestisce una traccia, la tabella TABELLA1 è in linea e significativa, la tabella TABELLA2 è in linea senza essere significativa (valori di default), la tabella TABELLA3 è in linea e significativa.
- L'entry point POINT2 ha gli stessi valori di default, eccetto che non vi è traccia, (la tabella TABELLA3 non è in linea).
- L'entry point POINT3 ha di default gli stessi valori (una traccia è aperta). La tabella TABELLA4 è aperta senza essere significativa.