You can index resources for their element usages within the selected scope of the Teamwork Cloud repository and later query these usages through the modeling tool. This enables you to evaluate what impact modifying or deleting certain model elements will have on other models that are using it. To enable this functionality, Teamwork Cloud needs to be incorporated with a dedicated search engine - Elasticsearch. This component makes it possible to index model element usage data and serve it quickly when queried from a modeling tool.


Conceptual solution for the global element usage indexing and search functionality.

Enabling global element usage indexing and search

 To start using the global element usage search functionality, you need to install Elasticsearch (v7 series) and configure Teamwork Cloud as described below.


To enable global element usage search


  1. Go to https://www.elastic.co/downloads/elasticsearch and install Elasticsearch (v7 series).

    We highly recommend deploying Elasticsearch on a machine separate from TWC and Cassandra due to additional server resource consumption.

    In the Elasticsearch installation directory, open the jvm.options file and make sure the -Xms and -Xmx properties are uncommented.

  2. Go to <install_root>\configuration, open the application.conf file, and add the following lines at the end of the file:
    1. To enable the querying component, add the following property and set it to true:

      esi.server.actor.query.component-enabled=true
    2. To enable resource indexing, add the following property and set it to true:

      esi.indexer.enabled = true
    3. If Elasticsearch and Teamwork Cloud run on different machines, add the following line:

      esi.query.es.node.host = "<es.host.or.ip>"
    4. If Elasticsearch is set up to listen on a different port from the default one (9200), add the following line:

      esi.query.es.node.port = <es.port>
  3. Restart Teamwork Cloud services.


Now you can index resources for their element usages in the Settings application and use the global element usage search functionality in a modeling tool.