Export the model documentation

When a model is complete or under development, it is possible to export the documentation for this model.

The model documentation is generated in HTML format, providing comprehensive information about the data model for other application designers to review. It also contains details about the physical tables, which are valuable for developing integration jobs that interact with the application by writing to or reading from these tables.

The model documentation includes the following documents:

  • The logical model documentation, which includes a description of the logical model and the rules involved in the certification process.

  • The applications documentation, which includes a description of the applications of the model and their related components (views, business view, etc).

  • The physical model documentation, which includes a description of the physical tables generated in the data location when the model is deployed. This page is a physical model reference document for the integration developers.

To generate the model documentation:

  1. In the Model Design view, select the model node located at the root of the tree.

  2. Right-click and select Export Model Documentation.

  3. In the Model Documentation Export dialog, select the documents to generate.

  4. Select the appropriate Encoding and Locale for the exported documentation.
    The locale determines the language used in the generated documentation.

  5. Click OK to download the documentation.

The documentation is exported in a ZIP file containing the selected documents.

It is possible to export the model documentation only for a valid model.