ExportOptions

Options for exporting requirement sets as ReqIF files

Since R2023a

Description

Use ExportOptions objects to configure options when exporting requirement sets as ReqIF™ files.

Creation

Syntax

options = slreq.export.ExportOptions

options = slreq.export.ExportOptions(Name=Value)

Description

options = slreq.export.ExportOptions creates a ExportOptions object.

options = slreq.export.ExportOptions(Name=Value) creates a ExportOptions object and sets properties using one or more name-value arguments. For example, slreq.export.ExportOptions(template="Generic") sets the export to map to a generic template.

Properties

outputFile — Exported file name and directory

"" (default) | string scalar | character vector

Exported ReqIF file name and directory, specified as a string scalar or character vector. The file name must have the .reqif or .reqifz extension. If the requirements contain images and you use the .reqif extension, the function updates the extension of the file automatically.

Data Types: char | string

template — Export mapping

"" (default) | "Generic" | "IBM DOORS" | "IBM DOORS Next" | ...

Export mapping, specified as one of these options:

Value	Description
empty string scalar or character vector	The export uses the mapping of the imported requirement set. Otherwise, the export maps to a generic template map.
"Generic"	The export template maps to a generic template.
"IBM DOORS"	The export template maps to IBM® Rational® DOORS®.
"IBM DOORS Next"	The export template maps to IBM DOORS Next.
"Jama Software"	The export template maps to Jama software.
"Polarion"	The export template maps to Polarion®.
"PREEvision"	The export template maps to PREEvision.

Data Types: enum

includeLinks — Whether file includes links

false or 0 (default) | true or 1

Whether the exported file includes the links associated with the requirement set, specified as a numeric or logical 0 (false) or 1 (true).

Data Types: logical

Examples

Export Requirement with Options

Suppose you have a requirement set in the current folder, myReqs.slreqx, and you want to export the requirement set with a custom name. Load the requirement set with the slreq.load function.

rs = slreq.load("myReqs.slreqx");

Specify the custom name you want by defining a ExportOptions object.

opts = slreq.export.ExportOptions(outputFile="custom_name.reqif");

Export the requirement set by using the slreq.export function.

slreq.export(req,opts)

ans =

    'custom_name.reqif'

Version History

Introduced in R2023a