Forward Compatibility Policy

 

At coolOrange, we believe that software should empower not restrict engineering teams. Our forward compatibility policy gives customers confidence that their automations and integrations will remain functional as Autodesk Software (like Vault / Inventor) evolves without surprises or hidden costs.

What Compatibility Means

In this context, forward compatibility means that your customizations will continue to work as expected when

  • Upgrading to a new Autodesk Software version
  • Updating to a new version of coolOrange software

This policy defines:

  • Which customizations are covered
  • When compatibility is guaranteed
  • Where adaptation may be required
  • What support is available in each case

Our goal is to turn upgrades into a smooth and straightforward experience without the usual complexity.


How coolOrange solves the API problem

Autodesk Software API (like Vault / Inventor) is powerful but also version sensitive. Even small API changes between versions can break existing customizations, leading to unexpected downtime, costs, and frustration.

At coolOrange, we solve this problem by abstracting the Autodesk API into a stable set of our own coolOrange API.

Our own coolOrange APIs:

  • Wrap the most frequently used Autodesk API calls
  • Simplify complex operations without losing capabilities
  • Allow customizations to focus on business logic rather than unnecessary technical API details

With this approach:

  • Less code is required, and it’s easier to maintain
  • Compatibility issues caused by Vault API changes, for the most frequently used Autodesk API calls, are handled internally by coolOrange
  • We reduce the complexity and costs for upgrades 


When native APIs are required

While our coolOrange API cover the majority of use cases, some scenarios still require direct access to:

  • Specific Vault or Inventor APIs not yet wrapped
  • External systems such as SharePoint or ERP systems

In such cases, native API calls are used alongside ours. 

This makes upgrades more complex, as Autodesk or other vendors may modify these components, impacting long-term stability.

The good news:

  • If the API does not change, our customizations are developed that they will still run without additional efforts.
  • If the API has changed, only those specific calls must be adapted, and the rest of the customization remains intact.

To give customers full clarity before any change, we::

  • Deliver a compatibility analysis for every project
  • Offer a free compatibility analysis on request

The more your customization relies on our coolOrange API, the more forward-compatible and low-maintenance it becomes.

 

When workflows or new features require changes

Some Autodesk Software upgrades introduce new features or workflow changes. 

In most cases, existing customizations remain unaffected. However, there are two exceptions:

  1. Mandatory changes
    A new feature may require a change in the way a workflow functions, making it necessary to adapt the related customization.
  2. Optional improvements
    A new feature may offer a better way to implement an existing workflow. While not required, adapting the customization could improve performance or maintainability.

These situations are:

  • Less frequent than API changes
  • Not predictable in advance
  • Not covered by the compatibility guarantee


Compatibility Scope

Fully Covered: Customizations using only coolOrange API

  • Guaranteed compatibility across Autodesk upgrades and updates
  • Free correction in case of breakage due to cmdlet changes (rare and usually syntactic)
  • Simplified support and long-term maintainability

⚠️ Partially Covered: Customizations mixing coolOrange APIs and native APIs

  • coolOrange API logic is maintained and forward compatible
  • Native API parts may be impacted by version updates, and related adjustments are billable.

Not Covered: Custom special features (.NET implementations) using only native APIs

  • Full add-ins for Vault, Inventor, Office, or ERP written using .NET and native APIs
  • Not guaranteed to remain compatible with future Autodesk versions.
  • Fixes will be charged

A compatibility analysis will be delivered to the customer for every project.

 

Upgrade Timing Recommendation

To maintain control and simplify testing, we recommend that customers:

  • Perform customizations at least 6 weeks before or after a Vault upgrade

Running upgrades and custom changes at the same time can create uncertainty. If an issue occurs, it’s harder to trace the cause. Separating the two ensures transparency and minimizes troubleshooting effort.

 

Compatibility Assessment

If you’re unsure whether your scripts rely on native APIs or fall under our compatibility guarantee, we offer a free compatibility analysis.

This helps you anticipate how an upgrade might affect your setup and prepare with confidence before proceeding.

 

Upgrade Execution Options

We offer three upgrade paths depending on your internal capabilities:

Variant

Description

coolOrange Role

Cost

Self-Upgrade You upgrade your environment and run the tests.   Free support if issues arise  No costs
Self-Upgrade with Mentoring You upgrade the system with a dedicated coolOrange expert available.  Issue analysis and mentoring Mentoring and fixes will be charged
coolOrange-Managed Upgrade We perform the upgrade remotely using your test environment.  We execute the upgrade and conduct smoke testing Fully chargeable

Like painting a room - You can do it yourself, do it with a coach, or hire a professional. In all three cases, you own the room and must approve the result.

 

Testing and Final Acceptance 

We perform comprehensive tests in our own lab environments. In customer environments, we run technical smoke tests, confirming that:

  • Customizations load correctly
  • Features execute without errors

We do not verify:

  • Whether workflows produce the right outcomes
  • Whether results comply with your internal process logic

Final acceptance always rests with the customer, based on their own data and quality expectations. 

Frequently Asked Questions (FAQs) 

It means your customizations, especially those using coolOrange API, continue working after Vault upgrades or updates, without requiring changes.

  • If it uses only coolOrange API → we fix it for free

  • If it includes native API  → issue analysis is free, implementation is charged

We offer a free compatibility analysis.

We’ll tell you how much of your customization is covered and where risks may exist.

We conduct technical smoke tests:

  • Verifying that the customization loads and runs without errors 
  • Ensuring that features work on a high level 

We do not test whether workflows behave correctly in your business context, or if the outcome of the features is correct, that's the customer's responsibility.

Custom special features (.NET implementations) using native APIs are not covered. Upgrades may affect them. All required changes will be charged.

No. Do customizations at least 6 weeks before or after an upgrade. Otherwise, it's hard to know what caused any issues.

You can: 

  • Upgrade yourself and get free support (Variant 1) 
  •  Upgrade yourself with a mentor (Variant 2) 
  • Let coolOrange manage the upgrade (Variant 3)

We release compatible software within 6 weeks of Autodesk releasing a new version, except in rare cases involving major platform changes (e.g., .NET Framework → .NET Core). 

Visit our documentation site for:

  • Cmdlet references
  • Change logs
  • Compatibility notes

Our product documentation site.