Dokumentationslinks
Mit der Verwaltungsfunktion Dokumentationslinkskönnen einer gegebenen Dokumentation Links zu den Dictionary-Elementen zugeordnet werden. Diese Elemente werden zusätzlich zu den Dictionary-Daten für die automatische Generierung von Absätzen sowie deren Inhalten verwendet, insbesondere für die Bereiche Voraussetzungen und Anhänge.
Links nach Dokumentationstypen
Im Folgenden werden die vorhandenen Links und ihre Verwendungsweise nach Dokumentationstypen aufgelistet. Diese Tabellen umfassen eine Spalte Zusatz.
Wenn diese Spalte auf Jagesetzt ist, werden die durch den entsprechenden Code definierten Links zusätzlich zu den Dictionary-Links verwendet. Bei der Generierung einer Funktionsdokumentation werden die zugeordneten Fenster, Tabellen und Objekte analysiert, um die zugehörigen Aktivitätscodes zu ermitteln. Die Funktionsweise der Funktion kann jedoch auch von einem Aktivitätscode beeinflusst sein, der mit der betreffenden Funktion nicht direkt verbunden ist. Solche Aktivitätscodes werden per Link hinzugefügt.
Wenn die Spalte Zusatz auf Neingesetzt ist, kann mit keinen weiteren Dictionary-Daten der entsprechende Link definiert werden. Wenn der Link in der generierten Dokumentation aufgeführt werden soll, muss er eigens erfasst werden. In bestimmten Fällen (Sonstige Tabellen, Lokale Menüs) sind diese Links weniger verlässlich (in diesem Falle interessieren wir uns lediglich für diejenigen Sonstigen Tabellen und Lokalen Menüs, deren Parametrierung zu den Voraussetzungen der Funktion zählen).
Funktionen
Die Funktionsdokumentationen (AFC) können um die Links der nachstehenden Tabelle erweitert werden.
Link | Bedeutung | Verwendung bei der Dokumentationsgenerierung | Zusatz |
ACV | Aktivitätscode | Liste der betreffenden Aktivitätscodes in den Voraussetzungen | Ja |
ADP | Parameter | Betroffene Parameter in den Voraussetzungen. | Nein |
ANM | Nummernkreise | Liste der der Funktion in den Voraussetzungen zugeordneten Aktivitätscodes | Nein |
GAU | Automatik-Belege | Liste der der Funktion in den Voraussetzungen zugeordneten Automatik-Belege | Nein |
CDE | Sektorcodes | Liste der der Funktion in den Voraussetzungen zugeordneten Sektorcodes | Nein |
TRS | Transaktionen | Liste der Funktionen, mit denen Transaktionen für die dokumentierte Funktion definiert werden können | Nein |
ADI | Sonstige Tabellen | Liste der Sonstigen Tabellen in den Funktionsvoraussetzungen | Nein |
AML | Lokale Menüs | Liste der in den Voraussetzungen zu parametrierenden Lokalen Menüs | Nein |
ARP | Berichte | Aus der Funktion gestartete Berichte | Ja |
ABT | Batchaufgaben | Anhang zu den Batchaufgaben, mit denen die Funktion aufgerufen werden kann | Ja |
ATB | Tabellen | In der Funktion verwendete Tabellen | Ja |
Hinweis : Die Suche nach Aktivitätscodes aus den Dictionary-Funktionen ist sehr umfangreich und gibt möglicherweise bestimmte Aktivitätscodes zurück, die nicht unbedingt erwünscht sind. Um dieses Verhalten zu vermeiden, kann ein Link zum Aktivitätscode FAL (immer falsch) angelegt werden. Wird ein Link von einem solchen Typ eingefügt, werden lediglich die anderen in der Liste vorhandenen Aktivitätscodes zurückgegeben.
Parameter
Die Funktionsdokumentationen (ADP) können um die Links der nachstehenden Tabelle erweitert werden.
Link | Bedeutung | Verwendung bei der Dokumentationsgenerierung | Zusatz |
AFC | Funktion | Liste der betroffenen Funktionen in der Parameterhilfe. | Nein |
ACV | Aktivitätscode | Liste der zugeordneten Aktivitätscodes | Ja |
AOE | Import- / Exportmodelle | Liste der Import- / Exportmodelle, in denen der Parameter verwendet wird. Dieser Link wird nur reziprok verwendet (zur Ermittlung der den Modellen in der betreffenden Dokumentation zugeordneten Parameter). | Nein |
AT2 | Benötigte Tabellen | Liste der in den Voraussetzungen zu parametrierenden Tabellen | Nein |
Dimensionierungsvariable
Die Funktionsdokumentationen (ADM) können um die Links der nachstehenden Tabelle erweitert werden.
Link | Bedeutung | Verwendung bei der Dokumentationsgenerierung | Zusatz |
ATB | Mehrdimensionale Tabellen | Liste von mehrdimensionalen Tabellen nach Variablen | Ja |
Import- / Exportmodelle
Die Dokumentationen der Import- / Exportmodelle (AOE) können um die Links der nachstehenden Tabelle erweitert werden.
Link | Bedeutung | Verwendung bei der Dokumentationsgenerierung | Zusatz |
ADP | Betroffene Parameter | Liste der Parameter, die sich auf die Funktionsweise des Modells auswirken. Auch die reziproken Links werden durchlaufen. | Nein |
AT2 | Benötigte Tabellen | Liste der in den Verwendungsvoraussetzungen erwähnten Tabellen | Nein |
ATB | Aktualisierte Tabellen | Liste der aktualisierten Tabellen | Ja |
Berichte
Die Berichtsdokumentationen (ARP) können um die Links der nachstehenden Tabelle erweitert werden.
Link | Bedeutung | Verwendung bei der Dokumentationsgenerierung | Zusatz |
ATB | Ausgegebene Tabellen | Liste der Tabellen, mit deren Daten der Bericht belegt wird | Ja |
Workflow-Ereignisse
Die Dokumentationen der Workflow-Ereignisse (AWA) können um die Links der nachstehenden Tabelle erweitert werden.
Link | Bedeutung | Verwendung bei der Dokumentationsgenerierung | Zusatz |
ATB | Kontexttabellen | Liste der Tabellen, deren Daten zum Triggerkontext zählen | Ja |
Aktionen
Die Aktionsdokumentationen (ACT) können um die Links der nachstehenden Tabelle erweitert werden.
Link | Bedeutung | Verwendung bei der Dokumentationsgenerierung | Zusatz |
ACT | Verbundene Aktionen | Mit der vorherigen Aktion verbundene Aktionen | Ja |
Statistik-Trigger
Die Dokumentationen der Statistik-Trigger (PS1) können um die Links der nachstehenden Tabelle erweitert werden.
Link | Bedeutung | Verwendung bei der Dokumentationsgenerierung | Zusatz |
ATB | Tabellen | Im Triggerkontext verwendete Tabellen | Ja |
Spezialfall Eingabepunkte
Die Eingabepunkte stützen sich auf eine etwas spezielle Weise auf die Links. Erläuterung:
- Das dokumentierte Dictionary-Element entspricht der Verarbeitung im Verarbeitungs-Dictionary.
- Alle Eingabepunkte sind durch einen Link vom Typ APE definiert. Der zugeordnete Code entspricht dem Namen des Eingabepunktes. Die nachfolgenden Links (bis zum nächsten APE-Link) charakterisieren diesen Eingabepunkt. Wenn vor dem ersten APE-Link gemeinsamen Eigenschaften vorhanden sind, wird standardmäßig davon ausgegangen, dass sie für alle Eingabepunkte gelten.
- Die Links ATB und AT2 werden zur Definition von offenen Tabellen verwendet (jeweils mit bedeutsamem oder unbedeutendem Inhalt).
- Mit dem Link TRF kann definiert werden, ob eine Transaktion läuft (Wert 2) oder nicht (Wert 1).
- Mit dem Link TRA kann definiert werden, ob eine Protokolldatei geöffnet ist (Wert 2) oder nicht (Wert 1).
Daraus ergibt sich folgende Link-Tabelle:
| TRS | 1 |
| TRA | 2 |
| ATB | TABELLE1 |
| AT2 | TABELLE2 |
| APE | PUNKT1 |
| ATB | TABELLE3 |
| APE | PUNKT2 |
| TRA | 1 |
| APE | PUNKT3 |
| AT2 | TABELLE4 |
In der Verarbeitung gibt es drei Eingabepunkte: PUNKT1, PUNKT2, PUNKT3:
- Zu PUNKT1 ist keine laufende Transaktion vorhanden; von PUNKT1 wird eine Protokolldatei geniert; TABELLE1 ist eine Onlinetabelle mit bedeutsamem Inhalt; TABELLE2 ist eine Onlinetabelle mit bedeutungslosem Inhalt (Standardwerte); TABELLE3 ist eine Onlinetabelle mit bedeutsamem Inhalt.
- PUNKT2 besitzt dieselben Standardwerte, es gibt aber keine Protokolldatei (da TABELLE3 keine Onlinetabelle ist).
- PUNKT3 besitzt dieselben Standardwerte (eine Protokolldatei ist geöffnet). TABELLE4 ist geöffnet, hat jedoch keine Bedeutung.