Back to tutorials

156 Get File Details

Chris McKeown / July 1, 2025

Cloud

~10 min read2,069 words
0 views

Overview

The Get File Details tool displays comprehensive information about the current Revit file, including local file paths, cloud collaboration paths, and unique identifiers (GUIDs). This is especially valuable for cloud-workshared projects (BIM 360/ACC) where files are referenced by GUIDs rather than traditional file paths.

Get File Details

Table of Contents

Key Features

  • Displays complete file path information
  • Shows BIM 360/ACC cloud collaboration paths
  • Reveals project and file GUIDs for cloud files
  • Identifies Revit version of the file
  • Formats cloud paths in both BIM 360 and C4R formats
  • Single-click information retrieval
  • No configuration or setup required
  • Works with local files, network files, and cloud files
  • Information displayed in easy-to-read dialog

Requirements

Pre-requisites

  1. Open Revit File

    • Any Revit project file (.rvt)
    • Can be local file, network file, or cloud file
    • File can be workshared or non-workshared

  2. File Must Be Saved

    • Tool works with saved files
    • Unsaved new files will show limited information
    • Save file first for complete details

Supported File Types

Local Files:

  • Standard Revit files saved to local drive
  • Network files saved to shared drives
  • Local files synced from cloud

Cloud Files:

  • BIM 360 Team/Design files
  • Autodesk Construction Cloud (ACC) files
  • Collaboration for Revit (C4R) files
  • Files with central model in the cloud

Interface Guide

Output Dialog

When you run the tool, a dialog box displays with the following information sections:

Basic Information:

  • Path Name
  • Title
  • File Name
  • Revit Version

Document Details:

  • Document Name and Path
  • Document Name

Cloud Collaboration Information (if applicable):

  • BIM A360 Path
  • C4R Path Name
  • Project Guid
  • File Guid
  • C4R File Name

All information is presented in a scrollable text dialog for easy reading and copying.

Running the Tool

  1. Navigate to Bonus Tools tab
  2. Click Get File Details
  3. Information dialog appears immediately
  4. Click OK to close

No additional inputs or selections required.

Step-by-Step Guide

Basic Workflow

  1. Open Your Revit File

    • Open any local, network, or cloud-based Revit file
    • Ensure file is saved (unsaved files show limited info)

  2. Run the Tool

    • Go to Bonus Tools tab
    • Click Get File Details
    • Tool executes instantly

  3. Review Information

    • Read the displayed file details
    • Copy any needed information
    • Note GUIDs for cloud files if needed

  4. Close Dialog

    • Click OK when finished
    • Information is also logged to Output Dialog

Copying Information

To copy specific details from the dialog:

  1. Click inside the information dialog
  2. Select text with mouse (click and drag)
  3. Press Ctrl+C to copy
  4. Paste into documentation, emails, or notes

Tip: Information is also written to the Revit Output Dialog, where it can be copied more easily.

Understanding the Output

Basic Information Section

Path Name

  • Full file system path to the Revit file
  • For local files: C:\Projects\Building.rvt
  • For network files: \\Server\Share\Projects\Building.rvt
  • For cloud files: BIM 360://Project/Folder/Building.rvt

Title

  • File name without extension
  • Example: Building (from Building.rvt)

File Name

  • Complete file name with extension
  • Example: Building.rvt

Revit Version

  • Version number of Revit used to save the file
  • Example: 2024 or 2025
  • Useful for compatibility checking

Document Details Section

Document Name and Path

  • Processed full path using internal helper functions
  • May differ from Path Name for cloud files
  • Shows resolved local cache path if applicable

Document Name

  • Extracted file name from full path
  • Example: Building.rvt

Cloud Collaboration Information

This section only appears for BIM 360/ACC cloud files.

BIM A360 Path

  • Cloud path in BIM 360 format
  • Example: BIM 360://ProjectName/FolderPath/Building.rvt
  • Empty for non-cloud files

C4R Path Name

  • Cloud path in Collaboration for Revit format
  • Uses GUID-based notation
  • Format: CLD://{ProjectGUID}FolderPath/{FileGUID}FileName.rvt
  • Example: CLD://{12345678-1234-1234-1234-123456789012}Project Folder/{87654321-4321-4321-4321-210987654321}Building.rvt
  • This is the format needed for API access and automation

Project Guid

  • Unique identifier for the BIM 360/ACC project
  • Format: 12345678-1234-1234-1234-123456789012
  • Remains constant for the project
  • Used for API calls and project identification

File Guid

  • Unique identifier for this specific file
  • Format: 87654321-4321-4321-4321-210987654321
  • Remains constant for the file even if renamed
  • Used for API calls and file identification

C4R File Name

  • Folder path within the cloud project
  • Does not include "BIM 360://" prefix
  • Does not include the file name
  • Example: Project Folder/Subfolder

Example Workflows

Workflow 1: Documenting Cloud File References

Scenario: Need to reference cloud file in external system

  1. Open cloud file in Revit
  2. Run Get File Details
  3. Copy the File Guid from dialog
  4. Use GUID in external database or documentation
  5. File can now be uniquely identified regardless of name changes

Benefit: Reliable file tracking across systems

Workflow 2: API Development Setup

Scenario: Developing Revit API tool that accesses cloud files

  1. Open target cloud file
  2. Run Get File Details
  3. Copy Project Guid and File Guid
  4. Copy C4R Path Name format
  5. Use these values in API authentication and file access code

Benefit: Correct GUID format for API calls

Workflow 3: Troubleshooting Cloud Sync Issues

Scenario: File won't sync properly to BIM 360

  1. Run Get File Details
  2. Note the BIM A360 Path and C4R Path Name
  3. Compare with central model path settings
  4. Verify Project and File GUIDs match in Autodesk portal
  5. Identify path mismatches or GUID issues

Benefit: Quick diagnosis of cloud sync problems

Workflow 4: Version Compatibility Check

Scenario: Ensuring file compatibility across team

  1. Open file in question
  2. Run Get File Details
  3. Note Revit Version
  4. Compare with team members' Revit versions
  5. Identify if upgrades or downgrades needed

Benefit: Prevents version compatibility issues

Tips and Best Practices

  1. Copy GUIDs Carefully

    • GUIDs are case-sensitive in some systems
    • Include curly braces {} where shown
    • Double-check copied values before using
    • Consider using the Output Dialog for easier copying

  2. Document Cloud Projects

    • Keep record of Project GUIDs for each cloud project
    • Create lookup table: Project Name → Project GUID
    • Helps with API development and troubleshooting
    • Useful for multi-project environments

  3. Use for Backup Documentation

    • Record file paths before major changes
    • Document cloud paths for disaster recovery
    • Include in project handover documentation
    • Helps locate files if cloud structure changes

  4. Check Version Before Sharing

    • Always verify Revit version before sharing files
    • Prevents "file saved in newer version" errors
    • Plan upgrades based on team's Revit versions
    • Document version requirements for projects

  5. Understand Path Differences

    • Local cache paths differ from cloud paths
    • Path Name shows local representation
    • C4R Path Name shows cloud representation
    • Both refer to the same file

  6. Keep Information Current

    • File details can change if file is moved
    • Re-run tool after moving or renaming cloud files
    • Update documentation when paths change
    • Verify GUIDs after cloud project restructuring

  7. Use for Training

    • Show new users how cloud files are referenced
    • Explain GUID concept with real examples
    • Demonstrate difference between local and cloud paths
    • Include in BIM 360/ACC onboarding

  8. API Integration

    • Save C4R Path Name format as template
    • Use for automated file opening routines
    • Include in custom plugins and add-ins
    • Essential for cloud-based automation

Common Use Cases

BIM 360/ACC Project Setup

Purpose: Verify cloud project configuration

Workflow:

  1. Set up new BIM 360/ACC project
  2. Upload initial files
  3. Open file in Revit
  4. Run Get File Details
  5. Verify BIM A360 Path is correct
  6. Document Project GUID for team reference
  7. Confirm C4R Path Name format

Benefits:

  • Ensures proper cloud setup
  • Provides reference for future troubleshooting
  • Documents project structure

Multi-Project File Organization

Purpose: Track files across multiple cloud projects

Workflow:

  1. Open file from Project A
  2. Run Get File Details, record Project GUID
  3. Open file from Project B
  4. Run Get File Details, record Project GUID
  5. Create spreadsheet: File Name → Project GUID → File GUID
  6. Use for quick project identification

Benefits:

  • Clear organization of files across projects
  • Easy lookup when files have similar names
  • Prevents opening wrong project files

Automation Script Development

Purpose: Develop tools that access cloud files programmatically

Workflow:

  1. Open target cloud file
  2. Run Get File Details
  3. Copy C4R Path Name
  4. Use format in script: CLD://{ProjectGUID}Path/{FileGUID}File.rvt
  5. Replace GUIDs with variables for dynamic access
  6. Test script with known GUIDs first

Benefits:

  • Correct path format for API
  • Working examples for development
  • Faster script creation

File Migration Documentation

Purpose: Document file locations before/after migration

Workflow:

  1. Before migration, run Get File Details on all files
  2. Export information to spreadsheet
  3. Perform migration (e.g., move to new BIM 360 project)
  4. After migration, run Get File Details again
  5. Compare old and new paths/GUIDs
  6. Verify all files migrated correctly

Benefits:

  • Complete migration audit trail
  • Easy verification of successful migration
  • Troubleshooting reference if issues arise

Support Ticket Creation

Purpose: Provide complete file info when requesting support

Workflow:

  1. Encounter issue with Revit file
  2. Run Get File Details
  3. Copy all information from dialog
  4. Paste into support ticket or email
  5. Include Revit version and file paths
  6. Support can identify file quickly

Benefits:

  • Faster support resolution
  • Eliminates back-and-forth for file details
  • Complete technical information provided

Troubleshooting

No Cloud Information Displayed

Problem: BIM A360 Path and GUIDs are empty Solutions:

  • File is not a cloud file
  • File is local copy, not synced with cloud
  • Open file directly from BIM 360/ACC instead
  • Verify cloud worksharing is enabled
  • Check if file has been detached from central

"Error" or Exception Messages

Problem: Tool displays error message Solutions:

  • File may not be saved yet - save first
  • File path may be corrupted
  • Try saving file to new location
  • Check if file is read-only
  • Verify file isn't corrupted

Incomplete Path Information

Problem: Some paths show as empty or partial Solutions:

  • File may be unsaved (new file)
  • Save file to establish paths
  • Some information only applies to certain file types
  • Cloud info only appears for cloud files
  • Network info only appears for network files

GUIDs Don't Match Autodesk Portal

Problem: GUIDs shown don't match portal/website Solutions:

  • Ensure you're in the correct project
  • Verify file hasn't been copied (creates new GUID)
  • Check if file was detached and re-saved
  • Confirm looking at same file in both locations
  • Portal may show folder GUID instead of file GUID

Cannot Copy Text from Dialog

Problem: Unable to select/copy text in dialog Solutions:

  • Click directly on text area
  • Try selecting smaller portions
  • Check Revit Output Dialog for same information
  • Information is also logged there for easy copying
  • Screenshot dialog as alternative

Wrong Revit Version Shown

Problem: Version number doesn't match expected Solutions:

  • Version shown is the last version that saved the file
  • File may have been upgraded from older version
  • Number reflects version format, not year
  • Example: 2024 may show as "2024" or "24.0"
  • This is correct behavior, showing last save version

C4R Path Name Format Issues

Problem: Path format doesn't work in API code Solutions:

  • Ensure GUIDs include curly braces {}
  • Verify no spaces added during copy/paste
  • Check for hidden characters
  • Use exact format: CLD://{GUID}path/{GUID}file.rvt
  • Test with known working example first

File Name Shows Incorrect Extension

Problem: File name shows .rvt but is different type Solutions:

  • Tool assumes .rvt extension
  • For family files (.rfa), extension will be wrong
  • Check title for correct file type
  • Path Name shows actual file type
  • Tool primarily designed for project files

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

Thank you for using Bonus Tools - Get File Details!