Track 1. Getting Started: exercise sheet
For everyone new to Holarch. 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
- Nothing: start here with a free account.
- Plan
- Free
- Project
- Chapter 1.1 tours the CubeSat EO-1 demo; the other chapters build a Bike-Share Dock from a starting file.
1.1 The Holarch Workspace
Watch chapter 1.1 (5:34)
Practice
On the CubeSat EO-1 demo project:
- Create the EO-1 demo: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering).
- On Home, read the Needs attention cards, then click Verification in the rail and open Test Center from its overview page.
- Click Database at the bottom of the rail, click + Filter and choose the class Test Case. Select TC-04 Pointing Accuracy Test and read its Trace in the inspector: which requirement it verifies.
- Double-click the TC-04 row to open it in the Item View, then press ⌘K / Ctrl+K, type
batteryand press Enter on 1.3.2 Battery Pack. Switch between the two editor tabs. - Click the Needs attention flag in the top bar and open the Failing tests entry. On that page, click ? in the top bar and read the Help panel.
- For a checked walk-through, run tutorial 1 Getting Around (Help → Tutorials).
You're done when TC-04 and 1.3.2 Battery Pack are open in their own editor tabs and you can name the requirement TC-04 verifies.
Questions
- You change a requirement's description in the Database. Does the system requirements specification still show the old text?
- When would you use ⌘K / Ctrl+K instead of the rail?
- Why is there no Save button?
1.2 Your First Project
Watch chapter 1.2 (5:43)
Practice
On the CubeSat EO-1 demo project:
- Open your EO-1 demo project (or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering)).
- Click Database at the bottom of the rail, then + New Item. Choose the class Statement, name it
Field Boundary Overlays, number itN4, describe the need (agronomists want field boundaries drawn on each vegetation map) and click Create. - Create a second Statement,
Rideshare Mass Limit, numberC1, stating that the spacecraft must not exceed the dispenser's mass limit. In the inspector, click + Label and choose Constraint. - Create a Requirement
Field Boundary Layer, number6.6, written as a shall statement, and check that its Status is Draft. Then create an ActionOverlay Field Boundaries, numberF12. - Double-click the description of N4 in the table, change a word and press Enter. Press ⌘Z / Ctrl+Z to undo it and ⇧⌘Z / Ctrl+Shift+Z to redo it.
- Click + Filter and choose the class Statement to see the needs and constraints together.
You're done when the Statement filter lists N1 to N4 and C1, C1 carries the Constraint label, and 6.6 Field Boundary Layer shows the status Draft.
Questions
- Why does the class matter when you create an item?
- A stakeholder says operators must be able to plan passes from home. Is that a Statement or a Requirement?
- What is a label for, if the class already says what an item is?
1.3 Attributes and Relationships
Watch chapter 1.3 (3:29)
Practice
On the CubeSat EO-1 demo project:
- Open your EO-1 demo project (or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering)).
- In the Database, select 2.5 Safe Mode Recovery and type a Rationale in the inspector (why the spacecraft must leave safe mode on its own).
- Select F10 Enter Safe Mode. In Trace, find satisfies (tick Show all relations if it is not listed), click + → Link existing…, tick 2.5 Safe Mode Recovery and click Link Selected. Select 2.5 and find the same link under satisfied by.
- Select 1.4 C&DH, tick Show all relations, and relate it with performs to OPS.9 Hold Data Onboard, the one operations step no part performs yet.
- Select 2.2 Mission Operations Center. On decomposed by, click + → New Asset… and create
Image Processing Server. - Double-click F10 Enter Safe Mode to open the Item View, then click through the related names: from F10 to 1.4 C&DH, and from there to 1 EO-1 Spacecraft.
You're done when the Item View of 2.5 Safe Mode Recovery lists F10 under satisfied by, and OPS.9 lists 1.4 C&DH under performed by.
Questions
- You add a link from F10 with satisfies. Why does 2.5 now show satisfied by without any extra step?
- Why does the picker in Link existing… not offer every item in the project?
- What does relating an asset with performs to an action record in systems engineering terms?
1.4 Your First Diagram
Watch chapter 1.4 (4:00)
Practice
On the CubeSat EO-1 demo project:
- Open your EO-1 demo project (or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering)).
- Click Diagrams at the bottom of the rail, then + New Diagram. Choose Asset Diagram, type
EPSin Diagram of, pick 1.3 EPS and click Create. Turn on Performed Actions to see which function each part performs. - Choose + Asset ▾ → New Child Asset… and create
Battery Heater. Click ⋯ (More actions) in the diagram toolbar, then + Conduit: from Battery Pack to Battery Heater, namedHeater Power Line. Then choose Arrange ▾ → Tidy Layout. - Open the Database and find Battery Heater and Heater Power Line as new rows.
- Back on the diagram's tab, switch the type to Hierarchy Diagram with the type selector.
- Create a Spider Diagram of 3.2 Battery Capacity and keep the level at 2.
You're done when the spider diagram of 3.2 shows the Battery Pack that satisfies it and TC-07 Battery Capacity Test that verifies it.
Questions
- You delete nothing, but rename a part on a diagram. Where else does the new name appear?
- Why does a new Asset Diagram of 1.3 EPS already show three parts?
- When is a Spider Diagram more useful than an Asset Diagram?
1.5 Documents
Watch chapter 1.5 (2:46)
Practice
On the CubeSat EO-1 demo project:
- Open your EO-1 demo project (or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering)).
- Open Needs & Requirements → Documents and click + New Document. Name it
EO-1 Ground Station Specification, choose the template Requirements Specification and click Create. - Select section 4.1 Primary Functions, click + Child, name the requirement
Track the Spacecraftand write its shall statement in the inspector's description. - In Quick add at the bottom, choose Under 10 Design Constraints, type
The ground station antenna shall have a diameter of no more than 3.7 m.and press Enter. Add a second constraint the same way. - Open the Database and type
in:"EO-1 Ground Station Specification" class:Requirementin the search box to list the new requirements. - Back in the document, choose Deliver ▾ → Specification (Word) and open the file.
You're done when the Word file shows your three requirements under their numbered sections.
Questions
- What is the difference between a requirement typed into a Holarch document and one typed into a word processor?
- How does Quick add choose the new requirement's name?
- When would you tick Include writing guidance?
1.6 Finding Things
Watch chapter 1.6 (2:37)
Practice
On the CubeSat EO-1 demo project:
- Open your EO-1 demo project (or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering)).
- In the Database, type
downlinkin the search box and read which classes the results come from. Clear the search. - Click + Filter, choose the class Requirement, then Status under Requirement attributes, = is, In Review, and click Add Filter.
- In the Views pane, click Save View…, name it
Awaiting decision, tick Share with project and click Save. - Press ⌘K / Ctrl+K and type
TC-09to open the Safe Mode Entry Test; press ⌘K / Ctrl+K again, typervtmand open the RVTM page; then typenew testand press Escape without creating anything. - Open 3.1 Orbit Average Power in the Item View and click History…. Read which fields changed and who changed them.
You're done when Awaiting decision appears in the Views pane with the shared mark and lists only In Review requirements.
Questions
- A colleague asks every week which requirements are still in review. What is the quickest way to give them that list?
- What does the filter No relationships find, and why is it useful?
- Who can see a view saved without Share with project?
1.7 Sharing and Roles
Watch chapter 1.7 (2:24)
Practice
On the CubeSat EO-1 demo project:
- Open your EO-1 demo project (or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering)). You also need a second email address you can read.
- Click Share at the right of the top bar. Under Invite people, enter the second address, choose Reviewer and click Invite. Check that it is listed under Pending invitations, then close the dialog.
- Select 6.4 Operator Interface in the SRS. In the inspector's Discussion section, write a question asking which measurable value the requirement should state, and click Add comment.
- In the inspector's Workflow group, set Assignee to yourself and a Due date next week. Open Plan → My Work and find the requirement under Assigned to me.
- Accept the invitation from the second address in a private browser window. As the reviewer, open 6.4 and confirm that you can reply to the comment but not edit the text.
You're done when 6.4 Operator Interface is on your My Work with its due date and the reviewer's reply shows in its Discussion.
Questions
- A stakeholder needs to approve requirements but should not change them. Which role do you give them?
- Why can you add reviewers and viewers without reaching the collaborator limit of a plan?
- Where should a question about one requirement go: an email or the item's Discussion?
1.8 Export, Import and Versions
Watch chapter 1.8 (2:31)
Practice
On the CubeSat EO-1 demo project:
- Open your EO-1 demo project (or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering)).
- In the Database, double-click the description of 6.3 Telemetry Archive, make it more precise and press Enter. Keep working for a minute or two so that a new automatic version is saved.
- Open Control & Reviews → Baselines & Versions and click Restore a Previous Version… in the page header. Select a version from before your edit, read the change it lists for 6.3, and click Cancel.
- In Manage Projects, open the project's row menu ⋯, choose Export this project… and click Export JSON.
- Choose Project Files ▾ → Import Project (.json)… and pick the file. Open the new project and check that the SRS and its diagrams are there.
- In the copy's Database, filter to the class Test Case, click Export…, choose Table (Excel) and click Export. Delete the copy when you are done: it counts as one of your projects.
You're done when you have the project JSON file, an Excel file of the test cases, and you saw the 6.3 change in the restore preview.
Questions
- What is the difference between an automatic version and a baseline?
- You restore a version by mistake. Can you get back to where you were?
- Does importing a project file overwrite the project it came from?
Answer key
1.1 The Holarch Workspace
- No. There is one copy of each item; the document, the Database, diagrams and the inspector all show the same item, so the edit appears everywhere.
- When you know the name or number of what you want. ⌘K / Ctrl+K finds items, pages, documents, diagrams and commands by name; the rail is for browsing by lifecycle stage.
- Holarch saves each change as you make it and shows the save status in the top bar. Every change is one undo step, so ⌘Z / Ctrl+Z takes it back.
1.2 Your First Project
- The class decides which attributes and relationships the item can have. Holarch only offers links that make sense for it: an asset can perform an action, a risk cannot.
- A Statement: it is a need in the stakeholder's words. Requirements that formalize it come later and trace back to it.
- A label sorts items of one class into kinds, such as a Statement labeled Constraint, so you can filter and report by kind without a new class.
1.3 Attributes and Relationships
- Each relationship has a name in each direction. It is one link, read as satisfies from the function and satisfied by from the requirement.
- It lists only items of the classes the relation allows for this item, so you cannot create a link the schema does not define.
- The allocation of a function to the physical part that carries it out.
1.4 Your First Diagram
- Everywhere the item appears: the Database, documents, other diagrams and the inspector. A diagram is a view of the model, not a separate drawing.
- The diagram reads the decomposed by relationships that already exist in the model, so the parts are drawn without any manual placement.
- When you want the trace around one item across relationship types: the need, the function, the part and the test, for example to judge the impact of a change.
1.5 Documents
- In Holarch each requirement in the document is a model item: you can trace it, check its quality, draw it on diagrams and find it in the Database.
- It names the requirement from the words after shall and numbers it after its siblings in the chosen section.
- When the authors are new to the document type: each section then gets a short note on what it should hold, which you delete as you write.
1.6 Finding Things
- Save the query as a view with Share with project. Everyone on the project gets it in the Views pane, and it always reflects the current model.
- Items with no links at all, such as needs nothing traces to or requirements nothing satisfies. They are the loose ends of the model.
- Only you, in this browser. It is kept in the browser and offered in every project you open there.
1.7 Sharing and Roles
- Reviewer. Reviewers read, comment, and approve, reject or reopen requirements, but cannot edit the model.
- Only owners and editors count toward the limit; reviewers and viewers do not.
- The item's Discussion. The comment stays with the requirement, a mention notifies the person, and it waits on their My Work.
1.8 Export, Import and Versions
- Automatic versions are saved about once a minute while you edit and kept only for the days of the owner's plan. A baseline is a named snapshot you make at a milestone, and it is kept.
- Yes. The state before the restore is saved as a version first, and the restore is one undo step.
- No. The import becomes a new project with a new identity, and you are its owner.
Published by Holarch