ReliaSoft API Reference: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) No edit summary |
Alex Ulanov (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Template:API|Version 9}} | {{Template:API|Version 9}} | ||
The Synthesis API can be used to accomplish many of the same tasks as within Synthesis applications, and it also enables seamless integration of the Synthesis Platform with other systems within your | The Synthesis API can be used to accomplish many of the same tasks as within Synthesis applications, and it also enables seamless integration of the Synthesis Platform with other systems within your organization—all through a programmer's own custom-developed code. This allows you to create customizable and automated solutions to reliability engineering problems by integrating Synthesis functionality into other applications. | ||
This reference describes all of the programming elements in the API. The sample code and documentation have been prepared for the Visual Basic and .NET development environments, and it is assumed that the reader is familiar with them. | This reference describes all of the programming elements in the API. The sample code and documentation have been prepared for the Visual Basic and .NET development environments, and it is assumed that the reader is familiar with them. | ||
== Requirements == | == Requirements == | ||
Before using the Synthesis API, note the following requirements: | Before using the Synthesis API, note the following requirements: | ||
*Your code must include a reference to the ReliaSoft Synthesis API Library. The library is located in the folder where ReliaSoft Synthesis is installed. By default, this folder is "C:\Program Files\ReliaSoft\Synthesis 9. | *Your code must include a reference to the ReliaSoft Synthesis API Library. The library is located in the folder where ReliaSoft Synthesis is installed. By default, this folder is "C:\Program Files\ReliaSoft\Synthesis 10" (for version 9 users it is "C:\Program Files\ReliaSoft\Synthesis 9"). | ||
** .NET developers – use the SynthesisAPI.dll library | **.NET developers – use the SynthesisAPI.dll library | ||
** VB6 / VBA developers – use the SynthesisAPI.tlb library | **VB6 / VBA developers – use the SynthesisAPI.tlb library | ||
*The version of the Synthesis Platform that you've installed (32- vs. 64-bit) must match your installed version of Microsoft Office. If they do not match, you may see an [http://www.reliasoft.com/support/rs20024.htm error] related to ActiveX controls. | *The version of the Synthesis Platform that you've installed (32- vs. 64-bit) must match your installed version of Microsoft Office. If they do not match, you may see an [http://www.reliasoft.com/support/rs20024.htm error] related to ActiveX controls. | ||
== API Elements == | == API Elements == | ||
The Synthesis API includes a rich set of programming elements that allow you to work with any of the following components of the Synthesis Platform: | The Synthesis API includes a rich set of programming elements that allow you to work with any of the following components of the Synthesis Platform: | ||
*'''[[Repository Class|Repositories]]''': {{Template:Repository Class.Cmt}} | *'''[[Repository Class|Repositories]]''': {{Template:Repository Class.Cmt}} | ||
*'''[[WeibullDataSet Class|Weibull++ Standard Folio]]''': {{Template:WeibullDataSet Class.Cmt}} | *'''[[WeibullDataSet Class|Weibull++ Standard Folio]]''': {{Template:WeibullDataSet Class.Cmt}} | ||
*'''[[ALTADataSet Class|ALTA Standard Folio]]''': {{Template:ALTADataSet Class.Cmt}} | *'''[[ALTADataSet Class|ALTA Standard Folio]]''': {{Template:ALTADataSet Class.Cmt}} | ||
*'''[[WAPlots Class|Plots in Weibull++/ALTA]]''': {{Template:WAPlots Class.Cmt}} | *'''[[WAPlots Class|Plots in Weibull++/ALTA]]''': {{Template:WAPlots Class.Cmt}} | ||
*'''[[Resource Classes|Resources]]''': {{Template:Resource Classes.Cmt}} | *'''[[Resource Classes|Resources]]''': {{Template:Resource Classes.Cmt}} | ||
*'''[[Common Class|Displayed Language]]''': {{Template:Common Class.Cmt}} | *'''[[Common Class|Displayed Language]]''': {{Template:Common Class.Cmt}} | ||
A complete list of all the classes and enumerations in the Synthesis API is available [[Full Synthesis API|here]]. | A complete list of all the classes and enumerations in the Synthesis API is available [[Full Synthesis API|here]]. | ||
== Application Examples == | == Application Examples == | ||
'''Excel VBA Samples''' | '''Excel VBA Samples''' | ||
Use the following links to download macro-enabled Excel files (*.xlsm) that utilize the Synthesis API. Note that to run/view the underlying code, the [http://msdn.microsoft.com/en-us/library/bb608625.aspx Developer tab must be enabled] in Excel so you can enter the Visual Basic for Applications (VBA) environment by choosing '''Developer | Use the following links to download macro-enabled Excel files (*.xlsm) that utilize the Synthesis API. Note that to run/view the underlying code, the [http://msdn.microsoft.com/en-us/library/bb608625.aspx Developer tab must be enabled] in Excel so you can enter the Visual Basic for Applications (VBA) environment by choosing '''Developer > View Code'''. Also, you must have [http://office.microsoft.com/en-us/excel-help/enable-or-disable-macros-in-office-documents-HA010031071.aspx macros enabled] to run the example files. If Excel displays a warning regarding macros in these files, select to enable them. | ||
*Use Synthesis analysis engines in Excel | |||
** [http://www.reliasoft.com/synthesis/api/examples/WeibullExample.xlsm Life Data Analysis in Excel (237 KB)] ([[Life Data Analysis in Microsoft Excel - Explanation|Code explanation]]) | *Use Synthesis analysis engines in Excel | ||
** [http://www.reliasoft.com/synthesis/api/examples/ALTAExample.xlsm Accelerated Life Testing Analysis (ALTA) in Excel (221 KB)] ([[Accelerated Life Testing Analysis in Microsoft Excel - Explanation|Code explanation]]) | **[http://www.reliasoft.com/synthesis/api/examples/WeibullExample.xlsm Life Data Analysis in Excel (237 KB)] ([[Life Data Analysis in Microsoft Excel - Explanation|Code explanation]]) | ||
* Transfer data from Excel to the Synthesis Reliability Data Warehouse (RDW) | **[http://www.reliasoft.com/synthesis/api/examples/ALTAExample.xlsm Accelerated Life Testing Analysis (ALTA) in Excel (221 KB)] ([[Accelerated Life Testing Analysis in Microsoft Excel - Explanation|Code explanation]]) | ||
** [http://www.reliasoft.com/synthesis/api/examples/RDW_Example_Standard_V10.xlsm Excel to Standard Repository (2.64 MB)] | *Transfer data from Excel to the Synthesis Reliability Data Warehouse (RDW) | ||
** [http://www.reliasoft.com/synthesis/api/examples/RDW_Example_Enterprise.xlsm Excel to Enterprise SQL Repository (2.65 MB)] ''Requires code modification to reference a SQL repository.'' | **[http://www.reliasoft.com/synthesis/api/examples/RDW_Example_Standard_V10.xlsm Excel to Standard Repository (2.64 MB)] | ||
* Use Excel to update Universal Reliability Definitions (URDs) used in BlockSim, etc. | **[http://www.reliasoft.com/synthesis/api/examples/RDW_Example_Enterprise.xlsm Excel to Enterprise SQL Repository (2.65 MB)] ''Requires code modification to reference a SQL repository.'' | ||
** [http://www.reliasoft.com/synthesis/api/examples/URDExample_V10.xlsm Update URDs with Excel (108 KB)] | *Use Excel to update Universal Reliability Definitions (URDs) used in BlockSim, etc. | ||
**[http://www.reliasoft.com/synthesis/api/examples/URDExample_V10.xlsm Update URDs with Excel (108 KB)] | |||
Revision as of 17:29, 28 April 2015
 |
The Synthesis API can be used to accomplish many of the same tasks as within Synthesis applications, and it also enables seamless integration of the Synthesis Platform with other systems within your organization—all through a programmer's own custom-developed code. This allows you to create customizable and automated solutions to reliability engineering problems by integrating Synthesis functionality into other applications.
This reference describes all of the programming elements in the API. The sample code and documentation have been prepared for the Visual Basic and .NET development environments, and it is assumed that the reader is familiar with them.
Requirements
Before using the Synthesis API, note the following requirements:
- Your code must include a reference to the ReliaSoft Synthesis API Library. The library is located in the folder where ReliaSoft Synthesis is installed. By default, this folder is "C:\Program Files\ReliaSoft\Synthesis 10" (for version 9 users it is "C:\Program Files\ReliaSoft\Synthesis 9").
- .NET developers – use the SynthesisAPI.dll library
- VB6 / VBA developers – use the SynthesisAPI.tlb library
- The version of the Synthesis Platform that you've installed (32- vs. 64-bit) must match your installed version of Microsoft Office. If they do not match, you may see an error related to ActiveX controls.
API Elements
The Synthesis API includes a rich set of programming elements that allow you to work with any of the following components of the Synthesis Platform:
- Repositories: Template:Repository Class.Cmt
- Weibull++ Standard Folio: Provides the functionality of a Weibull++ standard folio, including entering data in a data set, specifying analysis settings and fitting a distribution to the data set.
- ALTA Standard Folio: Provides the functionality of an ALTA standard folio, including entering data in a data set, specifying analysis settings and fitting a distribution and life-stress relationship to the data set.
- Plots in Weibull++/ALTA: Creates a plot based on a fitted model in a WeibullDataSet or ALTADataSet object.
- Resources: Use these classes to create resources, edit their properties and calculate reliability metrics from fitted models.
- Displayed Language: Sets the language of the entire library.
A complete list of all the classes and enumerations in the Synthesis API is available here.
Application Examples
Excel VBA Samples
Use the following links to download macro-enabled Excel files (*.xlsm) that utilize the Synthesis API. Note that to run/view the underlying code, the Developer tab must be enabled in Excel so you can enter the Visual Basic for Applications (VBA) environment by choosing Developer > View Code. Also, you must have macros enabled to run the example files. If Excel displays a warning regarding macros in these files, select to enable them.
- Use Synthesis analysis engines in Excel
- Transfer data from Excel to the Synthesis Reliability Data Warehouse (RDW)
- Excel to Standard Repository (2.64 MB)
- Excel to Enterprise SQL Repository (2.65 MB) Requires code modification to reference a SQL repository.
- Use Excel to update Universal Reliability Definitions (URDs) used in BlockSim, etc.