This function is used to trigger generation operations linked to the documentation management.

Screen management

Entry screen

Presentation

The screen displayed is used to select all the generation options.

Close

 

Fields

The following fields are present on this tab :

Selections

  • All existing languages (field ALLLAN)

If this box is checked, all languages are taken into account by the operation.

If this box is not checked, depending on the case:

  • the user's default language will be used, if no language code is entered.
  • otherwise, the entered language is used.

Used to define the generation language (when the box that is used to generate all the languages is not checked).

  • All types (field ALLTYP)

If this box is checked, all types are taken into account by the generation. It should be noted that, in this case, there is a limit on the generation of the standard documentation (except the documentation with a code less than X are taken into account).

Used to define the documentation type to be taken into account in the process (when the box is not checked to take all into account).

  • Documentation codes (field FUNDEB)

Used to give a range for the codes to be taken into account for the generation of the documentation.

  • field FUNFIN

 

Generate ADOCUMENT

  • field GENDOC

If this box is checked, a documentation skeleton is created (a paragraph hierarchy) from the technical elements found in the data dictionary. The documentation link is also taken into account. The paragraphs likely to be created are defined in the corresponding technical annex.

  • For all the groups (field ALLCREGRP)

 

Generate final document

  • field GENFIN

If this box is checked, the final documentation is created from the contents of the documentation paragraphs. This documentation is created in different directories defined by the user parameter REPDOC.

  • Only the validated documentations (field HLPVLD)
  • Field helps linked to documentations (field HLPLNKFLD)

If this box is checked, the field helps relating to the function or object documentation that are also processed are included. To find out which field helps need to be processed, the screens associated with the corresponding documentation paragraphs can be explored.

  • Other field helps (field HLPFLD)

If this box is checked, the final documentation is created from the contents of the documentation paragraphs. This documentation is created in the sub-directory FLD of the directory defined by the user parameter REPDOC.

  • Field help codes (field HLPDEB)

Used to give a range for the codes to be taken into account for the generation of the documentation.

  • field HLPFIN

 

  • Generation directory (field REPERT)

 

Close

 

Batch task

This function can be executed in batch mode. The standard task AGENADO can execute it.

Error messages

The only error messages are the generic ones.

Tables used

SEEREFERTTO Refer to documentation Implementation