Autodesk Data Exchange Console Connector

📋 Overview

This is a sample console connector that demonstrates how to use the Autodesk Data Exchange SDK without the UI component. It serves as a reference implementation for developers building their own Data Exchange integrations and provides a comprehensive example of SDK capabilities through a professional command-line interface.

Perfect for:

• Service-based integrations
• Custom UI development
• Learning Data Exchange SDK patterns
• Automated workflow testing
• Headless data processing

🔗 Quick Navigation

• 🚀 Quick Start - Get up and running quickly
• 💻 Usage Examples - See the console connector in action
• 📚 Command Reference - Complete command documentation
• 🔄 Migration Guide - SDK 6.3.0 Upgrade Guide
• 🏗️ Architecture - Understand the codebase structure
• 🔧 Extending the Application - Add custom functionality

🎯 Key Features

Core Functionality

• ✅ Exchange Management - Create, update, and retrieve exchanges
• ✅ Multi-Format Geometry Processing - BREP, IFC, Mesh, and Primitive geometries
• ✅ Parameter Operations - Add, modify, and delete instance/type parameters
• ✅ Version Control - Exchange synchronization and versioning
• ✅ Data Export - Download exchanges as STEP or OBJ files
• ✅ Folder Management - Set and manage working directories

Developer Experience

• 🚀 Professional Console Interface - Clean, categorized output messages
• 📋 Comprehensive Workflow Testing - Complete end-to-end validation
• 💻 Command-Based Architecture - Extensible command pattern
• 🔧 Error Handling - Robust error management and user feedback
• 📖 Built-in Help System - Detailed command documentation

🛠️ Prerequisites

1. Autodesk Platform Services App

   • Register an app
   • Select Data Management and Data Exchange APIs
   • Note your Client ID, Client Secret, and Auth Callback

2. Development Environment

   • Visual Studio 2019 or later
   • .NET Framework 4.8
   • Basic knowledge of C#

3. Access Requirements

   • Autodesk Construction Cloud (ACC) access
   • Valid Autodesk account with appropriate permissions

🚀 Quick Start

1. Clone and Setup

git clone https://github.com/your-repo/aps-dataexchange-console.git
cd aps-dataexchange-console

2. Install Dependencies

Follow the Data Exchange .NET SDK installation guide:

Option A: Visual Studio

• Open ConsoleConnector.sln
• Build the solution (packages restore automatically)

Option B: Command Line

# Run from project root
BuildSolution.bat

3. Configuration

Update src/ConsoleConnector/App.config with your app credentials:

<appSettings>
    <add key="APS_CLIENT_ID" value="your_client_id" />
    <add key="APS_CLIENT_SECRET" value="your_client_secret" />
    <add key="APS_CALLBACK_URL" value="your_callback_url" />
</appSettings>

4. Run the Application

• Build and run the console application
• Complete OAuth authentication in the browser
• Start using commands in the console interface

💻 Usage Examples

Basic Commands

# Get help
>> help

# Set working folder (using folder URL)
>> SetFolder [FolderUrl]
# OR set working folder (using individual parameters)
>> SetFolder [HubId] [Region] [ProjectUrn] [FolderUrn]

# Create a new exchange
>> CreateExchange [ExchangeTitle]

# Add BREP geometry
>> AddBrep [ExchangeTitle]

# Add instance parameters
>> AddInstanceParameter [ExchangeTitle] [ElementId] [ParameterName] [ParameterSchema] [ParameterValue] [ParameterValueDataType]

# Sync changes
>> SyncExchange [ExchangeTitle]

# Download exchange
>> GetExchange [ExchangeId] [CollectionId] [HubId] [ExchangeFileFormat]

Complete Workflow Test

# Run comprehensive end-to-end test
>> WorkFlowTest

This command executes a complete workflow that:

1. Creates a new exchange
2. Adds multiple geometry types (BREP, IFC, Mesh, Primitives)
3. Adds instance and type parameters
4. Syncs to Version 1
5. Deletes some parameters
6. Adds more geometries and parameters
7. Syncs to Version 2
8. Downloads the final exchange

📚 Command Reference

Command	Description	Example
help	Display all commands	help
help [command]	Get command details	help CreateExchange
CreateExchange	Create new exchange	CreateExchange [ExchangeTitle]
AddBrep	Add BREP geometry	AddBrep [ExchangeTitle]
AddIFC	Add IFC geometry	AddIFC [ExchangeTitle]
AddMesh	Add mesh geometry	AddMesh [ExchangeTitle]
AddPrimitive	Add primitives	AddPrimitive [ExchangeTitle] [PrimitiveGeometry]
AddInstanceParameter	Add instance parameter	AddInstanceParameter [ExchangeTitle] [ElementId] [ParameterName] [ParameterSchema] [ParameterValue] [ParameterValueDataType]
AddTypeParameter	Add type parameter	AddTypeParameter [ExchangeTitle] [ElementId] [ParameterName] [ParameterSchema] [ParameterValue] [ParameterValueDataType]
DeleteInstanceParam	Remove instance parameter	DeleteInstanceParam [ExchangeTitle] [ElementId] [ParameterName]
DeleteTypeParam	Remove type parameter	DeleteTypeParam [ExchangeTitle] [ElementId] [ParameterName]
SyncExchange	Sync exchange	SyncExchange [ExchangeTitle]
GetExchange	Download exchange	GetExchange [ExchangeId] [CollectionId] [HubId] [ExchangeFileFormat]
SetFolder	Set working folder	SetFolder [FolderUrl] or SetFolder [HubId] [Region] [ProjectUrn] [FolderUrn]
WorkFlowTest	Run complete test	WorkFlowTest
Exit	Close application	Exit

🏗️ Architecture

ConsoleConnector/
├── Commands/           # Command implementations
│   ├── CreateExchangeCommand.cs
│   ├── CreateBrepCommand.cs
│   ├── WorkFlowTestCommand.cs
│   └── ...
├── Helper/            # Utility classes
│   ├── ConsoleAppHelper.cs
│   ├── GeometryHelper.cs
│   └── ParameterHelper.cs
├── Interfaces/        # Abstractions
└── Assets/           # Sample geometry files

Key Components

• Command Pattern: Each operation is implemented as a separate command class
• Helper Classes: Reusable utilities for geometry, parameters, and console operations
• Interface Abstractions: Clean separation of concerns
• Asset Management: Sample files for testing and demonstration

🔧 Extending the Application

Adding New Commands

1. Create a new command class inheriting from Command
2. Implement required methods (Execute, Clone, ValidateOptions)
3. Register the command in ConsoleAppHelper

public class MyCustomCommand : Command
{
    public override async Task<bool> Execute()
    {
        Console.WriteLine("[CUSTOM] Executing my command");
        // Implementation here
        return true;
    }
    
    public override Command Clone()
    {
        return new MyCustomCommand(this);
    }
}

Adding Command Options

1. Create option class in Commands/Options/
2. Add to command's Options list
3. Use GetOption<T>() to access values

🔄 Migration Guide: SDK 6.3.0 Upgrade

This section documents the migration from SDK 6.2.0 to Autodesk Data Exchange SDK 6.3.0.

📋 Overview of Changes

This upgrade includes important API improvements and refinements:

• SDK Version: Upgraded to Autodesk.DataExchange 6.3.0
• Enhanced API Methods: Refined method signatures for better type safety
• API Cleanup: Removed deprecated classes and streamlined geometry handling

🚀 Key Dependency Updates

Package	Previous Version	New Version	Impact
Autodesk.DataExchange	6.2.0	6.3.0	Major - Core SDK upgrade with API refinements

⚠️ Breaking Changes

1. MeshAPI.Color() Parameter Type Change

Before (SDK 6.2.0):

// Color values were float from 0.0 to 1.0
MeshAPI.Color(0.5f, 0.75f, 1.0f, 1.0f); // RGBA as floats

After (SDK 6.3.0):

// Color values are now int from 0 to 255
MeshAPI.Color(127, 191, 255, 255); // RGBA as integers

Migration Action: Convert all MeshAPI.Color() calls from float values (0.0-1.0) to integer values (0-255). Multiply your float values by 255 and cast to int.

2. CurveSet Removal

Before (SDK 6.2.0):

// CurveSet class was available for curve operations
CurveSet curveSet = new CurveSet();
// ... curve operations

After (SDK 6.3.0):

// CurveSet has been removed - use GeometryContainer instead
GeometryContainer geometryContainer = new GeometryContainer();
// ... geometry operations

Migration Action: Replace all CurveSet usage with GeometryContainer. Update your curve handling logic to use the GeometryContainer API.

🔧 Migration Steps

Step 1: Update Package References

Update your packages.config or project file:

<package id="Autodesk.DataExchange" version="6.3.0" targetFramework="net48" />

Step 2: Update MeshAPI.Color() Calls

Search and replace all MeshAPI.Color() calls to use integer values:

// OLD: Float values (0.0 - 1.0)
MeshAPI.Color(0.5f, 0.75f, 1.0f, 1.0f);

// NEW: Integer values (0 - 255)
MeshAPI.Color(127, 191, 255, 255);

// Conversion formula: intValue = (int)(floatValue * 255)

Step 3: Replace CurveSet with GeometryContainer

Search for all CurveSet usage and replace with GeometryContainer:

// OLD: Using CurveSet
CurveSet curveSet = new CurveSet();
// curve operations...

// NEW: Using GeometryContainer
GeometryContainer geometryContainer = new GeometryContainer();
// geometry operations...

Step 4: Test Your Changes

Run your application and verify that all geometry rendering and curve operations work correctly with the new APIs.

🎯 New Features & Improvements

Enhanced Type Safety

• Integer-based color values provide more intuitive and precise color control
• Clearer API contracts with strongly-typed parameters
• Reduced ambiguity in color value ranges

Streamlined Geometry API

• Unified geometry handling through GeometryContainer
• Simplified API surface with removal of deprecated classes
• More consistent geometry operation patterns

Performance & Reliability

• Optimized color processing with integer operations
• Improved memory efficiency in geometry operations
• Better API consistency across the SDK

🧪 Testing Your Migration

After migration, run the comprehensive workflow test:

>> WorkFlowTest

This command validates:

• ✅ Exchange creation and management
• ✅ Geometry processing (BREP, IFC, Mesh, Primitives)
• ✅ Parameter operations
• ✅ Synchronization workflows
• ✅ File download capabilities

⚡ Performance Considerations

1. Color Operations: Integer-based colors are more efficient than float-based calculations
2. Geometry Container: The unified GeometryContainer provides better memory management
3. Async/Await: Ensure all async methods are properly awaited
4. API Simplification: Streamlined API reduces overhead and improves performance

🐛 Troubleshooting Common Issues

Issue: MeshAPI.Color() Type Mismatch

Error: ArgumentException: Cannot convert float to int Solution: Update all MeshAPI.Color() calls to use integer values (0-255) instead of float values (0.0-1.0). Use the conversion formula: (int)(floatValue * 255).

Issue: CurveSet Not Found

Error: Type or namespace 'CurveSet' could not be found Solution: Replace all CurveSet references with GeometryContainer. Update your curve handling logic to use the new API.

Issue: Color Rendering Differences

Error: Colors appear different after migration Solution: Verify your color conversion is correct. Ensure you're multiplying float values by 255 and not accidentally dividing or using incorrect conversions.

Issue: Package Conflicts

Error: Assembly binding conflicts Solution: Clean and rebuild solution, ensure all packages are updated to 6.3.0 consistently.

📞 Support & Resources

• Breaking Changes: See above migration steps
• New Features: Explore the enhanced API documentation
• Performance: Review the optimization guidelines
• Issues: Report SDK-specific issues through official channels

---

Migration Checklist:

• Updated all package references to 6.3.0
• Converted all MeshAPI.Color() calls to use integer values (0-255)
• Replaced all CurveSet usage with GeometryContainer
• Tested mesh rendering with new color values
• Verified geometry operations with GeometryContainer
• Tested core workflows with WorkFlowTest
• Reviewed and updated error handling

📖 Documentation

• Autodesk Data Exchange SDK
• SDK Without UI Tutorial
• Authentication Guide

🤝 Contributing

This is a sample project for reference purposes. While direct contributions may not be accepted, you're encouraged to:

1. Fork the repository for your own modifications
2. Report issues or suggestions
3. Share improvements with the community

📄 License

This sample code is part of the Autodesk Data Exchange .NET SDK (Software Development Kit) beta. It is subject to the license covering the Autodesk Data Exchange .NET SDK (Software Development Kit) beta.

✍️ Authors

Dhiraj Lotake - Autodesk
Hariom Sharma - Autodesk

---

🆘 Support

For SDK-related questions and support:

• Autodesk Platform Services Documentation
• Community Forums
• SDK Issues

---

This sample demonstrates the power and flexibility of the Autodesk Data Exchange SDK for building custom integrations and automating design data workflows.