To use Cognos product documentation, you must enable JavaScript in your browser.

Understanding the Metadata in Your Model

Before making changes to a published model, you can better understand the metadata by doing the following:

      

Exploring your projects to see packages and roles in a project .

      

Viewing the objects in your packages to see where specific objects exist .

      

Creating documentation about your model to satisfy the specific requirements of your company .

Explore a Package

When you have a large number of projects and object-based security in a project, it can be difficult to keep everything organized. You can explore packages to see the packages and roles in a project.

In the Package Explorer, you see a list of all the packages (normal and object-based) in a project, as well as the objects that were selected, unselected, or hidden for each package.

In the Roles Explorer, you see a list of all the users, groups, and roles in a project, and in which package the object-based security is applied. You can also see whether the objects in the project are hidden or visible to that specific user, group, or role.

Steps
  1. Select the Packages folder.

  2. From the Actions menu, click Package and click Explore Packages.

  3. Choose what you want to do.

    Goal

    Action

    View the contents of a package

    Click the Package Contents tab.

    Edit the package

    Click the Package Contents tab, select the package and click Edit.

    For more information, see Create or Modify a Package.

    View the security for each package

    Click the Object Security tab and select a package.

  4. Click Close.

View the Distribution of an Object in Packages

When you view the package inclusion of an object, you see, by package, where that object exists and whether it is selected, unselected, or hidden in that package.

If the object is secured, you will also see the object-based package in which the object exists.

Steps
  1. Click the object you want to see, and from the Actions menu, select Edit Package Inclusion.

  2. To edit the package, click Edit Package.

    For more information, see Create or Modify a Package.

  3. Click OK.

Create 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 HTML or XML format. If you are viewing the report in XML format, you may want to customize the report output by providing your own XML schema. You can specify the path to the schema in the ModelDocXSL section of the fm.ini file, located in the install_location/configuration directory.

Steps
  1. Click the object that you want to document.

    Tip: Click the top-level namespace to document the entire model.

  2. From the Tools menu, click Model Report.

    The model report appears.

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