Difference between revisions of "API Changelog"

From ReliaWiki
Jump to navigation Jump to search
 
(40 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{InProgress}}{{Template:API}}{{Template:APIUpgradesNavBox}}
+
{{Template:API}}{{Template:APIUpgradesNavBox}}
 
   
 
   
The latest version of the Synthesis API is Version 10.  
+
Before you upgrade to the latest version of the ReliaSoft 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 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.
+
'''How to get the latest version of the ReliaSoft API object library file'''
  
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'''
+
The object library file is located in the folder where the ReliaSoft applications are installed. By default, this folder is at "C:\Program Files\ReliaSoft\ReliaSoft 2019".  
  
 +
To get the latest version of the file, choose '''File > Help > Check for Updates''' or download the latest software update from [https://support.hbmprenscia.com HBM Prenscia Support Portal]. 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 ReliaSoftAPI19.tlb file. For .NET applications, use the ReliaSoftAPI19.dll file.
  
==What's New in Synthesis API Version 10==
+
 
Here’s a quick overview of the most significant enhancements and deprecations in the latest version.
+
== 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]].
 +
 
 +
===19.0.1===
 +
*Changed the name of the libraries to ReliaSoftAPI19.tlb and ReliaSoftAPI19.dll. The API's are also now version dependent.
 +
*Added the following to the [[Repository Class|Repository]] class:
 +
:*[[Repository.Action.GetFMEAActionLocatorLinkPath|Repository.Action.GetFMEAActionLocatorLinkPath]]
 +
*Added the following methods and properties to [[CCorrectiveTask Class|cCorrectiveTask]] class:
 +
:*[[CCorrectiveTask.GetPools_Method|GetPools]]
 +
:*[[CCorrectiveTask.SetPools_Method|SetPools]]
 +
:*[[CCorrectiveTask.GetTeams_Method|GetTeams]]
 +
:*[[CCorrectiveTask.GetTeams_Method|SetTeams]]
 +
:*Pools
 +
:*Teams
 +
*Removed the following methods and property from the [[CCorrectiveTask Class|cCorrectiveTask]] class:
 +
:*SetCrewIDs
 +
:*GetCrewIDs
 +
:*CrewIDs
 +
*Added the following methods and properties to the [[CScheduledTask Class|cScheduledTask]] class:
 +
:*[[CScheduledTask.OnCondGetTeams_Method|OnCondGetTeams]]
 +
:*[[CScheduledTask.OnCondSetTeams_Method|OnCondSetTeams]]
 +
:*[[CScheduledTask.GetPools_Method|GetPools]]
 +
:*[[CScheduledTask.SetPools_Method|SetPools]]
 +
:*[[CScheduledTask.GetTeams_Method|GetTeams]]
 +
:*[[CScheduledTask.GetTeams_Method|SetTeams]]
 +
:*OnCondTeams
 +
:*Pools
 +
:*Teams
 +
*Removed the following methods and property from the [[CScheduledTask Class|cScheduledTask]] class:
 +
:*SetCrewIDs
 +
:*GetCrewIDs
 +
:*CrewIDs
 +
:*OnCondCrewIDs
 +
*Added the [[PoolInfo|PoolInfo]] structure to be used with the [[CScheduledTask.GetPools_Method|GetPools]] and [[CScheduledTask.SetPools_Method|SetPools]] methods, as well as the Pools property.
 +
*Added the [[TeamInfo Class|TeamInfo]] class which contains the following methods and property:
 +
:*[[TeamInfo.GetCrewIDs_Method|GetCrewIDs]]
 +
:*[[TeamInfo.SetCrewIDs_Method|SetCrewIDs]]
 +
:*CrewIDs
 +
*Added the following properties to the [[XfmeaEffect Class|XFMEAEffect]] class:
 +
:*SubSev1Init
 +
:*SubSev1Rev
 +
:*SubSev2Init
 +
:*SubSev2Rev
 +
:*SubSev3Init
 +
:*SubSev3Rev
 +
:*SubSev4Init
 +
:*SubSev4Rev
 +
:*SubSev5Init
 +
:*SubSev5Rev
 +
:*SubSev6Init
 +
:*SubSev6Rev
 +
:*SubSev7Init
 +
:*SubSev7Rev
 +
:*SubSev8Init
 +
:*SubSev8Rev
 +
*Added the following property to the [[XfmeaItem Class|XFMEAItem]] class:
 +
:*Qty
 +
 
 +
===18.0.3===
 +
*Added the following methods to the [[Repository Class|Repository]] class:
 +
:*[[Repository.Project.GetUserAccessibleProjects|Repository.Project.GetUserAccessibleProjects]]
 +
:*[[Repository.Project.GetUserPermissions|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 <code>'''[[WeibullDataSet Class|WeibullDataSet]]'''</code> object, the type for the NumberInGroup parameter was changed from Integer to Double to allow fractional failure calculations.
 +
*In <code>'''[[XfmeaItem Class|XfmeaItem]]'''</code> object, added the ReliabilityPolicyType property.
 +
*Added the following properties to the [[WAPlotSettings Class|WAPlotSettings ]]:
 +
**ShowDataPoints
 +
**Show3PWeibullAdjustedItems
 +
**Show3PWeibullUnadjustedItems
 +
*Added the following methods to the Repository class:
 +
:*[[Repository.Xfmea.AssignActionToXfmeaCause Method|Repository.Xfmea.AssignActionToXfmeaCause]]
 +
:*[[Repository.Xfmea.AssignControlToXfmeaCause Method|Repository.Xfmea.AssignControlToXfmeaCause]]
 +
:*[[Repository.Xfmea.GetXfmeaCauseActions Method|Repository.Xfmea.GetXfmeaCauseActions]]
 +
:*[[Repository.Xfmea.GetXfmeaCauseActionsDictionary Method|Repository.Xfmea.GetXfmeaCauseActionsDictionary]]
 +
:*[[Repository.Xfmea.GetXfmeaCauseControls Method|Repository.Xfmea.GetXfmeaCauseControls]]
 +
:*[[Repository.Xfmea.GetXfmeaCauseControlsDictionary Method |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|ALTAStressProfile]] class and replaced it with the new [[CProfile Class|cProfile]] class.
 +
*Removed the obsolete [[ALTASegment Class|ALTASegment]] class and replaced it with the new [[ProfileSegment Class|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 <code>Repository</code>, <code>WeibullDataSet</code> and <code>ALTADataSet</code> objects.
 +
*For locally-hosted licensing, added the [http://www.synthesisplatform.net/synthesis_api_ante_service.htm Synthesis API Ante Service] to improve response times.
 +
 
 +
===10.1.1===
 +
*Added ability to get global and reference resources. An optional <code>Filter</code> 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'''
 
'''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, 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]].
 

Latest revision as of 17:54, 14 March 2019

APIWiki.png


<< Back to API Main Page

API Changelog

API Reference Documentation

Before you upgrade to the latest version of the ReliaSoft 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 ReliaSoft API object library file

The object library file is located in the folder where the ReliaSoft applications are installed. By default, this folder is at "C:\Program Files\ReliaSoft\ReliaSoft 2019".

To get the latest version of the file, choose File > Help > Check for Updates or download the latest software update from HBM Prenscia Support Portal. 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 ReliaSoftAPI19.tlb file. For .NET applications, use the ReliaSoftAPI19.dll file.


Highlights

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

19.0.1

  • Changed the name of the libraries to ReliaSoftAPI19.tlb and ReliaSoftAPI19.dll. The API's are also now version dependent.
  • Added the following to the Repository class:
  • SetCrewIDs
  • GetCrewIDs
  • CrewIDs
  • Added the following methods and properties to the cScheduledTask class:
  • Removed the following methods and property from the cScheduledTask class:
  • SetCrewIDs
  • GetCrewIDs
  • CrewIDs
  • OnCondCrewIDs
  • Added the PoolInfo structure to be used with the GetPools and SetPools methods, as well as the Pools property.
  • Added the TeamInfo class which contains the following methods and property:
  • Added the following properties to the XFMEAEffect class:
  • SubSev1Init
  • SubSev1Rev
  • SubSev2Init
  • SubSev2Rev
  • SubSev3Init
  • SubSev3Rev
  • SubSev4Init
  • SubSev4Rev
  • SubSev5Init
  • SubSev5Rev
  • SubSev6Init
  • SubSev6Rev
  • SubSev7Init
  • SubSev7Rev
  • SubSev8Init
  • SubSev8Rev
  • Added the following property to the XFMEAItem class:
  • Qty

18.0.3

  • Added the following methods to the Repository class:

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 WeibullDataSet object, the type for the NumberInGroup parameter was changed from Integer to Double to allow fractional failure calculations.
  • In XfmeaItem object, added the ReliabilityPolicyType property.
  • Added the following properties to the WAPlotSettings :
    • ShowDataPoints
    • Show3PWeibullAdjustedItems
    • Show3PWeibullUnadjustedItems
  • Added the following methods to the Repository class:

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 Repository, WeibullDataSet and ALTADataSet 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 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 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 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.