API Tutorials - Revision history

Kate Racaza at 23:29, 2 August 2017

2017-08-02T23:29:58Z

← Older revision		Revision as of 23:29, 2 August 2017
Line 2:		Line 2:
	{{Template:BacktoPrevPage\|[[Synthesis API Reference\|<< Back to API Main Page]]}}		{{Template:BacktoPrevPage\|[[Synthesis API Reference\|<< 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 Synthesis applications.		Below are simple tutorials to help you get started with using the Synthesis API. The tutorials assume some basic working knowledge in VBA or .NET programming, and general familiarity with Synthesis applications.

Kate Racaza at 15:43, 13 April 2017

2017-04-13T15:43:29Z

@@ Line 6: / Line 6: @@
 ==Referencing the Synthesis API Library File==
-To use the Synthesis API in your code, you must reference the Synthesis API library in your VBA or .NET projects. The file is located in the folder where the Synthesis application is installed. By default, this folder is at "C:\Program Files\ReliaSoft\Synthesis 11." For VBA, you will use the '''SynthesisAPI.tlb''' file; for .NET applications, you will use the '''SynthesisAPI.dll''' file.
+{{:Synthesis API Reference}}
 ==Tutorials==
 Before you begin, be sure to review the [[Synthesis_API_Reference|prerequisites]] presented in the overview page. The tutorials are designed to work with the latest version of the Synthesis applications.

Kate Racaza at 22:12, 12 April 2017

2017-04-12T22:12:52Z

← Older revision		Revision as of 22:12, 12 April 2017
Line 41:		Line 41:
	====Importing Data====		====Importing Data====
	*[[Transfer Data to the Synthesis Data Warehouse (SDW)]]		*[[Transfer Data to the Synthesis Data Warehouse (SDW)]]
	*[[Upload XML File to XFRACAS]]

	====Performing Analyses and Creating Plots <span style="color:#585858">(requires a Synthesis API license)</span>====		====Performing Analyses and Creating Plots <span style="color:#585858">(requires a Synthesis API license)</span>====

Kate Racaza at 19:04, 3 April 2017

2017-04-03T19:04:41Z

← Older revision		Revision as of 19:04, 3 April 2017
Line 48:		Line 48:
	*[[Perform Accelerated Life Testing Data Analysis with Stress Profiles]] (Click [[Perform Accelerated Life Testing Data Analysis with Stress Profiles 10\|here]] for Version 10 of this tutorial.)		*[[Perform Accelerated Life Testing Data Analysis with Stress Profiles]] (Click [[Perform Accelerated Life Testing Data Analysis with Stress Profiles 10\|here]] for Version 10 of this tutorial.)
	*[[Create Plots]]		*[[Create Plots]]



	~~''<span style="font-size:12pt; color:#808080;">More tutorials coming soon...</span>''~~

Kate Racaza at 17:44, 3 April 2017

2017-04-03T17:44:34Z

← Older revision		Revision as of 17:44, 3 April 2017
Line 2:		Line 2:
	{{Template:BacktoPrevPage\|[[Synthesis API Reference\|<< Back to API Main Page]]}}		{{Template:BacktoPrevPage\|[[Synthesis API Reference\|<< 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~~.		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 Synthesis applications.


	==~~Using Object IDs~~==		==Referencing the Synthesis API Library File==
	~~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 use the Synthesis API in your code, you must reference the Synthesis API library in your VBA or .NET projects. The file is located in the folder where the Synthesis application is installed. By default, this folder is at "C:\Program Files\ReliaSoft\Synthesis 11." For VBA, you will use the '''SynthesisAPI.tlb''' file; for .NET applications, you will use the '''SynthesisAPI.dll''' file.

			To obtain the latest version of the library file and the Synthesis application, choose '''File > Help > Check for Updates''' or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.

	~~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 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]).
	~~{\|border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align~~: ~~left; cellborder"~~		:#In the VBA environment, choose '''Tools > References'''.
	~~\|- style="background~~:#~~F2F2F2;"~~		:#Click '''Browse''' and find the SynthesisAPI.tlb file on your computer. Click '''OK'''.
	~~!<span style="color:#585858;">Item</span>~~
	~~!<span style="color:#585858;">Location of ID in~~ the ~~application</span>~~
	\|-
	~~\|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~~.
	\|}

			'''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'''.
			:#Copy the following files from the Synthesis installation folder to your target folder (e.g., bin/Debug or bin/Release Folder).
			:::*licncr.dll
			:::*licncr.dll.nsign
			:::*licshr.dll
			:::*licshr.dll.nsign
			:::*libcrypto-1_1.dll
			:::*msvcp110.dll
			:::*msvcr110.dll
			:::*RSDB.dll
			:::*RSLM8nCodeDotNetWrapper.dll
			:::*utlibr.dll

	==Tutorials==		==Tutorials==
	Before you begin, be sure to review the [[Synthesis_API_Reference\|prerequisites]] presented in the overview page. The tutorials are designed to work with the latest version of the Synthesis ~~Platform~~.		Before you begin, be sure to review the [[Synthesis_API_Reference\|prerequisites]] presented in the overview page. The tutorials are designed to work with the latest version of the Synthesis applications.

	====Basics====		====Basics====

Kate Racaza at 18:44, 23 March 2017

2017-03-23T18:44:34Z

← Older revision		Revision as of 18:44, 23 March 2017
Line 47:		Line 47:
	*[[Perform Life Data Analysis on External Data Source\|Perform Life Data Analysis]]		*[[Perform Life Data Analysis on External Data Source\|Perform Life Data Analysis]]
	*[[Perform Accelerated Life Testing Data Analysis on External Data Source\|Perform Accelerated Life Testing Data Analysis]]		*[[Perform Accelerated Life Testing Data Analysis on External Data Source\|Perform Accelerated Life Testing Data Analysis]]
	*[[Perform Accelerated Life Testing Data Analysis with Stress Profiles]]		*[[Perform Accelerated Life Testing Data Analysis with Stress Profiles]] (Click [[Perform Accelerated Life Testing Data Analysis with Stress Profiles 10\|here]] for Version 10 of this tutorial.)
	*[[Create Plots]]		*[[Create Plots]]

Kate Racaza at 15:42, 8 September 2016

2016-09-08T15:42:09Z

← Older revision		Revision as of 15:42, 8 September 2016
Line 44:		Line 44:
	*[[Upload XML File to XFRACAS]]		*[[Upload XML File to XFRACAS]]

	====Performing Analyses and Creating Plots====		====Performing Analyses and Creating Plots <span style="color:#585858">(requires a Synthesis API license)</span>====
	*[[Perform Life Data Analysis on External Data Source\|Perform Life Data Analysis]]		*[[Perform Life Data Analysis on External Data Source\|Perform Life Data Analysis]]
	*[[Perform Accelerated Life Testing Data Analysis on External Data Source\|Perform Accelerated Life Testing Data Analysis]]		*[[Perform Accelerated Life Testing Data Analysis on External Data Source\|Perform Accelerated Life Testing Data Analysis]]

Kate Racaza at 15:07, 7 September 2016

2016-09-07T15:07:51Z

← Older revision		Revision as of 15:07, 7 September 2016
Line 32:		Line 32:

	==Tutorials==		==Tutorials==
	Before you begin, be sure to review the [[Synthesis_API_Reference\|prerequisites]] presented in the overview page.		Before you begin, be sure to review the [[Synthesis_API_Reference\|prerequisites]] presented in the overview page. The tutorials are designed to work with the latest version of the Synthesis Platform.

	====Basics====		====Basics====

Kate Racaza at 00:53, 7 September 2016

2016-09-07T00:53:14Z

← Older revision		Revision as of 00:53, 7 September 2016
Line 32:		Line 32:

	==Tutorials==		==Tutorials==
	Before you begin, be sure to review the [[Synthesis_API_Reference\|prerequisites]] presented in the ~~API~~ overview page.		Before you begin, be sure to review the [[Synthesis_API_Reference\|prerequisites]] presented in the overview page.

	====Basics====		====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]]
			*[[Calculate Results from a Model]]

	* [[~~Connect or Disconnect from a~~ Synthesis ~~Repository~~]]		====Importing Data====
			*[[Transfer Data to the Synthesis Data Warehouse (SDW)]]
			*[[Upload XML File to XFRACAS]]

	* [[~~Add New Synthesis Resources to a Repository~~]]		====Performing Analyses and Creating Plots====
			*[[Perform Life Data Analysis on External Data Source\|Perform Life Data Analysis]]
	* [[~~Edit Existing Synthesis Resources~~]]		*[[Perform Accelerated Life Testing Data Analysis on External Data Source\|Perform Accelerated Life Testing Data Analysis]]
			*[[Perform Accelerated Life Testing Data Analysis with Stress Profiles]]
	~~====Applications====~~		*[[Create Plots]]
	* [[~~Calculate Results from a Model~~]]

	* [[~~Transfer Data to the Synthesis Data Warehouse (SDW)~~]]



	''<span style="font-size:12pt; color:#808080;">More tutorials coming soon...</span>''		''<span style="font-size:12pt; color:#808080;">More tutorials coming soon...</span>''

Kate Racaza at 00:28, 7 September 2016

2016-09-07T00:28:50Z

← Older revision		Revision as of 00:28, 7 September 2016
Line 3:		Line 3:

	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.


	==Using Object IDs==		==Using Object IDs==