Documentation links

Links according to the documentation types

The list of existing links and the fashion where they are used according to the original documentation type is given in the following sections. Found in these grids is a Compl column.

This columns defines, when it is set to Yes, that the links defined by this code come as a complement to the links found in the dictionary. Thus, when a functional documentation generation is carried out, the windows, tables, objects that are associated with it are analyzed to recover the associated activity codes, but it is possible that an activity code not directly linked to the influence on the functioning. This activity code is then added via a link.

When the Compl is set to No, no other information from the dictionary is used to define the link in question. It is therefore mandatory to enter this type of link if this information is to appear in the generated documentation. It should be noted that in certain cases (miscellaneous tables, local menus), it is possible to recover the links of this type, but in a not very reliable fashion (only the miscellaneous tables and the local menus where the parameterization is a pre-requisite in the function are of interest.

Functions

The documentation for the functions (AFC codes) can be enriched by the links to the next grid.

Link	Meaning	Usage during the generation of the documentation	Compl
ACV	Activity code	List of the activity codes concerned in the pre-requisites.	Yes
ADP	Parameter	Parameters involved in the pre-requisites. It should be noted that this link is also used to load the sectionFunctions concerned in the help describing the parameter (it is therefore not useful to enter the reciprocal link if the direct link is defined).	No
ANM	Sequence number counters	List in the sequence number counters as the function in the pre-requisites.	No
GAU	Automatic journals	List in the automatic journals as the function in the pre-requisites.	No
CDE	Dimension codes	List in the dimension codes as the function in the pre-requisites.	No
TRS	Transactions	List the functions that are used to define the transactions for the documented function.	No
ADI	Miscellaneous tables	List of the miscellaneous tables in the function pre-requisites.	No
AML	Local menus	List of the local menus to be parameterized in the pre-requisites.	No
ARP	Reports	Reports launched from the function.	Yes
ABT	Batch tasks	Annex for the batch tasks that are used to launch the function.	Yes
ATB	Tables	Tables used in the function.	Yes

Note : the search of the activity codes from the functions in the dictionary is very exhaustive and is likely to be sent certain activity codes whose presence is not strictly required. To improve the behaviour, it is necessary to create a link to the activity code FAL (always false). Once a link of this type is inserted, only the activity codes present in the list of links are returned.

Parameters

The documentation for the functions (ADP codes) can be enriched by the links to the next grid.

Link	Meaning	Usage during the generation of the documentation	Compl
AFC	Function	List of the functions concerned in the help describing the parameter. It should be noted that this link is also used to load the Parameters section in the help describing the function (it is therefore not necessary to enter the reciprocal link if the direct link is defined).	No
ACV	Activity code	List of the associated activity codes.	Yes
AOE	Import/export template	List of the import/export templates using this parameter. This link is only used in a reciprocal fashion (to obtain the parameters associated with the templates in the documentation in question).	No
AT2	Pre-requisite tables.	List of tables to be entered in the pre-requisites.	No

Sizing variables

The documentation for the functions (ADM codes) can be enriched by the links to the next grid.

Link	Meaning	Usage during the generation of the documentation	Compl
ATB	Sized tables	List of the tables sized by the variable.	Yes

Import/export template

The documentation of the import/export templates (AOE codes) can be enriched by the links in the next grid.

Link	Meaning	Usage during the generation of the documentation	Compl
ADP	Parameters concerned	List of the parameters influencing the functioning of the template. It should be noted that the reciprocal links are also run.	No
AT2	Pre-requisite tables.	List of the tables mentioned in the pre-requisite usage.	No
ATB	Updated tables	List of the update tables	Yes

Reports

The documentation of the report templates (ARP codes) can be enriched by the links in the next grid.

Link	Meaning	Usage during the generation of the documentation	Compl
ATB	Printed tables	List of tables whose contents load the report.	Yes

Workflow events

The documentation for the Workflow events (AWA codes) can be enriched by the links to the next grid.

Link	Meaning	Usage during the generation of the documentation	Compl
ATB	Tables for the context	List of tables where the contents form part of the triggering context.	Yes

Actions

The documentation for the actions (ACT codes) can be enriched by the links to the next grid.

Link	Meaning	Usage during the generation of the documentation	Compl
ACT	Linked actions	Actions linked to the previous one	Yes

Statistical triggers

The documentation for the statistics triggers (PS1 codes) can be enriched by the links to the next grid.

Link	Meaning	Usage during the generation of the documentation	Compl
ATB	Tables	Tables used in the triggering context	Yes

Specific case for the entry points

The entry points act in a particular fashion on the links. In fact :

• the element of the dictionary that is documented is processed in the processes dictionary
• each entry point is defined by a link to the type APE and the associated code is the name of the entry point. The links that follow (until the next APE link) characterize this entry point. If these common characteristics exist before the first APE link, they are assumed to be valid by default for all the entry points.
• the ATB and AT2 links are used to define the open tables (respectively with a significant or non significant content)
• the TRS link is used to define if there is a transaction in process (value 2) or not (value 1)
• the TRA link is used to define if there is an open log file (value 2) or not (value 1)

Thus, if there is a grid containing the following links :

TRS	1
TRA	2
ATB	TABLE1
AT2	TABLE2
APE	POINT1
ATB	TABLE3
APE	POINT2
TRA	1
APE	POINT3
AT2	TABLE4

The process has available 3 entry points POINT1, POINT2, POINT3 :

• The POINT1 has no open transaction, manages a log file, the table TABLE1 is on line and significant, the table TABLE2 is on line without being significant (value by default), the table TABLE3 is on line and significant.
• The entry point POINT2 has the same default values, except there is no log file (the TABLE3 table is not online).
• The entry point POINT3 has the same default values (an open log file). TABLE4 table is open without being significant.