API Tutorials: Difference between revisions
Jump to navigation
Jump to search
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…') |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 6: | Line 6: | ||
Before you begin, note the following prerequisites: | Before you begin, note the following prerequisites: | ||
*''' | * '''The Quick Start Guide is written for the latest version of the Synthesis Platform'''. We recommend installing or updating your Synthesis application to the latest version before working with the guide. You can check for the latest version at [http://www.reliasoft.com/synthesis/downloads.htm http://www.ReliaSoft.com/synthesis/downloads.htm]. | ||
::Note that 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].) | |||
: | *'''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 | ::For VBA applications, use SynthesisAPI.tlb. For .NET applications, use SynthesisAPI.dll. | ||
::For help with referencing the library, see this simple [[Referencing_an_Object_Library|How-To Guide]]. | |||
*'''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 guide. This will allow you to work and experiment with the examples unhindered by folder and database permissions. | |||
*'''Some basic knowledge is assumed'''. 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. The tutorials also make use of database/record IDs to help you understand and test the response of particular API calls. We recommend reading [[Using Database and Record IDs|this topic]] on database IDs before starting the tutorials. | |||
==Tutorials== | ==Tutorials== | ||
<span style="font-size:12pt; | <span style="font-size:12pt; color:#00009C; font-weight:bold">[[APISynthesisResourcesTutorial|Synthesis Resources]]</span> | ||
The [[APISynthesisResourcesTutorial|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. | The [[APISynthesisResourcesTutorial|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. | ||
<span style="font-size:12pt; | <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 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. | The [[APISDWTutorial|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. | ||
''<span style="font-size:12pt; color:#808080;">More tutorials coming soon...</span>'' | |||
Revision as of 20:49, 21 October 2015
 |
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:
- The Quick Start Guide is written for the latest version of the Synthesis Platform. We recommend installing or updating your Synthesis application to the latest version before working with the guide. You can check for the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.
- Note that 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 ReliaSoft KB article RS20024.)
- 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 SynthesisAPI.tlb. For .NET applications, use SynthesisAPI.dll.
- For help with referencing the library, see this simple How-To Guide.
- 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 guide. This will allow you to work and experiment with the examples unhindered by folder and database permissions.
- Some basic knowledge is assumed. 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. The tutorials also make use of database/record IDs to help you understand and test the response of particular API calls. We recommend reading this topic on database IDs before starting the tutorials.
Tutorials
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.
More tutorials coming soon...