TraceabilityLink Object

Applies to QAComplete 12.84 SaaS, last modified on July 19, 2021

A TraceabilityLink object represents a cross-reference link between entities in QAComplete. Using QAComplete SOAP API you can add, enumerate, and delete links.

To manage traceability link, you need a user account that belongs to a security group with the access to Manage and View traceability and Read, Add, or Update privileges for the corresponding entity. You can view or set these privileges in  > Setup > Security > Security Groups > Manage Security Rights > select group.

When you link an item to releases, you can specify the type of the link. These types are based on the choice lists defined in your QAComplete project for the corresponding entity. You can find these values in [Item type] > Show Items >  Tools (Actions) >  Manage Choice Lists.

Properties

LinkId  :  integer

The unique identifier of the traceability link.

ProjId  :  integer

The ID of the QAComplete project that contains the traceability link.

EntityCode  :  string (max 106 chars)

The entity class of the item that contains a link to another item. Possible value:

  • Bugs (defects)
  • Contacts
  • FunctionalSpecs (requirements)
  • ProjectPlans
  • ProjectPlanTasks
  • ProjectTasks (agile tasks)
  • Releases
  • TestCases (legacy test cases used in release 9.6.0 and earlier)
  • TestConfigurations
  • Tests
  • TestSets

FKId  :  integer

The ID of the item that contains a link to another item. The appropriate property depends on the entity class of the item. For example, it can be BugID for Defects or Id for Releases.

LinkedEntityCode  :  string (max 106 chars)

The entity class of the linked item. Possible values are the same as in the EntityCode property.

LinkedFKId  :  integer

The ID of the linked item. The appropriate property depends on the entity class of the item. For example, it can be BugID for Defects or Id for Releases.

Status  :  string (max 100 chars)

The status of the linked item based on its Status or StatusCode property.

Title  :  string (max 100 chars)

The title of the linked item. Depending on the entity class it can contain different properties of the item. For example, it is equal to the Title property of Tests, but the title of Releases represents in a combination of the FolderName and FullReleaseName properties in a FolderName: FullReleaseName format.

XML entities in the title are double encoded:

& – &

< – &amp;#60;

> – &amp;#62;

LinkType  :  string (max 100 chars)

The type of the link between Release and Agile Task, Requirement or Defect based on the Release Link Types chose list of the corresponding entity.

DateUpdated  :  dateTime

The date when the link was created.

Relevant Operations

Remarks

When you link one item to another, QAComplete creates a pair of the TraceabilityLink objects with equal LinkID properties. One object shows the first item is linked to the second one, and another TraceabilityLink object shows the second item is linked to the first one. For example, when you link Defect to Release it will create two TraceabilityLink objects:

XML

 <TraceabilityLink>
   <LinkId>32</LinkId>
   <ProjId>11873</ProjId>
   <EntityCode>Bugs</EntityCode>
   <FKId>35</FKId>
   <LinkedEntityCode>Releases</LinkedEntityCode>
   <LinkedFKId>23</LinkedFKId>
   <Status>In Progress</Status>
   <Title>TestItem: Release 1.0/Beta/0.9.22</Title>
   <LinkType>Fixed in build</LinkType>
   <DateUpdated>2014-07-23T23:11:13.397</DateUpdated>
</TraceabilityLink>
<TraceabilityLink>
   <LinkId>32</LinkId>
   <ProjId>11873</ProjId>
   <EntityCode>Releases</EntityCode>
   <FKId>23</FKId>
   <LinkedEntityCode>Bugs</LinkedEntityCode>
   <LinkedFKId>35</LinkedFKId>
   <Status>Active</Status>
   <Title>Flash plug-in does not work</Title>
   <LinkType>Fixed in build</LinkType>
   <DateUpdated>2014-07-23T23:11:13.397</DateUpdated>
</TraceabilityLink>

As you can see, the EntityCode and FKId properties of the first object are equal to the LinkedEntityCode and LinkedFKId properties of the second one. QAComplete takes the Title and Status properties from the linked item so they are different.

Example

XML

<TraceabilityLink>
  <LinkId>31</LinkId>
  <ProjId>11873</ProjId>
  <EntityCode>Bugs</EntityCode>
  <FKId>35</FKId>
  <LinkedEntityCode>Releases</LinkedEntityCode>
  <LinkedFKId>24</LinkedFKId>
  <Status>In Progress</Status>
  <Title>TestApplication: Release 1.0/Alfa/0.4.86</Title>
  <LinkType>Found in build</LinkType>
  <DateUpdated>2014-07-23T23:11:12.237</DateUpdated>
</TraceabilityLink>

See Also

TraceabilityLinks_Add Operation
TraceabilityLinks_Load Operation
Traceability Operations

Highlight search results