Reports > Element Reports

Most of the formatting options in eaDocX are designed to let you print the contents of your EA model based on its package structure.

The Element Report feature lets you cut across the package structure, and gather elements from anywhere in the model, and list them, either as a table or inline. This is useful for collecting all the instances of an EA element together, regardless of where those elements appear, for example, all the 'issues' you've created.

Element Reports are also useful to check on the completeness of your model, or to find new elements created after a particular date.

Element Report Types

You can print four types of element report:

Package-based reports - These print all the elements of a particular type which are underneath a specified package, regardless of where they are in the hierarchy of that package.

EA Model Search Reports - these print the results of running an EA Model Search.

Custom SQL Queries, which allow you to create any query, with any selection of output columns, direct from the EA Database.

Cross-reference reports - these can list all the elements of a particular type which are mentioned elsewhere in your document.

You can also apply filters to Package- and Cross-reference reports.

Adding a Report

To add an element report Section to your document, select Insert | Report | Element report:

The Element Report page

An Element Report has the following settings:

On the General Page:

Report Header

Report Name

Title of the heading.

Heading Level

Heading level for the title

Copy existing report

Choose a previously defined Report to copy/edit - from this or another model

Description

Create your own text description to appear directly below the title, as normal text.

Source

Package

Choose the package where eaDocX will start to collect elements. All elements of the type specified in all child packages of this one will be searched. See Package reports

EA Search

Name of an EA Model Search. see Model Searches.

SQL Query

Choose any EA Search which contains any valid SQL query which can be run against the EA database. Only use this if you are familiar with writing SQL, and understand the internals of the EA database structure.

See Custom SQL Queries

Element Cross Reference

Specify the type of element below. All elements of this type in the document will be printed.

Note: to be part of an Element Cross Reference report, elements must be referenced by a hyperlink. See Cross Reference reports

Filter

Element type (mandatory) and optionally stereotype of that element.

Formatting

Option

Use defaults - elements found using the selection above will be printed according to their element settings?

Custom - either Table or Inline formatting can be specified which apply only to this report.?

Each time the document is re-generated, the report will be run against the current contents of the EA model.

Tip:

If you cancel while creating this report, eaDocX will default to creating an empty Section.