API Changelog

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 11".

To get the latest version of the file, choose File > Help > Check for Updates or download the latest software 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 .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.


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

18.0.3

 * Added the following methods to the Repository class:
 * Repository.Project.GetUserAccessibleProjects
 * Repository.Project.GetUserPermissions

18.0.2

 * Increased the length of a scheduled task name up to 2,000 characters to match the desktop applications.

18.0.1
Initial public release for Version 2018 applications.


 * In the  object, the type for the NumberInGroup parameter was changed from Integer to Double to allow fractional failure calculations.
 * In  object, added the ReliabilityPolicyType property.
 * Added the following properties to the WAPlotSettings :
 * ShowDataPoints
 * Show3PWeibullAdjustedItems
 * Show3PWeibullUnadjustedItems
 * Added the following methods to the Repository class:
 * Repository.Xfmea.AssignActionToXfmeaCause
 * Repository.Xfmea.AssignControlToXfmeaCause
 * Repository.Xfmea.GetXfmeaCauseActions
 * Repository.Xfmea.GetXfmeaCauseActionsDictionary
 * Repository.Xfmea.GetXfmeaCauseControls
 * Repository.Xfmea.GetXfmeaCauseControlsDictionary

11.0.1
Initial public release for Version 11 applications.
 * Added new classes and methods for accessing profiles, which is a new type of Synthesis resource introduced in the latest version of the Synthesis desktop applications.
 * Removed the obsolete ALTAStressProfile class and replaced it with the new cProfile class.
 * Removed the obsolete ALTASegment class and replaced it with the new ProfileSegment class.

10.1.4

 * Added ability to assign a URD to a BlockSim block in a Synthesis repository. Includes ability to get an array of BlockSim block names, RBDs, fault trees and properties.
 * Added ability to hide messages when doing batch calculations and customize event procedures for,   and   objects.
 * For locally-hosted licensing, added the Synthesis API Ante Service to improve response times.

10.1.1

 * Added ability to get global and reference resources. An optional  parameter has been added to the following methods. The filter's default value is 0, which returns local resources.
 * Repository.Action.GetAllActions
 * Repository.Control.GetAllXfmeaControls
 * 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
Initial public release for Version 10 applications.

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  method, which returns a cModel object, has been renamed to  ; similarly, the   method has been renamed to , 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.