Create Search Definitions

If you want to define your own searches, you can do so using the SQL Editor, Query Builder or an Add-In, through the New Search dialog. User-defined searches are stored in the user application data for the machine being used, and not in the project repository.

Access     Edit | Search Model:

Create a new search definition

Field/Option/Button	Action	See also
Name	Type a name for the search.
Query Builder	Click on this radio button to create your search through the internal search editor.
SQL Editor	Click on this radio button to create your search by directly writing SQL statements. (For advanced users.)
Add-In Search	Click on this radio button to define the search as a function of an Add-In.
Add-In Name and Method	(Available if you have selected the Add-In Search radio button) Type in: · The name of your Add-In · A period (full stop) and · The name of the method to be called whenever the search is run (for example, MyAddin.RunThisMethod); this search can be exported and distributed as a part of your Add-In	Add-In Search
OK	Click on this button to create the new search and close the dialog. The search builder panel opens underneath the toolbar.  For: · An Add-In search, no further action is required; click on the icon to  close the search builder panel · A Query Builder search, the panel defaults to the Query Builder tab and you can start adding filters and constructing the search; see the Create and Modify Searches topic · An SQL search, the panel defaults to the Query Builder tab and you can start to create the SQL statement for the search, as in Create SQL Search, below   The Search Builder also provides an SQL Scratch Pad tab, which you can use to create and test SQL statements before copying them across to the Query Builder tab. SQL statements on the SQL Scratch Pad are not attached to any search and are not the focus of any operations initiated from the Find in Project toolbar.	Define & Modify Searches
Cancel	Click on this button to abort the search creation and close the dialog.

Create SQL Search

You can create SQL statements using the SQL Editor through the Query Builder tab. The SQL editor is based on the common Code Editor, and provides an Intelli-sense autocompletion list populated from the Enterprise Architect repository structure.

To display the autocompletion list, position the cursor after a command and press Ctrl+Spacebar.

A simple search might be to locate an object from a table, given a search term that the user enters in the Search Term field, such as:

SELECT * FROM t_object WHERE NAME='<Search Term>'
 

In the WHERE statements you can also use #xxx# macros as string replacers, so that the same search can be used by different people in different environments. These macros include:

 
This only uses the section of code between two matching #DB=<DBNAME># macros if the current database type matches the specified DBNAME;  it can be used where a section of the SQL might require special handling depending upon the current database type
 
For example:
 
#DB=ORACLE# t_object.ModifiedDate >= (SYSDATE - INTERVAL '<Search Term>' DAY) #DB=ORACLE#
 

For all functions in which you use a custom SQL statement (such as Document Reporting or Model Views) the statement must return the guid and type of the object found so that the system can search for the selected item in the Project Browser:

SELECT ea_guid AS CLASSGUID, Object_Type AS CLASSTYPE, Name FROM t_object
 

You can extend the usability of your SQL searches using the aliases CLASSGUID and CLASSTYPE, so that you can display the Properties dialog and icon for elements, connectors, attributes or operations, as well as selecting them in the Project Browser.

Some simple examples for using these aliased fields are provided below:

You can enable your search users to drag and drop elements from the search results onto a diagram, by including one or other of the following in your search's SELECT statement:

When you have defined the SELECT statement, click on the Save button in the Query Builder toolbar to save this search; the search is then available from the Search drop-down list.

SQL Scratch Pad Toolbar buttons

The SQL Scratch Pad tab provides a small number of facilities through its toolbar.

Notes

·	When you create a custom SQL search on the Query Builder tab, the only two icons that are available in the Toolbar are the Save icon and the Remove Filter icon; the Remove Filter icon is effectively a Delete icon that removes the search content (the SQL statement)

Learn more