Exercise 20.2 - Exploring the Search/Details/Relations Tab and Graph View of TWC Artifacts
Objectives
The new learning objectives of this exercise are to:
Use the Search/Details/Relations tabs in the Digital Thread project workspace.
Create digital thread (inter-model) relations between Teamwork Cloud artifacts and artifacts in other repositories.
View the Syndeia Heatmap and Sankey plots in the Explore tab to analyze relation distribution.
Preparation
This exercise assumes the student has:
Syndeia Cloud 3.7 installed with a valid user account,
A valid user account to a Teamwork Cloud repository, and
A valid user account to a at least one other on-line repository, e.g. JIRA
User has reviewed and successfully performed all the steps in the previous tutorial - Exercise 20.1 - Teamwork Cloud Integration on Web Dashboard
The user can use any TWC repository they have available. Because the content of your TWC repository 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 first carry out these exercises in a non-production repository, a “sandbox”, set up for training and practice purposes.
See Part 1 - Syndeia Web Dashboard Introduction for an introduction to the Syndeia Web Dashboard.
Background – Teamwork Cloud
Refer to the Background section in the previous tutorial Exercise 20.1 - Teamwork Cloud Integration on Web Dashboard .
Exercise
Expand a Teamwork Cloud project, such as the one used in the previous exercise (20.1). On the RHS, there are three tabs, labeled Details, Relations and Search. Select a TWC artifact in the Tree View (Spacecraft Total Mass Requirement in this example) and click on the Details tab. You will see details of that artifact, as shown in Figure 2. Scroll down and review the details of the TWC artifact that are available to Syndeia, including Basic Information and External Identity. Click the Details tab again to close the list.
Click the Search tab next as highlighted below in Figure 3.
In the Search tab, select a Workspace (i.e. Applications)
Select Element in the Search for dropdown.
Select a TWC project available (in this example, Spacecraft_Architecture)
Choose the radio button Search by branch and select Trunk in the next dropdown
Specify the element ID and click Search
In our example, the result(s) of the search are shown on the right, as in Figure 3. It returned the model element of the Spacecraft called ‘Body.SLDPRT’. Click the Search tab again to close the Search window.
Select a TWC artifact in the Tree View column (Spacecraft assembly.SLDASM in our example) and click on the Relations tab on the right.
In the Relations tab (Figure 4), you will see a list of Inter-model relations, between the selected TWC artifact and other non-TWC artifacts, and a list of Intra-model relations, between the selected TWC artifact to other TWC artifacts in the same TWC repository. Intra-model relations are relations within the same repository (i.e. Teamwork Cloud).
In this example, there is one Inter-model relation, to the Spacecraft assembly.SLDASM. Inter-model relations are relations from one repository to a different repository or data source (i.e. TWC - Solidworks PDM).
Figure 4 - Relations tab for a TWC artifact shows Inter-model relations (from/to artifacts in other repositories) and Intra-model relations (from/to artifacts in the same TWC repository)
To create a new inter-model relation between the selected TWC artifact and an artifact in another repository, click on the + (Add) button highlighted under the Inter-model table, as shown in Figure 4. A Create Relation dialog will appear as in Figure 5.
Under Select target artifact, choose the other repository to which the new relation will be made. In our example this is Jama @ Intercax.
If you have valid access to this repository, its contents will appear at the bottom of the window. Scroll down to the artifact that will be the target of the new relation and click the checkbox beside it. This is Jama artifact Spacecraft Functional Requirements in our example.
Each Syndeia relation has a type. Select one from the Relation type dropdown in the middle. This is Verifies in our example. See https://intercax.atlassian.net/wiki/x/p4BrBwE for how to create new relation types. A library of relation types is already available with Syndeia deployment.
Each Syndeia relation has a directionality. The Select direction pull down menu at the bottom of the window allows the directionality to be set as desired before the relation is made. The Outgoing and Incoming labels shown in the middle make the semantics of the relation explicit, e.g. Spacecraft Assembly (TWC) Verifies Spacecraft Functional Requirement (Jama),
Click on the Create button at the bottom.
The new relation should appear in the Inter-model pane as shown in Figure 6. The relation type is also shown.
Inter-model relations can be viewed in other ways. Figure 7 shows the relations table under the Explore > Relations tab for digital thread project Spacecraft 01 (SC01). Two relations are shown in Figure 7.
Click the Distribution by Repository Type panel or the downward arrow on the RHS to expand the Heat Map/Sankey pane. After expansion, you will see a Heat Map similar to that shown in Figure 8 below. The Heat Map shows the number of inter-model relations between each repository type pair in each direction (outgoing/incoming).
Select Sankey to view the relation distribution between repository types as a Sankey diagram, as shown in Figure 9.
Hover over a band to view the number of relations between the given repository types. The width of each band is directly proportional to the number of relations between the repository types.
Click on a band to view a filtered set of relations between the given repository types in the table below the diagram as highlighted in Figure 9.
The Digital Thread Explorer or DTE provides interactive visualization of relations in a graph format. To launch DTE, right-click an artifact in the Tree View and select Graph View. In our example, this is Spacecraft assembly.SLDASM. Initially, it appears as a single node in Graph View, as in Figure 10.
Click the gear icon in the upper right corner to set preferences for display. Scroll down and select Relation Type for Inter-Model Edge Display Label and Name for Intra-Model Edge Display Label as shown below. Click OK.
Click on double arrow icon at the bottom of the node for Spacecraft assembly.SLDASM in Step 9.
All intra-model relations to the child TWC artifacts in the Spacecraft assembly.SLDASM with the edge name contains are displayed as shown in Figure 12.
The inter-model relations in Figure 12 are also shown to a Jama artifact and and Solidworks PDM artifact with relation types Verifies and Relates To respectively.
Next Teamwork Cloud Tutorial:
Go to Exercise 20.3 - Digital Thread Queries for Teamwork Cloud to create and run Teamwork Cloud Digital Thread Graph queries.