I. Introduction
Similar to the Functions as tree script , arKItect allows you to export an Excel file with the tree of requirements of the project. This may help you having a clear visual of a family of requirements, being able to see their parent/child relationship.
You can choose the requirement family, going from the system itself, enabling system or stakeholder (whichever applies), to the last requirements in the family tree (leaf requirements). You may also choose all of the requirements between the different actors: the system, enabling systems and stakeholders.
There are two different types of trees: the down tree (descending hierarchy) and the up tree (ascending hierarchy). You will be able to decide which tree interests you, and if you choose both, each will be represented in a different sheet of the exported Excel file.
Additionally, you will be able to select the variants that concern the exported objects, as well as their tagged options.
II. Export Procedure
To exemplify this, we will go back to the Laptop exercise:
Having already established the requirements for the system Laptop, we may go directly to the view 2.1. Define Requirements.
Once there, you will click on the Project Tools icon, located at the menu bar in Home tab.
Now you will display the options under the Document Generation Tools. You will find the Requirement as Tree script. Proceed to click on it.
The following window will display:
II.1 Start export from
- Tag "Start export from": This will allow you to select the object you wish to export; by clicking on the “…” button. At this point you may select the requirement tree you wish to export.
A window will display, showing the requirement's structure (according to the view 2.1)).
In our example, we will tag the Laptop system, which will allow you to export all of the requirements in their parent/child relationship for the object Laptop.
Click on “Ok”.
- Do not tag "Start export from": In order to select all of the requirements from all actors (the system, enabling systems and stakeholders), you may run the script without tagging “Start export from”. The result will be the exported Excel file with all of the requirements’ parent/child trees.
II.2 Exported sheets
You will be able to export either the "down" tree or the "down + up" tree.
- "Down": By selecting "down", the script will export a descending tree for the selected requirement(s).
- "Down + Up": By selecting "down + up", the script will export a both a descending and an ascending tree for the selected requirement(s). They will be separated in two tabs, named "down" and "up".
II.3 Refine Following
The Requirement as tree export will automatically consider refines as allocation in the tree diagram. To avoid exporting refine allocation in your Excel export, uncheck "Following refines"
| With refine following | without refine following |
|---|---|
 |
The refine between battery charger and the "Technical" |
II.4 Attributes in Up/Down sheets
The Requirement as tree export will automatically be accompanied by a Dictionary of the exported requirements. This dictionary will include the requirement's attributes and some other relevant information such as relations such as children requirements, owner (component allocation), among others.
In addition, you will be able to select which of these attributes you're interested in exporting in the "Down" and "Up" tags. This means that they will appear too next to the requirement tree, in addition to the dictionary.
The default attributes exported are the following:
- ASIL
- Attachments
- CSR
- Comments
- Component
- Description
- Grade
- Revision
- Source Documents
- Spec Review
- State
- Type
If you want to change the default configuration, you may tag on the "..." button of the "Attributes in sheet" section. You may click on it.
A window will pop up, with the attributes list from the dictionary.
The default attributes mentioned before will be tagged. You may then be able to manually select all of the attributes that you're interested in exporting in the "Down" and "Up" tabs.
In our example, we will tag the default configuration and we will add the attribute "Revision".
You may click on "Ok".
Limit Dictionary content
By default, the Dictionary sheet exports every possible attribute of Requirements objects. If you want to have the same list of attributes in both TREE and Dictionary sheet, check the "Limit Dictionary to these attributes" option.
II.5 Export Tests
The Requirement as tree export can automatically axport all tests directly allocated to a requirement as allocation in the tree diagram. To allow exporting tests allocation in your Excel export, check "Export tests"
II.6 Stop export at requirement type
The Requirement as tree export will automatically export requirements until there is no requirement allocation (or refine) left to follow.
RAT export allows you to choose which requrement types you want to use as leafs.
If you want to change the default configuration, you may tag on the "..." button of the "Stop export at requirement type" section. You may click on it after enabling the checkbox.
By default, all requirement types will be selected. You may then be able to manually select all of the requirement typesthat you're interested in.
You may click on "Ok".
II.7 Export Options and Variants
1. Export Options
This feature will allow you to visualize in the columns next to the exported objects (in the "Tree" tab), a group of selected options concerning each of the exported objects, with an "X" that indicates that the object is tagged with a particular option.
Tree Level | Folder | Category | Option node | Option name 1 | Option name 2 |
|---|---|---|---|---|---|
| Requirement 1 | X |
You will be able to choose:
- Option folder
- Option category
- Option node
- Option (leaf)
In the export, folders, categories and option nodes will be exported in gray. Only the leaf options will be marked with "X" to indicate that they are tagged in the project.
If you wish to export this information, you may select "Export options".
By doing so, the "..." button, that will allow you to select the project's options.
The following pop-up window contains all of the options folders, categories, nodes and leaf options of the project. You may select the options(s) that interest you.
Once you have selected the options, press on "Ok".
2. See object's Variants
This feature will allow you to visualize in the columns next to the exported objects (in the "Tree" tab), the variants filters in which that object can be visualized.
The format will be the following:
Tree Level | Variant name 1 | Variant name 2 |
|---|---|---|
| Function 1 | x |
The object will have an "X" in the cell corresponding to the variants where this object is visualized.
If you wish to export this information, you may select "See object's variants".
By doing so, the "..." button, that will allow you to select the project's variants.
The following pop-up window contains all of the variants Folder names and variants of the project. You may select the variant(s) that interest you.
Once you have selected the variants, press on "Ok".
3. Export Options and Variants
You will be able to select both export options and see object's variants, and they will be both exported in the resulting excel file(s).
After you've succeeded in configuring your export, you may click on "run".
Automatically, an excel file will be generated. Wait for the export to finish before opening the file.
III. Result
An excel file will open with the Requirements as tree file, showing the tree relationship between all of the requirements selected.
In the exported Excel file, you will have two different views of the requirement tree.
III.1 The “Down” tab
It shows the requirements in a descending hierarchy, going from the higher level requirements to the very last requirement in the tree.
III.2 The “Up” tab
It allows you to visualize an inverted requirement tree, going from the low level requirements to the higher levels in the hierarchy.
III.3 The "Dictionary" tab
You may as well be able to see all of the requirements' attributes in the Dictionary tab (the ones you selected to view in the tabs "Down" and "Up", and all of the others you didn't select.
Feel free to go back to the View 2.1. Define Requirements, and compare your tree in arKItect with the tree you just exported to Excel.