Back to tutorials

132 Reload From Links

Chris McKeown / July 1, 2025

Linking

~17 min read3,430 words
0 views

Welcome to this demonstration on Bonus Tools – 132 Reload From Links. This powerful tool reloads and repaths links in bulk from an Excel file using External Resource References, enabling sophisticated link management including C4R cloud link repathing. Use in conjunction with tool 133 Export Links.

Table of Contents

Key Features

  • Bulk Link Reloading: Process multiple links simultaneously from Excel
  • External Resource References: Uses advanced API method for reliable repathing
  • C4R Cloud Support: Fully supports cloud-hosted (BIM 360/ACC) links
  • Multiple Link Types: Handles Revit links, CAD links, keynote tables, assembly codes
  • Excel-Based Control: Edit paths and settings in familiar spreadsheet format
  • Color-Coded Output: Real-time feedback on success/failure
  • Transaction Safety: Protected operations with automatic rollback on errors
  • Validation: Checks for required data before processing
  • Batch Processing: Handle hundreds of links efficiently

Requirements

Essential Components

  1. Valid Bonus Tools License: Active license key required
  2. Excel File from Tool 133: Must first export links using 133 Export Links
  3. Excel Software: Microsoft Excel or compatible spreadsheet editor
  4. Open Revit Project: Project containing links to be reloaded
  5. Link Accessibility: New link paths must be accessible to Revit
  6. Write Permissions: Ability to modify project links

Prerequisites

Critical Workflow:

  1. First, run 133 Export Links to create base Excel file
  2. Edit Excel file with new paths/information
  3. Then run 132 Reload From Links with edited file

Cannot skip step 1 - Tool requires External Resource Reference data that only 133 Export Links can provide.

  • Backup Project: Save copy before bulk repathing
  • Test First: Try on single link before bulk operation
  • Verify Paths: Ensure new paths are valid and accessible
  • Close Dialogs: Tool will attempt to dismiss dialogs automatically
  • Output Window: Keep visible to monitor progress

How It Works

Processing Flow

1. File Selection

  • Tool prompts for Excel file (from 133 Export Links)
  • Opens and reads "General" worksheet
  • Validates required columns present

2. Data Extraction

  • Reads each row (skips header)
  • Extracts External Resource Reference data:
    • Server ID (GUID)
    • Reference Information dictionary
    • Version information
    • In-Session Path
    • Display Name
    • Link Type

3. Validation

  • Checks all required fields present
  • Verifies GUIDs valid
  • Confirms paths exist
  • Reports any errors to output window

4. Link Processing

  • For each valid entry:
    • Identifies link type
    • Finds matching link in project
    • Creates External Resource Reference
    • Reloads link from new reference
    • Reports success (green) or failure (red)

5. Completion

  • Shows count of processed files
  • Displays comprehensive log
  • Commits changes if successful

External Resource Reference Method

Why This Method:

  • Standard path repathing doesn't work for C4R links
  • External Resource References provide API-level access
  • Required for cloud-hosted link management
  • More reliable for complex link scenarios
  • Supports all link types uniformly

What Gets Used:

ExternalResourceReference Components:
- ServerId: Unique GUID identifying server/source
- ReferenceInformation: Dictionary of link metadata
- Version: Version information string
- InSessionPath: New path or location for link

Required Workflow

Step-by-Step: Export, Edit, Reload

Phase 1: Export Current Links (Tool 133)

  1. Open project with links to repath
  2. Launch "133 Export Links"
  3. Check desired link types
  4. Export to Excel
  5. Save Excel file with descriptive name

Phase 2: Edit Excel File

  1. Open exported Excel file
  2. Navigate to "General" worksheet
  3. Locate "InSessionPath" column
  4. Edit paths as needed:
    • For local links: C:\NewPath\File.rvt
    • For network links: \\Server\Path\File.rvt
    • For C4R links: Proper cloud path format
  5. Do NOT modify other columns:
    • LinkType
    • ServerId
    • Version
    • DisplayName
    • Reference Information columns
  6. Save Excel file

Phase 3: Reload Links (Tool 132)

  1. Ensure project still open
  2. Launch "132 Reload From Links"
  3. Select edited Excel file
  4. Monitor output window
  5. Review results
  6. Verify links loaded correctly

Critical Rules:

  • MUST use Excel from Tool 133 (contains required metadata)
  • ONLY edit InSessionPath column
  • DO NOT modify GUIDs, version info, or reference data
  • Maintain exact worksheet name ("General")
  • Keep header row intact

Excel File Format

Required Worksheet

Name: "General" (exact match required)

Required Columns

Column Headers (order can vary, but names must match exactly):

  1. LinkType

    • Value: Link type name (e.g., "RevitLink", "CADLink")
    • DO NOT EDIT
    • Used to determine processing method
  2. InSessionPath

    • Value: File path or location
    • EDIT THIS for repathing
    • New path where link should load from
    • Examples:
      • C:\Projects\NewLocation\File.rvt
      • \\Server\Share\Folder\File.dwg
      • RSN://Server/Project/File.rvt (C4R)
  3. ServerId

    • Value: GUID string
    • DO NOT EDIT
    • Example: {12345678-1234-1234-1234-123456789012}
    • Critical for External Resource Reference
  4. Version

    • Value: Version string
    • DO NOT EDIT
    • May be empty for some link types
    • Preserved from export
  5. DisplayName

    • Value: Link name as shown in Revit
    • DO NOT EDIT
    • Used to match link in project
    • Must remain exactly as exported
  6. Additional Columns (Reference Information)

    • Various metadata columns
    • DO NOT EDIT
    • Part of External Resource Reference
    • Examples: ProjectId, ModelId, etc.

Example Excel Structure

LinkType    | InSessionPath           | ServerId        | Version | DisplayName
------------|-------------------------|-----------------|---------|------------------
RevitLink   | C:\Old\ARCH.rvt        | {guid}          | 15      | ARCH.rvt
RevitLink   | C:\Old\STRUCT.rvt      | {guid}          | 8       | STRUCT.rvt
CADLink     | C:\CAD\Site.dwg        | {guid}          |         | Site.dwg

After Editing (change paths only):

LinkType    | InSessionPath           | ServerId        | Version | DisplayName
------------|-------------------------|-----------------|---------|------------------
RevitLink   | C:\NEW\ARCH.rvt        | {guid}          | 15      | ARCH.rvt
RevitLink   | C:\NEW\STRUCT.rvt      | {guid}          | 8       | STRUCT.rvt
CADLink     | C:\NEW_CAD\Site.dwg    | {guid}          |         | Site.dwg

Validation Rules

Tool will reject rows with:

  • Empty ServerId
  • Invalid GUID format
  • Missing InSessionPath
  • Empty DisplayName
  • No Reference Information data
  • Missing LinkType

Rejected rows:

  • Logged to output window in red
  • Shows which field is missing
  • Not processed (skipped)
  • Does not stop other rows

Step-by-Step Guide

Scenario: Moving project and links to new folder

1. Export Current State

Tool 133 Export Links
├── Check: Revit Link
├── Check: CAD Link
└── Export: "Project_Links_Before.xlsx"

2. Edit Excel

Open: Project_Links_Before.xlsx
Find InSessionPath column
Change:
  C:\OldProject\Links\ARCH.rvt
To:
  C:\NewProject\Links\ARCH.rvt
(Repeat for all links)
Save As: "Project_Links_New_Paths.xlsx"

3. Reload Links

Tool 132 Reload From Links
Select: Project_Links_New_Paths.xlsx
Monitor: Output window for results

4. Verify

Manage → Manage Links
Verify: All links show new paths
Test: Open link to confirm accessibility

Advanced Workflow: C4R Migration

Scenario: Moving from local file server to BIM 360

1. Export Current Local Paths

  • Run 133 Export Links
  • Focus on Revit Links
  • Document all current local paths

2. Upload Models to BIM 360

  • Upload all link files to cloud
  • Note new cloud paths (RSN://)
  • Document project structure

3. Edit Excel with Cloud Paths

Change from:
  C:\LocalServer\Project\ARCH.rvt
To:
  RSN://ProjectServer/Project/ARCH.rvt
  • Use proper BIM 360/ACC path format
  • Maintain External Resource Reference data
  • Update ALL Revit links

4. Reload with New Cloud Paths

  • Close and reopen project if needed
  • Run 132 Reload From Links
  • Select edited Excel file
  • Watch for errors (cloud paths are tricky)

5. Verify Cloud Links

  • Check Manage Links shows cloud paths
  • Verify links load from cloud
  • Test syncing
  • Confirm team access

Batch Workflow: Multiple Projects

Goal: Repath links across multiple related projects

1. Create Master Link Map

For each project:
├── Export links (133)
├── Combine into master spreadsheet
├── Document all link relationships
└── Plan new path structure

2. Bulk Edit Path Mapping

In Excel:
├── Create mapping table (old → new paths)
├── Use formulas to update InSessionPath
├── Apply to all project sheets
└── Save separate file per project

3. Process Each Project

For each project:
├── Open project
├── Run 132 Reload From Links
├── Load corresponding Excel file
├── Verify results
├── Move to next project

4. Validation Pass

For each project:
├── Open and check links loaded
├── Verify no missing links
├── Document any issues
└── Reprocess failures if needed

Fully Supported (Working)

1. Revit Link

  • Class: RevitLinkType
  • Most commonly used
  • Full C4R support
  • Transaction protected
  • Output feedback provided

2. CAD Link

  • Class: CADLinkType
  • DWG, DGN, DXF files
  • Local and network paths
  • Transaction protected
  • Output feedback provided

3. Assembly Code Table

  • Class: AssemblyCodeTable
  • Uniformat/classification codes
  • Reference table files
  • Transaction protected
  • Output feedback provided

4. Keynote Table

  • Class: KeynoteTable
  • Keynote text files
  • Annotation reference
  • Transaction protected
  • Output feedback provided

Not Yet Implemented

5. Decal Bump Map

  • Material texture maps
  • Code structure exists but not active
  • Future implementation possible

6. Decal Cut Out

  • Material transparency maps
  • Code structure exists but not active
  • Future implementation possible

7. Decal Map

  • Material appearance images
  • Code structure exists but not active
  • Future implementation possible

8. DWF Markup

  • DWF markup files
  • Code structure exists but not active
  • Future implementation possible

9. IFC Link

  • Industry Foundation Classes
  • Code structure exists but not active
  • Future implementation possible

10. Point Cloud

  • Laser scan data (RCS, RCP)
  • Code structure exists but not active
  • Future implementation possible

11. Fabrication Configuration

  • MEP fabrication databases
  • Code structure exists but not active
  • Future implementation possible

Note: Focus on working types (Revit, CAD, Assembly, Keynote) for production use.

Example Workflows

Workflow 1: Server Migration

Goal: Move all project links from old server to new server

Preparation:

  1. Export all links (133)
  2. Document current paths
  3. Set up new server structure
  4. Copy all link files to new location

Excel Editing:

Find and Replace:
  Find: \\OldServer\
  Replace: \\NewServer\
  In Column: InSessionPath

Before: \\OldServer\Projects\A\ARCH.rvt
After:  \\NewServer\Projects\A\ARCH.rvt

Execution:

  1. Test with one project first
  2. Run 132 Reload From Links
  3. Verify links load from new server
  4. Process remaining projects
  5. Update central models if workshared

Verification:

  • All links show new server paths
  • Links load successfully
  • No "Not Found" status
  • Team can access new location

Workflow 2: Folder Reorganization

Goal: Reorganize project folder structure

Old Structure:

C:\Projects\
├── ARCH_Model.rvt
├── STRUCT_Model.rvt
├── MEP_Model.rvt
└── Site.dwg

New Structure:

C:\Projects\
├── Models\
│   ├── ARCH_Model.rvt
│   ├── STRUCT_Model.rvt
│   └── MEP_Model.rvt
└── CAD\
    └── Site.dwg

Steps:

  1. Export links before move
  2. Move files to new structure
  3. Edit Excel paths to match new structure
  4. Reload links with new paths
  5. Save project

Goal: Enforce company standard paths across projects

Company Standard:

All links in: \\CompanyServer\BIM\[ProjectCode]\Links\

Current State:

Mixed paths:
- C:\Local\Links\...
- \\OldServer\...
- Various user drives

Process:

  1. Copy all links to standard location
  2. Export current link state
  3. Update Excel with standard paths
  4. Reload using tool 132
  5. Verify compliance
  6. Document in project standards

Benefits:

  • Consistent path structure
  • Easier troubleshooting
  • Better team coordination
  • Simplified backups

Goal: Recover after accidental link path changes

Situation:

  • Links accidentally repathed incorrectly
  • Multiple links now broken
  • Need to restore previous paths

Recovery:

  1. Locate last good link export (from 133)
  2. If none exists, recreate manually
  3. Run 132 with last good Excel file
  4. Verify links restored
  5. Implement regular exports going forward

Prevention:

  • Export links regularly (weekly)
  • Archive exports with project versions
  • Document link changes
  • Test repathing on copies first

Workflow 5: Multi-Discipline Coordination Path Update

Goal: Update all discipline model links after coordination meeting

Scenario:

  • Coordination models moved to new location
  • All disciplines need updated paths
  • Must be done simultaneously

Coordination:

  1. BIM Manager exports all discipline links
  2. Documents new agreed paths
  3. Updates master Excel with new paths
  4. Distributes to all disciplines
  5. Each discipline runs reload tool
  6. Verifies in coordination meeting

Excel Template:

Discipline | Old Path              | New Path
-----------|----------------------|-------------------------
ARCH       | \\Old\ARCH.rvt      | \\Coord\ARCH.rvt
STRUCT     | \\Old\STRUCT.rvt    | \\Coord\STRUCT.rvt
MEP        | \\Old\MEP.rvt       | \\Coord\MEP.rvt

Workflow 6: Cloud Migration Testing

Goal: Test cloud migration with ability to rollback

Phase 1: Preparation

1. Export current state → "Links_Local.xlsx"
2. Upload to cloud
3. Document cloud paths
4. Create "Links_Cloud.xlsx" with cloud paths

Phase 2: Test Migration

1. Open test copy of project
2. Run 132 with "Links_Cloud.xlsx"
3. Verify cloud links load
4. Test functionality
5. Document any issues

Phase 3: Rollback Test

1. Run 132 with "Links_Local.xlsx"
2. Verify return to local paths
3. Confirm rollback capability

Phase 4: Production Migration

1. Backup everything
2. Run 132 with "Links_Cloud.xlsx"
3. Test thoroughly
4. Keep local backup for emergency rollback

Tips and Best Practices

Excel File Management

Naming Convention:

ProjectName_Links_Purpose_Date.xlsx

Examples:
- Hospital_Links_New_Server_2026-01-27.xlsx
- Office_Links_Cloud_Migration_2026-01-27.xlsx
- School_Links_Reorganize_2026-01-27.xlsx

Version Control:

Keep multiple versions:
- _Before: Original export from 133
- _Edit: Working version with changes
- _Final: Confirmed working version
- _Backup: Emergency rollback version

Documentation:

Add worksheet tabs:
- General: Required data (don't rename)
- Notes: Document changes made
- Mapping: Old → New path reference
- Issues: Problems encountered

Path Editing Best Practices

Before Editing:

  • Copy InSessionPath column to new column
  • Keep original for reference
  • Use Excel formulas for bulk changes
  • Verify paths exist before saving

Path Formats:

Local:   C:\Path\To\File.rvt
Network: \\Server\Share\Path\File.rvt
Cloud:   RSN://Server/Project/File.rvt

Bulk Editing:

Find & Replace in InSessionPath column:
=SUBSTITUTE(OriginalPath, "C:\Old\", "C:\New\")

Validation:

  • Check no empty paths
  • Verify no typos in paths
  • Confirm file extensions correct
  • Test one path manually first

Processing Best Practices

Before Running:

  1. Backup project file
  2. Close other applications
  3. Ensure output window visible
  4. Verify Excel file ready
  5. Check new paths accessible

During Processing:

  • Watch output window
  • Note any red error messages
  • Don't interrupt process
  • Allow transactions to complete
  • Be patient with large link counts

After Processing:

  • Review output summary
  • Check "Completed" vs "Error" counts
  • Verify links in Manage Links
  • Test opening links
  • Save project if successful

Troubleshooting Strategy

If Links Don't Reload:

  1. Check output window for specific errors
  2. Verify Excel has "General" worksheet
  3. Confirm all required columns present
  4. Check GUIDs not corrupted
  5. Verify paths are accessible
  6. Try single link first

If Some Links Fail:

  • Review output for specific link errors
  • Check those paths manually
  • Verify file accessibility
  • Confirm permissions
  • Try those links individually

Emergency Rollback:

  • Keep original Excel export
  • Reload with original paths
  • Restores previous state
  • Always have this backup

Common Use Cases

Infrastructure Changes

Server Migration:

  • Old server to new server
  • Network drive changes
  • Server name changes
  • Path structure updates

Folder Reorganization:

  • Project restructuring
  • Clean up scattered links
  • Standardize locations
  • Improve organization

Cloud Adoption

Local to Cloud:

  • Upload to BIM 360/ACC
  • Repath to cloud locations
  • Test cloud functionality
  • Enable team collaboration

Cloud to Local:

  • Download from cloud
  • Repath to local drives
  • Offline work scenarios
  • Backup strategies

Standards Compliance

Path Standardization:

  • Enforce company standards
  • Consistent link locations
  • Easier management
  • Better organization

Naming Convention:

  • Update to standard names
  • Consistent structure
  • Improved clarity
  • Better documentation

Disaster Recovery

Link Recovery:

  • Restore broken paths
  • Fix accidental changes
  • Emergency restoration
  • Return to working state

Migration Rollback:

  • Undo cloud migration
  • Return to previous paths
  • Emergency fallback
  • Risk mitigation

Troubleshooting

Common Issues

Problem: "Excel file not found" or "File does not exist"

  • Cause: Invalid file path or file deleted
  • Solution:
    • Verify file exists
    • Check file path spelling
    • Ensure file not open exclusively
    • Try Browse dialog again
    • Check file permissions

Problem: "Worksheet 'General' not found"

  • Cause: Excel file missing required worksheet or renamed
  • Solution:
    • Verify worksheet named exactly "General"
    • Check Excel file from tool 133
    • Don't rename worksheet
    • Re-export from 133 if needed

Problem: "No links processed" (count shows 0)

  • Cause: No valid rows found or validation failures
  • Solution:
    • Check output window for red error messages
    • Verify ServerId column not empty
    • Confirm GUIDs are valid
    • Check InSessionPath not blank
    • Verify DisplayName matches project links
    • Ensure all required columns present

Problem: "Some links error (red) in output"

  • Cause: Specific link reload failed
  • Solution:
    • Review error message for that link
    • Verify new path exists and accessible
    • Check file permissions
    • Confirm link type supported
    • Try that link manually in Manage Links
    • Check if link is corrupted

Problem: "DisplayName contains an error" (red output)

  • Cause: Required data missing or invalid
  • Solution:
    • Check which field showed empty:
      • ServerId: GUID corrupted or deleted
      • InSessionPath: Path deleted or empty
      • DisplayName: Name deleted
      • ReferenceInformation: Columns deleted
    • Don't delete columns from Excel
    • Re-export from 133 if corrupted
    • Only edit InSessionPath column

Problem: "Links show old paths after reload"

  • Cause: Reload failed silently or not saved
  • Solution:
    • Check output for errors
    • Verify transaction committed
    • Save project after reload
    • Check Manage Links for actual paths
    • May need to reload links manually

Problem: "Cloud (C4R) links won't reload"

  • Cause: Cloud path format incorrect or connectivity issues
  • Solution:
    • Verify exact cloud path format
    • Check cloud connectivity
    • Confirm BIM 360/ACC access
    • Review External Resource Reference data not corrupted
    • Try loading link manually first
    • Contact cloud administrator

Problem: "CAD links fail to reload"

  • Cause: CAD file issues or path problems
  • Solution:
    • Verify CAD file exists at new path
    • Check CAD file not corrupted
    • Confirm file format supported (DWG, DGN, DXF)
    • Try importing CAD manually first
    • Check CAD file version compatibility

Problem: "Keynote or Assembly Code table doesn't update"

  • Cause: File format or path issues
  • Solution:
    • Verify text file (.txt) for keynotes
    • Check assembly code file format
    • Confirm path accessible
    • Try loading manually in Revit first
    • Check file not locked by another process

Problem: "Process hangs or very slow"

  • Cause: Many links, network issues, or large files
  • Solution:
    • Be patient (normal for many links)
    • Check network connectivity
    • Close other applications
    • Process smaller batches
    • Check link file sizes

Problem: "Tool completes but links still broken"

  • Cause: Paths still incorrect or files missing
  • Solution:
    • Verify new paths actually correct
    • Check files exist at new locations
    • Review output for which links failed
    • Manually test path accessibility
    • Re-edit Excel and try again

Excel File Issues

Column Problems:

  • Missing required columns → Re-export from 133
  • Renamed columns → Use exact names from export
  • Deleted columns → Re-export, don't delete columns
  • Extra spaces in headers → Remove spaces, exact match needed

Data Problems:

  • Corrupted GUIDs → Re-export from 133
  • Empty required fields → Check red output messages
  • Wrong data types → Don't modify non-path columns
  • Formula errors → Use values, not formulas in Excel

Validation Errors

Output Shows:

Red message: "[DisplayName] contains an error:"
  serverId: [value or empty]
  InSessionPath: [value or empty]
  DisplayName: [value or empty]
  Version: [value or empty]
  referenceInformationDictionary: [count]

Interpretation:

  • Empty ServerId → GUID deleted or corrupted
  • Empty InSessionPath → Path not entered
  • Empty DisplayName → Name deleted
  • Dictionary count 0 → Reference columns deleted

Fix: Re-export from 133, only edit paths


Need Help? Contact support or refer to additional Bonus Tools documentation.

Thank you for using Bonus Tools - 132 Reload From Links!