Exercise 20.1 - Teamwork Cloud Integration on Web Dashboard
Objectives
The new learning objectives of this exercise are to:
Add a new Teamwork Cloud (TWC) repository on the Syndeia Web Dashboard (SWD)
View the Teamwork Cloud repository contents in the updated tree view that includes:
Enhanced display of elements and diagram icons for improved navigation and recognition.
New Relations category that groups all incoming and outgoing relations for each element.
Ability to view stereotype tag values and default property values directly in the Tree View.
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.
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
As envisioned by Intercax, the Digital Thread is composed of inter-model relations between models in different repositories, which Syndeia creates and manages, and intra-model relations between elements in the same repository, which the individual tool creates and manages. Figure 1 shows a tree view of this information, with labels identifying the Teamwork Cloud element types. The label color coding indicates how the Teamwork Cloud element type is mapped to the Syndeia Cloud element types: Repository (green), Container (red), Artifact (blue), Attributes (purple), and Relation (yellow).
This information is important in formulating and interpreting Syndeia graph queries. A more complete diagram of the Teamwork Cloud data model as it is understood by Syndeia is available through the web dashboard help menu on the left.
Exercise
Log on to the Syndeia Cloud Web Dashboard and click on the Repositories menu on the main menu bar (left border), as shown in Figure 2.
If a Teamwork Cloud repository has not yet been added by you or your peer/admin on this Syndeia Cloud server, click on the + icon to add a new Teamwork Cloud repository (shown when hovering over Teamwork Cloud in the left column, as in Figure 2 above). Complete the form with your TWC credentials. When complete, click Test to check whether a connection has been made. A green checkmark indicates success; click Create to save (Figure 3).
If a Teamwork Cloud repository has been added by you or your peer/admin on this Syndeia Cloud server, click on the gear icon next to the repository when you hover over it to set your credentials. Enter your Teamwork Cloud credentials (e.g. Username and Password for Basic authentication) and click Test and Update (Figure 4).
Your repository should load. The tree view can be expanded in the steps below.
When you expand the repository, you should see Workspaces.
When you expand a Workspace, you should see Projects in that workspace.
When you expand a Project, you can view contents by: Branches, Revisions, or the latest Revision on the default branch shown in Figure 5.
In this example, the contents of a Spacecraft Architecture model is loaded in the tree view.
Go to the Projects menu item on the LHS and select a Digital Thread Project. Then go to the Workspace tab at the top of the dashboard. Expand the same Teamwork Cloud repository done in Step 4 and now keep expanding model packages (i.e. Spacecraft_Hardware). The tree view in 3.7 includes enhanced display of element and diagram icons as shown below in Figure 6.
With the Spacecraft_Hardware package still expanded, expand the IR scanner block and Spacecraft assembly block underneath, highlighted below in Figure 7. The Relations category now shows the incoming and outgoing relations for each element and the relation type. For example, the Spacecraft assembly block satisfies the Requirement called Spacecraft Total Mass. Expand the Spacecraft assembly part property body and under ‘Relations’ it shows this part property is typed by the block element Body.
Syndeia 3.7 includes the ability to view stereotype tag values and default property values directly in the Tree View as shown in Figure 8 below. For example, if the Antenna arm block is expanded, the value property Length and its default value (=70 in) can be seen in the tree. Stereotype tags applied to the Antenna arm block and the tag values can also be seen, such as mass, mass_unit, and others shown in Figure 8 below.
In Figure 9 below, the Spacecraft_Requirements package is expanded with the enhanced icons for Spacecraft Fuel Performance requirement and the Spacecraft_Requirements table diagram highlighted below in red. Syndeia 3.7 shows the tag values of requirements in the Tree view as also shown below for Spacecraft Total Mass.
Next Teamwork Cloud Tutorial:
Go to Exercise 20.2 - Exploring the Search/Details/Relations Tab and Graph View of TWC Artifacts to use the Search/Details/Relations tabs in the Digital Thread project workspace and create digital thread (inter-model) relations between Teamwork Cloud artifacts and artifacts in other repositories.