Documentation

Modules

A module is first of all a logical container which holds tables. Security assignments can be made to modules which cascade down to the tables within it.

Secondly, modules are used to build the administrative menu system.

A module is not the same as a database schema. Andromeda puts all of its tables into the 'public' schema. The module exists only as a container for tables for organizing menus and security.

Required

Every database must have at least one module.

Module Example

A module definition can occur anywhere in your .dd.yaml file, although by convention we put them at the top.

Modules are defined as top-level elements. That means that module definitions have an indent level of zero. Here is an example module definition:

module ordering:
    description: Ordering System
    uisort: 100

There are only three elements to a module definition:

• The name is always "module -name-:", the keyword module, a space, the name of the module, and a colon.
• The property description is used on the menu system.
• The property uisort is used by the menu system to order the modules. If you leave this out, they will appear on the menu in the order they are defined.