Prev Next

Reporting Profiled Relationship Matrices

When you are using the Relationship Matrix, you search on combinations of source and target Packages, element types, connector type and connector direction. You can save your frequently-used combinations as profiles, and you can include the results of using these profiles in your document report by setting up a section in the report template.

If you have set up matrix profiles directly within the Relationship Matrix, you do not directly specify a matrix profile in the report; the Document Generator returns the Relationship Matrix for all profiles that include the documented Package as the source or target Package.

You can have more direct control over which matrix profiles are presented in a report, by creating a Matrix Specification Artifact element that defines a profile and then reporting on the Package that contains that Artifact. The profile defined in the Artifact is independent of the Package that contains the Artifact element, and therefore could specify source and target Packages other than the parent Package. The Document Generator can report on only one Matrix Specification Artifact per Package, so if you want to include more than one profile, place each Artifact element in a separate subPackage of the target Package for the report.

Access

Ribbon

Publish > Tools > Document Templates > Sections

Other

Resources window | Document Generation | User Templates : right-click on a template | Open > Sections

Add section to report on Relationship Matrix contents

Action

Detail

See also

Add section

Select the 'Package > Relationship Matrix' checkbox; the relationship matrix section markers are added to the template.

Right-click between the markers and add the 'Image' field to return the Relationship Matrix in the report.

     relationship matrix >

     {Matrix.Image}

     < relationship matrix

You can also insert a number of fields to identify specific aspects of the profile, such as relationship name, direction, type, target element and element type, and source element and element type.

 Add Section Content

Notes

  • You can view a list of the profiles created directly in the Relationship Matrix, in the Matrix Profiles folder of the Resources window
  • If a reported Package contains a Matrix Specification Artifact and is also part of a profile created directly in the Relationship Matrix, the Artifact element takes precedence and the report does not include the direct Relationship Matrix profile

Learn more