Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Traceability

This command does not only process the selected entities, this is normally indicative of a bulk action which supports being passed a TQL query which forms the basis of entities it should apply to.

ParameterDescription
columnsThe columns to export (if export all is set to false, this is an array of columns states i.e. [{ "Name": "col1", "IsVisible": true }, { "Name": "col2", "IsVisible": true }] )
commandNameMust be set to value 'Traceability'
exportAllExport all records (true/false)
projectIdId of the the project the action applies to (used by some actions to determine the custom fields & permissions required to complete the action)
targetPackageIdId of the target package (if any, normally same as the targetId)

Scenarios

  • CSV

Scenario "CSV"

Supported Types: Requirement

This scenario has scenario-specific parameters:

ParameterDescription
additionalcolumnsThe additional columns to be included (these columns don't necessarily have to be in-scope for the entity type defined by the query / current context).
delimiterThe CSV delimiter to use (valid values are 'comma', 'colon', 'pipe', 'semicolon' or 'tab')
encodingThe exporting enncoding type
entitiesToIncludeList of entity types to include
includeAllRunsValue specifying of either all runs or last of script are traced (All or LastRun)
includeAssociatedLinksBoolean value, if true then association columns (Associated requirements, Associated Scripts, Associated Incidents, External Identifiers) will include hyperlinks to the associated entities
includeAttachmentsLinksIf true, then include attachment URL links in the generated output (otherwise just include attachment names)
includeHeaderInclude headers in export file
queryThe TQL query used to filter the root items being included in the traceability report CSV output
scenarioNameMust be set to value 'CSV'