Skip to main content

Create a report

Add a report, choose one of the five report types, and define the objects and properties it returns.

Prerequisites​

  • A license with report-authoring access. Risk Map reports additionally require risk-reporting access — see the License capability matrix.

Steps​

You can create a report from the repository tree — the usual way — or from the Reporting area.

Add a report from the repository tree​

  1. In the repository tree, select the Reports folder, or a Report folder inside it.

  2. Click Add object, choose Report, type a Name, and click Finish.

  3. Open the new report and choose a Report Type.

  4. Define the report settings for the type you chose:

    • Generic List or Table: enter a Filter to select the objects, and Properties to choose the columns.
    • Text Search Report: the same as a list report, plus a search term to refine the results.
    • Generic Matrix: enter a Row Filter, a Column Filter, and the Relationships that color the intersecting cells.
    • Risk Map: enter a Filter to select the objects to plot.
    • Narrative Template: arrange the sections that make up the document — see Narrative reports.

    The Filter, Properties, and Relationships fields use the iGrafx Query Language. See Use IQL in a report.

  5. For Generic List or Table and Text Search Report, choose Current Approved Version to report only on approved objects, or Latest Version to report on the most recent version.

The report is saved to the Reports folder, where you can rename, move, or copy it.

Add a report from the Reporting area​

  1. Click Reports in the navigation rail, then Design Report.
  2. Choose a Report Type and click Continue.
  3. Define the settings as in the steps above, then click Finish.
note

A new report is visible to anyone who can see unapproved objects, and they can run it. To make it visible to readers who can only see approved content, run an approval cycle on the report.

Verify​

Open the report and select the Report tab. The report builds and shows its output. A report with no filter or properties defined shows a prompt to define at least one before it can run.