Creating indexing configuration for SysML v2 API Querying

For SysML v2 API Query Services to support queries that include derived properties, the SysML v2 resources to be queried must be indexed in advance.

This chapter describes how to index selected SysML v2 resources to get the most out of the SysML v2 standard API.

Prerequisites

• To enable this functionality, you need to install Elasticsearch (v7 series) and configure Teamwork Cloud.
• Only users with the Server Administrator and Index Manager roles can create indexing configurations.

To create SysML v2 API Querying indexing configurations

1. In the right-side menu of the Settings application, select Indexing management.
2. Select tab SysML v2 API Querying at the top.
3. Click  on the bottom right corner of the screen as shown in the figure above.

4. In the open wizard, make sure that the indexing configuration type SysML v2 API Querying is selected.

5. Select the resource you want to create an indexing configuration for and click Next.
   

   

   Note

   You can index only one resource at a time. Note that only indexed resources can be queried.

6. In the last step of the wizard, select one of the following indexing modes:
   • Automatic (default) - the resource is automatically indexed every time new project versions are committed in the indexing scope.
   • Manual - the resource is indexed only when indexing is initiated by an authorized user.
   • By specific commit tag - the resource is indexed only when new project versions are committed with a specified commit tag in the indexing scope. If you select this indexing mode, the Commit tag box appears where you need to specify the desired commit tag.
     
     
     
     
7. Click the Create button.

The created indexing configuration automatically appears in the Indexing configurations list on the SysML v2 API Querying tab. To refresh the indexing status, reload the web page.