ReliaSoft API Reference
The Synthesis Platform’s Application Programming Interface (API) enables you to programmatically read and write data to Synthesis repositories, as well as analyze and plot data sets from external sources. It is provided for Visual Basic for Applications (VBA) and .NET applications, allowing you to create automated solutions using popular Microsoft Office applications, such as Excel and PowerPoint, or create custom applications for your organization.
Implementing the Synthesis API allows you to connect data in Synthesis repositories with the systems and tools used within your organization. It provides the functionality to:
- Transfer and synchronize data via XML
- Use XML files to manage structured data (such as system hierarchies/BOMs, incidents and work orders) between ReliaSoft’s XFRACAS and a variety of different PLMs, ERPs, CMMS and other external systems. You can also use XML files to create reliability block diagrams (RBDs) in BlockSim.
- Read/write specific data elements
- Read or write data to Synthesis resources (models, actions, URDs, etc.), system hierarchy items and FMEA records (causes, effects, failures, etc.). Initiate batch data processing and create custom solutions for importing/exporting data from Synthesis repositories, as well as load data into the Synthesis Data Warehouse (SDW).
- Obtain calculated results
- Read data from published Synthesis models and obtain calculated results such as reliability, probability of failure, BX% life, failure rate and mean time.
- Analyze data
- Use Weibull++'s or ALTA’s analysis and plotting engines to analyze data from third-party sources, and incorporate the functionality into your own custom applications. (Requires a Synthesis API license.)
- Getting the latest version
- The Synthesis API consists of a library file that contains the classes, methods and events that provide access to Synthesis applications. The file is located in the folder where the Synthesis application is installed. By default, this folder is at "C:\Program Files\ReliaSoft\Synthesis 11." For VBA, you will use the SynthesisAPI.tlb file; for .NET applications, you will use the SynthesisAPI.dll file.
- To obtain the latest version of the library file and the Synthesis application, choose File > Help > Check for Updates or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.
- Build environment
- For Visual Studio projects using Version 10 or 11 of the Synthesis Platform, at minimum you will need Visual Studio 2010 and the .NET Framework 4.0 runtime. Version 2018 and later require Visual Studio 2015 and the .NET Framework 4.6.1 developer pack and runtime.
- 32- vs. 64-bit
- For VBA, the bit version of the Synthesis Platform that you've installed must match your installed version of Microsoft Office. If they do not match, you may see an error related to ActiveX controls. (See ReliaSoft KB article RS20024.)
- For Visual Studio projects targeting the .NET Framework 4.5 (or later) and compiled to run an any platform (Any CPU), turn off the Prefer 32-bit property of the build configuration if you want instances of your application to run as a 64-bit process; otherwise, the application will run as a 32-bit process on both 32- and 64-bit versions of Windows. Note that when using locally hosted licensing, it is necessary to ensure your application bitness matches the bitness of the Synthesis Platform installed wherever your application is run due to dependencies on platform-specific libraries.
- Running API applications on a server
- If you plan to run the API on a Windows server, you must use locally hosted licensing and you’ll need to install the ReliaSoft API Ante Service to scale the implementation (the service is not required when running the API on a Windows desktop environment). For instructions on how to install and configure the service, see http://www.synthesisplatform.net/reliasoft_api_ante_service.htm.
- Access to calculations functionality
- Access to Weibull++'s and ALTA’s analysis and plotting engines require a Synthesis API license. To obtain a license, please contact ReliaSoft.
Referencing the Synthesis API Library File
To use the Synthesis API in your code, you must reference the Synthesis API library in your VBA or .NET projects. The file is located in the folder where the Synthesis application is installed. By default, this folder is at "C:\Program Files\ReliaSoft\Synthesis 11." For VBA, you will use the SynthesisAPI.tlb file; for .NET applications, you will use the SynthesisAPI.dll file.
To reference the library in VBA:
- Enter the VBA environment by clicking the Visual Basic command on the Developer tab (If the Developer tab is not visible, see this Microsoft article).
- In the VBA environment, choose Tools > References.
- Click Browse and find the SynthesisAPI.tlb file on your computer. Click OK.
To reference the library in Visual Studio:
- In the Solution Explorer, right-click the References node and choose Add References.
- In the Reference Manager window, click the Browse tab and find the SynthesisAPI.dll file on your computer. Click OK.
- Copy the following files from the Synthesis installation folder to your target folder (e.g., bin/Debug or bin/Release Folder).
Sample applications that you can test and tweak yourself are included with the Synthesis Platform installation. The files are stored on your computer at C:\Users\Public\Public Documents\ReliaSoft\Examples11\API. (For Version 10, see C:\Users\Public\Public Documents\ReliaSoft\Examples10\API.)
The sample applications are available for Excel VBA and VB.NET projects. (To run the Excel examples, macros must be enabled. See this Microsoft article.)
Tutorials are available to help you learn the core objects of the Synthesis API and start coding right away. The tutorials include code samples for both VBA and VB.NET.
Below is a summary of the core objects in the Synthesis API library. For an alphabetical listing of all objects in the latest version, see API Reference Documentation. (Click here for the list of objects in Version 10.)
Repositoryobject represents the Synthesis repository. All other objects use the functions in this class to read or write data to the repository. This class also contains the functions for importing/exporting XML files.
- The following objects represent the Synthesis resources. Instances of each class can be used to store data for an existing or new resource.
- The following objects build data sets for the Synthesis Data Warehouse (SDW).
XfmeaItemobject represents a system hierarchy item. Instances of this class can be used to store data for a system or assembly, as well as build a multi-level system configuration.
- The following objects represent the FMEA records. Instances of each class can be used to store data for an existing or new FMEA analysis.
WeibullDataSetobject represents a Weibull++ data sheet for life data analysis. Instances of this class are used to define a data set and fit a statistical distribution to the data.
ALTADataSetobject represents an ALTA data sheet for accelerated life testing data analysis. Instances of this class are used to define a data set, and fit a distribution and life-stress relationship to the data.
WAPlotsobject represents a plot based on a
ALTADataSetobject. Instances of this class are used to display a plot of the analysis results.