Populating artifact areas

Creating links between artifacts or editing a single link requires you to insert one or more artifacts into the Artifact A and Artifact B areas of YT Editor’s Link tab. In case you are editing all links of an artifact, you have to insert an artifact into the Replace artifact by area of YT Editor’s Artifact tab.

You have several different options to achieve this comfortably in various situations. In particular, you can

By the way, clicking on the clear icon symbol: document clear clears all YT Editor fields and resets the editor completely.

Artifact areas' behavior

The Artifact A and Artifact B areas in YT Editor’s Link tab behave differently, depending on whether YT Editor is currently operating in create mode or in edit mode. When you are creating links, both fields may contain an arbitrary number of artifacts. However, when you are editing a single link, by definition that link has a single artifact at each of its two link ends. Thus the Artifact A and Artifact B areas can hold only a single artifact each.

As long as both Artifact A and Artifact B areas are empty, you can insert any artifact into any artifact area.

After you inserted the first artifact into one of the artifact areas, that artifact’s type is displayed in the area’s heading. In create mode, you can add more artifacts to that area, but only artifacts of the same artifact type. In edit mode, you cannot add further artifacts.

If one of the artifact areas has some contents, certain constraints are applied to the opposite artifact area. Adding an artifact to the latter is allowed only if there is a link type between the type of the artifact to be added and the opposite artifact area’s artifact type.

Please note: In create mode, the above assumes that YT has not been configured to create links across different link types. Otherwise certain restrictions are lifted, allowing you to add artifacts of different types to the same artifact area.

Searching for artifacts by type

You can search for artifacts by their respective type using the Artifact Search dialog. To open that dialog, click on the magnifying glass icon symbol: magnifying glass in YT Editor. On the Link tab, it is located right from the "Create link" resp. "Edit link" heading. On the Artifact tab, you can find it right from the Replace artifact by field.

Figure "The Artifact Search dialog" shows how the dialog looks like.

The "Artifact Search" dialog

The Artifact Search dialog

  1. In the Artifact type drop-down menu, select the type of the desired artifact.
  2. Optionally, define a textual filter to find your artifacts faster in the Filter in visible tree field.
    1. If a filter is set, the dialog shows only artifacts (and hierarchies containing them) with names conforming to that filter.
    2. To clear the filter, please enter a blank (empty) text, or click on the rubber icon.
    3. The Regexp checkbox controls whether the entered text is a plain text filter or a regular expression filter:
      1. A plain text filter matches if the name of an artifact contains the given filter text. Matching is not case-sensitive.
      2. A regexp filter matches if the name of an artifact matches the given regular expression.
  3. The Matching Artifacts section displays artifacts according to the choices you made above. Select the artifact or artifacts you want to deal with.
  4. Click on the Add to favorites button to add the selected artifacts to your YT Favorites view. In YT Favorites, you can maintain a list of frequently-used artifacts for easier access.
  5. Click on the Add to A or Add to B button to add the selected artifacts to the respective artifact area of the YT Editor view.
  6. Click on the Close button to close the Artifact Search dialog.

Please note: In create mode, you can usually add artifacts via the Add to A or Add to B button only if the respective artifact area is either empty or contains artifacts of the same type already. To remove any unwanted artifact from an artifact area, click on the symbol: red "x" symbol right from the artifact, see section Removing artifacts from an artifact area.

In order to support the efficient creation of a large number of links, you can have multiple Artifact Search dialogs open simultaneously. To open them, click on the magnifying glass icon symbol: magnifying glass multiple times. These dialogs remain open after link creation; close them explicitly by clicking on their Close button, if needed.

Pasting artifacts from the clipboard

Most if not all tools offer the possibility to copy elements of whatever kind to the system-wide clipboard. You can paste the clipboard contents as artifacts to the A or B artifacts area.

  1. Select one or more artifacts in the originating tool, e.g., a portion of text in an editor, cells in a spreadsheet, entries in a requirement management tool, etc.
  2. Copy your selection to the clipboard, typically using the [Ctrl+C] key combination, a menu entry like Edit → Copy, or some tool-specific means.
  3. In YT Editor’s Artifact A or Artifact B area, click on the clipboard icon symbol: clipboard.
  4. YT reads the clipboard contents, tries to convert it into one or more artifacts, and – if successful – inserts them into the respective A or B artifacts area. If you are editing an existing link, only the first artifact on the clipboard will be added to the artifact area.

YT checks for duplicate artifacts. It won’t add an artifact to an area twice.

Adapter support for pasting from clipboard

Converting clipboard contents into artifacts requires YT …

  • to recognize the type of data that is currently on the clipboard and
  • to actually do the conversion.

Recognition and conversion are performed by YT adapters. Currently the PTC Integrity and the Microsoft Word adapters are supporting pasting from the clipboard. Please refer to the reference documentation to find out how pasting is supported.

Selecting the artifact type to be pasted

If the clipboard contents matches several different artifact types, choose the type of the artifacts to be inserted by selecting it from the drop-down menu that opens when clicking on the black triangle symbol: black triangle.

Consider, for example, you have two artifact types Requirement and Test specification. Both of them use the Microsoft Word adapter. Now let’s say you select some text in a Word document, copy it to the clipboard, and want to insert it as a Test specification into the B artifact area.

  1. Clicking simply on the clipboard icon symbol: clipboard won’t help, because YT can not decide whether it should insert the selected text as a Requirement or as a Test specification.
  2. Click on the black triangle symbol: black triangle of the artifact area you want to insert the artifact into, and select the appropriate artifact type, here: Test specification.
  3. Now click on the clipboard icon symbol: clipboard. The selected text will be inserted as a new Test specification artifact. If the same Test specification artifact is already present in the system, no new artifact will be created. Instead, the „old” artifact will appear in the artifact area.

Inserting selected artifacts

Click on the crosshair icon symbol: crosshair at the top of an artifact area to add the currently selected artifact. The currently selected artifact is an artifact that you have selected either …

  • elsewhere in YAKINDU Traceability, e.g., in YT Explorer or in YT Overview, or
  • in its „natural” editor, viewer, or other tool.

Inserting selected artifacts into an artifact area is similar to pasting artifacts from the clipboard. However, no conversion into an artifact is needed, because YT knows about the artifact already.

If you are editing an existing link, only the first selected artifact will be inserted into the respective artifact area.

Drag and drop

Use the „drag and drop” functionality to insert artifacts into the artifact areas, i.e., use the mouse to „drag” an artifact from any place within YAKINDU Traceability, e.g., from YT Explorer or YT Overview, and „drop” it into an artifact area. In create mode, you can drag and drop multiple artifacts simultaneously, in edit mode only a single one.

Picking artifacts from YT Selection History or YT Favorites

In the YT Selection History or YT Favorites view, click on an entry’s A symbol: A or B symbol: B icon to add it to the Artifact A or Artifact B area.

Removing artifacts from an artifact area

You can remove an artifact from an artifact area in the following different ways:

  • Click on the symbol: red "x" symbol right from the artifact to be removed.
  • Select the artifacts to be removed and hit the [Del] key.
  • Click on symbol: clear editor input to clear the input area of YT Editor and remove the artifacts from the artifact area.

Please note: Removing an artifact from an artifact area does not delete the artifact as such. It is just no longer displayed in the respective artifact area. If you wish, you can add it back anytime.