API Tutorials: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 4: Line 4:
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.  
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.  


==Prerequisites==
Before you begin, be sure to review the [[Synthesis_API_Reference|prerequisites]] presented in the API overview page.
Before you begin, note the following requirements:


*'''Install the latest version of the Synthesis application'''.
==Using Object IDs==
:Choose '''File > Help > Check for Updates''' or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.
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.  
 
: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].)
 
*'''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 .NET applications, use ''SynthesisAPI.dll''.
 
:To reference the library in VBA:
:# Enter the VBA environment by clicking the '''Visual Basic''' command on the Developer tab (If the Developer tab is not visible, see [https://msdn.microsoft.com/en-us/library/bb608625.aspx this Microsoft article]).
:# In the VBA environment, choose '''Tools > References'''. (If the References command is unavailable, click the '''Reset''' button on the ribbon and then try again.)
:# Click '''Browse''' and find the SynthesisAPI.tlb file on your computer. Click '''OK'''.
 
:To reference the library in Visual Studio:
:# In the Solution Explorer, right-click the '''References''' node and choose '''Add References'''.
:# In the Reference Manager window, click the '''Browse''' tab and find the SynthesisAPI.dll file on your computer. Click '''OK'''.
 
==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 is 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:
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:
Line 31: Line 13:
{|border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
{|border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
|- style="background:#F2F2F2;"  
|- style="background:#F2F2F2;"  
!<span style="color:#585858;">Object</span>
!<span style="color:#585858;">Item</span>
!<span style="color:#585858;">Where to find the ID</span>
!<span style="color:#585858;">Location of ID in the application</span>
|-
|-
|Project||The ID is displayed in two locations:
|Project||The ID is displayed in two locations:
Line 45: Line 27:
|-
|-
|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.
|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.
|}
|}


Revision as of 00:27, 7 September 2016

APIWiki.png


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

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

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

Basics

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

Applications


More tutorials coming soon...

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