Book a Demo

Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.

Prev Next

Element Filters

As you specify the output of your report, you might want to include only elements that have specific properties, rather than every element encountered. Using the 'Element Filters' tab, you can define which element properties to report on, and which fields and field values. You can also delete the element filters if you no longer want to apply them.

The 'Element Filters' tab is provided in two different ways, as a tab of:

  • The 'Generate Documentation' dialog, to set filters for a specific instance of a report; the filters are reset when you exit the dialog or select a different template, or
  • The 'Document Options' dialog, to set filters in a template as the default settings to be applied to every report generated using that template; these settings can be overridden by the 'specific instance' settings on the 'Generate Documentation' dialog

The options and behavior are the same for both dialogs, except that the 'Document Options' dialog provides a facility for importing a previously-defined set of Model Search filters from within your model or from an external file (created by exporting a Model Search from another model).

The facilities are also provided through the 'Element Filters' page of the 'Properties' dialog for a Standard Chart element. This page most closely resembles the tab of the 'Document Options' dialog in the Document Template editor.

Access - 'Generate Documentation' dialog

Display the 'Generate Documentation' dialog, then select the 'Element Filters' page.

To open the 'Generate Documentation' dialog, use one of the methods outlined here.

Ribbon

Publish > Model Reports > Report Builder > Generate Documentation > Element Filters

Keyboard Shortcuts

F8 | Element Filters

Access - Template Editor 'Document Options' dialog

Display the Document Template editor window, select a template, then display the 'Document Options' dialog and finally select the 'Element Filters' page of that dialog.

To open the 'Document Options' dialog, use one of the methods outlined here.

Ribbon

Publish > Model Reports > Templates : select a particular template > (toolbar icon) > Element Filters

Review Element Filters

Column/Button

Action

See also

Search In

Shows the type and name of each element property field to search on.

Select the checkbox against a property field to include it in the current search.

Condition

Displays the condition of the search parameter.

The possible values are Contains, Equal To, Not Equals and One Of.

Look For

Displays the search term to perform the conditional search on.

This value is specific to the selected field; for example, the value could be a date for 'DateCreated' or a text or numerical value for other fields.

The search term can contain multiple values, separated by commas.

Required

Indicates that the search results must include elements with the search term in that field; these checkboxes are set on the 'Add Filters' dialog.

When no 'Required' checkboxes are selected, the fields listed as filters have an OR relationship; that is, if the search term is found in any one of those fields, then the element is displayed.

Any field having the 'Required' checkbox ticked overrides fields where the 'Required' checkbox is not ticked.

 Add Filters

Element Features
- Optional
- Required

Specify whether element features are optional or required; these appear as a new branch underneath the root element term in the 'Search In' column.

If you scroll down the 'Search In' column, you might see sub-branches such as Attribute, Change and Custom Property; these are the element features. You can add these features using the 'Add Filters' dialog.

Select the:

  • 'Optional' radio button to generate a list of elements that have one of the element features (Element Type = Object), or one of the feature filters (Attribute Name = Att1); for example, if your search is:
         Element Name = Class11, Attribute Name = m_Att1 or Scope = Public
    the search results list all the elements that have the name of Class11 and all the elements that have an Attribute Name of m_Att1 or a Scope of Public
  • Required radio button to generate a list of elements that must have the element features; for example, if your search is:
         Element Name = Class, Attribute Name = m_Att1 or Scope = Public
    you would get elements that must have the name of Class AND have an attribute with a name of m_att1 OR a Scope of Public

Import Search

Click on this button and select to import the filters defined within a search, from either:

  • An external XML file exported from another project, located on a browser dialog, or
  • A list of the standard and custom Model Searches within your installation of Enterprise Architect

Add Filter

Click on this button to display the 'Add Filters' dialog, to add a new set of parameters to filter the search on.

Edit Filter

Click on this button to display the 'Edit Filters' dialog, to change the search parameters.

Remove Filter

Click on this button to immediately remove the selected filter from the search.

Notes

  • Check that the values you provide for the 'Look for' fields are exactly what is contained in the element data fields to be searched; for example, the Unit, Integration, System, Acceptance, Scenario and Inspection TestClasses are represented by attribute values 1 - 6, not by their respective tab names
  • Filters set in a template operate only on that template, and do not operate on subtemplates and template fragments inserted into the template; to filter the subtemplates, set the filter within each one

Learn more

Prev Next