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:API}}
-{{Template:BacktoPrevPage|<< [[Synthesis API Reference|Back to API Main Page]]}}
+{{Template:BacktoPrevPage|[[Synthesis API Reference|<< 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 VB.NET programming, and general familiarity with the Synthesis Platform.
+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.
-==Prerequisites==
-Before you begin, note the following requirements:
-*'''Install the latest version of the Synthesis application'''.
+==Referencing the Synthesis API Library File==
-:Choose '''File > Help > Check for Updates''' or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.
+{{:Synthesis API Reference}}
+==Tutorials==
-: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].)
+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.
-*'''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''.
-: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 [https://msdn.microsoft.com/en-us/library/bb608625.aspx this Microsoft article]).
-:# In the VBA environment, choose '''Tools > References'''. (If the References command is unavailable, click the '''Reset''' button on the ribbon and then try again.)
-:# 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'''.
-==Object IDs==
-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 learning how to use the API to read/write data to a repository.
-To display the object ID in a Synthesis application, choose '''File > Application Setup''', then click '''Other''' under the '''Synthesis Settings''' heading in the navigation panel. Select the check box for '''Display Object IDs'''. The object IDs will be displayed for the following items:
-{|border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
-|- style="background:#F2F2F2;"
-!<span style="color:#585858;">Object</span>
-!<span style="color:#585858;">Where to find the ID</span>
-|-
-|Project||The ID is displayed in two locations:
-* The Project Properties window ('''Project > Management > Edit Project Properties''') displays the project's object ID at the caption bar of the window.
-* The Manage Projects window ('''Project > Management > Manage Projects''') displays a column containing the object IDs of each project in the database.
-|-
-|Resource (e.g., models,URDs, etc.)||The Resource Manager ('''Project > Synthesis > Resource Manager''') displays a column containing the object IDs of the resources.
-|-
-|Xfmea, RCM++ or RBI system hierarchy item||To display the object ID (also called ''record ID'') of a system hierarchy item, right-click any of the column headers in the System Hierarchy panel and choose '''Customize Columns'''. Select the '''Record ID''' check box.
-|-
-|FMEA records (e.g., functions, causes, etc.)||To display the object IDs of FMEA functions, causes, effects, controls and actions, right-click any of the column headers in the FMEA analysis and choose '''Customize Columns'''. Select the '''Record ID''' check box.
-|}
-==Tutorials==
 ====Basics====
-If you're new to the Synthesis API, we recommend starting with the basic tutorials in the order given below.
+*[[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]]
-====Applications====
-* [[Calculate Results from a Model]]
-* [[Transfer Data 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]]