Search Requirements Actions
Search Requirements actions search the specified Test Repository to retrieve the details for one or more requirements. User-defined fields associated with the requirements may also be retrieved. Single-valued fields are stored in the action’s Result table; multi-valued fields are stored in separate table datasets.
| Action Property | Description |
|---|---|
|
Approved Label |
A String parameter or dataset which stores the label used for the requirement’s ‘Approved’ field. The action retrieves requirements whose Approved Label field is set to ‘Y’. If this parameter is not set, all the requirements in the specified Include Paths will be retrieved. |
|
Fields to Retrieve |
A Table parameter which specifies the requirement field values to retrieve and the Table dataset to be associated with each multi-valued field. |
|
Include Paths |
A String List parameter or dataset which is set to a list of paths to search for requirements, for example, ‘Requirements\TestFolder\Process\Subprocess\Task’ or ‘Requirements\TestFolder’. Each path and all its descendants are searched. If this parameter is not set, all requirement paths will be searched. |
|
Result |
A Table dataset which stores the ID and path of each retrieved requirement. The table also includes a column for each single-valued field listed in the action’s Field to Retrieve property. Each column is populated with the retrieved field value. |
|
<Tables> |
The action should include a Table dataset matching each TABLE_NAME entry in the Fields to Retrieve table. Use the Define Action Parameters Wizard to add additional Table datasets to the action. |
| TestRepository | A Test Repository parameter or dataset referring to the Test Repository whose requirements are to be searched. |
The Fields to Retrieve table should have the following columns:
| Column | Description |
|---|---|
|
LABEL |
The label used to identify a user-defined requirements field in the specified Test Repository. |
|
S_O_M |
This column should be set to ‘S’ if the field stores a single value, or to ‘M’ if the field stores a list of values with a custom character separating each one, for example, VA01; VA02; VA03. |
|
TABLE_NAME |
For multi-valued requirement fields, this column should be set to the name of a Table dataset created for the action using the Define Action Parameters Wizard. The table dataset will store the retrieved field values. For single-valued requirement fields, this column should be left blank. |
The Result dataset has the following columns:
| Column | Description |
|---|---|
|
REQ_ID |
The ID of a retrieved requirement. |
|
REQ_PATH |
The requirement’s path. |
|
<Additional Columns> |
The Result dataset also includes a column for each single-valued field specified in the Fields to Retrieve table. These column names are converted to upper case, and any spaces they contain are replaced with underscores. |
Each Table dataset that stores multiple field values has two columns. The REQ_ID column stores a retrieved requirement ID, and the VALUE column stores each of the retrieved field values.
Example:
