# Bridge Workflow Generation Guide ## Overview This guide provides step-by-step instructions for AI agents to create new bridge workflow objects in OpenBrIM. Workflows provide structured, guided modeling processes for different bridge types, organizing components, loading, construction stages, and code checks into logical hierarchies. **Purpose:** * Generate new bridge workflow definitions for specific bridge types * Adapt existing workflows to new configurations * Maintain consistency with OpenBrIM workflow standards * Properly organize WorkFlowItems with documentation links **Key Concepts:** * **Workflow Template**: Base Steel I Girder workflow used as starting point * **Reusable Components**: Substructure, loading, and construction framework common across workflows * **Bridge-Specific Items**: Superstructure components unique to each bridge type * **Hierarchical Organization**: Logical grouping of components by category ## What's Common vs. What's Different Understanding what sections to preserve versus customize is critical for efficient workflow generation. ### Sections That Are IDENTICAL Across All Bridge Types (Never Change) These sections should be copied exactly from the Steel I Girder workflow: 1. **Bridge Geometry** - Complete section (Alignment, Support Lines, Insertion Point, Girder Layout) 2. **Properties** - Materials, Rebars, Strands, Sections, Bolt Property, Pushover (all common) 3. **Superstructure Attachments** - Barrier, Roadway, Rail (reusable for all bridge types) 4. **Substructure** - Complete section (Abutments, Bents, Pier, Foundation, Pile, Soil) 5. **Tendon** - Cap/Bent Tendon, Column Tendon (for PT substructure) 6. **Construction Framework** - Construction Stage object and all substructure construction/deconstruction 7. **Construction Changes** - Bearing Fixity Change, Pier Section Override, Material Change 8. **Loading** - Load Geometry Definitions, most load types, influence surfaces, combinations 9. **Combinations** - Result Extraction, Limit States, Load Combination Tables 10. **Substructure Code Check Templates** - All pier/foundation templates 11. **Substructure Code Checks** - All pier/foundation code checks (complete section) 12. **Reports (Most)** - Universal reports like Project Inputs, Seat/Slab Elevation Tables, Quantity Takeoff 13. **CADD (Most)** - Plan/Elevation, Cross Section, Substructure, Alignment Data, Framing Plan 14. **GIS** - Complete section (Map Tile, Digital Terrain Model) 15. **Organization** - Complete section (Object Group, Saved Reports, Cross-Project Data, Export) 16. **Standard Extensions** - GirderFEGroupAll, BackComp, IFC Schema ### Sections That Change Based on Bridge Type (Customize) These sections require bridge-specific modifications: 1. **Superstructure** - Complete replacement: * **Bearings Group**: Same across types (reuse) * **Girders Group**: Steel vs Precast vs Box girder objects * **Stiffeners Group**: Steel only (remove for concrete) * **Splice Group**: Steel only (remove for precast) * **Connections Group**: Different connection types * **Cross-Frames/Bracing**: Different object types (use PIG suffix for precast) * **Diaphragm Group**: Precast only (add for concrete) * **Lateral Bracing**: Steel only (remove for precast) * **Deck Group**: Same structure, different deck object type 2. **Superstructure Construction** - Different construction objects: * Girder construction/erection objects * Cross-frame vs diaphragm construction * Temporary support (steel) vs railroad (precast) 3. **Superstructure Deconstruction** - Mirror of construction changes 4. **Loading - Element Loads** - Bridge-specific load objects: * Girder Load (different object types) * Other element loads remain the same 5. **Code Check Templates** - Superstructure only: * Steel: Steel Girder, Splice, Cross Frame, Shear Stud templates * Precast: Concrete Girder, Cross Frame templates * Substructure templates stay the same 6. **Superstructure Code Checks** - Complete replacement: * Steel: Steel Girder, Plate, Rolled Beam, Splice, Cross Frame code checks * Precast: Concrete Girder, Cross Frame code checks 7. **Load Rating** - Girder-specific: * Steel: Steel Girder Load Rating * Precast: Concrete Girder Load Rating 8. **Reports (Bridge-Specific)** - Some reports differ: * Steel: Steel Girder Analysis Summary Table * Precast: Girder Camber Diagram * Most reports stay the same 9. **Summary Report Objects** - Different summary report types and object collections ### Quick Reference: Preservation vs. Customization Ratio * **\~80% of workflow is reusable** across all bridge types * **\~20% requires customization** for specific bridge type * Focus customization on: Superstructure, element loads, superstructure construction, superstructure code checks ## Workflow Object Structure ### Root Workflow Object ```xml ``` **Key Attributes:** * `N`: Unique identifier (e.g., `OBPWorkflowGirderSteel`, `OBPWorkflowGirderPrecastI`) * `ObjLabel`: User-friendly display name * `Category`: Hierarchical path (e.g., `Project Templates:Steel Bridge Workflows`) * `Tags`: Filterable metadata (`@usastandard,workflow,release`) * `Role="WorkFlow"`: Marks as workflow object ## Step-by-Step Workflow Generation Process ### Step 1: Identify Bridge Type and Scope **Determine:** 1. **Bridge Type**: Steel I-girder, Precast I-girder, Box girder, etc. 2. **Primary Differences**: What makes this workflow unique? 3. **Reusable Components**: What can be inherited from existing workflows? 4. **New Components**: What objects need to be created? **Example:** ``` Bridge Type: Precast I Girder Bridge Primary Differences: - Precast girders instead of steel - Different connections (no bolted splices) - Deck casting sequence differs - Prestressing tendons required Reusable: - All substructure (piers, columns, foundations) - Most loading definitions - Construction stages framework - Code check templates structure New: - Precast girder objects - Prestressing components - Concrete deck integration ``` ### Step 2: Copy Base Workflow Template Start with the Steel I Girder workflow as the foundation: ```xml ``` **Modify:** 1. Change `N` attribute: `OBPWorkflow[NewBridgeType]` 2. Update `ObjLabel`: User-friendly name 3. Update `Category`: Appropriate bridge type category 4. Update `Tags`: Add bridge-type-specific tags **Example:** ```xml ``` ### Step 3: Preserve Standard Workflow Sections **Always Keep (Reusable Across All Bridge Types):** #### Bridge Geometry ```xml ``` **Rationale:** Bridge geometry is fundamental to all bridge types. #### Properties (Partial) ```xml ``` **Rationale:** All bridges need materials, rebars, and sections. #### Substructure (Complete) ```xml ``` **Rationale:** Substructure components are largely bridge-type-agnostic. #### Loading (Most Items) ```xml ``` **Rationale:** Most loading types apply to all bridges; only element-specific loads change. #### Combinations (Complete) ```xml ``` **Rationale:** Load combinations follow AASHTO standards across all bridge types. #### Reports (Partial) ```xml ``` #### CADD (Partial) ```xml ``` #### GIS (Complete) ```xml ``` #### Organization (Complete) ```xml ``` ### Step 4: Modify Bridge-Specific Sections **Sections to Customize:** #### Superstructure Replace the entire superstructure section with bridge-type-specific components. **Steel I Girder Superstructure (from base template):** ```xml ``` **Precast I Girder Superstructure (actual from real workflow):** ```xml ``` **Critical Differences - Steel vs Precast:** | Component | Steel I Girder | Precast I Girder | | ------------------- | ---------------------------------------- | ------------------------------------- | | **Bearings** | Same | Same (reuse completely) | | **Girder Types** | Multiple (Plate, Rolled) | Single (Precast I) | | **Stiffeners** | YES (Transverse, Longitudinal, Bearing) | NO (not needed for concrete) | | **Splices** | YES (Bolted Field Splice) | NO (precast units are continuous) | | **Connections** | Shear Studs, Shear Plates, Gusset Plates | Gusset Plates only | | **Diaphragm Group** | NO separate group | YES (Custom, Continuity, End, X-Type) | | **Cross-Frames** | Steel-specific objects | PIG-suffixed objects | | **Lateral Bracing** | YES (Top/Bottom) | NO (not typical for precast) | | **Deck Object** | `@OBPDeckConcrete` | `@OBPDeckConcretePrecastIGirder` | #### Properties The Properties section is ALMOST IDENTICAL between Steel and Precast workflows. **Common Elements (Keep in all workflows):** ```xml ``` **Note:** Both Steel and Precast workflows include Strands (for post-tensioning in steel or prestressing in precast) and Bolt Properties (for bolted connections in both types). The Properties section is largely reusable across bridge types. #### Tendon Section The Tendon section is COMMON to both Steel and Precast workflows (for substructure post-tensioning). **Keep in All Workflows:** ```xml ``` **Note:** Even steel girder bridges may have post-tensioned concrete pier caps or columns, so this section is typically included in all bridge workflows. For prestressed girders, prestressing is handled through Strand properties, not the Tendon section. #### Construction Sections The Construction section structure is IDENTICAL between Steel and Precast. Only specific object types within construction change. **Construction Framework (Same for All Bridge Types):** ```xml ``` **Superstructure Construction - Only These Items Change:** **Steel I Girder:** ```xml ``` **Precast I Girder:** ```xml ``` **Key Differences in Superstructure Construction:** * Steel uses separate girder and cross-frame erection objects * Precast combines girder and diaphragm construction * Precast includes Railroad construction item * Steel includes Temporary Support construction **Important:** Substructure Construction, Substructure Deconstruction, and Changes sections are IDENTICAL across all bridge types - always keep them unchanged. #### Code Check Templates and Code Checks There are THREE separate sections for code checks: Templates, Superstructure Code Checks, and Substructure Code Checks. **Templates for Code Check and Load Rating - Superstructure Changes Only:** **Steel I Girder:** ```xml ``` **Precast I Girder:** ```xml ``` **Superstructure Code Checks - Change Based on Bridge Type:** **Steel I Girder:** ```xml ``` **Precast I Girder:** ```xml ``` **Substructure Code Checks - IDENTICAL Across All Bridge Types:** ```xml ``` **Load Rating - Change Based on Bridge Type:** **Steel I Girder:** ```xml ``` **Precast I Girder:** ```xml ``` **Important:** Always keep the Substructure Code Checks section identical - it's reusable across all bridge types since substructure is typically concrete regardless of superstructure type. ### Step 5: Add Documentation URLs Every WorkFlowItem should have a `DocumentURL` attribute pointing to Confluence documentation. **URL Pattern:** ``` https://docs.openbrim.org/templates/// ``` The path mirrors the folder structure under `docs/documentation/templates/` in the repo (kebab-case, no `.md` extension). **Bridge Type Abbreviations:** * `SIG`: Steel I Girder * `PIG`: Precast I Girder * `SPIG`: Spliced I Girder * `CBG`: Concrete Box Girder * `TUBG`: Tub Girder **Examples:** ```xml ``` **For New Objects Without Documentation:** * Omit `DocumentURL` attribute initially * Create placeholder documentation page * Add URL once documentation is published ### Step 6: Update Object Versions Include `ObjectVersion` attributes for all WorkFlowItems: **Purpose:** * Track compatibility between workflow and object definitions * Indicate minimum required object version * Help detect outdated references **Example:** ```xml ``` **Versioning Guidelines:** * Use current object version from library * Update when object interface changes significantly * Increment when breaking changes occur ### Step 7: Organize Workflow Hierarchy **Standard Organization Pattern:** ``` Workflow Root ├── Bridge Geometry ├── Properties ├── Superstructure │ ├── Bearings │ ├── [Girder Type] │ ├── [Connections/Stiffeners/etc.] │ ├── [Cross Frames/Bracing/Diaphragm] │ └── Deck ├── Superstructure Attachments ├── Substructure │ ├── Abutments │ ├── Bents │ ├── Pier │ ├── Foundation │ ├── Pile │ └── Soil Structure Interaction ├── Tendon (if applicable) ├── Construction │ ├── Construction Stages │ ├── Superstructure Construction │ ├── Substructure Construction │ ├── Superstructure Deconstruction │ ├── Substructure Deconstruction │ └── Changes ├── Loading │ ├── Load Geometry Definitions │ ├── Loads (Static, Element, Live Load, Wind, etc.) ├── Combinations ├── Templates for Code Check and Load Rating ├── [Superstructure] Code Checks ├── Substructure Code Checks ├── Load Rating ├── Reports ├── CADD ├── GIS └── Organization ``` **Group Naming:** * Use `T="Group"` with `Label` attribute * Keep labels descriptive and consistent * Match existing workflow conventions ### Step 8: Add Summary Report Objects At the end of the workflow, add summary report configuration: ```xml

``` **Example - Precast I Girder:** ```xml

``` ### Step 9: Add Standard Extensions and Compatibility At the end of the workflow, add standard compatibility objects: ```xml ``` **Purpose:** * `GirderFEGroupAll`: FE analysis group for all girders * `BackComp`: Backwards compatibility layer ### Step 10: Validate and Test Workflow **Validation Checklist:** 1. **Metadata Complete:** * [ ] Unique workflow name (`N` attribute) * [ ] User-friendly label (`ObjLabel`) * [ ] Correct category * [ ] Appropriate tags 2. **Enumerations Present:** * [ ] `WFLoadTypeEnums` * [ ] `WFStateTypeEnums` * [ ] `WFSoilMaterialEnums` 3. **Hierarchy Organized:** * [ ] Bridge Geometry section * [ ] Properties section * [ ] Superstructure section (customized) * [ ] Substructure section (complete) * [ ] Loading section * [ ] Construction section (customized) * [ ] Code checks section (customized) * [ ] Reports section * [ ] CADD/GIS sections * [ ] Organization section 4. **Documentation URLs:** * [ ] All WorkFlowItems have `DocumentURL` or are placeholders * [ ] URLs follow correct pattern * [ ] Bridge type suffix correct (SIG, PIG, etc.) 5. **Object Versions:** * [ ] All WorkFlowItems have `ObjectVersion` * [ ] Versions match library objects 6. **Bridge-Specific Changes:** * [ ] Superstructure girder types updated * [ ] Connections appropriate for bridge type * [ ] Bracing/diaphragm types correct * [ ] Deck object type correct * [ ] Element loads match bridge type * [ ] Construction sequence objects correct * [ ] Code check templates match bridge type * [ ] Code check objects match bridge type * [ ] Reports specific to bridge type updated 7. **Summary Report:** * [ ] Summary report object defined * [ ] Object collection parameters defined * [ ] `objs()` calls reference correct types 8. **Compatibility:** * [ ] `GirderFEGroupAll` defined * [ ] `BackComp` extends latest version ## Common Workflow Patterns ### Pattern 1: Superstructure Component Differences | Component Category | Steel I Girder | Precast I Girder | | ------------------- | ---------------------------------------- | -------------------------------------------------- | | **Girder Objects** | Plate Girder, Rolled Beam Girder | Precast I Girder | | **Stiffeners** | Transverse, Longitudinal, Bearing | None (not applicable) | | **Splices** | Bolted Field Splice | None (continuous precast units) | | **Connections** | Shear Studs, Shear Plates, Gusset Plates | Gusset Plates only | | **Cross-Frames** | Standard objects (K-Bot, K-Top, X, Z) | PIG-suffixed objects (K-Bot-PIG, K-Top-PIG, X-PIG) | | **Diaphragms** | None (separate group) | Dedicated group (Custom, Continuity, End, X-Type) | | **Lateral Bracing** | Top and Bottom Lateral Bracing | None (not typical for precast) | | **Deck Type** | `@OBPDeckConcrete` | `@OBPDeckConcretePrecastIGirder` | ### Pattern 2: Construction Object Differences **Superstructure Construction Only (Substructure is identical):** | Construction Item | Steel I Girder | Precast I Girder | | ----------------- | ------------------------------------ | ----------------------------- | | **Bearing** | Same | Same | | **Girder** | Separate erection (Complete/Partial) | Combined girder & diaphragm | | **Diaphragm** | Included with cross-frame | Separate partial construction | | **Deck** | Same | Same | | **Attachments** | Same | Same | | **Special** | Temporary Support Construction | Railroad Construction | ### Pattern 3: Code Check Pattern (3-Tier System) **Tier 1: Templates for Code Check and Load Rating** * Superstructure templates: Change based on bridge type * Substructure templates: IDENTICAL across all types **Tier 2: Superstructure Code Checks** * Steel: Steel Girder, Plate, Rolled Beam, Splice, Cross Frame * Precast: Concrete Girder, Cross Frame * Complete replacement between bridge types **Tier 3: Substructure Code Checks** * IDENTICAL across all bridge types (never change) * Pier Cap, Pier Column, Footing, Pile Capacity, Pile Interaction ### Pattern 4: Loading Differences **Element Loads - Only Girder Load Changes:** ```xml ``` **All Other Loading Sections Identical:** * Load Geometry Definitions (Surface, Line, Point) * Static Loads (Surface, Line, Point, Vehicle) * Influence Surface Based Live Load * Wind Load (on structure and live load) * Temperature Load * Prestressing Load (if applicable) * Water Load * Construction Load * Dynamic Loads (Eigenvalue, Response Spectrum) * Pushover Load ## Workflow Generation Checklist When creating a new bridge workflow, use this checklist: ### Phase 1: Setup * [ ] Copy Steel I Girder workflow as base * [ ] Update root object name (`N` attribute) * [ ] Update `ObjLabel` and `Category` * [ ] Update `Tags` with bridge-type-specific tags * [ ] Keep enumeration extends ### Phase 2: Preserve Standards * [ ] Keep entire Bridge Geometry section * [ ] Keep Materials, Rebars, Sections in Properties * [ ] Keep entire Substructure section * [ ] Keep Load Geometry Definitions * [ ] Keep Static Loads (universal types) * [ ] Keep Inf. Surf Based LL/BR/CE * [ ] Keep Wind Load section * [ ] Keep Temperature, Water, Construction loads * [ ] Keep Dynamic and Pushover loads * [ ] Keep entire Combinations section * [ ] Keep GIS section * [ ] Keep Organization section ### Phase 3: Customize Superstructure * [ ] Update Girder section (object type) * [ ] Add/remove Stiffeners section * [ ] Update Connections section * [ ] Update Cross-Frames/Bracing/Diaphragm section * [ ] Update Deck section (if needed) * [ ] Add Temporary Supports (if needed) ### Phase 4: Customize Properties * [ ] Add/remove Strand property (for prestressing) * [ ] Keep/remove Bolt Property * [ ] Keep Pushover subsection ### Phase 5: Add/Remove Tendon * [ ] Add Tendon section for prestressed bridges * [ ] Remove for non-prestressed bridges ### Phase 6: Update Construction * [ ] Update Superstructure Construction items * [ ] Update Superstructure Deconstruction items * [ ] Keep Substructure Construction/Deconstruction ### Phase 7: Update Loading * [ ] Update Element Loads (girder load type) * [ ] Add/remove Prestressing Load section * [ ] Keep all other load types ### Phase 8: Update Code Checks * [ ] Update Templates section (girder type) * [ ] Update Superstructure Code Checks section * [ ] Keep Substructure Code Checks section * [ ] Update Load Rating section ### Phase 9: Update Reports * [ ] Keep universal reports * [ ] Update bridge-specific reports * [ ] Update CADD items (if needed) ### Phase 10: Finalize * [ ] Add Documentation URLs to all items * [ ] Add Object Versions to all items * [ ] Create Summary Report object * [ ] Add object grouping parameters * [ ] Add GirderFEGroupAll * [ ] Add BackComp extension ### Phase 11: Validate * [ ] Run validation checklist * [ ] Test workflow in OpenBrIM * [ ] Verify all object types exist * [ ] Check documentation links * [ ] Confirm hierarchy is logical ## Best Practices ### 1. Consistency **Use Standard Names:** ```xml ``` ### 2. Documentation **Always Include DocumentURL:** ```xml ``` ### 3. Hierarchy **Maintain Logical Organization:** ```xml ``` ### 4. Reusability **Don't Duplicate Substructure:** ```xml ``` ### 5. Deprecation **Mark Deprecated Items:** ```xml ``` ### 6. Version Tracking **Track Workflow Evolution:** ```xml ...> ``` ## Summary **Workflow Generation Steps:** 1. **Identify** bridge type and scope 2. **Copy** Steel I Girder workflow as template 3. **Preserve** standard sections (geometry, substructure, loading, combinations, organization) 4. **Modify** bridge-specific sections (superstructure, construction, code checks) 5. **Add/Remove** bridge-specific features (tendons, stiffeners, etc.) 6. **Update** documentation URLs and object versions 7. **Organize** hierarchy logically 8. **Create** summary report objects 9. **Add** compatibility extensions 10. **Validate** completeness and correctness **Key Principles:** * **Reuse** substructure, loading, combinations across all bridge types * **Customize** superstructure for each bridge type * **Maintain** consistent naming, organization, and documentation * **Track** object versions and backwards compatibility * **Document** every WorkFlowItem with Confluence links * **Test** workflow in OpenBrIM before release By following this guide, AI agents can systematically generate new bridge workflows that maintain OpenBrIM standards while adapting to specific bridge types and configurations.