Traceability matrix template: published logic

File: data/tool-logic/traceability.json
Version: v1.0
Used by: Traceability matrix template

An obligation to test to evidence matrix, prefilled from a classifier result passed in the page address or from the role and tier chosen on the page. For every obligation page in the selected profiles, each testable element becomes a row with the protocol that runs it and the artifact it produces; each documentation and process element becomes a row whose test column names the documentation protocol and whose evidence column names the record the element itself describes. Row ids follow the id scheme below and are assigned at generation, as the obligation-mapping skill requires. The export is CSV.

Columns, id scheme and statuses

Id · Obligation · Requirement element · Kind · Test · Evidence · Applies from · Evidence status

TM-<article number>-<row number> (example TM-15-03)

Missing · Draft · Ready · Recorded as not applicable

Documentation and process rows name PR-11-DOC v1.0 as their test.

The file

data/tool-logic/traceability.json

{
  "id": "traceability",
  "version": "1.0",
  "title": "Traceability matrix template",
  "summary": "An obligation to test to evidence matrix, prefilled from a classifier result passed in the page address or from the role and tier chosen on the page. For every obligation page in the selected profiles, each testable element becomes a row with the protocol that runs it and the artifact it produces; each documentation and process element becomes a row whose test column names the documentation protocol and whose evidence column names the record the element itself describes. Row ids follow the id scheme below and are assigned at generation, as the obligation-mapping skill requires. The export is CSV.",
  "idScheme": {
    "prefix": "TM",
    "pattern": "TM-<article number>-<row number>",
    "example": "TM-15-03"
  },
  "columns": [
    {
      "id": "id",
      "label": "Id"
    },
    {
      "id": "article",
      "label": "Obligation"
    },
    {
      "id": "requirement",
      "label": "Requirement element"
    },
    {
      "id": "kind",
      "label": "Kind"
    },
    {
      "id": "test",
      "label": "Test"
    },
    {
      "id": "evidence",
      "label": "Evidence"
    },
    {
      "id": "appliesFrom",
      "label": "Applies from"
    },
    {
      "id": "status",
      "label": "Evidence status"
    }
  ],
  "kinds": {
    "testable": "test",
    "documentation": "document",
    "process": "process record"
  },
  "documentationProtocol": "PR-11-DOC",
  "statuses": [
    {
      "value": "missing",
      "label": "Missing"
    },
    {
      "value": "draft",
      "label": "Draft"
    },
    {
      "value": "ready",
      "label": "Ready"
    },
    {
      "value": "not-applicable",
      "label": "Recorded as not applicable"
    }
  ],
  "csv": {
    "filename": "traceability-matrix.csv",
    "columns": [
      "id",
      "system",
      "article",
      "requirement",
      "kind",
      "test",
      "evidence",
      "appliesFrom",
      "status"
    ]
  }
}