Checker remarks
A reviewing engineer's remarks on inputs, results and the whole project, kept in the project file with their author, date and status; marked outdated when what they are about changes, answered and closed by the designer, and printed in the report.
When a design is checked, the checker writes down what to look at again: "Is the seat diameter right for k5?", "Life with the peak load case?", "Add the duty cycle". Axomek keeps these checker remarks in the project file, beside the field or result they are about, so that the designer can answer them there and the checker can see which ones the design has moved past.
Each remark has its text, its author (a name typed freely, no account needed), its date, and a status: open until the designer closes it, with an answer, or closed. A remark is outdated when what it is about changed since it was written, and item removed when the element it is about is no longer in the project; it is kept either way.
The remarks list
Click Remarks in the top bar, or run Checker remarks from the command palette (Ctrl+K). The list opens beside the work; Esc or × closes it. The button shows how many remarks are open.
- All, Open, Closed and Outdated show those remarks, with their number. Outdated also shows the remarks whose item was removed.
- Each remark shows its number (RM1, RM2, …), its status, what it is about, its text, who wrote it and when, and the designer's answer. Go to (the name of what it is about) opens that element in its module.
- Close… asks for the answer and closes the remark; Reopen opens it again (the answer stays); Remove deletes it. Undo takes any of these back.
- An outdated remark says so; Mark as current takes the inputs as they are now, after the checker has looked at the change.
Adding a remark
Under Add a remark, choose what it is about: the field or element you came from, or The project. Type the remark and your name (it starts as the author of Settings › Report header) and choose Add remark. It gets today's date.
To remark on one field, click the remark badge beside it (where a field already has remarks), or select the element and add the remark on it. The badge shows how many remarks a field has, marked while one is open; a badge in the results column shows the remarks on the results shown.
Outdated remarks
A remark keeps a fingerprint of the inputs it is about, taken when it was written. It is outdated when those inputs no longer give the same fingerprint:
| A remark about | Is outdated when |
|---|---|
| An input, such as a section's outer diameter or a bearing's speed | that value changes. |
| An element, such as a bearing, or one of its results, such as its life or a check | any input its results can depend on changes: its own inputs, those of the items linked to it (the shaft and supports it sits on, the other shafts and the gear pairs of a gearbox, a fit's housing), and the duty cycle. |
| The project, or a result of the whole project such as the system life | any input of the project changes. |
Display names, the project's description, the report's settings and the remarks themselves do not change element or result fingerprints. A remark on a name field still tracks that name. The strength material's grade name remains an engineering input because it selects FKM size constants. Undoing a change, or setting a value back, makes a remark current again.
In the report
Under Contents in the report screen, tick The checker remarks, with their status and answers: the report gets a section Checker remarks before the methods, with every remark, and its verdict line counts the open ones. The template Short for checking makes a short report of the modules the project uses with the remarks. See Reports and export.
What is kept, and where
The remarks, their texts and the names in them are kept only in the project file you save: on your computer, or in the cloud when you save the project there, and in a report PDF that prints them (a PDF carries its project, without the remarks when the report leaves them out). Nothing else of them is sent anywhere: the assistant is not given them (it may add a remark when you ask, but not answer, close or remove one), a project saved as a template leaves them out, and usability replays never show them. They never change a result or the project's fingerprint, and comparing two projects leaves them out.
From the command line
axm remark add pump.axm.json sections.S2.outerDiameter "Seat for 6207: 35 k5?"
axm remark add pump.axm.json bearings.BR1.result.lifeHours "Life with the peak case?" --author "B. Checker"
axm remark list pump.axm.json --status open
axm remark close pump.axm.json RM2 --answer "Peak case added"
axm remark reopen pump.axm.json RM2
axm remark update pump.axm.json RM1 --refresh
axm report pump.axm.json --short --remarksThe path is project, an input, an element, a result (bearings.BR1.result.lifeHours) or a check: a check's id as axm solve names it (gears.G1.pinionContactSafety, maxDeflection) is kept as gears.G1.checks.pinionContactSafety, so that a check named like an input is not taken for that input. A path that names nothing, a misspelt field too, is refused with what it could be. --author and --by default to axm config report.author, the date to today. axm remark list --json gives every remark with its status and whether it is outdated or its item missing. Agents use the axm_remarks tool. See Command line and agents.