Difference between revisions of "API Changelog"

From ReliaWiki
Jump to navigation Jump to search
m
Line 1: Line 1:
 
{{Template:API}}{{Template:APIUpgradesNavBox}}
 
{{Template:API}}{{Template:APIUpgradesNavBox}}
 
   
 
   
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 most significant enhancements and deprecations since the previous versions.
+
Before you upgrade to the latest version of the Synthesis API object library file, review what's new and what has changed since the last version. The latest version may have introduced some code-breaking changes, requiring you to make changes to your code before upgrading.  
  
When you're ready to upgrade, first install the latest version of Synthesis on your computer. The Synthesis API 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'''
+
===How to get the latest version of the Synthesis API object library file===
 +
The Synthesis API object library file is installed with the Synthesis Platform; hence, the version number of the object library file always corresponds to the version number of the Synthesis Platform. You can get the latest version of the object library file by simply installing or upgrading to the latest version of Synthesis.
 +
 
 +
You can get the latest version of Synthesis by choosing '''File > Help > Check for Updates''' or downloading the latest update at [http://www.reliasoft.com/synthesis/downloads.htm http://www.ReliaSoft.com/synthesis/downloads.htm]. Note that for VBA, the bit version (32- vs. 64-bit) of the Synthesis Platform that you've installed must match your installed version of Microsoft Office. If they do not match, you may see an error related to ActiveX controls. (See [http://www.reliasoft.com/support/rs20024.htm ReliaSoft KB article RS20024].)
 +
 
 +
The Synthesis API object library file is located in the folder where you've installed the Synthesis applications. You may need to to update the library reference of your custom applications to point to the file in that location. For VBA applications, use the SynthesisAPI.tlb file. For .NET applications, use the SynthesisAPI.dll file.
 +
 
 +
 
 +
==Changelog==
 +
The version numbers in the changelog correspond to the version numbers of the installed Synthesis Platform.
 +
<!--
 +
===10.1.1===
  
  
For a complete list of all new classes and enumerations in the object library, see [[New Classes and Enumerations]].
 
  
For a complete list of all new methods and properties in existing objects, see [[New Members and Constants]].
 
  
For a complete list of all deprecations, see [[Deprecated and Removed Members]].
 
  
 +
--->
 +
===10.0.4===
 +
Here's an overview of the most significant enhancements and deprecations since the previous version.
  
==What's New in Synthesis API Version 10.0==
 
 
'''Improved flexibility'''
 
'''Improved flexibility'''
:*We've added all new classes and methods for accessing FMEA and related data from Xfmea, RCM++ and RBI.
+
:*Added all new classes and methods for accessing FMEA and related data from Xfmea, RCM++ and RBI.
:*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.  
+
:*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.  
  
 
'''New features incorporated'''
 
'''New features incorporated'''
:*We've added new properties and enumerations in the cAction class to take advantage of the expanded action-tracking capabilities introduced in the latest version of the Synthesis platform. This includes action properties relevant to the project planner and Xfmea/RCM++/RBI test plans.
+
:*Added new properties and enumerations in the cAction class to take advantage of the expanded action-tracking capabilities introduced in the latest version of the Synthesis platform. This includes action properties relevant to the project planner and Xfmea/RCM++/RBI test plans.
:*For all resource objects (e.g., cModel, cURD, cCrew, etc.), we've added a new set of properties for accessing the Synthesis identifiers fields in the platform.
+
:*For all resource objects (e.g., cModel, cURD, cCrew, etc.), added a new set of properties for accessing the Synthesis identifiers fields in the platform.
  
 
'''Deprecations'''
 
'''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.
 
:*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.
 +
 +
 +
For a complete list of all new classes and enumerations added to the object library, see [[New Classes and Enumerations]].
 +
 +
For a complete list of all new methods and properties added to existing objects, see [[New Members and Constants]].
 +
 +
For a complete list of all deprecations, see [[Deprecated and Removed Members]].
 +
 +
===10.0.3===
 +
Initial public release for Version 10 applications.

Revision as of 20:42, 3 November 2015

APIWiki.png


<< Back to API Main Page

API Changelog

API Reference Documentation

Before you upgrade to the latest version of the Synthesis API object library file, review what's new and what has changed since the last version. The latest version may have introduced some code-breaking changes, requiring you to make changes to your code before upgrading.

How to get the latest version of the Synthesis API object library file

The Synthesis API object library file is installed with the Synthesis Platform; hence, the version number of the object library file always corresponds to the version number of the Synthesis Platform. You can get the latest version of the object library file by simply installing or upgrading to the latest version of Synthesis.

You can get the latest version of Synthesis by choosing File > Help > Check for Updates or downloading the latest update at http://www.ReliaSoft.com/synthesis/downloads.htm. Note that for VBA, the bit version (32- vs. 64-bit) of the Synthesis Platform that you've installed must match your installed version of Microsoft Office. If they do not match, you may see an error related to ActiveX controls. (See ReliaSoft KB article RS20024.)

The Synthesis API object library file is located in the folder where you've installed the Synthesis applications. You may need to to update the library reference of your custom applications to point to the file in that location. For VBA applications, use the SynthesisAPI.tlb file. For .NET applications, use the SynthesisAPI.dll file.


Changelog

The version numbers in the changelog correspond to the version numbers of the installed Synthesis Platform.

10.0.4

Here's an overview of the most significant enhancements and deprecations since the previous version.

Improved flexibility

  • Added all new classes and methods for accessing FMEA and related data from Xfmea, RCM++ and RBI.
  • 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.

New features incorporated

  • Added new properties and enumerations in the cAction class to take advantage of the expanded action-tracking capabilities introduced in the latest version of the Synthesis platform. This includes action properties relevant to the project planner and Xfmea/RCM++/RBI test plans.
  • For all resource objects (e.g., cModel, cURD, cCrew, etc.), added a new set of properties for accessing the 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.


For a complete list of all new classes and enumerations added to the object library, see New Classes and Enumerations.

For a complete list of all new methods and properties added to existing objects, see New Members and Constants.

For a complete list of all deprecations, see Deprecated and Removed Members.

10.0.3

Initial public release for Version 10 applications.