Main Content

slreq.import

外部ドキュメントからの要件のインポート

説明

slreq.import(docPath) は、docPath にある外部ドキュメントから参照要件として要件コンテンツをインポートします。インポートした要件は、外部ドキュメントと同じ名前で新しい要件セットに保存されます。このインポート方法を使用して、Microsoft® Office ドキュメントおよび要件交換形式 (.reqif および .reqifz) のファイルから要件コンテンツをインポートします。

[refCount, reqSetFilePath, reqSetObj] = slreq.import(docPath) は、docPath にある外部ドキュメントから参照要件として要件コンテンツをインポートし、インポートされた参照の数 refCount を返します。インポートされた要件は、外部ドキュメントと同じ名前で、reqSetFilePath にある reqSetObj 要件セットに保存されます。

slreq.import(docType) は、登録されたドキュメント タイプ docType である外部ドキュメントから参照要件として要件の内容をインポートします。インポートした要件は、外部ドキュメントと同じ名前で新しい要件セットに保存されます。

slreq.import(docPath,Name,Value) は、1 つ以上の Name, Value ペアの引数で指定されたオプションを使用して、docPath にある外部ドキュメントから参照要件として要件の内容をインポートします。

slreq.import(reqifFile) は、事前に設定された属性マッピングを使用して、ReqIF ファイル reqifFile から要件の内容をインポートします。

slreq.import(reqifFile, 'mappingFile', mapFilePath) は、mapFilePath で指定された属性マッピングを使用して、ReqIF ファイル reqifFile から要件の内容をインポートします。

slreq.import('clearcache') は、リッチ テキスト要件をインポートするときに作成される一時 HTML ファイルをクリーンアップします。

参照要件のインポート

% Import referenced requirements from Microsoft Office documents
slreq.import('Specification002.docx');
slreq.import('D:/Projects/Requirements/Safety321.xlsx');

% Import referenced requirements from an IBM DOORS Module
slreq.import('linktype_rmi_doors');

サードパーティ アプリケーションからの参照要件のインポートの詳細については、サードパーティ製アプリケーションからの要件のインポートを参照してください。

入力引数

すべて折りたたむ

外部要件ドキュメントのファイル パス。文字ベクトルとして指定します。

外部要件ドキュメントのドキュメント タイプ。文字ベクトルとして指定します。

例: 'linktype_rmi_doors'

ReqIF ファイルのファイル パス。文字ベクトルとして指定します。

属性マッピング ファイルのファイル パス。文字ベクトルとして指定します。

名前と値の引数

引数のオプションのペアを Name1=Value1,...,NameN=ValueN として指定します。Name は引数名、Value は対応する値です。名前と値の引数は他の引数の後に表示されなければなりませんが、ペアの順序は重要ではありません。

R2021a より前では、名前と値をそれぞれコンマを使って区切り、Name を引用符で囲みます。

例: 'ReqSet','design_specs.slreqx'

参照要件として要件をインポートするオプション。ブール値として指定します。

要件を引き続きサードパーティ製ツールで管理するには、値を true に設定するか既定値を使用して、要件を参照要件としてインポートします。要件を Requirements Toolbox™ に移行するには、値を false に設定して、要件を slreq.Requirement オブジェクトとしてインポートします。詳細については、インポート モードの選択を参照してください。

'attr2reqprop' および containers.Map オブジェクトで構成されるコンマ区切りのペアとして属性マッピングを指定して、ReqIF 形式からインポートします。以下に例を示します。

attrMap = containers.Map('KeyType','char','ValueType','char')
attrMap('SourceID') = 'Custom ID'; % Built-in attribute
attrMap('ReqIF.ChapterName') = 'Summary'; % Built-in attribute
attrMap('Data Class') = 'MyDataClass'; % Custom attribute

slreq.import('myfile.reqif','attr2reqprop',attrMap);

例: slreq.import('myfile.reqif','attr2reqprop',attrMap);

要件セット内の要件のカスタム属性としてマッピングする Microsoft Excel® スプレッドシートの列。double 配列として指定します。

例: 'attributeColumn',[4 6]

カスタム属性列の属性名。文字ベクトルの cell 配列として指定します。

メモ

Microsoft Excel スプレッドシートから要件をインポートする場合、この cell 配列の長さは、attributeColumn 引数を使用してインポートに対して指定された列数と一致しなければなりません。

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

ユーザー定義のブックマークを使用して要件の内容をインポートするオプション。データ型 logical1 または 0 として指定します。

既定では、Requirements Toolbox はこの値を、Microsoft Word ドキュメントの場合は 1Microsoft Excel スプレッドシートの場合は 0 に設定します。

例: 'bookmarks',false

Microsoft Excel スプレッドシートからインポートする列の範囲。double 配列として指定します。

例: 'columns',[1 6]

要件セット内の要件の CreatedBy プロパティにマッピングする Microsoft Excel スプレッドシートの列。double として指定します。

例: 'createdByColumn',5

要件セット内の要件の Description プロパティにマッピングする Microsoft Excel スプレッドシートの列。double として指定します。

例: 'descriptionColumn',2

要件セット内の要件の ID プロパティにマッピングする Microsoft Excel スプレッドシートの列。double として指定します。

例: 'idColumn',1

ReqIF ファイルから要件をインポートするときにリンクをインポートするオプション。ブール値として指定します。

例: importLinks=true

インポートする要件の Keywords プロパティにマッピングする、外部ドキュメントからの属性の名前。

IBM® DOORS® またはカスタムのドキュメント タイプからインポートする場合はこの引数を使用します。

例: "keywords","Requirement Keywords"

要件セット内の要件の Keywords プロパティにマッピングする Microsoft Excel スプレッドシートの列。double として指定します。

例: 'keywordsColumn',3

Microsoft Office ドキュメントでの ID 検索の正規表現パターン。

例: 'match','^REQ\d+'

要件セット内の要件の ModifiedBy プロパティにマッピングする Microsoft Excel スプレッドシートの列。double として指定します。

例: 'modifiedByColumn',6

インポート中に使用するカスタムのインポート後コールバック スクリプト名。string スカラーまたは文字ベクトルとして指定します。

このコールバックに割り当てたスクリプトは、要件のインポートまたは更新の後に実行されます。

例: "postImportFcn","myPostImportScript"

インポート中に使用するカスタムのインポート前コールバック スクリプト名。string スカラーまたは文字ベクトルとして指定します。

このコールバックに割り当てたスクリプトは、要件のインポートまたは更新の前に実行されます。

例: "preImportFcn","myPreImportScript"

ReqIF ファイルから要件とリンクをインポートするときに使用するプロファイルの名前。string スカラーまたは文字ベクトルとして指定します。

この名前のプロファイルが存在しない場合は作成され、インポートされた要件セットとリンク セットに割り当てられます。この名前のプロファイルが存在する場合は、そのプロファイルがインポートされた要件セットとリンク セットに割り当てられます。

例: profile="myProfile"

ReqIF ファイルから要件とリンクをインポートするときに使用するプロファイル マッピング ファイルの名前。string スカラーまたは文字ベクトルとして指定します。

プロファイル マッピング XML ファイルは、ReqIF の要件とリンクのタイプおよび属性を Requirements Toolbox のステレオタイプおよびステレオタイプ プロパティにどのようにマッピングするかを指定します。この引数を使用するには、インポートされた要件セットとリンク セットに割り当てるプロファイルも profile 引数を使用して指定する必要があります。

ヒント

プロファイル マッピング ファイルは、プロファイル マッピングをもつ要件セットから saveProfileMapping メソッドを使用して作成できます。

例: profileMapping="myMapping.xml"

インポートする要件の Rationale プロパティにマッピングする、外部ドキュメントからの属性の名前。

IBM DOORS またはカスタムのドキュメント タイプからインポートする場合はこの引数を使用します。

例: "rationale","Requirement Rationale"

要件セット内の要件の Rationale プロパティにマッピングする Microsoft Excel スプレッドシートの列。double として指定します。

例: 'rationaleColumn',5

要件をインポートする要件セットの名前。文字ベクトルとして指定します。

その要件セットが存在する場合、要件は新しいインポート ノードにインポートされます。要件セットが存在しない場合、Requirements Toolbox により要件セットが作成されます。

例: 'ReqSet','My_Requirements_Set'

リッチ テキストとして要件をインポートするオプション。ブール値として指定します。

例: 'RichText',true

Microsoft Excel スプレッドシートからインポートする行の範囲。double 配列として指定します。

例: 'rows',[3 35]

Microsoft Excel ワークブック内のワークシート名。文字ベクトルとして指定します。

例: 'sheet','Sheet1'

要件セット内の要件の Summary プロパティにマッピングする Microsoft Excel スプレッドシートの列。double として指定します。

例: 'summaryColumn',4

USDM (Universal Specification Describing Manner) 標準形式で指定された Microsoft Excel スプレッドシートからインポートします。値は、ID の接頭辞の後にオプションで区切り文字が続く文字ベクトルとして指定します。

例: 'RQ -' は、RQ01RQ01-2RQ01-2-1 などと同様の ID をもつエントリと一致します。

出力引数

すべて折りたたむ

インポートされた参照要件の数。double として返されます。

要件をインポートする要件セットのファイル パス。文字ベクトルとして返されます。

要件をインポートする要件セットのハンドル。slreq.ReqSet オブジェクトとして返されます。

ヒント

バージョン履歴

R2018a で導入

すべて展開する