ReliaSoft API Reference

The ReliaSoft Synthesis API enables you to programmatically read and write data in Synthesis desktop applications. The API has been developed 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.

Requirements
Before using the Synthesis API, note the following requirements:


 * You must reference the required Synthesis API library in your .NET project or VBA file (show me how). The library is located in the folder where the Synthesis applications are 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 developers, use the SynthesisAPI.tlb library
 * For .NET developers, use the SynthesisAPI.dll 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. (See ReliaSoft KB article RS20024.)

Examples
Sample applications that you can test and tweak yourself are shipped by default with every Synthesis desktop application. They are available for Excel, PowerPoint and Visual Basic projects. 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.)

To run the Excel and PowerPoint examples, macros must be enabled. (To learn how, see this Microsoft article.)

You must also recompile the example before first use. In Excel or PowerPoint, choose Developer > Visual Basic. In the Microsoft Visual Basic for Applications window, choose Debug > Compile VBAProject.

API Reference Documentation
This documentation is organized by object type. For an alphabetical listing of all classes and enumerations, see Full Synthesis API.


 * The Repository object represents a connection to a Synthesis repository. You will need to establish a connection to a Synthesis repository before you can read and/or write data to it. Once you have a connection, you can use the methods in the Repository class to update Synthesis resources, import or export data from XML files, or transfer data to the Synthesis Data Warehouse (SDW).


 * The following objects represent a type of Synthesis resource.
 * cModel
 * cAction
 * cURD
 * cVariable
 * cCrew
 * cPool
 * cCorrectiveTask
 * cScheduledTask
 * cXfmeaControl

To specify the displayed language for the Synthesis API library, use the SynthesisAPI.SetLanguage common class method.

<!-- 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 .NET, VB6 and VBA 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: Allows you to connect to a standard or enterprise Synthesis repository to access/edit repository-level information. This includes accessing/adding/modifying resources, exporting/importing BlockSim and XFRACAS XML files and exporting data to the Synthesis Data Warehouse (SDW).
 * Weibull++ Data Sets:
 * ALTA Data Sets:
 * Weibull++/ALTA Plots:
 * Resources:
 * Displayed Language:

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 &gt; 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
 * Life Data Analysis in Excel (243 KB) (Code explanation)
 * Accelerated Life Testing Analysis (ALTA) in Excel (224 KB) (Code explanation)
 * Transfer data from Excel to the Synthesis Reliability Data Warehouse (RDW)
 * Excel to Standard Repository (2.64 MB)
 * Excel to Enterprise SQL Repository (2.64 MB) Requires code modification to reference a SQL repository.
 * Use Excel to update Universal Reliability Definitions (URDs) used in BlockSim, etc.
 * Update URDs with Excel (108 KB)