Design Specification ‐ Recipe Design & Workflow Dialog - lucasgsantos/BIM GitHub Wiki

Recipe Design & Workflow Dialog – Detailed Specification

This section provides a comprehensive breakdown of the Recipe Design & Workflow dialog, including:

  • UI Layout & Navigation
  • Buttons & Actions
  • Menus & Sub-Menus
  • Key Functionalities

1. Recipe Design & Workflow Dialog – UI Layout

The dialog is structured into four main sections:

1.1. Header Section

  • Recipe Name & Version (e.g., "Aspirin-100mg-v1.2")
  • Status Indicator (Draft, Under Review, Approved, Archived)
  • Quick Actions (Save, Undo/Redo, Help)

1.2. Left Panel – Recipe Structure Navigator

  • Tree View of recipe phases (expandable/collapsible)
    • Pre-Weighing
    • Mixing
    • Filling
    • Packaging
  • Drag-and-drop reordering of steps

1.3. Central Workspace – Phase/Step Configuration

  • Parameter Grid (Editable table for process variables)
  • Conditional Logic Builder (IF-THEN-ELSE rules)
  • Equipment Assignment Panel

1.4. Right Panel – Properties & Validation

  • Step Properties (Duration, Tolerance, Criticality)
  • Real-Time Validation (Checks for missing data)
  • Linked Documents (SOPs, Safety Sheets)

2. Buttons & Their Functions

2.1. Top Toolbar Buttons

Button Function Shortcut
New Recipe Creates blank recipe Ctrl+N
Open Recipe Loads existing recipe Ctrl+O
Save Saves current recipe Ctrl+S
Save As Version Creates new version Ctrl+Shift+S
Validate Checks for errors F9
Simulate Dry-run execution F10
Submit for Approval Locks edits, sends to QA Ctrl+Enter

2.2. Phase/Step Context Buttons

Button Function
Add Phase Inserts new phase (e.g., "Heating")
Add Step Adds sub-step to selected phase
Delete Removes selected item (with confirmation)
Clone Duplicates selected step
Set as Critical Marks step for extra QA checks

2.3. Parameter Grid Buttons

Button Function
Add Parameter Inserts new CPP (Critical Process Parameter)
Import from Library Loads pre-defined parameters (e.g., "Temperature")
Link to Sensor Binds to PLC/SCADA data point
Formula Editor Opens math/logic builder

3. Menus & Sub-Menus

3.1. Main Menu Bar

Menu Sub-Items
File New, Open, Save, Export (PDF/XML), Print
Edit Undo, Redo, Cut, Copy, Paste, Find
View Zoom, Toggle Panels, Dark Mode
Recipe Validate, Simulate, Compare Versions
Tools Equipment Manager, BOM Linker
Help User Guide, Shortcuts, Support

3.2. Right-Click Context Menus

Context Options
On Phase Rename, Add Step, Delete, Set Dependencies
On Step Edit, Clone, Set Alarms, Attach Media
On Parameter Define Range, Add Comment, Link to LIMS

4. Key Functionalities

4.1. Drag-and-Drop Workflow Builder

  • Reorder steps by dragging phases in the tree view.
  • Drop equipment icons onto steps to assign resources.

4.2. Conditional Logic Editor

  • Rule Builder: 
    IF [Temperature] > 30°C THEN 
  [MixingTime] = [MixingTime] + 5min
ELSE
  Proceed to Next Step
  • Visual Flowchart mode available.

4.3. Real-Time Validation

  • Error Highlights: Missing parameters, out-of-range values.
  • Auto-Correct Suggestions: "Did you mean 50°C instead of 500°C?"

4.4. Equipment Integration

  • Drag-and-drop machines from a palette.
  • Conflict Detection: Alerts if same equipment is double-booked.

4.5. Version Comparison

  • Side-by-Side Diff: Highlights changes between versions.
  • Rollback: Revert to any previous version.

5. Example User Flow

  1. User clicks "New Recipe" → Names it "Antibiotic-X-v1.0".
  2. Adds phases: Weighing → Mixing → Sterilization.
  3. Defines parameters:
    • MixingTime: 30min (±5min tolerance).
    • Temperature: 25°C (linked to reactor PLC).
  4. Sets conditional step:
    • "IF viscosity > 1000cP, THEN extend mixing by 10min."
  5. Validates → Fixes warnings → Submits for QA approval.

6. UI Mockup Wireframe

+-----------------------------------------------------+
| [Recipe Name]         [Status]       [Save][Validate]|
+-----------------------------------------------------+
| [Phases Tree] | [Step Parameters]   | [Properties]   |
|---------------|---------------------|----------------|
| > Pre-Weigh   | Parameter | Value   | Duration: 15m  |
|   - Step 1    |---------------------| Critical: Yes  |
| > Mixing      | Temp.     | 25°C    | Equipment: R-01|
|   - Step 2    | Time      | 30min   |                |
+-----------------------------------------------------+
| [Add Phase] [Add Step] [Simulate] [Submit to QA]     |
+-----------------------------------------------------+

7. Compliance Features

  • Audit Trail: Logs all edits (who changed what and when).
  • E-Signatures: Required for approval/rejection.
  • Read-Only Mode: Locked after QA approval.

8. Next Steps

  1. Prototype in Figma/Adobe XD for stakeholder review.
  2. User Testing with process engineers.
  3. Integrate with Equipment DB for real-world validation.

This design ensures intuitive recipe authoring while enforcing GMP compliance and error-proofing. Adjust based on industry needs (Pharma vs. Food).