Difference between revisions of "API Tutorials"

From ReliaWiki
Jump to navigation Jump to search
Line 2: Line 2:
 
{{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 VB.NET programming, and general familiarity with Synthesis applications.  
  
  
==Using Object IDs==
+
==Referencing the Synthesis API Library File==
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 are helpful when learning how to use the API to read/write data to a repository.  
+
To use the Synthesis API in your code, you must reference the Synthesis API library in your VBA or .NET projects. The file is located in the folder where the Synthesis application is installed. By default, this folder is at "C:\Program Files\ReliaSoft\Synthesis 11." For VBA, you will use the '''SynthesisAPI.tlb''' file; for .NET applications, you will use the '''SynthesisAPI.dll''' file.
 +
 +
To obtain the latest version of the library file and the Synthesis application, choose '''File > Help > Check for Updates''' or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.
  
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:
+
'''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]).  
{|border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
+
:#In the VBA environment, choose '''Tools > References'''.
|- style="background:#F2F2F2;"
+
:#Click '''Browse''' and find the SynthesisAPI.tlb file on your computer. Click '''OK'''.  
!<span style="color:#585858;">Item</span>
 
!<span style="color:#585858;">Location of ID in the application</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.
 
|-
 
|BlockSim diagrams and block IDs ||The IDs are displayed on the diagram control panel.
 
|}
 
  
 +
'''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'''.
 +
:#Copy the following files from the Synthesis installation folder to your target folder (e.g., bin/Debug or bin/Release Folder).
 +
:::*licncr.dll
 +
:::*licncr.dll.nsign
 +
:::*licshr.dll
 +
:::*licshr.dll.nsign
 +
:::*libcrypto-1_1.dll
 +
:::*msvcp110.dll
 +
:::*msvcr110.dll
 +
:::*RSDB.dll
 +
:::*RSLM8nCodeDotNetWrapper.dll
 +
:::*utlibr.dll
  
 
==Tutorials==
 
==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 Platform.
+
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====

Revision as of 17:44, 3 April 2017

APIWiki.png


<< 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 Synthesis applications.


Referencing the Synthesis API Library File

To use the Synthesis API in your code, you must reference the Synthesis API library in your VBA or .NET projects. The file is located in the folder where the Synthesis application is installed. By default, this folder is at "C:\Program Files\ReliaSoft\Synthesis 11." For VBA, you will use the SynthesisAPI.tlb file; for .NET applications, you will use the SynthesisAPI.dll file.

To obtain the latest version of the library file and the Synthesis application, choose File > Help > Check for Updates or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.

To reference the library in VBA:

  1. 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).
  2. In the VBA environment, choose Tools > References.
  3. Click Browse and find the SynthesisAPI.tlb file on your computer. Click OK.

To reference the library in Visual Studio:

  1. In the Solution Explorer, right-click the References node and choose Add References.
  2. In the Reference Manager window, click the Browse tab and find the SynthesisAPI.dll file on your computer. Click OK.
  3. Copy the following files from the Synthesis installation folder to your target folder (e.g., bin/Debug or bin/Release Folder).
  • licncr.dll
  • licncr.dll.nsign
  • licshr.dll
  • licshr.dll.nsign
  • libcrypto-1_1.dll
  • msvcp110.dll
  • msvcr110.dll
  • RSDB.dll
  • RSLM8nCodeDotNetWrapper.dll
  • utlibr.dll

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

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


More tutorials coming soon...