Managing report templates

SECollab allows to create report templates. Report templates are a way for the users with the appropriate permission to define documents that anyone in the team can rely on to create homogeneous reports that span different scopes.

Creating report templates

To create Report Templates, go to the Project Administration's "Report templates" section:

• Click the "+ New report template" link
• Set a title, and optionally a description

You can then create chapters:

• Click the "+" action icon on the template line (will be the same icon on the chapter line if you want to create sub-chapters)
• Set a title, and optionally a description
  • If the chapter is a descriptive chapter (used for textual information), that'll be all
  • If the chapter is a chart chapter, select the query and rendering

You can create the hierarchy you want for the chapters.

When your template is ready, you may create a report that uses it.

Managing query and display settings in report templates

We have 4 main types of display for report templates and each of them is associated with a query kind:

• Horizontal Bar Chart displays matching ()coverage) metrics between related source and target objects, it requires a Join Query as input
• Pie Chart displays matching (coverage) metrics between related source and target objects, it requires a Join Query as input
• Traceability Matrix displays specific link instances as a matrix view between source and target objects, it requires a Join Typed Query as input
• Traceability Table displays linked objects starting from a list of objects computed from an initial query, it requires a Simple Query as input

Based on the type of the query (simple, joined or typed), only the matching displays are available when editing the template chapter.

Please check Managing queries for more details about query types.

Managing Traceability Matrix

Prerequisites

The traceability matrix link instances as a matrix view between source and target objects. Creating a traceability matrix requires to have at least one Join Typed query in the project.

Note: The Traceability Matrix chapter MUST be unique in the owning report for performance purpose.

Managing Traceability Table

Prerequisites

The traceability table displays linked objects starting from an initial Simple query getting a flat list of resources. Creating a traceability table requires to have at least one Simple query in the project. The title of this input query is used for label of the first column.

Note: The Traceability Table chapter MUST be unique in the owning report for performance purpose.

When selecting traceability table display, you have to specify at least one computed column. Each computed column has:

• a label used as the column header,
• an internal name (used to specify data source name for a next column)
• an optional data source that refers to a previous column name. Let empty to refer to the initial request data. For the first computed column, data source is always empty because applied on the initial query results.
• a Join query used to compute the matching resources from the data source

The list of proposed queries is filtered on the data source choice:

• if the optional data source is not set, then the queries source type is matching the initial simple query source type
• if the optional data source is another column, then the queries source type is matching the specific column target type