ReliaSoft API Reference

• API Changelog
• Documentation

The Synthesis Platform’s Application Programming Interface (API) enables you to programmatically connect your Synthesis applications and data with other systems and tools used within your organization. The API is written for Visual Basic for Applications (VBA) and Visual Basic.NET. This gives you the ability to create automated solutions using popular Microsoft Office applications, such as Excel and PowerPoint, as well as create custom applications for your organization.

Transfer and synchronize data via XML

For structured data (such as system hierarchies/BOMs, incidents and work orders) you can use XML files and the API to manage data transfer and synchronization between XFRACAS and variety of different PLMs, ERPs, CMMS and other external systems. You can also use XML files to create reliability block diagrams (RBDs) in BlockSim.

Input/output specific data elements and analyses

With the Synthesis API, you can read from or write data to Synthesis resources (models, actions, URDs, etc.), system hierarchy items and FMEA records (causes, effects, failures, etc.). You can 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

You can use the Synthesis API to read data from published Synthesis models and obtain calculated results such as the reliability, probability of failure, BX% life, failure rate and mean time.

Getting Started

Examples

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. See API Tutorials.

In addition, 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\Examples10\API. (For Version 9, see C:\Users\Public\Public Documents\ReliaSoft\Examples\API.) The sample applications are available for Excel VBA and VB.NET projects. (To run the Excel examples, macros must be enabled. To learn how, see this Microsoft article.)

Prerequisites

• Install the latest version of the Synthesis application. Choose File > Help > Check for Updates or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.

Note that for VBA, the bit version (32- vs. 64-bit) 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.)

• Reference the Synthesis API object library. The object library is located in the folder where the Synthesis application is installed. By default, this folder is at "C:\Program Files\ReliaSoft\Synthesis 10". (For Version 9, it is "C:\Program Files\ReliaSoft\Synthesis 9".)

For VBA applications, use the SynthesisAPI.tlb library file. For VB.NET applications, use SynthesisAPI.dll.

For help with referencing the library, see this simple How-To Guide.

Object Library

Below are the core objects in the Synthesis API library. For an alphabetical listing of all classes and enumerations in the object library, see Full Synthesis API.

• The Repository object 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. Note that the cModel class provides the methods for obtaining calculated results from a model, such as reliability, probability of failure, etc.
  • cAction
  • cCorrectiveTask
  • cScheduledTask
  • cCrew
  • cModel
  • cPool
  • cURD
  • cVariable
  • cXfmeaControl

• The following objects build data collections for the SDW: RawData represents a single data point, while RawDataSet serves as the data container for the RawData objects.

• The XfmeaItem object 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.
  • XfmeaFunction
  • XfmeaCause
  • XfmeaEffect
  • XfmeaFailure