Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Content layer
id1674906535
Content column
id1674906537
Content block
id1231783541

On this page

Table of Contents
maxLevel4

Content block
id1674906536

The global element usage search allows you to check the usages of elements within the Teamwork Cloud repository. This makes it easier to examine how deleting or modifying an element can impact the projects that use it. The following demo shows how this functionality works:

Widget Connector
width700
urlhttps://www.youtube.com/watch?v=1TUWPUtM4Pc
height394


Note
titlePrerequisites
  • You can only use the Global Element Usage Search feature if Elasticsearch is installed on the server.
  • You can investigate element usages only in projects that have been indexed.

  • Your web application platform URL must be entered in the environment options. If this URL is not added to the environment options, once you select Related Elements > Used by in Server, a window appears, prompting you to enter the web application platform URL.

The command is only available for the elements in an open (main) project. You cannot execute it if:

  • the selected element is from a Used Project
  • the selected element has not yet been committed to the server
  • multiple elements are selected

Performing global element usage search

There are two ways to perform the element usage search you can look for usages of the element only or perform a recursive element usage search. Recursive search finds usages of both the element and all of the elements that are owned by it.

Searching for usages of an element


To find usages of an elementTo find element usages


  1. Do one of the following:
    • In the the Containment tab or diagram pane, right-click an element and select select Related Elements > Used by in Server.On the diagram pane, right-click an element shape and select Related Elements  > Search in Server > Used by in Server.

The element usage search results panel opens with a list of server projects that use the selected element:

Image Removed

Note

Only the latest indexed branch versions are found. For example, if an element is used in the historical version but is no longer in use, it is not displayed in the element usage search results panel.

If you see a warning message (see below), it means that you do not have permission to read the project(s) using the element you performed the usage search for.

Image Removed

Info

Press the Refresh button Image Removedto see the latest information on element usage.

2. Select a project to see a list of project branches and versions that use the element.

Image Removed

Info

Press Actions Image Removed > Open project to open the specific project branch that uses the element.

3. To investigate element usage in more detail, select a specific branch. This shows usage details at the element level:

Image Removed

Searching for usages recursively

To search for element usages recursively

    • Choose this option if you want to search solely for the usages of the element.
    • In the Containment tab or diagram pane
    Do one of the following:
    • In the Containment tab, right-click an element and select select Related Elements > Search in Server > Used by in Server Recursively. On the diagram pane, right-click an element shape and select Related Elements > Used by in Server RecursivelyChoose this option if you want to search for the usages of both the element and all of the elements that are owned by it.

The element usage search results panel opens with a list of server projects that use the selected element:

Note

Only the latest indexed branch versions are found. For example, if an element is used in the historical version but is no longer in use, it is not displayed in the element usage search results panel.


If you see a warning message (see below), it means that you do not have permission to read the project(s) using the element you performed the usage search for.

Info

Press the Refresh button to see the latest information on element usage.


2. Select a project to see a list of project branches and versions that use the element.

Info

Press Actions > Open project to open the specific project branch that uses the element.


3. To investigate element usage in more detail, select a specific branch. This shows usage details at the element level:


Content block
id1674906533

Related pages