slreq.import

从外部文档导入需求

全页折叠

语法

slreq.import(docPath)

[refCount, reqSetFilePath, reqSetObj] = slreq.import(docPath)

slreq.import(docType)

slreq.import(___,Name=Value)

slreq.import("clearcache")

说明

slreq.import(docPath) 从位于 docPath 的外部文档中导入需求，并将它们保存为引用需求，存储在一个与外部文档同名的新的需求集中.使用此函数从 Microsoft^® Office 文档和要求交换格式(RIF)"）文件中导入需求。

示例

[refCount, reqSetFilePath, reqSetObj] = slreq.import(docPath) 从外部文档中导入引用需求，并返回生成的引用需求数量 refCount、包含引用需求的 demand 集合的路径 reqSetFilePath，以及引用需求对象的名称 reqSetObj。

示例

slreq.import(docType) 从外部文档中导入引用需求，这些外部文档的文档类型为已注册的 docType 类型。该函数将导入的需求保存到一个新的需求集，该需求集与外部文档具有相同的名称。

示例

slreq.import(___,Name=Value) 除了前面语法中的输入参量外，还使用一个或多个名称-值参量指定选项。

示例

slreq.import("clearcache") 清理在导入富文本格式需求时生成的临时 HTML 文件。

示例

全部折叠

从 Microsoft Office 导入引用需求

从一个 Microsoft Word 文档中导入引用需求。

slreq.import("Specification002.docx");

从 Microsoft Excel 导入引用需求

将电子表格 MyExcelDoc.xlsx 中 3 至 150 的行以富文本格式导入。将电子表格的第二列映射到需求中的 ID 属性，将第三列映射到需求中的 Description 属性。然后，清理临时 HTML 文件。

slreq.import("MyExcelDoc.xlsx",rows=[3 150],...
idColumn=2,descriptionColumn=3,RichText=true);

slreq.import("clearcache");

导入需求及退货需求设置信息

从一个 Microsoft Excel^® 文档中导入引用需求，并返回导入的需求数量、需求集文件路径以及需求集对象。

[count,reqSetFilePath,reqSet] = slreq.import( ...
    "ExampleRequirements.xlsx");

从 IBM DOORS 导入引用需求

从 IBM DOORS 模块导入引用需求。要导入引用需求，DOORS 应用程序必须正在运行，您必须已登录，并且要导入的模块必须已打开且处于当前状态。

slreq.import("linktype_rmi_doors");

输入参数

全部折叠

`docPath` — 外部需求文档的路径或 ReqIF™ 文件
字符串标量 | 字符向量

外部需求文档或 ReqIF 文件的路径，指定为字符串标量或字符向量。

`docType` — 外部需求文档的文档类型
字符串标量 | 字符向量

外部需求文档的文档类型，指定为字符向量。docType 的值必须与已注册文档域之一的标签匹配.您可以指定内置的或自定义的文档域。要查看已注册的域名标签列表，请运行以下命令：

rmi("linktypelist");

例如，要从当前打开的 IBM DOORS^® 模块导入需求，请将 docType 指定为 "linktype_rmi_doors"。

名称-值参数

全部展开

以 Name1=Value1,...,NameN=ValueN 的形式指定可选参量对组，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但对各个参量对组的顺序没有要求。

示例: slreq.import(docPath,AsReference=true) 将位于 docPath 的文档中的需求导入为参考需求。

常规选项

全部展开

`AsReference` — 根据引用需求导入的选项
`true` (默认) | `false`

将需求作为引用需求导入的选项，指定为 true 或 false。

要将引用需求导入为引用需求，请将值设置为 true。如果希望继续在第三方工具中管理需求，请选择此选项。要将需求导入为 slreq.Requirement 对象，请将值设置为 false。使用此选项将需求迁移到 Requirements Toolbox™。有关详细信息，请参阅选择导入模式。

示例: AsReference=true

`attributes` — 自定义属性列的属性名称
元胞数组

自定义属性列的属性名称，指定为字符向量元胞数组。

注意

从 Microsoft Excel 电子表格导入需求时，此元胞数组的长度必须与 attributeColumn 参量指定的列数相匹配。

示例: attributes={'Test Status','Test Procedure'}

`DocID` — 外部需求文档标识符
字符串标量 | 字符向量

外部需求文档标识符，指定为字符串标量或字符向量。

提示

从 IBM DOORS 导入时，请使用 DocID 参量指定模块 ID。

示例: DocID="0000abcd"

`preImportFcn` — 自定义导入前回调
字符串标量 | 字符向量

导入期间使用的自定义预导入回调脚本名称，指定为字符串标量或字符向量。

您分配给此回调的脚本在您导入或更新需求之前执行。有关详细信息，请参阅使用回调自定义需求导入行为。

示例: preImportFcn="myPreImportScript"

`postImportFcn` — 自定义导入后回调
字符串标量 | 字符向量

导入期间使用的自定义导入后回调脚本名称，指定为字符串标量或字符向量。

您导入或更新需求后，将执行分配给此回调的脚本。有关详细信息，请参阅使用回调自定义需求导入行为。

示例: postImportFcn="myPostImportScript"

`ReqSet` — 需求集名称
字符串标量 | 字符向量

用于导入需求的条件集名称，指定为字符串标量或字符向量。

如果需求集存在，则需求导入到新的导入节点下。如果需求集不存在，Requirements Toolbox 会创建它。

示例: ReqSet="My_Requirements_Set"

`RichText` — 导入需求作为富文本的选项
`false` (默认) | `true`

导入需求为富文本格式，格式选项指定为 true 或 false。要导入富文本格式需求，请将 RichText 设置为 true。

示例: RichText=true

Microsoft Excel 和 Microsoft Word 的选项

全部展开

`bookmarks` — 使用书签导入需求的选项
`true` 或 `1` | `false` 或 `0`

导入需求内容的选项，支持通过用户自定义书签导入需求内容，书签格式可指定为数字或逻辑值 1 (true) 或 0 (false)。

默认情况下，Requirements Toolbox 将 Microsoft Word 文档的值设置为 1，将 Microsoft Excel 电子表格的值设置为 0。

示例: bookmarks=false

`match` — 正则表达式模式
字符串标量 | 字符向量

用于在 Microsoft Office 文档中搜索 ID 的正则表达式模式，指定为字符串标量或字符向量。

示例: match="^REQ\d+"

Microsoft Excel 的选项

全部展开

`attributeColumn` — 要映射为自定义属性的列范围
`double` 数组

在 Microsoft Excel 电子表格中，用于映射到需求集中的需求自定义属性的列范围，以 double 数组形式指定.

示例: attributeColumn=[4 6]

`columns` — 要导入的列范围
`double` 数组

要从 Microsoft Excel 电子表格中导入的列范围，指定为一个 double 数组。

示例: columns=[1 6]

`createdByColumn` — 将列映射到需求中的 `CreatedBy` 属性
`double`

在 Microsoft Excel 电子表格中的列，用于映射到需求集中的需求属性 CreatedBy，该属性以 double 格式指定.

示例: createdByColumn=5

`descriptionColumn` — 将列映射到需求中的 `Description` 属性
`double`

在 Microsoft Excel 电子表格中的列，用于映射到需求集中的需求属性 Description，该属性以 double 格式指定.

示例: descriptionColumn=2

`idColumn` — 将列映射到需求中的 `ID` 属性
`double`

在 Microsoft Excel 电子表格中的列，用于映射到需求集中的需求属性 ID，该属性以 double 格式指定.

示例: idColumn=1

`keywordsColumn` — 将列映射到需求中的 `Keywords` 属性
`double`

在 Microsoft Excel 电子表格中的列，用于映射到需求集中的需求属性 Keywords，该属性以 double 格式指定.

示例: keywordsColumn=3

`modifiedByColumn` — 将列映射到需求中的 `ModifiedBy` 属性
`double`

在 Microsoft Excel 电子表格中的列，用于映射到需求集中的需求属性 ModifiedBy，该属性以 double 格式指定.

示例: modifiedByColumn=6

`rationaleColumn` — 将列映射到需求中的 `Rationale` 属性
`double`

在 Microsoft Excel 电子表格中的列，用于映射到需求集中的需求属性 Rationale，该属性以 double 格式指定.

示例: rationaleColumn=5

`rows` — 要导入的行范围
`double` 数组

要从 Microsoft Excel 电子表格导入的行范围，指定为 double 数组。

示例: rows=[3 35]

`sheet` — 工作表名称
字符串标量 | 字符向量

要从 Microsoft Excel 工作簿中导入的电子表格名称，指定为字符串标量字符向量。

示例: sheet="Sheet1"

`summaryColumn` — 将列映射到需求中的 `Summary` 属性
`double`

在 Microsoft Excel 电子表格中的列，用于映射到需求集中的需求属性 Summary，该属性以 double 格式指定.

示例: summaryColumn=4

`USDM` — 以 USDM 标准格式导入
字符串标量 | 字符向量

从符合 USDM（通用规范描述方式）标准格式的 Microsoft Excel 电子表格导入。将值指定为带有 ID 前缀的字符向量，后面可以跟一个分隔符。

示例: USDM="RQ -" 将匹配 ID 与 RQ01、RQ01-2、RQ01-2-1 等类似的条目。

ReqIF 文件的选项

全部展开

`attr2reqprop` — ReqIF 属性映射
`containers.Map` 对象

ReqIF 属性映射，指定为一个 containers.Map 对象。

示例: attr2reqprop=attrMap

`importLinks` — 导入链接的选项
`false` (默认) | `true`

在从 ReqIF 文件导入需求时，提供导入链接的选项，链接格式指定为 true 或 false。

示例: importLinks=true

`mappingFile` — 属性映射文件路径
字符串标量 | 字符向量

属性映射文件的路径，指定为字符串标量或字符向量。

示例: mappingFile="D:/reqifmapping/myMapping.xml"

`profile` — 配置文件名称
字符串标量 | 字符向量

从 ReqIF 文件导入需求和链接时使用的配置文件名称，指定为字符串标量或字符向量.

如果不存在名为“此名称”的配置文件，软件将创建该配置文件，并将其分配给导入的需求集和链接集。如果存在名称相同的配置文件，软件将该配置文件分配给导入的需求集和链接集。

示例: profile="myProfile"

`profileMapping` — 配置文件映射文件的名称
字符串标量 | 字符向量

导入 ReqIF 文件中的需求和链接时使用的配置文件映射 XML 文件的名称，指定为字符串标量或字符向量.

配置文件映射文件指定了 ReqIF 需求、链接类型和属性如何映射到 Requirements Toolbox 构造型和构造型属性。要使用此参量，您还必须使用 profile 参量指定要分配给导入的需求集和链接集的配置文件。

提示

您可以使用 saveProfileMapping 方法从具有配置文件映射的需求集创建配置文件映射文件。

示例: profileMapping="myMapping.xml"

DOORS 和自定义文档类型的导入选项

全部展开

`keywords` — 将属性映射到需求中的 `Keywords` 属性
字符串标量 | 字符向量

要映射到导入需求中 Keywords 属性的外部文档中的属性名称，指定为字符串标量或字符向量。

示例: keywords="Requirement Keywords"

`rationale` — 将属性映射到需求中的 `Rationale` 属性
字符串标量 | 字符向量

要映射到导入需求中 Rationale 属性的外部文档中的属性名称，指定为字符串标量或字符向量。

示例: rationale="Requirement Rationale"

输出参量

全部折叠

`refCount` — 导入参考需求数值
`double`

导入的引用需求数量，以 double 格式返回。

`reqSetFilePath` — 需求文件路径
字符向量

包含导入需求的规范集文件的路径，以字符向量形式返回。

`reqSetObj` — 需求集
`slreq.ReqSet` 对象

导入需求时所设置的需求集，以 slreq.ReqSet 对象形式返回。

限制

MATLAB^® Online™ 不支持从 Microsoft Word、Microsoft Excel 或 IBM^® DOORS 文档导入需求。

提示

当您导入或更新需求时，您可以使用回调来执行代码。有关详细信息，请参阅使用回调自定义需求导入行为。

版本历史记录

在 R2018a 中推出

全部展开

R2023b: 从 ReqIF 文件导入需求和链接时使用配置文件和配置文件映射

使用 profile 名称-值参量来指定在从 ReqIF 文件导入需求和链接时要使用的配置文件名称.
使用 profileMapping 名称-值参量指定在从 ReqIF 文件导入需求和链接时要使用的配置文件映射 XML 文件的名称.

R2022a: 从 ReqIF 文件导入链接

使用 importLinks 参量从 ReqIF 文件中导入链接。

另请参阅

类

slreq.ReqSet | slreq.Reference | slreq.Requirement

函数

slreq.new | importFromDocument | slreq.export

slreq.import

语法

说明

示例

从 Microsoft Office 导入引用需求

从 Microsoft Excel 导入引用需求

导入需求及退货需求设置信息

从 IBM DOORS 导入引用需求

输入参数

docPath — 外部需求文档的路径或 ReqIF™ 文件 字符串标量 | 字符向量

docType — 外部需求文档的文档类型 字符串标量 | 字符向量

名称-值参数

常规选项

AsReference — 根据引用需求导入的选项 true (默认) | false

attributes — 自定义属性列的属性名称 元胞数组

DocID — 外部需求文档标识符 字符串标量 | 字符向量

preImportFcn — 自定义导入前回调 字符串标量 | 字符向量

postImportFcn — 自定义导入后回调 字符串标量 | 字符向量

ReqSet — 需求集名称 字符串标量 | 字符向量

RichText — 导入需求作为富文本的选项 false (默认) | true

Microsoft Excel 和 Microsoft Word 的选项

bookmarks — 使用书签导入需求的选项 true 或 1 | false 或 0

match — 正则表达式模式 字符串标量 | 字符向量

Microsoft Excel 的选项

attributeColumn — 要映射为自定义属性的列范围 double 数组

columns — 要导入的列范围 double 数组

createdByColumn — 将列映射到需求中的 CreatedBy 属性 double

descriptionColumn — 将列映射到需求中的 Description 属性 double

idColumn — 将列映射到需求中的 ID 属性 double

keywordsColumn — 将列映射到需求中的 Keywords 属性 double

modifiedByColumn — 将列映射到需求中的 ModifiedBy 属性 double

rationaleColumn — 将列映射到需求中的 Rationale 属性 double

rows — 要导入的行范围 double 数组

sheet — 工作表名称 字符串标量 | 字符向量

summaryColumn — 将列映射到需求中的 Summary 属性 double

USDM — 以 USDM 标准格式导入 字符串标量 | 字符向量

ReqIF 文件的选项

attr2reqprop — ReqIF 属性映射 containers.Map 对象

importLinks — 导入链接的选项 false (默认) | true

mappingFile — 属性映射文件路径 字符串标量 | 字符向量

profile — 配置文件名称 字符串标量 | 字符向量

profileMapping — 配置文件映射文件的名称 字符串标量 | 字符向量

DOORS 和自定义文档类型的导入选项

keywords — 将属性映射到需求中的 Keywords 属性 字符串标量 | 字符向量

rationale — 将属性映射到需求中的 Rationale 属性 字符串标量 | 字符向量

输出参量

refCount — 导入参考需求数值 double

reqSetFilePath — 需求文件路径 字符向量

reqSetObj — 需求集 slreq.ReqSet 对象

限制

提示

版本历史记录

R2023b: 从 ReqIF 文件导入需求和链接时使用配置文件和配置文件映射

R2022a: 从 ReqIF 文件导入链接

另请参阅

类

函数

主题

`docPath` — 外部需求文档的路径或 ReqIF™ 文件
字符串标量 | 字符向量

`docType` — 外部需求文档的文档类型
字符串标量 | 字符向量

`AsReference` — 根据引用需求导入的选项
`true` (默认) | `false`

`attributes` — 自定义属性列的属性名称
元胞数组

`DocID` — 外部需求文档标识符
字符串标量 | 字符向量

`preImportFcn` — 自定义导入前回调
字符串标量 | 字符向量

`postImportFcn` — 自定义导入后回调
字符串标量 | 字符向量

`ReqSet` — 需求集名称
字符串标量 | 字符向量

`RichText` — 导入需求作为富文本的选项
`false` (默认) | `true`

`bookmarks` — 使用书签导入需求的选项
`true` 或 `1` | `false` 或 `0`

`match` — 正则表达式模式
字符串标量 | 字符向量

`attributeColumn` — 要映射为自定义属性的列范围
`double` 数组

`columns` — 要导入的列范围
`double` 数组

`createdByColumn` — 将列映射到需求中的 `CreatedBy` 属性
`double`

`descriptionColumn` — 将列映射到需求中的 `Description` 属性
`double`

`idColumn` — 将列映射到需求中的 `ID` 属性
`double`

`keywordsColumn` — 将列映射到需求中的 `Keywords` 属性
`double`

`modifiedByColumn` — 将列映射到需求中的 `ModifiedBy` 属性
`double`

`rationaleColumn` — 将列映射到需求中的 `Rationale` 属性
`double`

`rows` — 要导入的行范围
`double` 数组

`sheet` — 工作表名称
字符串标量 | 字符向量

`summaryColumn` — 将列映射到需求中的 `Summary` 属性
`double`

`USDM` — 以 USDM 标准格式导入
字符串标量 | 字符向量

`attr2reqprop` — ReqIF 属性映射
`containers.Map` 对象

`importLinks` — 导入链接的选项
`false` (默认) | `true`

`mappingFile` — 属性映射文件路径
字符串标量 | 字符向量

`profile` — 配置文件名称
字符串标量 | 字符向量

`profileMapping` — 配置文件映射文件的名称
字符串标量 | 字符向量

`keywords` — 将属性映射到需求中的 `Keywords` 属性
字符串标量 | 字符向量

`rationale` — 将属性映射到需求中的 `Rationale` 属性
字符串标量 | 字符向量

`refCount` — 导入参考需求数值
`double`

`reqSetFilePath` — 需求文件路径
字符向量

`reqSetObj` — 需求集
`slreq.ReqSet` 对象