API Tutorials

From ReliaWiki
Revision as of 19:02, 20 October 2015 by Kate Racaza (talk | contribs) (Created page with '{{DISPLAYTITLE:Synthesis API Quick Start Guide}}{{Template:InProgress}}{{Template:API}} This Quick Start Guide presents a series of simple tutorials to help you get started usin…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Template:InProgress

APIWiki.png



This Quick Start Guide presents a series of simple tutorials to help you get started using the Synthesis API.


Before you begin, note the following prerequisites:

  • Install the latest version of the Synthesis Platform on your computer. The version of the Synthesis Platform that you've installed (32- vs. 64-bit) must match your installed version of Microsoft Office. If they do not match, you may see an error related to ActiveX controls. (See ReliaSoft KB article RS20024.)
  • 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 SynthesisAPI.tlb. For .NET applications, use SynthesisAPI.dll.
For help with referencing the library, see this simple How-To Guide.
  • You’ll need a repository for testing purposes. We recommend creating a new standard repository and saving it on your local drive when working with this Quick Start guide. 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 basic working knowledge in VBA or VB.NET programming, and that you are generally familiar with the Synthesis Platform environment.

Tutorials

Synthesis Resources

The Synthesis Resources Tutorial introduces you to the basic functionalities of the Synthesis API. In this tutorial, you will learn how to use the API to create new and update existing resources in a Synthesis repository.


Synthesis Data Warehouse (SDW)

The Synthesis Data Warehouse (SDW) Tutorial demonstrates how to transfer data from a third-party data source to the SDW of a Synthesis repository. Data in the SDW can then be transferred to a Weibull++ or RGA standard folio for analysis.