Track 6. Migrating to Holarch: exercise sheet
For teams moving from other tools. One practice task and a few questions per chapter, to work through after each video. Print this page from your browser, or work on screen. The answer key starts on a new page at the end.
Before you start
- Take first
- Track 1. Getting Started, chapters 1.1 to 1.3.
- Plan
- Free
- Project
- Your own requirements files, or files you export from the EO-1 demo to practice.
6.1 Planning a Migration
Watch chapter 6.1 (3:00)
Practice
On the CubeSat EO-1 demo project:
- Open your EO-1 demo project (if you have none, create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering)).
- Open Settings → Schema in the rail, click Requirement under Classes, and list the attributes a requirements spreadsheet could fill (for example Priority, Owner, Verification Method).
- Open the Labels page of the schema and find where kinds such as Performance Requirement are kept.
- Say a supplier's tracker has a column
Supplier Refwith no home: on Requirement, click + Attribute, name itSupplier Ref, choose a text type, and click Add Attribute. - Open Needs & Requirements → Import and Export and read which formats the drop zone takes and what the Export card offers.
You're done when Supplier Ref is last in Requirement's attribute list and you can say where each column of a typical tracker would go.
Questions
- Why decide where each kind of data goes before importing?
- A column has no matching attribute. What are your options?
- An import went wrong. How do you take it back?
- When do you use Manage Projects → Import Project (.json)… instead of the Import page?
6.2 Requirements from Excel and CSV
Watch chapter 6.2 (2:32)
Practice
On the CubeSat EO-1 demo project:
- Open your EO-1 demo project (if you have none, create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering)). In the Database, search
class:Requirement, click Export…, choose Table (CSV), tick Status and Priority (keep Labels ticked), and click Export. - Open the file in a spreadsheet app. Keep the header and the rows of sections 1 and 2, then add two rows at the top:
1,Mission Imaging, ClassStatement, and2,Attitude Determination and Control, ClassStatement. Save it as .xlsx or .csv. - In Manage Projects, click + New Project, name it
EO-1 Import Practice, and click Create Project. - Open Needs & Requirements → Import and Export, drop the file, click Continue, and check each column's Holarch field (set any column you do not want to Skip).
- Click Continue, keep Create a document from these N items ticked, and click Import N items.
- In the new document, check that 1.6.1 and 1.6.2 sit under 1.6, and select 1.5 to see its labels and status.
You're done when the new document shows sections 1 and 2 with their requirements nested by number, labels and statuses intact.
Questions
- How does Holarch rebuild the hierarchy of spreadsheet rows?
- Some rows came in with the wrong class. Why?
- You want to update the owners of 50 existing requirements from a spreadsheet, not create copies. How?
6.3 Requirements from Word and ReqIF
Watch chapter 6.3 (2:22)
Practice
On the CubeSat EO-1 demo project:
- Open your EO-1 demo project (if you have none, create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering)). Open Documents → EO-1 System Requirements Specification and click Deliver ▾ → Specification (Word).
- In the same document, click Deliver ▾ → Requirements (ReqIF)… and click Export.
- In Manage Projects, click + New Project, name it
EO-1 Import Practice, and click Create Project. Open Needs & Requirements → Import and Export, drop the .docx, click Continue twice, and import it. - Compare the new document with the SRS: note which headings became Statements and which shall sentences became Requirements, and how they were named.
- Import the .reqif file into the same project, then open the document it creates and select 1.6 Revisit Time to check its children and labels.
You're done when the project holds two documents, one from Word and one from ReqIF, and you can say which kept the original names and numbers.
Questions
- What does the Word import read as a section, and what as a requirement?
- A supplier can send Word or ReqIF. Why ask for ReqIF?
- A ReqIF relation has a name Holarch does not know. What happens?
6.4 Models from Other Tools
Watch chapter 6.4 (2:44)
Practice
On the CubeSat EO-1 demo project:
- Open your EO-1 demo project (if you have none, create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering)). Open Needs & Requirements → Import and Export, click Export UML/SysML (XMI)… on the Export card, keep Format at OMG XMI 2.5.1 (.xmi), and click Export. This file stands in for an export from a SysML tool such as Cameo or Enterprise Architect.
- In Manage Projects, click + New Project, name it
EO-1 Import Practice, and click Create Project. Open Needs & Requirements → Import and Export, drop the .xmi file, check that Format shows UML/SysML (.xmi, .uml, .mdzip), click Continue twice, read Review, and click Import N items. - In the Database, search
class:Asset, select Payload Camera, and check in Trace that it is part of EO-1 Spacecraft and which actions it performs. - Open Diagrams, click + New Diagram, choose Asset Diagram, choose EO-1 Spacecraft in Diagram of, and click Create.
- Turn on Performed Actions to list each subsystem's functions.
You're done when the new project's asset diagram shows the spacecraft's subsystems with the actions they perform.
Questions
- Which files from a SysML v1 tool can Holarch import, and how do you get them?
- Why can you rebuild diagrams quickly after an import?
- You import a later export of the same model. Why do you not get copies?
6.5 Cleaning Up After Import
Watch chapter 6.5 (2:40)
Practice
On the CubeSat EO-1 demo project:
- Open your
EO-1 Import Practiceproject from the earlier chapters (or import a CSV of EO-1's requirements as in chapter 2). - Open Needs & Requirements → Quality, choose one of the imported documents in the scope bar, and click Check Quality.
- If you imported the same requirements twice (Word and ReqIF), check a duplicate's row in the Database and delete it with Delete Item… in the bulk bar. Rewrite 2.5 Safe Mode Recovery so it is measurable, then check quality again.
- Open Verification → Model Checks and open the rule Requirement.8, Leaf requirements no design entity meets.
- If you imported the assets too (chapter 4), select 2.1 Pointing Accuracy, and in Trace add satisfied by with + → Link existing… to ADCS. Run Model Checks again.
You're done when 2.5 scores higher than before and Requirement.8 no longer lists 2.1.
Questions
- What does the quality check look at, and what do Model Checks look at?
- Why does the automatic quality score never go above 78%?
- Why connect requirements and parts right after a migration?
Answer key
6.1 Planning a Migration
- Data that lands in the right classes, labels, attributes and relationships works at once in tracing, quality checks and reports. Fixing it after the import means editing many items by hand.
- Add the attribute in Settings → Schema before the import, or map the column to New attribute (added to the schema) in the Map step.
- Press ⌘Z / Ctrl+Z once: an import from the Import page is a single undo step.
- To restore a whole project as a new, separate project. The Import page merges a file's items into the project that is open.
6.2 Requirements from Excel and CSV
- From a Parent Row ID or Parent Number column if mapped, otherwise from the outline number: 1.2 goes under 1. If the parent is missing, the nearest existing ancestor is used.
- A Class column with names the schema does not know falls back to the Class for rows without a class, with a warning. Use the class names from the Schema editor.
- Export them with the ID column, edit the file, and import it with the ID column mapped to Global ID and Match existing entities by set to Global ID. Review then lists them under Updated items.
6.3 Requirements from Word and ReqIF
- Paragraphs in Word heading styles become Statements (sections). A paragraph with shall, must, will or should becomes a Requirement, named after the first words after the verb. Headings typed as plain bold text are read as ordinary text.
- ReqIF carries each requirement's identifier, hierarchy, attributes and relations. When the supplier sends a newer file, importing it updates the same items instead of adding copies.
- It comes in as traced to. If the schema does not allow traced to between the two classes, the relation is skipped with a warning.
6.4 Models from Other Tools
- XMI 2.x with the SysML 1.x profile from Cameo/MagicDraw, Enterprise Architect, Rhapsody or Papyrus (export it from the tool), a Cameo or MagicDraw .mdzip project directly, and a Papyrus .uml file. Requirements alone can also come as ReqIF, and tables as Excel or CSV.
- Diagram layouts from another tool are not imported, but the relationships are. Holarch draws asset, hierarchy and other diagrams from those relationships.
- Each imported item keeps its XMI id, and Match existing entities by defaults to XMI ID for XMI files, so the later import updates those items. Relationships already present are not added twice.
6.5 Cleaning Up After Import
- The quality check scores the wording of each requirement against the qualities of a good requirement. Model Checks look across the whole model for gaps such as requirements nothing satisfies, items that stand alone or actions nobody performs.
- Correct and Feasible need a person's judgment, so the check never marks them met. You mark them after reviewing the requirement.
- They arrive from different files with no links between them. Each satisfied by link feeds traceability, coverage and the model checks from then on.
Published by Holarch