Difference between revisions of "API Tutorials"

From ReliaWiki
Jump to navigation Jump to search
Line 41: Line 41:
 
====Importing Data====
 
====Importing Data====
 
*[[Transfer Data to the Synthesis Data Warehouse (SDW)]]
 
*[[Transfer Data to the Synthesis Data Warehouse (SDW)]]
*[[Upload XML File to XFRACAS]]
 
  
 
====Performing Analyses and Creating Plots <span style="color:#585858">(requires a Synthesis API license)</span>====
 
====Performing Analyses and Creating Plots <span style="color:#585858">(requires a Synthesis API license)</span>====

Revision as of 22:12, 12 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)