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: @@
-{{Template:InProgress}}{{Template:API}}
+{{Template:API}}
-<div style="border:1px solid #AAA; background:#f9f9f9; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em; float:right;">
+{{Template:BacktoPrevPage|[[Synthesis API Reference|<< Back to API Main Page]]}}
-<nowiki><<</nowiki> [[Synthesis API Reference|Back to Main Page]]
-</div>
-Below are simple tutorials to help you get started with using the Synthesis API. Before you begin:
+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.
-*Be sure to complete all requirements described in the Getting Started section of the [[Synthesis API Reference]] page.
-*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 tutorials. This will allow you to work and experiment with the examples unhindered by folder and database permissions.
-*Display the object IDs in Synthesis applications. Each item in a Synthesis repository is identified by a unique record identifier called an ''object ID''. Object IDs can help you trace responses from the API, which is helpful when you're just beginning to learn. We recommend reading [[Using Object IDs|this short topic]] on object IDs before you begin.
-Finally, the tutorials assume some basic working knowledge in VBA or VB.NET programming, and general familiarity with the Synthesis Platform.
+==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.
-===Basics===
+====Basics====
-The following tutorials introduce you to the basic functionalities of the Synthesis API.
+*[[Connect or Disconnect from a Synthesis Repository]]
+*[[Add New Synthesis Resources to a Repository]]
-* [[Connect or Disconnect from a Synthesis Repository]].
+*[[Edit Existing Synthesis Resources]]
+*[[Calculate Results from a Model]]
-* [[Add New Synthesis Resources to a Repository]].
-* [[Edit Existing Synthesis Resources]].
-* [[Calculate Results from a Model]].
-===Application Examples===
-* [[APISDWTutorial|Transfer data from an Excel file to the Synthesis Data Warehouse (SDW)]].
+====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]]