API Changelog: Difference between revisions

Revision as of 19:14, 1 September 2015

The latest version of the Synthesis API is Version 10.

Before upgrading to the latest version, review what's new and what has changed since the last version. This page provides a quick overview of the major points to consider before upgrading. Detailed lists are provided in the following pages:

For a complete list of new classes and enumerations, see New Classes and Enumerations.
For a complete list of new methods, properties, events and constants, see New Members and Constants.
For a complete list of deprecated, changed or removed members, see Deprecated and Removed Members.

When you're ready to upgrade, first install any Version 10 Synthesis application on your computer. The object library file will be located in the folder where the Synthesis application is installed. You can then update the library reference of your custom applications to point to the file in that location. For VBA applications, use SynthesisAPI.tlb. For .NET applications, use SynthesisAPI.dll

Upgrading to Synthesis API Version 10

With the release of the Version 10 platform, we’ve added several new methods, properties and classes to the API to improve the way it handles Synthesis resources and to take advantage of new features available in the Synthesis platform.

Here’s a quick overview of the most significant enhancements and deprecations in the latest version.

Improved flexibility

We've added several new methods in the Repository class to provide more options for manipulating Synthesis resources. The most significant of these is the ability to get a single resource from a Synthesis repository. You are no longer limited to using arrays to access a particular resource item.
We've created all new classes and methods for accessing FMEA and related data from Xfmea/RCM++/RBI.

Platform features incorporated

New properties and enumerations in the cAction class take advantage of the expanded action-tracking capability in the latest version of the platform.
For all resource objects (e.g., cModel, cURD, cCrew, etc.), a new set of properties were added for accessing the improved Synthesis identifiers fields in the platform.

Deprecations

The Repository class has been restructured to organize its growing number of members. All of its members are now organized into fields named after the object type they apply to. For example, the Repository.GetAllModels() method, which returns a cModel object, has been renamed to Repository.Model.GetAllModels(); similarly, the Repository.ImportBlockSimXMLFile method has been renamed to Repository.BlockSim.ImportBlockSimXMLFile, etc. The previous versions of the methods still exist so your code is not broken, but they are deprecated and may be removed in future versions of the API.

@@ Line 1: / Line 1: @@
-{{InProgress}}{{Template:API}}
+{{InProgress}}{{Template:API}}{{Template:APIUpgradesNavBox}}
+The latest version of the Synthesis API is Version 10.
-<!--
+Before upgrading to the latest version, review what's new and what has changed since the last version. This page provides a quick overview of the major points to consider before upgrading. Detailed lists are provided in the following pages:
-==What's New in Synthesis API Version 10==
+:*For a complete list of new classes and enumerations, see [[New Classes and Enumerations]].
-* We've added several new methods to the Repository class and organized them into fields named after the object type they apply to. This means that existing methods in the class have also been moved to the appropriate fields. For example, the <code>Repository.GetAllModels()</code> method, which affects model resources, has been renamed to <code>Repository.Model.GetAllModels()</code>; similarly, <code>Repository.ImportBlockSimXMLFile</code> has been renamed to <code>Repository.BlockSim.ImportBlockSimXMLFile</code>, etc. The Version 9 methods still exist so your code is not broken, but they are deprecated and may be removed in future versions of the API.
+:*For a complete list of new methods, properties, events and constants, see [[New Members and Constants]].
-* In Version 9, you had to get all of a single resource (e.g., all models) from a repository before you could update a single one. In the latest version, we've added new methods that allow you to get just a single resource from the repository and update it.
+:*For a complete list of deprecated, changed or removed members, see [[Deprecated and Removed Members]].
-*We've added new methods that allow access to FMEA and related data from Xfmea/RCM++/RBI.
+When you're ready to upgrade, first install any Version 10 Synthesis application on your computer. The object library file will be located in the folder where the Synthesis application is installed. You can then update the library reference of your custom applications to point to the file in that location. For VBA applications, use '''SynthesisAPI.tlb'''. For .NET applications, use '''SynthesisAPI.dll'''
-For a list of new classes and enumerations, see [[New Classes and Enumerations]].
-For a list of new methods, properties, events and constants, see [[New Members and Constants]].
-For a list of deprecated, changed or removed members, see [[Deprecated and Removed Members]].
+==Upgrading to Synthesis API Version 10==
--->
+With the release of the Version 10 platform, we’ve added several new methods, properties and classes to the API to improve the way it handles Synthesis resources and to take advantage of new features available in the Synthesis platform.
+Here’s a quick overview of the most significant enhancements and deprecations in the latest version.
+===Improved flexibility===
+:*We've added several new methods in the Repository class to provide more options for manipulating Synthesis resources. The most significant of these is the ability to get a single resource from a Synthesis repository. You are no longer limited to using arrays to access a particular resource item.
+:*We've created all new classes and methods for accessing FMEA and related data from Xfmea/RCM++/RBI.
+===Platform features incorporated===
+:*New properties and enumerations in the cAction class take advantage of the expanded action-tracking capability in the latest version of the platform.
+:*For all resource objects (e.g., cModel, cURD, cCrew, etc.), a new set of properties were added for accessing the improved Synthesis identifiers fields in the platform.
+===Deprecations===
+:*The Repository class has been restructured to organize its growing number of members. All of its members are now organized into fields named after the object type they apply to. For example, the <code>Repository.GetAllModels()</code> method, which returns a cModel object, has been renamed to <code>Repository.Model.GetAllModels()</code>; similarly, the <code>Repository.ImportBlockSimXMLFile</code> method has been renamed to <code>Repository.BlockSim.ImportBlockSimXMLFile</code>, etc. The previous versions of the methods still exist so your code is not broken, but they are deprecated and may be removed in future versions of the API.