Codebeamer

The Codebeamer adapter supports extraction of traceability information from projects and trackers of a Codebeamer installation.

Data access

The Codebeamer data access configuration specifies the Codebeamer server to connect to and the projects and tracker of artifacts to load.

Configuration

Open the YT configuration with the YT configuration editor, and add a new data access as described in section "Data accesses". Select Codebeamer as data access type.

Supported keywords:

  • server – The Codebeamer server’s URL or the server’s IP address and port number
  • projects – The project(s) on the Codebeamer server from which YT will load artifacts
  • tracker – The tracker(s) that belong to a specific project or component on the Codebeamer server from which YT will load artifacts

Sample configuration:

server "https://192.168.3.160/cb" 
projects { "MY_PROJECT" {
		tracker "Requirements" {
			"baseline"
		}
	}
}
undefined attribute value = \"N/A\"

In the example above, YT will connect to a Codebeamer server at the IP address 192.168.3.160 via https. YT will consider items from the baseline baseline of tracker Requirements in project MY_PROJECT.

When you first start YT with the adapter enabled, a dialog will ask you for a user name and password for the login. You can store this information in Eclipse’s Secure Store such that you don’t need to re-enter it later.

You can also provide the login credentials as java system properties CODEBEAMER_LOGIN_USER_NAME and CODEBEAMER_LOGIN_PASSWORD. You can set these properties either directly via the the command line or in a configuration file that you specify with YT’s --properties command line option (see Executing YAKINDU Traceability in batch mode ). Alternatively, you can define environment variables with the same names.

Artifact type

The Codebeamer adapter allows for flexible artifact configuration to specify which artifacts YAKINDU Traceability should import from the Codebeamer data access.

Configuration

Open the YT configuration with the YT configuration editor, and add a new artifact type as described in section "Artifact types". Select your previously-configured Codebeamer data access in the Data access drop-down list.

Keywords

Supported keywords:

  • map – Starts a mapping block. This is optional.
  • name – Defines the name of the artifacts.
  • valueOf( attributeName) – References the value of an item attribute with the name attributeName. Possible attributes are:
    • "id" – The type of an artifact.
    • "name" – The name of the project where the artifact is contained.
    • "description" – The name of the component of the artifact.

All items in the configured baseline will be included as YT artifacts. If the optional baseline is not specified, all items in the head version of the tracker are fetched.

You can map attributes, too. Example:

name valueOf ("id")+": "+valueOf ("name")
map {
	desc to valueOf("description")
}

In this example the name of an artifact is build by the id, a colon and the name of the item. In addition we are mapping the custom attribute desc in YT to the values of the attribute description of a Codebeamer item.

Version

An artifact’s version is used for suspicious links validation. The version of an artifact of this type is evaluated as a JSON-like concatenation of all artifact custom attribute values.

The Codebeamer adapter allows to specify which links YAKINDU Traceability should import from the Codebeamer data access. Make sure artifact types have been configured before.

Open the YT configuration with the YT configuration editor, and add a new link type as described in section "Configuring a link type".

Supported keywords:

  • link source is A|B – This optional statement specifies the association source in Codebeamer. If the configured project in Codebeamer contains an association from an object A to an object B, YT will usually (i.e., without link source statement) create a link from the artifact representing A to the artifact representing B. The statement link source is B turns this around: a Codebeamer association from A to B will be loaded as a link from the artifact for B to the artifact for A. You can specify link source is A, but this is equivalent to an empty configuration, because it just defines the default behavior.

Example:

link source is B

As discussed above, this effectively turns around the link direction when loading links from Codebeamer into YT.

Links of this link type will never become suspicious.