To generate Model Documentation:
Select “Tools | Generate
Model Documentation” on the menu bar:
You can also click on the
icon from toolbar:
Available in: Free(Basic
documentation), Starter, Professional and Enterprise
A setting window will
appear, containing three tabs:
General: In this tab, you will need to:
Directory to save the model documentation.
You can check
Images Diagram to embed the diagram model image into the
If you check the object
counts, you will integrate a section in your report which contains
the number of each objects, such as Tables, Columns, Views,
Select “one page” to generate the model
report in a single HTML page or select “Multi page” to
generate multiple HTML pages, one for each object.
part consists of checking the elements of the treeview composed of
Tables, Columns, Views, Procedures, Sequences, Domains,
Relationships, etc. and their own fields. If you check these
elements, the model documentation will include a table with their
fields and their values.
Elements details to
part is similar to the Previews part. You just need to check
elements of tables and columns with their fields to detail them.
The documentation model will contain a table with fields and values
for each table and column.
You can check all elements
of treeview with the checkbox in the top
You can uncheck all elements
of treeview with the checkbox in the top right:
You can save your model documentation settings
to reuse them later in another project.
To save settings:
Click on the “Save Settings” button, and
name you settings file (*.CFG)
To load previously saved settings:
Click on the “Load Settings” button,
browse to your file (*.CFG) and open it.
Available in: Starter,
Professional and Enterprise Editions