Difference between revisions of "API Changelog"

From ReliaWiki
Jump to navigation Jump to search
(v10.1 update)
Line 3: Line 3:
 
Before you upgrade to the latest version of the Synthesis API, 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.  
 
Before you upgrade to the latest version of the Synthesis API, 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.  
  
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 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 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]].
+
*For a complete list of all deprecations, see [[Deprecated and Removed Members]].
  
 
===How to get the latest version of the Synthesis API object library file===
 
===How to get the latest version of the Synthesis API object library file===
Line 16: Line 16:
 
== Highlights ==
 
== Highlights ==
 
Here's a brief overview of the most significant enhancements and deprecations in the API since the previous version.
 
Here's a brief overview of the most significant enhancements and deprecations in the API since the previous version.
===10.0.4===
+
 
No updates.
+
===10.1.0===
 +
*Added ability to get global and reference resources. The new <code>Filter</code> parameter has been added to the following methods. The filter's default value is 0, which returns local resources. 
 +
:*[[Repository.Model.GetAllModels]]
 +
:*[[Repository.Model.GetAllModelsInfo]]
 +
:*[[Repository.Crew.GetAllCrews]]
 +
:*[[Repository.Pool.GetAllPools]]
 +
:*[[Repository.Task.GetAllScheduledTasks]]
 +
:*[[Repository.Task.GetAllCorrectiveTasks]]
 +
:*[[Repository.URD.GetAllURDs]]
 +
:*[[Repository.Variable.GetAllVariables]]
 +
*Added a class that allows VBA users to change the API library language..
 +
*Added a method for getting a single system hierarchy item.
 +
*Added new user-defined properties to relevant resource classes.
 +
*Deprecated a couple of obsolete properties.
 +
*Various fixes and non-breaking changes.
 +
 
  
 
===10.0.3===
 
===10.0.3===
Initial public release for Version 10 Synthesis API.  
+
Initial public release for Synthesis API 10.  
  
 
'''Improved flexibility'''
 
'''Improved flexibility'''

Revision as of 00:31, 1 March 2016

APIWiki.png


<< Back to API Main Page

API Changelog

API Reference Documentation

Before you upgrade to the latest version of the Synthesis API, 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 object library file is located in the folder where the Synthesis application is installed. By default, this folder is at "C:\Program Files\ReliaSoft\Synthesis 10". (For Version 9, it is "C:\Program Files\ReliaSoft\Synthesis 9".)

To get the latest version of the object library file, simply install or upgrade to the latest version of Synthesis. Choose File > Help > Check for Updates or download the latest update from our website at http://www.ReliaSoft.com/synthesis/downloads.htm. You may need to to update the library reference of your custom applications to point to the location of the object library file. For VBA applications, use the SynthesisAPI.tlb file. For VB.NET applications, use the SynthesisAPI.dll file.

Highlights

Here's a brief overview of the most significant enhancements and deprecations in the API since the previous version.

10.1.0

  • Added ability to get global and reference resources. The new Filter parameter has been added to the following methods. The filter's default value is 0, which returns local resources.
  • Added a class that allows VBA users to change the API library language..
  • Added a method for getting a single system hierarchy item.
  • Added new user-defined properties to relevant resource classes.
  • Deprecated a couple of obsolete properties.
  • Various fixes and non-breaking changes.


10.0.3

Initial public release for Synthesis API 10.

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.