ReliaSoft API Reference

Template:InProgress

The ReliaSoft Synthesis API enables you to programmatically read and write data in Synthesis desktop applications. The API has been developed for Visual Basic for Applications (VBA) and Visual Basic.NET. This gives you the ability to create automated solutions using popular Microsoft Office applications, such as Excel and PowerPoint, as well as create custom applications for your organization.

Requirements

Before using the Synthesis API, note the following requirements:

• You must reference the required Synthesis API library in your .NET project or VBA file (show me how). The library is located in the folder where the Synthesis applications are 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 developers, use the SynthesisAPI.tlb library
• For .NET developers, use the SynthesisAPI.dll library

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

Examples

Sample applications that you can test and tweak yourself are shipped by default with every Synthesis desktop application. They are available for Excel, PowerPoint and Visual Basic projects. The files are stored on your computer at C:\Users\Public\Public Documents\ReliaSoft\Examples10\API. (For Version 9, see C:\Users\Public\Public Documents\ReliaSoft\Examples\API.)

To run the Excel and PowerPoint examples, macros must be enabled. (To learn how, see this Microsoft article.)

You must also recompile the example before first use. In Excel or PowerPoint, choose Developer > Visual Basic. In the Microsoft Visual Basic for Applications window, choose Debug > Compile VBAProject.

API Reference Documentation

This documentation is organized by object type. For an alphabetical listing of all classes and enumerations, see Full Synthesis API.

• The Repository object represents a connection to a Synthesis repository. You will need to establish a connection to a Synthesis repository before you can read and/or write data to it. Once you have a connection, you can use the methods in the Repository class to update Synthesis resources, import or export data from XML files, or transfer data to the Synthesis Data Warehouse (SDW).

• The following objects represent a type of Synthesis resource.
  • cModel
  • cAction
  • cURD
  • cVariable
  • cCrew
  • cPool
  • cCorrectiveTask
  • cScheduledTask
  • cXfmeaControl

To specify the displayed language for the Synthesis API library, use the SynthesisAPI.SetLanguage common class method.