Document Generation

Overview

Holarch builds deliverables from the model, so a document always matches the requirements, tests and links behind it. Three tools cover what reviewers usually ask for:

• Matrix blocks: a traceability or verification matrix inside a document's text that updates whenever the model changes.
• Export Matrix: the same matrices as their own file in Excel, Word, CSV or a web page.
• Page Setup: a classification or distribution banner, a cover page and page numbers for a document's Word export.

Live values and tables in text are covered on the Documents page: Entity Notation… inserts one attribute of an entity and Table Notation… inserts a table from a query.

Concepts

The four matrices

• Parent is the requirement the row decomposes. Traced From, Traced To and Satisfied By list the related entities.
• In the VCRMVerification Cross-Reference Matrix A table that maps requirements to verification methods (test, analysis, inspection, demonstration) and events. an X marks each planned method; Status is the verification result so far, rolled up from the test cases as in the Test Center.
• Scope: a matrix covers either one document's requirements (in document order and numbering) or the whole project. The allocation matrix uses the document's functions, or all functions when the document has none.

Live, not copied

A matrix block stores only what to show, not the rows. Every time the document is displayed or exported, Holarch rebuilds the rows from the model. The result is cached until the next change, so large projects stay fast.

How to use it

Insert a matrix into a document

1. Open the document and click into the description of the document or of an item.
2. In the rich-text toolbar, open + and choose Matrix….
3. Pick the Matrix and the Scope. The scope starts on the open document.

   You see a preview. It updates whenever the model changes.

4. Click Insert.

   The matrix appears in the text with a dashed outline. Its caption names the matrix, the scope and how many rows have gaps.

The matrix cannot be edited cell by cell; change the model instead. To remove it, delete the table in the editor like any other content.

Export a matrix

1. In a document, open Export ▾ and choose Export Matrix…. Or choose Export ▾ → All Reports…, pick Traceability and Verification Matrix (XLSX, DOCX, CSV, HTML), and set the options there.
2. Pick the Matrix, the Scope and the Format: Excel (.xlsx), Word (.docx), CSV, or Web page (.html).

   The line under the fields gives the row count and the number of rows with gaps.

3. Click Export.

   The toast reads "Matrix exported." Gaps are shaded red in Excel, Word and the web page. Word and web page exports use the document's Page Setup. In Word, the text columns are wide and the verification-method columns are narrow, headed I, A, D and T with a legend under the table (I = Inspection, A = Analysis, D = Demonstration, T = Test). Matrices with more than five columns use a landscape page.

Add a banner, a cover page and page numbers

1. In a document, open Export ▾ and choose Page Setup… (the first item).
2. Fill in what you need:
   • Top banner and Bottom banner: text such as "COMPANY PROPRIETARY" or "Distribution Statement A".
   • Cover page, with Version and Prepared by.
   • Page numbers ("Page X of Y") in Word exports.
3. Click Apply.

   The toast reads "Page setup saved." The banners appear at the top and bottom of the document. ⌘Z / Ctrl+Z undoes the change in one step.

Banners are plain text you choose. Holarch prints them as written and does not check markings or apply any security rules.

Where Page Setup applies

• Basic Document Output (DOCX) in Reports: the banners repeat in the header and footer of every page, with page numbers if chosen, and the cover page replaces the plain title. A live matrix block in the document becomes a Word table with its title above it, the same column widths and I/A/D/T headers, and its gaps shaded red.
• Export Matrix and the matrix report in Word or web page format.
• Print / PDF: the banners print at the top and bottom of each page.
• A compilation has its own Page Setup, used when you export the compilation.

Model Checks

Model Checks report a notation that points to something deleted (rule Global.7, "Notations pointing to missing entities"):

• An Entity Notation whose entity was deleted shows "{Entity: … Not found}".
• A matrix block whose scope document was deleted.

Open the description, then remove the notation or insert it again for an entity that exists. See Model Checks.

Tips

• Put the RVTMRequirements Verification Traceability Matrix A table of each requirement with how it is verified, the tests that verify it and their latest result. or VCRMVerification Cross-Reference Matrix A table that maps requirements to verification methods (test, analysis, inspection, demonstration) and events. at the end of a specification as its verification section; it stays current until the review.
• For a review package, build a compilation and give it a cover page and banner in its own Page Setup.
• Export the VCRM to Excel for a review board that marks it up, and keep the live block in the document.