API Changelog

From ReliaWiki
Revision as of 20:31, 17 September 2015 by Kate Racaza (talk | contribs)
Jump to navigation Jump to search
DRAFT GRAY.png

WORK IN PROGRESS
API Changelog

DRAFT GRAY.png
APIWiki.png


<< Back to API Main Page

API Changelog

API Reference Documentation

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.

When you're ready to upgrade, first install any Version 10 Synthesis application 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


What's New in Synthesis API Version 10

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

Improved flexibility

  • We've 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.

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.
  • 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.

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, see New Classes and Enumerations.

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

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