API Tutorials: Difference between revisions

Latest revision as of 23:29, 2 August 2017

<< Back to API Main Page

Below are simple tutorials to help you get started with using the Synthesis API. The tutorials assume some basic working knowledge in VBA or .NET programming, and general familiarity with Synthesis applications.

Referencing the Synthesis API Library File

To use the ReliaSoft API in your code, you must reference the ReliaSoft API library in your VBA or .NET projects. The file is located in the folder where the ReliaSoft desktop applications are installed. By default for Version 2023, this folder is at "C:\Program Files\ReliaSoft\ReliaSoft 2023." For VBA, you will use the ReliaSoftAPI23.tlb file; for .NET applications, you will use the ReliaSoftAPI23.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 ReliaSoftAPI23.tlb file on your computer. Click OK.

To reference the library in Visual Studio:

In the Solution Explorer, right-click the References node of your project and choose Add References.
In the Reference Manager window, click the Browse tab and find the ReliaSoftAPI23.dll file on your computer. Click OK.
Edit your project file, either directly using any text editor, or by right-clicking your project and choosing Unload Project, then right-clicking your project again and choosing Edit Project File
Insert the following line just before the last </Project> clause (change the path if necessary):

This will ensure the required files are copied into your project’s destination folder during the build.

Save the project file. If you unloaded the project in step 3, right-click the project and choose Reload Project.

Tutorials

Before you begin, be sure to review the prerequisites presented in the overview page. The tutorials are designed to work with the latest version of the Synthesis applications.

Basics

Importing Data

Transfer Data to the Synthesis Data Warehouse (SDW)

Performing Analyses and Creating Plots (requires a Synthesis API license)

Perform Life Data Analysis
Perform Accelerated Life Testing Data Analysis
Perform Accelerated Life Testing Data Analysis with Stress Profiles (Click here for Version 10 of this tutorial.)
Create Plots

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:Synthesis API Quick Start Guide}}{{Template:InProgress}}{{Template:API}}
+{{Template:API}}
+{{Template:BacktoPrevPage|[[Synthesis API Reference|<< Back to API Main Page]]}}
-This Quick Start Guide presents a series of simple tutorials to help you get started using the Synthesis API.
+Below are simple tutorials to help you get started with using the Synthesis API. The tutorials assume some basic working knowledge in VBA or .NET programming, and general familiarity with Synthesis applications.
-Before you begin, note the following prerequisites:
-* '''The Quick Start Guide is written for the latest version of the Synthesis Platform'''. We recommend installing or updating your Synthesis application to the latest version before working with the guide. You can check for the latest version in the software by choosing '''File > Help > Check for Updates''' or download the latest version at [http://www.reliasoft.com/synthesis/downloads.htm 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 [http://www.reliasoft.com/support/rs20024.htm ReliaSoft KB article RS20024].)
-*'''You must 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 SynthesisAPI.tlb. For .NET applications, use SynthesisAPI.dll.
-::For help with referencing the library, see this simple [[Referencing_an_Object_Library|How-To Guide]].
-*'''Create a Synthesis repository for testing purposes'''. We recommend creating a new standard repository and saving it on your local drive when working with the guide. This will allow you to work and experiment with the examples unhindered by folder and database permissions.
-*'''Some basic knowledge is assumed'''. The tutorials assume that you have some basic working knowledge in VBA or VB.NET programming, and that you are generally familiar with the Synthesis Platform environment. The tutorials also make use of database/record IDs to help you understand and test the response of particular API calls. We recommend reading [[Using Database and Record IDs|this topic]] on database IDs before starting the tutorials.
+==Referencing the Synthesis API Library File==
+{{:Synthesis API Reference}}
 ==Tutorials==
+Before you begin, be sure to review the [[Synthesis_API_Reference|prerequisites]] presented in the overview page. The tutorials are designed to work with the latest version of the Synthesis applications.
-<span style="font-size:12pt; color:#00009C; font-weight:bold">[[APISynthesisResourcesTutorial|Synthesis Resources]]</span>
+====Basics====
+*[[Connect or Disconnect from a Synthesis Repository]]
-The [[APISynthesisResourcesTutorial|Synthesis Resources Tutorial]] is a four-part tutorial that introduces you to the basic functionalities of the Synthesis API. In this tutorial, you will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.
+*[[Add New Synthesis Resources to a Repository]]
+*[[Edit Existing Synthesis Resources]]
+*[[Calculate Results from a Model]]
-<span style="font-size:12pt; color:#00009C; font-weight:bold">[[APISDWTutorial|Synthesis Data Warehouse (SDW)]]</span>
-The [[APISDWTutorial|Synthesis Data Warehouse (SDW) Tutorial]] demonstrates how to transfer data from a third-party data source to the SDW of a Synthesis repository. Data in the SDW can then be transferred to a Weibull++ or RGA standard folio for analysis.
+====Importing Data====
+*[[Transfer Data to the Synthesis Data Warehouse (SDW)]]
-''<span style="font-size:12pt; color:#808080;">More tutorials coming soon...</span>''
+====Performing Analyses and Creating Plots <span style="color:#585858">(requires a Synthesis API license)</span>====
+*[[Perform Life Data Analysis on External Data Source|Perform Life Data Analysis]]
+*[[Perform Accelerated Life Testing Data Analysis on External Data Source|Perform Accelerated Life Testing Data Analysis]]
+*[[Perform Accelerated Life Testing Data Analysis with Stress Profiles]] (Click [[Perform Accelerated Life Testing Data Analysis with Stress Profiles 10|here]] for Version 10 of this tutorial.)
+*[[Create Plots]]