Generating Database Document

This topic describes how to configure and generate the database documentation file.

To Generate a Database Document:

  1. On the Start Page or on the Main toolbar, click New Documenter.
  2. In the Select Connections dialog box that opens, select one or several existing connections or create a new connection.

    Select connections

  3. Optionally, in the Database Documenter project that opens, select a style for the document in the Style drop-down list box. By default, the Default style is used.
  4. In the Structure pane, select Cover Page to set up a cover page of the generated document.

    Cover page setup

  5. In the Structure pane, select databases, object groups, and database objects for documenting.
  6. Optionally, configure documentation by including/excluding sections and properties of the documented databases and database objects. dbForge Documenter for Oracle allows you to configure elements of documentation on several levels, including:

    • Servers level
    • Server level
    • Schemas level
    • Schema level
    • Objects group level
    • Objects level
    • Users level
    • Roles level
    • Profiles level

    Note

    You can save the Documenter project file at any time and then re-use it.

    For this, on the Main toolbar, click Save. The Documenter project files have the .ddoc extension.

    To load the saved file, on the Start page, click Open File or just click its name in Recent Projects.

  7. To start generating the document, click Generate.

  8. In the Generate Documentation dialog box that opens, select a format and a directory for the document file.
  9. Optionally, click Save Command Line to create an executable .bat file for automation of database documentation. For more information, refer to Creating Command Line Execution File.
  10. Click Generate.