API Tutorials: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:InProgress}}{{Template:API}}
{{Template:InProgress}}{{Template:API}}


This Quick Start Guide presents a series of simple tutorials to help you get started with using the Synthesis API.  
Below are simple tutorials to help you get started with using the Synthesis API. Before you begin:
*Be sure to complete all requirements described in the Getting Started section of the [[Synthesis API Reference]] page.


Before you begin, we recommend installing or updating your Synthesis application to the latest version. You can check for the latest version in the software by choosing '''File > Help > Check for Updates''' or downloading 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].)
*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.


In addition, 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.  
*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.


===Prerequisites===
Finally, the tutorials assume some basic working knowledge in VBA or VB.NET programming, and general familiarity with the Synthesis Platform.  
*To begin, 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 the '''SynthesisAPI.tlb''' library file. For VB.NET applications, use '''SynthesisAPI.dll'''. For help with referencing the library, see this simple [[Referencing_an_Object_Library|How-To Guide]].
==Tutorials==


*If you are coding in VB.NET, add an Imports statement for <code>SynthesisAPI</code>. This is assumed in all VB.NET code samples.
===Basics===
The following tutorials introduce you to the basic functionalities of the Synthesis API.


*You will need 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.
* Connect to and disconnect from a Synthesis repository.


* Add new Synthesis resources to a repository.


==Tutorials==
* Edit existing Synthesis resources in a repository.


<span style="font-size:12pt; color:#00009C; font-weight:bold">[[APISynthesisResourcesTutorial|Synthesis Resources]]</span>
* Calculate results from a model.


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. 
===Application Examples===


* Transfer data from an Excel file to the Synthesis Data Warehouse (SDW).


<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 an Excel file to the SDW of a Synthesis repository. Data in the SDW can then be transferred to a Weibull++ or RGA standard folio for analysis.






''<span style="font-size:12pt; color:#808080;">More tutorials coming soon...</span>''
''<span style="font-size:12pt; color:#808080;">More tutorials coming soon...</span>''

Revision as of 21:39, 9 February 2016

Template:InProgress

APIWiki.png



Below are simple tutorials to help you get started with using the Synthesis API. Before you begin:

  • 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 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.

Tutorials

Basics

The following tutorials introduce you to the basic functionalities of the Synthesis API.

  • Connect to and disconnect from a Synthesis repository.
  • Add new Synthesis resources to a repository.
  • Edit existing Synthesis resources in a repository.
  • Calculate results from a model.

Application Examples

  • Transfer data from an Excel file to the Synthesis Data Warehouse (SDW).



More tutorials coming soon...

Retrieved from "https://www.reliawiki.com/index.php?title=API_Tutorials&oldid=62892"