WF27: Capture Model Knowledge

Pre-requisites

• MADE Project: containing FBD items defined with modelling details requiring further information to capture model knowledge.

Detailed Descriptions (numbered steps)

1. Access Annotations Editor through 'Annotations' under the 'Modeling' tab in the main menu bar.
2. Only proceed if editing narratives, assumptions or comments. To update Data Quality Index, by annotating model parameters, proceed to WF28. Continue following the decision logic.
3. Open the 'Narratives' tab and click the pencil icon to select the types of narratives to populate the list.
4. Define a narrative from the list via double left-click, input the narrative in the text field and click 'OK'.
5. Open the 'Assumptions' tab and use the Filter Options to refine the list.
6. Create an assumption with the green plus icon, select an item type from the list, input assumption in the text field and click 'OK'. To edit an existing assumption, double left-click it.
7. Open the 'Comments' tab and use Filter Options to refine the list.
8. Create a comment with the green plus icon, select an item type from the list, input comment in the text field and click 'OK'. To edit a comment, double left-click it.
9. Continue defining all annotations until model knowledge is captured.

Decision points

• Update DQI? — Yes → Go to WF28: Update Data Quality Index (DQI); No → Define Narrative? decision.
• Define Narrative? — Yes → View Narratives / Add a Narrative; No → Define Assumption? decision.
• Define Assumption? — Yes → View Assumptions / Edit or Add an Assumption; No → View Comments / Edit or Add a Comment.
• All Annotations Defined? — No → loop back to Update DQI? decision; Yes → Model Knowledge Captured.

Outputs

• Annotation Report: documentation that lists all model parameter annotations of the selected model item(s), including the Data Quality Index (DQI).

Screenshot walkthrough (captions/labels extracted)

Step 1: Open Annotations Editor

• 'Modeling' menu: New Connection, New Item, New RBD Group, Activate Failure Diagram, Hazard Diagram, Functional Diagram, Mission Profile Definition, Requirements, System Environment, Unit Life Parameter, System Model, Bond Graph, Failure Diagram, Functions, RBD Model, Maintenance Actions, System Maintenance Editor, Environment Library, Sensor Library, Annotations (highlighted).
• "MADE Training - Annotations - Annotations": left nav Dashboard, Model Parameters, Narratives, Assumptions, Comments, Event Log. "Model Quality Index": "The Model Quality Index shows the Coverage, Quality and resulting Confidence Level of completed annotations that have a severity level that is higher than 'Optional'." Bar chart: Coverage 10.5%, Quality 38.7%, Confidence Level 4.1%. "Data Sources": pie chart with legend Engineer, Peer Reviewed Discussion, Published Database, OEM, Operating Data (red/green dominant slices). "Recent Events" table (Status/Date/User/Type/Item/Event) — "There have been no Annotatable Events in the past 24 hours."

Step 3: View Narratives

• "Narrative Types" dialog: "Select the Narrative Types to include." Tree: All Narrative Types (checked) > Failure (Cause Narrative, Compensating Provisions, Detection Method, Failure Conditions, Narrative, Response Narrative), Function (Functional Narrative), Item (Physical Description), Mission Profiles. Buttons OK, Cancel.
• "MADE Training - Annotations - Annotations": "Narratives" tab. "Filter Options": Narrative Type "Failure - Cause Narrative; Failure - Compensating Provisions; Failure - Detection Method; Failure - Failure Conditions; Failure - Narrative; Failure - Response Narrative; Function - Functional Narrative; Item..."; Narrative Status checkboxes Empty (checked), Completed (checked); Item Name/Narrative Text search field. Table (Item/Category/Type/Narrative): Vehicle System (Item, Physical Description, "A land vehicle consisting of a driveline and power generation system."); Convert Mechanical - rotational Angular velocity Low/High (Vehicle System) rows (Failure, Cause Narrative/Response Narrative, empty); Coupling (Item); Couple Mechanical - rotational Torque Low/High (Coupling) rows (Failure, Cause Narrative/Response Narrative); Couple (Function, Functional Narrative); Driveline (Item, Physical Description).

Step 4: Add a Narrative

• Same tab with Item Name/Narrative Text filter "Coupling": Table filtered to Coupling 1 (Item, Physical Description, highlighted) and related Failure rows: Cause - High temperature (Coupling 1), Cause - Maximum continuous use time exceeded (Coupling 1), Fault - Fractured (Coupling 1), Mechanism - Corrosive attack (Coupling 1), Mechanism - Creep stress rupture (Coupling 1), Cause - High mechanical load (Coupling 1), Cause - Imbalanced mechanical loads (Coupling 1), Mechanism - Torsion deformation (Coupling 1) — all Type "Narrative".
• "Edit Narrative Text" dialog: "Enter the Narrative text." Item Name "Coupling 1", Narrative Type "Item - Physical Description", Narrative: "Couples the output of one mechanical device to the input of another." Buttons OK, Cancel.

Step 5: View Assumptions

• "Assumptions" tab: "Filter Options": Type checkboxes System Model, Failure Diagram, Item, Part, Pair (all checked); Date range "All"; From date field; Item/Narrative search. Table (Date/User/Item/Type/Narrative): row with green-plus/red-x action icons: "2026/03/25 15:29:08" / "Rahul Gottumukkala (..." / "Vehicle System" / Item / "Only select subsystems have been modelled for this concept system to reduce modeling time for MADE training."

Step 6: Edit or Add an Assumption

• "Assumptions" tab with add (green plus) button highlighted; empty table with Date/User/Item/Type/Narrative columns.
• "Edit Assumption" dialog: "Choose the item type and enter a narrative." Item type tree: MADE Training - Annotations > Vehicle System (greyed) > Failure Diagram, System Model. Narrative: "Only select subsystems have been modelled for this concept system to reduce modeling time for MADE training." Buttons OK, Cancel.
• "Add New Assumption" dialog: Item type tree: MADE Training - Annotations > Vehicle System > Failure Diagram, System Model > Coupling, Driveline, Power Generation (selected/highlighted), Vehicle. Narrative: "The power generation subsystem produces and regulates electrical power for all onboard vehicle systems by converting mechanical or stored energy into usable electrical energy. It is assumed to operate continuously under normal conditions, providing sufficient and stable power within nominal limits, with failures simplified as a loss of generation capability." Buttons OK, Cancel.

Step 7: View Comments

• "Assumptions" tab table populated with two rows: "2026/03/25 15:29:08" / Sam (PHM Technology) / Vehicle System / Item / "Only select subsystems have been modelled for this concept system to reduce modeling time for MADE training."; "2026/03/25 16:41:32" / Sam (PHM Technolog...) / Power Generation / Item / "The power generation subsystem produces and regulates electrical power for all onboard vehicle systems by converting mechanical or stored energy into usable electrical energy. It is assumed to operate continuously under normal conditions, providing sufficient and stable power within nominal limits, with failures simplified as a loss of generation capability."

Step 8: Edit or Add a Comment

• "Comments" tab: "Filter Options": Type System Model, Failure Diagram (checked); Date range "All"; Item/Narrative search. Table (Date/User/Item/Type/Narrative): "2023/11/06 14:49:24" / Rahul Gottumukkala (... / Vehicle System / System Model / "The simulation parameters are not added to the model, they will be added in training session 2.2."; "2026/03/25 16:52:07" / Sam (PHM Technolog... / Coupling / Failure Diagram / "Coupling manufacturer from ABC Pty. Ltd"
• "Edit Comment" dialog: "Choose a System Model or Failure Diagram and enter a comment." Item type tree: MADE Training - Annotations > Vehicle System > Failure Diagram, System Model (greyed) > Coupling, Driveline, Power Generation, Vehicle. Narrative: "The simulation parameters are not added to the model, they will be added in training session 2.2." Buttons OK, Cancel.
• "Add New Comment" dialog: Item type tree: MADE Training - Annotations > Vehicle System > Failure Diagram, System Model > Coupling > Failure Diagram (selected/highlighted), System Model; Driveline, Power Generation, Vehicle. Narrative: "Coupling manufacturer from ABC Pty. Ltd" Buttons OK, Cancel.

Step 10: Model Knowledge Captured

• Annotation Report excerpt: "DATA QUALITY INDEX" — Coverage 11%, Quality: 39%, Confidence Level: 4%. Bar chart: Coverage 10.5%, Quality 38.7%, Confidence Level 4.1%. Pie chart legend: Engineer, Peer Reviewed Discussion, Published Database, OEM, Operating Data. "ANNOTATIONS BY TYPE" table: Model Property 316, Assumptions 2, Comments 1, Total 319. "ANNOTATIONS BY STATUS": Pending 295, Annotated 18. "ANNOTATIONS BY SOURCE" table (Source/Description/Confidence/Annotations): Engineer ("Value determined by a User/Engineer currently using MADE (experienced)", 20%, 28), Peer Reviewed Discussion ("Value determined during discussions/meetings involving multiple experts", 50%, 0), Published Database ("Information provided in a Published Database", 60%, 1), OEM ("Information provided by the Original Equipment Manufacturer", 70%, 16), Operating Data ("Data collected through operating the system", 90%, 0). Footnote: "* Optional severity annotations are not included". "ANNOTATIONS" table (Item/Model Element/Type/Status/Description/Annotation/Date/Source (Confidence)/User): "Air Filter" rows — Model Properties, Status "Pending" for each: "Delay Time (hrs) changed from 0.0 to 5.0", "MTTR changed from 1.0 to 5.0", "Characteristic Life changed from 1 to 10000", "Expression Method changed from EXPONENTIAL to WEIBULL", "Part Failure Rate changed from 1.00 to 2.5197 using MTBUM Allocation (MTBUM Analysis).", "Slope changed from 1.00 to 3.00", "Turn Around Time (hrs) changed from 0.0 to 12.0" — all dated 13 Nov 2023, User Rahul Gottumukkala (PHM Technology); further rows for "Blocked", "Contaminated", "High", "Low", "Fault - Outgrowths (Air Filter)", "Fault - Perforated (Air Filter)" with Probability/Occurrence and Failure Mode Ratio changes dated 8 Nov 2023 / 13 Nov 2023.

Related workflows

• WF28 – Update Data Quality Index (DQI)