Creating model documentation

After you model the metadata, you can create an HTML or XML representation of the model that can be customized and printed. This is useful for debugging your model or if your company requires this type of documentation to satisfy process requirements.

When you create model documentation, you can document the entire model or you can select a subset of the model. To document the entire model, you click the top-level namespace. The model documentation shows the selected object and all the properties and children of that object.

You can view, save, or print the report in XML or HTML format. By default, the XML format within IBM® Cognos® Framework Manager is always raw XML. To customize the XML report output in your browser, you can provide your own XSLT transformation.

To customize the HTML output, you can use your own XSLT by specifying the path and XSL file in the ModelDocXSL section of the fm.ini file, located in the install_location/configuration directory. Framework Manager will use the specified XSL file when showing the HTML version of the Model Report.

Procedure

  1. Click the object that you want to document.
    Tip: Click the top-level namespace to document the entire model.
  2. Click Tools, Model Report.

    The model report displays.

    You can save, print, or change the format of the report.