You are here: LANSA for i User Guide > 7. Documentor > 7.6 Include Files in the Document

7.6 Include Files in the Document

When the option to "Include files in Document" is chosen from the "Review/Change Selected Objects" menu a screen similar to this example is used to include files in the document.

 

 DC@P840108                 Include Files in Document                   

 

 

 Document :   XXXXXXXXXX  XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX     

 

 Enter full or partial name of the file definition(s) to be worked      

 With or leave blank to select from all file definitions . . . .  _____  

 

      File                                                 Include all 

 Sel   Name       Library    Description                        Fields  

  X    DEPTAB     DC@DEMOLIB Department code tabl                       

  _    LCOI01     DC@DEMOLIB Testing LCOI file                    N     

  _    LCOI02     DC@DEMOLIB Large LCOI test file                 N     

  _    LCOI03     DC@DEMOLIB LCOI Department File                 N     

  _    LCOI04     DC@DEMOLIB LCOI Section File                    N     

  X    PSLMST     DC@DEMOLIB Personnel master                           

  X    PSLSKL     DC@DEMOLIB Personnel skills                           

  X    SECTAB     DC@DEMOLIB Section code table                         

  X    SKLTAB     DC@DEMOLIB Skill code table                           

 

 

 

 F1=Help  F3=Exit  F12=Cancel  F14=Msgs                                 

 

 

This facility allows you to build temporary lists of active file definitions known to LANSA and display them on the screen. From these displayed lists file definitions can be chosen for inclusion into your document.

Note the use of the words file definition. Only the name of the file definition, which is the same as the associated physical file name, is ever included into the list of objects to be documented. When a file definition is included, all associated details such as logical views, virtual fields, etc, are automatically included for documentation.

These lists can be built from all files or only files that have a certain generic name.

A displayed list may not fit onto one screen. This is indicated by a "+" sign in the lower right of the screen. In such cases use the roll up and roll down keys to scroll backwards and forwards through the displayed list.

Files shown in the displayed list which are already included in the document are shown with an "X" beside them. The "X" cannot be removed. Thus a file cannot be excluded from the document by using this facility. Use the option "Review/exclude objects in document" to do this. This option is described in detail in a later section.

When you want to choose a file from the displayed list for inclusion into the document enter a "Y" beside it in the column headed "Sel".

The "Include all Fields" column is used (by entering a "Y" in this column beside a chosen file) to indicate that all fields defined on this file are also to be included for documentation.

When you have completed using this facility, use the Cancel function key to return to the "Review/Change Selected Objects" Menu.