COMMAND:FILEMAINT
path: NEWS:NUWIKI > ABOUT SCCS > SHL:MENU > FUNCTIONS:OVERVIEW > COMMAND:FILEMAINT

Nucleus Commands

FILEMAINT

FILEMAINT is a Nucleus utility for maintaining file dictionaries and cross-reference information. If the file has not been previously created, Filemaint will create one based on parameters provided.

Table of Contents show/hide

Feature Summary

  • Create and document files.
  • Build dictionaries, assign properties.
  • Builds B-tree cross-reference.
  • Automatically builds cross-reference/lookup screen.
  • Binds DICTs to use as $INCLUDE ISUB.INCLUDES DICT.FILENAME to enable addressing data as:
    • MyInfo = REC<attr$FileName$FieldName>

Syntax

FILEMAINT {FileName}

If FileName is not specified, FILEMAINT provides a list of valid files plus an option for a NEW file. The list of files visible to FILEMAINT is in the CONFIGURATION file in an item using the layout:

ProjectName_FILES

image1: FILEMAINT files choice

The choice of NEW prompts as follows

image2: filemaint create new file

Choosing a file name (like ICUST) brings up the function bar:

image3: filemaint bar menu

Note: Dictionary elements must be created before the the bar functions are active. Use the "Dictionary" choice to build/maintain the file dictionary.

InfoProvides documentation on the file's purpose, modulo, etc.
DictionaryDefine/Maintain dictionary elements. The Cross Reference parameters are defined in the dictionary elements and are used by the Compile and Build functions.
BindDictCreates an include code segment in the ISUB,INCLUDES file which equates a name to each file attribute position, i.e. EQU attr$filename$defname TO attrnum. See example
CompileReview the dictionary for Xref definitions and creates the XREF.filename WINPUT screen.
BuildUsing the parameters in the XREF.filename screen, rebuild the cross reference (btree) data.
TestRun the XREF.filename screen to test cross reference lookups

See also