Getting source code associations for report

Thursday, August 4, 2022

Since we managing our requirements BDD-style, it makes good sense to have links between our Gherkin files (source code) and Requirements, since the Gherkin serves both as a test case and as an extension to the requirements. I don't want to maintain Gherkins as separate Spira artifacts since our CI server runs continuous (cucumber) tests based on those Gherkins, so they are considered source code. 

Thankfully, this type of association is supported by Spira. However, I'd like to make a custom report that shows the requirements listed and for each its associated source files (=gherkins). Now I don't see an out of the box table to use for getting to the source files (although I can pull that info out using the REST API). Also, I'm not sure if the links between source files and requirements would show up in the ArtifactAssociations table (since the source files have no table and no Ids).

Is a report like this possible, or will it be possible in the near future?


4 Replies
Sunday, August 7, 2022
re: dl.pie Thursday, August 4, 2022


The Standard Report sections should include this association. It won't be available for use in custom sections because that table is not currently exposed as a reportable view.

If you run the Requirements Detailed report in Raw XML format, you should see the Source Code associations?



Monday, August 8, 2022
re: inflectra.david Sunday, August 7, 2022

Hey David,

No unfortunately not. I think what you refer to are associations with source code revisions

I can link a revision with a requirement, and this will show up in the XML (SourceCodeRevisions subtable).  This will also show up in the Associations tab of the requirement in question (while a source code link will only show up in the associations tab of the source file, but not in the requirement)

While I can also see uses for linking source code revisions with requirements, this is not what we are looking for here. The link is between the source file itself and the requirement. Spira supports this, but the reporting does not. 


Tuesday, August 9, 2022
re: dl.pie Monday, August 8, 2022

Oh I see.

Does it not show up in the Attachments collection?

Thursday, August 11, 2022
re: inflectra.david Tuesday, August 9, 2022

That doesn't seem to be the case. I can add an existing source file as an attachment to a requirement (which is the other way around from what I would want), but also in that case, the association won't show up in any tables. Also, the listed 'Document' attachment in this case has a strange (negative) ID in the Spira GUI. 

Spira Helps You Deliver Quality Software, Faster and With Lower Risk

And if you have any questions, please email or call us at +1 (202) 558-6885


  • Started: Thursday, August 4, 2022
  • Last Reply: Thursday, August 11, 2022
  • Replies: 4
  • Views: 380