Aras.IOM 15.0.1

Aras IOM

Aras IOM (Innovator Object Model) is a robust, object-oriented API for interacting with Aras Innovator. It allows developers to build integrations, automate processes, and extend Innovator’s capabilities using AML (Aras Markup Language) under the hood.

Features

• Robust Integration Framework: Provides a high-level object-oriented API for working with Aras Innovator data and processes
• Authentication Flexibility: Supports Basic and OAuth 2.0 flows (Authorization Code, Impersonate, Password)
• AML-Powered API: Executes and manages Aras Markup Language (AML) queries and transactions
• Advanced File Management: Efficient upload and download of large file structures (e.g., CAD, drawings, documents, etc) using CheckinManager and CheckoutManager
• Seamless COM Interop: Supports COM-based integrations through stable ProgIDs and type library exposure
• Backward-Compatible SDK Design: Designed to work across multiple Aras Innovator versions and preserve long-term integration stability

Target Platforms

The IOM SDK is compatible with the following platforms:

• .NET Framework 4.7.2
• .NET 6.0
• .NET 8.0
• COM Interop (via .NET Framework 4.7.2)

COM support is provided through a COM-visible .NET assembly and registered type libraries.

Dependencies

The Aras IOM relies on the following libraries:

• Aras.Net: Provides core networking functionality for interacting with Aras Innovator.
• Aras.Cryptography: Handles cryptographic operations required for secure communication.
• Aras.IOM.OAuth.WpfBrowserNavigator: Supports OAuth 2.0 authentication flows using a WPF-based browser navigator.

Ensure these dependencies are installed and available in your project. They are typically included as part of the NuGet package installation process.

Documentation

A comprehensive Aras IOM SDK - Programmer’s Guide is available for subscribers. For access, please visit the Aras Subscriber Portal, or contact your Aras representative.

Installation

• NuGet (Recommended) Install packages (e.g., Aras.IOM) from nuget.org using Visual Studio’s Manage NuGet Packages.

• Local Feed (Alternative) If nuget.org is inaccessible, see Appendix A: Local NuGet Repository in the programmer’s guide for how to create and reference a local feed.

Versioning

Starting with IOM SDK 15.0.0, versioning follows the Semantic Versioning (SemVer) format: MAJOR.MINOR.PATCH.

Major (X.0.0) – May introduce breaking changes

Major releases can include breaking changes; however, they do not always require updates to existing integrations. The actual impact depends on the nature of the change, which is often isolated and may not affect all consumers.

Developers should always review the changelog to assess whether their implementation is impacted.

Examples of changes that may trigger a major version but not affect all users:

• Support for older Aras Innovator releases is dropped, which might not affect consumers not using those versions.
• Support for older .NET platforms (e.g., .NET 6) is dropped, which won’t affect consumers already using newer platforms.
• Breaking changes in the IOM API or COM interfaces, which may not affect consumers who do not use the modified APIs.

Minor (X.Y.0) – Adds new functionality in a backward-compatible manner

Minor releases introduce new features that are fully compatible with earlier minor versions within the same major version. They follow a strict non-breaking change policy.

Patch (X.Y.Z) – Includes bug fixes and optimizations

Patch versions include:

• Bug fixes
• Security patches
• Performance improvements

These do not introduce new APIs or breaking changes, and are safe for all consumers within the same minor version.

End-of-Life (EOL) Policy

To ensure predictable support timelines, the IOM SDK follows a structured End-of-Life (EOL) policy. Older versions are phased out as new versions are released, with support and maintenance limited based on version level.

General EOL Rules

Major releases transition previous major versions into maintenance mode

• When a new major version (X.0.0) is released, the previous major version ((X-1).Y.Z) enters maintenance mode.
• In this phase, the version is still supported for critical security updates, but no new features or regular updates will be provided.

Example: When IOM 16.0.0 is released, IOM 15.x.x enters maintenance mode.

Minor releases replace previous minor versions within the same major version

• Minor releases are backward-compatible and do not introduce breaking changes.
• When a new minor version (X.Y.0) is released, earlier minor versions in the same major line (X.(Y-1).Z) are no longer updated — future bug fixes and improvements are delivered only to the latest minor.

Example: When IOM 15.1.0 is released, IOM 15.0.x will not receive further patches.

Users may continue using an earlier minor version if their implementation is stable, but to receive ongoing updates, they should move to the latest minor-patch release within the same major version.

Patch versions are maintained only through the latest release in each minor line

• All patch versions (X.Y.Z) within a given minor version (X.Y) are compatible and non-breaking.
• However, only the latest patch version is maintained — earlier patch versions do not receive further updates once a new patch is released.
• Bug fixes, performance improvements, and critical updates are always released as new patch versions. Existing patch versions are never modified or re-issued after publication.

Example: If 15.0.7 is the latest patch, any new fix will be released as 15.0.8.

Users may choose to apply the latest patch within their current minor release, but in many cases a newer minor (with its own patches) may be a better upgrade option.

Compatibility with Aras Innovator Versions

Backward Compatibility

IOM SDK versions are designed with backward compatibility in mind. New SDK releases are generally intended to work with previously released and supported versions of Aras Innovator.

As of this IOM SDK release, backward compatibility is expected to include:

• Aras Innovator 12.0 SP18
• Aras Innovator Release 14
• Aras Innovator Release 15
• Aras Innovator Release 16
• Aras Innovator Release 17
• Aras Innovator Release 18
• Aras Innovator Release 19
• Aras Innovator Release 20
• Aras Innovator Release 21
• Aras Innovator Release 22
• Aras Innovator Release 23
• Aras Innovator Release 24
• Aras Innovator Release 25
• Aras Innovator Release 26
• Aras Innovator Release 27
• Aras Innovator Release 28
• Aras Innovator Release 29
• Aras Innovator Release 30
• Aras Innovator Release 31
• Aras Innovator Release 32
• Aras Innovator Release 33
• Aras Innovator Release 34
• Aras Innovator Release 35

These are the Innovator versions available at the time of this SDK release. For compatibility with newer versions of Aras Innovator, see the Forward Compatibility section and consult the official compatibility matrix.

Forward Compatibility

After an IOM SDK version is released, it may be tested against future versions of Aras Innovator to determine compatibility.

• If compatibility is confirmed, it will be documented in the official compatibility matrix, which can be found on the Aras Subscriber Portal.
• If breaking changes are introduced in a future Innovator release, the matrix will indicate whether an updated SDK version is required.

Always consult the compatibility matrix for the most up-to-date guidance on supported IOM–Innovator version combinations.

COM Compatibility and ProgID Stability

In earlier versions of Aras Innovator, COM ProgIDs were version-specific and would change automatically with each new major release — which could disrupt COM-based integrations.

Starting with IOM SDK 15.0.0:

• COM ProgIDs remain stable across major versions, unless a breaking change requires modification (which will be explicitly documented).
• IOM SDK 15.0.0 maintains the same ProgIDs as IOM 14.0.0, ensuring continued compatibility for existing COM-based integrations.
• Future major SDK versions will preserve existing ProgIDs by default, unless otherwise stated in release notes.

Getting Started

Refer to the Aras IOM SDK - Programmer’s Guide for detailed instructions on installation, authentication, and usage. The guide provides step-by-step examples and advanced scenarios to help you integrate and work with the Aras IOM Library effectively.

Release Notes

For version history and detailed changes, refer to the official Release Notes available on the Aras Subscriber Portal.

License

This package is provided under the terms specified in LICENSE.txt. Please review and comply with the licensing before using or distributing this software.