Exercise 7.2 - Gremlin Queries for Jama Requirements
- Ambarish Ganesh (Unlicensed)
Objectives
The objective of this exercise is to help new users of Syndeia graph analysis to formulate Gremlin queries to analyze their graph with the Syndeia Web Dashboard. The specific learning objectives of this exercise are to create lists of
Jama artifacts of a specific artifact type
Jama artifacts in a specific Container
Jama artifacts connected as part of a specific Syndeia Project
Preparation
This exercise assumes the student has
Syndeia Cloud 3.3 or 3.4 installed with a valid user account, and
An existing Syndeia graph containing Jama requirements connected to elements in other repositories.
Because the content of your Syndeia graph will be different, the specific examples in the following exercise instructions are only a guide and example for your actions. It is generally advisable to carry out these exercises in a non-production repository, a "sandbox", set up for training and practice purposes.
See the tutorials under Syndeia Cloud Web-Dashboard/Part 19 – Syndeia Cloud Graph Analysis for an overview of this feature.
Background – Syndeia Cloud Data Model
Figure 1 provides a simplified schema for elements in the Syndeia Cloud graph. All graph nodes are either Repositories, Containers, or Artifacts, where each Artifact is owned by a Container and Each Container is owned by a Repository. Each has a Type; the set of ContainerTypes and ArtifactTypes are owned by the Repository. How the Jama data model maps to the Syndeia Cloud data model is discussed in the next section.
Figure 1 Syndeia Cloud Schema (simplified)
Background – Jama
As of Syndeia release 3.4, the Syndeia Web Dashboard can extract and display some model information from a Jama repository. Figure 1 shows a tree view of this information, with labels identifying the Jama element types. Note the different icons. The label color coding indicates how the Jama element type is mapped to the Syndeia Cloud element types: Repository (green), Container (red), and Artifact (blue). The Syndeia Jama integration supports a large number of standard Jama requirement types, including Requirement, Set, and Component, as well as other standard and custom types. A more complete diagram of the Jama data model as it is understood by Syndeia is available through the web dashboard help menu on the left.
It is also important to understand the limitations of graph queries with respect to the Jama repositories. As of Syndeia 3.4, graph queries cannot extract the internal structure of a Jama repository, i.e. they cannot be used to obtain the full structure of the Jama repository or internal (intra-model) relations between Jama artifacts. In this way, graph queries are different than the Tree View or Graph View (Digital Thread Explorer) capabilities of the Repositories page in the Syndeia Web Dashboard. Graph queries are most useful in viewing inter-model connections from Jama elements to other repositories.
Figure 2 Tree view of Jama repository
Exercise
Log on to the Syndeia Cloud Web Dashboard (see Video 1.9) and click on the Graph Queries icon on the left border.
The first task is to compile a list of Jama Artifacts of a specific type. Per Figure 1, ArtifactTypes are owned by (specific to) a Repository. We typically want to begin by creating a list of Artifact types available in such a Repository.
If we use Query Builder (Figure 3), we select ArtifactType from the pull-down menu under Label.
Figure 3 Graph Queries page (icon outlined in red) – Query Builder
To restrict the list of ArtifactTypes to our current Jama repository, we click Filters. We will filter by the name of our Repository, so we select Repository from the pull-down menu at the top marked Property of. Under Property Key, we select the Name property and under Property Value, we enter Jama @ Intercax. We then click the Plus button to add the filter in the bottom list and the window should look similar to Figure 4. Click Close.
Figure 4 Query Builder Filters window
Back on the Graph Queries page, click Run. The results, a list of all ArtifactTypes in Jama @ Intercax, may be displayed in table form as in Figure 5. Key ArtifactType properties in the table are Name and Key because we will use these in the next search. Click the Exports icon to export the list as a CSV file for future reference, if desired.
Figure 5 Graph Queries page, ArtifactTypes results in table format (Export icon highlighted in red)
Note at the top of Figure 5, the Query Builder utility has created a Gremlin query. We could have performed the same search with the same results by going to the Raw Query mode and entering this query directly.
g.V().has('sLabel','ArtifactType').where(outE().has('sLabel','ownedBy').inV().has('name','Jama @ Intercax'))The final part of the first task is to generate a list of all Artifacts of type Requirement within the Jama @ Intercax Repository. Note that Syndeia will return only those Jama Requirements that are connected within the Syndeia Cloud graph, not all Requirements in the repository.
We can search by ArtifactType Name ("Requirement") or Key (ART-TYPE22), which we got from the table in Figure 5. Generally, it is better to search by Key, which is unique within the Syndeia Cloud database, rather than Name, which is not unique.
If we use Query Builder, we select Artifact from the pull-down menu under Label, as in Figure 6.
Figure 6 Query Builder, Artifact search
To restrict the list of Artifacts to the Jama Requirement type, we click Filters. We will filter by the ArtifactType Key, so we select ArtifactType from the pull-down menu at the top marked Property of. Under Property Key, we select the sKey property and under Property Value, we enter ART-TYPE22, which we took from the table in Figure 5. After we click the Plus icon, the Filters window should look like Figure 7. Click Close.
Figure 7 Query Builder Filters window, filter by ArtifactType sKey
Back on the Graph Queries page, click Run. The results, a list of all Artifacts of type ART-TYPE22, which is owned by the repository Jama @ Intercax, may be displayed in table form as in Figure 8. Click the Exports icon to export the list as a CSV file for future reference, if desired.
Figure 8 Graph Queries page, Artifacts results in table format, truncated (Export icon outlined in red)
Note at the top of Figure 5, the Query Builder utility has created a Gremlin query. We could have performed the same search with the same results by going to the Raw Query mode and entering this query directly.
g.V().has('sLabel','Artifact').where(outE().has('sLabel','hasType').inV().has('sKey','ART-TYPE22'))The second task is to compile a list of Jama Artifacts in a specific Jama Project. Per Figure 2, Projects in Jama are Containers and are owned by (specific to) a Repository. We will begin by creating a list of Containers available in a Jama Repository.
If we use Query Builder (Figure 9), we select Container from the pull-down menu under Label.
Figure 9 Graph Queries page (icon outlined in red) – Query Builder
To restrict the list of Containers to our current Jama repository, we click Filters. We will filter by the name of our Repository, so we select Repository from the pull-down menu at the top marked Property of. Under Property Key, we select the Name property and under Property Value, we enter Jama @ Intercax. We then click the Plus button to add the filter in the bottom list and the window should look similar to Figure 10. Click Close.
Figure 10 Query Builder Filters window
Back on the Graph Queries page, click Run. The results, a list of all Containers in Jama @ Intercax may be displayed in table form as in Figure 11. Key Container properties in the table are Name and Key because we will use these in the next search. Click the Exports icon to export the list as a CSV file for future reference, if desired.
Figure 11 Graph Queries page, Containers results in table format (Export icon highlighted in red)
Caution: The list of Jama Projects listed in Figure 11 does not include all Projects in the Jama @ Intercax repository. Only those Projects that own Artifacts that are connected to other models (or are connected directly themselves) appear on the list. Other Jama Projects that do not involve connections to other repositories are not part of the Syndeia Cloud graph and do not appear in Gremlin graph query results.Note at the top of Figure 11, the Query Builder utility has created a Gremlin query. We could have performed the same search with the same results by going to the Raw Query mode and entering this query directly.
g.V().has('sLabel','Container').where(outE().has('sLabel','ownedBy').inV().has('name','Jama @ Intercax'))The final part of the second task is to generate a list of all Artifacts in a specific Container within the Jama @ Intercax Repository. Note that Syndeia will return only those Jama Requirements that are connected within the Syndeia Cloud graph, not all Requirements in the repository.
We can search by Container Name ("Syndeia Applications") or Key (CONT565), which we got from the table in Figure 11. Generally, it is better to search by Key, which is unique within the Syndeia Cloud database, rather than Name, which is not unique.
If we use Query Builder, we select Artifact from the pull-down menu under Label, as in Figure 12.
Figure 12 Query Builder, Artifact search
To restrict the list of Artifacts to the Jama Project Syndeia Application, we click Filters. We will filter by the Container Key, so we select Container from the pull-down menu at the top marked Property of. Under Property Key, we select the sKey property and under Property Value, we enter CONT565, which we took from the table in Figure 11. After we click the Plus icon, the Filters window should look like Figure 13. Click Close.
Figure 13 Query Builder Filters window, filter by Container sKey
Back on the Graph Queries page, click Run. The results, a list of all Artifacts in Container CONT565, which is owned by the repository Jama @ Intercax, may be displayed in table form as in Figure 14. Note that only Jama requirements that are part of the Syndeia Cloud graph appear; there may be other Jama requirements in this Project without connections to other repositories that do not appear.
Figure 14 Graph Queries page, Artifacts results in table format, truncated
Note at the top of Figure 14, the Query Builder utility has created a Gremlin query. We could have performed the same search with the same results by going to the Raw Query mode and entering this query directly.
g.V().has('sLabel','Artifact').where(outE().has('sLabel','ownedBy').inV().has('sKey','CONT565'))The third task is to compile a list of Jama Artifacts that are connected as part of a specific Syndeia Project. Syndeia Projects are partitions within the Syndeia Cloud graph database that separate different projects or system models. Syndeia Projects are Containers owned by the Syndeia Repository. Unlike Jama Projects, Syndeia Projects contain only relations, the inter-model relations that define the "macrostructure" of the Digital Thread for that system or project. In this case, we are looking not for the Jama requirements directly; we are looking for inter-model connections where one end is a Jama requirement.
We will begin by creating a list of Containers available in the Syndeia Repository.
If we use Query Builder (Figure 15), we select Container from the pull-down menu under Label.
Figure 15 Graph Queries page (icon outlined in red) – Query Builder
To restrict the list of Containers to the Syndeia repository, we click Filters. We will filter by the name of our Repository, so we select Repository from the pull-down menu at the top marked Property of. Under Property Key, we select the Name property and under Property Value, we enter Syndeia Repository. We then click the Plus button to add the filter in the bottom list and the window should look similar to Figure 16. Click Close.
Figure 16 Query Builder Filters window
Back on the Graph Queries page, click Run. The results, a list of all Containers in the Syndeia Repository may be displayed in table form as in Figure 17. Key Container properties in the table are Name and Key because we will use these in the next search. Click the Exports icon to export the list as a CSV file for future reference, if desired.
Figure 17 Graph Queries page, Containers results in table format, truncated
Note at the top of Figure 17, the Query Builder utility has created a Gremlin query. We could have performed the same search with the same results by going to the Raw Query mode and entering this query directly.
g.V().has('sLabel','Container').where(outE().has('sLabel','ownedBy').inV().has('name','Syndeia Repository'))The next part of the third task is to generate a list of all Relations within a specific Syndeia Project.
We can search by Container Name ("Dirk Sandbox 15") or Key (DZSB15), which we got from the table in Figure 17. Generally, it is better to search by Key, which is unique within the Syndeia Cloud database, rather than Name, which is not unique.
If we use Query Builder, we select Relation from the pull-down menu under Label, as in Figure 18. Remember, the Syndeia Projects contain relations, not artifacts.
Figure 18 Query Builder, Artifact search
To restrict the list of Relations to a specific Syndeia Project, we click Filters. We will filter by the Container Key, so we select Container from the pull-down menu at the top marked Property of. Under Property Key, we select the sKey property and under Property Value, we enter DZSB15, which we took from the table in Figure 17. After we click the Plus icon, the Filters window should look like Figure 19. Click Close.
Figure 19 Query Builder Filters window, filter by Container sKey
Back on the Graph Queries page, click Run. The results, a list of all Relations in Container DZSB15, which is owned by the Syndeia Repository, may be displayed in table form as in Figure 20. Note that all relations within the project appear, not just those with a Jama artifact at one end.
Figure 20 Graph Queries page, Relations (Edges) results in table format, truncated
The final step is to identify the Jama requirements that participate in these relations, but this cannot be done in Query Builder alone. Note at the top of Figure 20, the Query Builder utility has created a Gremlin query.
g.E().has('sLabel','Relation').has('container','DZSB15')
We will use the Gremlin query language to append an additional condition. First, we will add an additional traversal step to go to the vertices at the end of the relations. Since we don't know whether the Jama requirement will have an incoming or outgoing relation in the Syndeia project, we use the bothV() step to cover both ends.
g.E().has('sLabel','Relation').has('container','DZSB15').bothV()
Next, we will check all vertices for ArtifactType. Going back to the table in Figure 5, we choose Jama Requirement, ART-TYPE22.
g.E().has('sLabel','Relation').has('container','DZSB15').bothV().has('type','ART-TYPE22')
If we select Raw Query and enter this in the Gremlin Query field, we generate the table in Figure 21, showing all Jama requirements of ART-TYPE22 used in the Syndeia Project DZSB15.Figure 21 Graph Queries page, Artifacts results in table format, truncated
There are alternate ways to approach the problem. If we wanted to search for Jama requirements in a specific Jama Project (CONT565) that were used in a Syndeia Project (DZSB15), we could reformulate the query using the first part from Step 20 and the second part from Step 13.
g.E().has('sLabel','Relation').has('container','DZSB15').bothV().where(outE().has('sLabel','ownedBy') .inV().has('sKey','CONT565'))