API Tutorials

<< 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 the Synthesis Platform.

Using Object IDs

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 are helpful when learning how to use the API to read/write data to a repository.

To display the object ID in a Synthesis application, choose File > Application Setup, then click Other under the Synthesis Settings heading in the navigation panel. Select the check box for Display Object IDs. The object IDs will be displayed for the following items:

Item	Location of ID in the application
Project	The ID is displayed in two locations: The Project Properties window (Project > Management > Edit Project Properties) displays the project's object ID at the caption bar of the window. The Manage Projects window (Project > Management > Manage Projects) displays a column containing the object IDs of each project in the database.
Resource (e.g., models,URDs, etc.)	The Resource Manager (Project > Synthesis > Resource Manager) displays a column containing the object IDs of the resources.
Xfmea, RCM++ or RBI system hierarchy item	To display the object ID (also called record ID) of a system hierarchy item, right-click any of the column headers in the System Hierarchy panel and choose Customize Columns. Select the Record ID check box.
FMEA records (e.g., functions, causes, etc.)	To display the object IDs of FMEA functions, causes, effects, controls and actions, right-click any of the column headers in the FMEA analysis and choose Customize Columns. Select the Record ID check box.
BlockSim diagrams and block IDs	The IDs are displayed on the diagram control panel.

Tutorials

Before you begin, be sure to review the prerequisites presented in the API overview page.

Basics

If you're new to the Synthesis API, we recommend starting with the basic tutorials in the order given below.

• Connect or Disconnect from a Synthesis Repository

• Add New Synthesis Resources to a Repository

• Edit Existing Synthesis Resources

Applications

• Calculate Results from a Model

• Transfer Data to the Synthesis Data Warehouse (SDW)

More tutorials coming soon...