importFromDocument

类: slreq.ReqSet
命名空间: slreq

从外部文档导入可编辑需求

全页展开

语法

importFromDocument(rs,pathToFile)

importFromDocument(___,Name=Value)

说明

importFromDocument(rs,pathToFile) 从外部文档 pathToFile 中导入可编辑的需求，并将其导入到由 rs 指定的需求集.

示例

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

示例

输入参数

全部展开

`rs` — 需求集文件
`slreq.ReqSet` 对象

需求集文件，指定为 slreq.ReqSet 对象。

`pathToFile` — 需求文档文件路径
字符串标量 | 字符向量

要导入可编辑需求文件的文件路径，指定为字符串标量或字符向量。

示例: "C:\MATLAB\System_Requirements.docx"

名称-值参数

全部展开

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

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

常规选项

全部展开

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

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

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

示例: 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`

您想要映射到需求集需求的 Keywords 属性的 Microsoft Excel 电子表格中的列，指定为 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"

示例

全部展开

从 Microsoft Word 文档导入可编辑的需求

此示例演示了如何创建需求集，并从 Microsoft Excel 电子表格中导入需求到需求集。

% Create a new requirement set and save it
rs = slreq.new("newReqSet");
save(rs);

% Import editable requirements as rich text from a Word document
importFromDocument(rs,"C:\Work\Requirements_Spec.docx");

从 Microsoft Excel 导入可编辑的需求，使用选项

此示例演示了如何创建并保存需求集。然后，示例演示了如何通过指定要导入的行和列，以及将列映射到需求中的 Summary 和 ID 属性，来导入需求。

% Create a new requirement set and save it
rs = slreq.new("newReqSet");
save(rs);

% Import editable requirements from an Excel spreadsheet
importFromDocument(rs,"C:\Work\Req_Spec.xlsx", ... 
columns=[2 6],rows=[3 32],idColumn=2, ...
summaryColumn=3);

importFromDocument

语法

说明

输入参数

rs — 需求集文件 slreq.ReqSet 对象

pathToFile — 需求文档文件路径 字符串标量 | 字符向量

名称-值参数

常规选项

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 属性 字符串标量 | 字符向量

示例

从 Microsoft Word 文档导入可编辑的需求

从 Microsoft Excel 导入可编辑的需求，使用选项

版本历史记录

另请参阅

类

函数

主题

`rs` — 需求集文件
`slreq.ReqSet` 对象

`pathToFile` — 需求文档文件路径
字符串标量 | 字符向量

`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` 属性
字符串标量 | 字符向量