ReqIF mapping file

Mapping of the types and attributes of one ReqIF source to the own metamodel, saved as YAML in the mapping folder of the workspace (mappings, default reqif in the main repository) and reused for every later import from and export to that source (N-045, D-022, SR-054). The own metamodel is never changed by it (SR-054 AK3). Also holds saved export profiles (SR-059 AK3).

Fields

Field	Type	Required	Description
reqseq-reqif-mapping	1	yes
source	object	yes
source.name	string	yes	Name of the source as written to the property with meaning source (SR-057, D-059).
source.tool-id	string	no	REQ-IF-TOOL-ID seen in deliveries, for recognising the source.
target	location	no	Folder where imported elements are written.
types	array of any or any	no
types[].source	string	yes	LONG-NAME or IDENTIFIER of the SPEC-OBJECT-TYPE.
types[].type	key	no	Fixed metamodel key of a type, property, relation kind or status value. Readable English, lower case, dashes (D-043, SR-010 AK2).
types[].omit	true	no
attributes	array of any or any	no
attributes[].source-type	string	no	Restricts the entry to one SPEC-OBJECT-TYPE.
attributes[].source	string	yes	LONG-NAME or IDENTIFIER of the ATTRIBUTE-DEFINITION.
attributes[].property	one of "title", "text" or key	no
attributes[].values	object	no	Enumeration value -> choice key.
attributes[].omit-values	array of string	no	Enumeration values left out on import, each listed as a loss (SR-055 AK2).
attributes[].omit	true	no
relations	array of any or any	no
relations[].source	string	yes	LONG-NAME or IDENTIFIER of the SPEC-RELATION-TYPE.
relations[].kind	key	no	Fixed metamodel key of a type, property, relation kind or status value. Readable English, lower case, dashes (D-043, SR-010 AK2).
relations[].omit	true	no
statement	object	no	Where the statement (Stellungnahme) goes when exporting back to the source (SR-058).
statement.property	key	yes	Own property that holds the statement.
statement.attribute	string	yes	ATTRIBUTE-DEFINITION in the source’s model.
statement.datatype	one of "string", "xhtml"	no	How the statement is written: as STRING, or as XHTML converted from its Markdown (SR-058 AK1). Default: "string".
omit-properties	array of key	no	Properties left out of every export to this source; written by reqif.export with mapping and omitProperties (SR-059 AK1, AK3).
export-profiles	array of object	no
export-profiles[].name	string	yes
export-profiles[].selection	selection	yes	Which elements a command works on: a saved filter, an inline filter, a package, a baseline or explicit IDs, optionally seen through a variant view.
export-profiles[].omit-properties	array of key	no	SR-059 AK1.

Examples

customer-acme.yaml

reqseq-reqif-mapping: 1
source: { name: ACME, tool-id: DOORS Next }
target: { repository: system, path: imported/acme }
types:
  - { source: Customer Requirement, type: system-requirement }
  - { source: Heading, omit: true }
attributes:
  - { source: ReqIF.Name, property: title }
  - { source: ReqIF.Text, property: text }
  - { source: Priority, property: requirement-type, values: { High: functional, Low: quality } }
  - { source: Internal Comment, omit: true }
relations:
  - { source: satisfies, kind: derives-from }
statement: { property: statement, attribute: Supplier Statement }
export-profiles:
  - name: Supplier sensor
    selection: { package: 19fd3f5e-9caf-4c94-9e30-c4eb8a40324a }
    omit-properties: [rationale]