Talk:Synthesis API Reference/Notes - Revision history

Kate Racaza: Replaced content with '=DRAFT='

2017-03-30T21:14:21Z

Replaced content with '=DRAFT='

← Older revision		Revision as of 21:14, 30 March 2017
Line 1:		Line 1:
	=DRAFT=		=DRAFT=


	~~'''Tasks for V11'''~~

	*Add the new classes and enums to the list.

Kate Racaza at 18:04, 6 October 2016

2016-10-06T18:04:38Z

← Older revision		Revision as of 18:04, 6 October 2016
Line 1:		Line 1:
	=DRAFT=		=DRAFT=


			'''Tasks for V11'''

	*Add the new classes and enums to the list.		*Add the new classes and enums to the list.

Kate Racaza at 18:03, 6 October 2016

2016-10-06T18:03:44Z

← Older revision		Revision as of 18:03, 6 October 2016
Line 1:		Line 1:
	=DRAFT=		=DRAFT=
			*Add the new classes and enums to the list.

Kate Racaza: published changes for 10.1.4

2016-09-07T00:17:31Z

published changes for 10.1.4

← Older revision		Revision as of 00:17, 7 September 2016
Line 1:		Line 1:
	~~{{Template:API}}~~		=DRAFT=
	=DRAFT ~~for 10.4~~=
	The Synthesis Platform’s ''Application Programming Interface'' (API) enables you to programmatically read and write data to Synthesis repositories, as well as analyze and plot data sets from external sources. It is provided for Visual Basic for Applications (VBA) and .NET applications, allowing you to create automated solutions using popular Microsoft Office applications, such as Excel and PowerPoint, or create custom applications for your organization.

	~~Implementing the Synthesis API allows you to connect data in Synthesis repositories with the systems and tools used within your organization. It provides the functionality to:~~

	*'''Transfer and synchronize data via XML'''
	:Use XML files to manage structured data (such as system hierarchies/BOMs, incidents and work orders) between ReliaSoft’s [http://xfracas.reliasoft.com/ XFRACAS] and a variety of different PLMs, ERPs, CMMS and other external systems. You can also use XML files to create reliability block diagrams (RBDs) in [http://blocksim.reliasoft.com/ BlockSim].
	*'''Read/write specific data elements'''
	:Read or write data to Synthesis resources (models, actions, URDs, etc.), system hierarchy items and FMEA records (causes, effects, failures, etc.). Initiate batch data processing and create custom solutions for importing/exporting data from Synthesis repositories, as well as load data into the Synthesis Data Warehouse (SDW).
	*'''Obtain calculated results'''
	~~:Read data from published Synthesis models and obtain calculated results such as reliability, probability of failure, BX% life, failure rate and mean time.~~
	*'''Analyze data'''
	:Use [http://weibull.reliasoft.com/ Weibull++'s] or [http://alta.reliasoft.com/ ALTA’s] analysis and plotting engines to analyze data from third-party sources, and incorporate the functionality into your own custom applications. (Requires a Synthesis API license.)

	~~==Prerequisites==~~
	The Synthesis API consists of a library file that contains the classes, methods and events that provide access to Synthesis applications. For VBA, you will use the '''SynthesisAPI.tlb''' file; for .NET, you will use the '''SynthesisAPI.dll''' file.

	To access these files, you must have the latest version of the Synthesis Platform installed and activated on your computer. The files are 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".)

	If you plan to run API applications on a Windows server, you’ll need to run the Synthesis API Ante Service to allow clients to access the application (the service is not required when running API applications locally). The API Service may be installed on the server or on a different machine. For instructions on how to install and configure the service, see http://www.synthesisplatform.net/synthesis_ap_ante_service.htm.

	~~====Installing the Latest Version of Synthesis====~~
	~~Choose '''File > Help > Check for Updates''' or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.~~

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

	~~====Using the Synthesis API Library Files====~~
	~~To use the classes, methods and events in the Synthesis API object library, you must reference the library file to a project.~~

	~~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'''.~~
	~~#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'''.~~

	~~:In addition, you must 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~~
	~~:*libeay32.dll~~
	~~:*msvcp110.dll~~
	~~:*msvcr110.dll~~
	~~:*RSLM8nCodeDotNetWrapper.dll~~
	~~:*utlibr.dll~~

	~~==Getting Started==~~

	~~====Tutorials====~~
	~~[[API Tutorials\|Tutorials]] are available to help you learn the core objects of the Synthesis API and start coding right away. The tutorials include code samples for both VBA and VB.NET.~~

	~~====Examples====~~
	Sample applications that you can test and tweak yourself are included with the Synthesis Platform installation. 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.)

	The sample applications are available for Excel VBA and VB.NET projects. (To run the Excel examples, macros must be enabled. See [http://office.microsoft.com/en-us/excel-help/enable-or-disable-macros-in-office-documents-HA010031071.aspx this Microsoft article].)

	~~==Object Library ==~~
	The Synthesis API is designed to closely follow the user interface of Synthesis desktop applications. For example, there is a class for every type of Synthesis resource and every type of FMEA record; there’s a class to represent a Weibull++ folio, and a class to represent the analysis settings that you might find in the folio’s control panel.

	~~Below is a summary of the core objects in the Synthesis API library. For an alphabetical listing of all classes and enumerations, see [[API Reference Documentation]].~~

	*The <code>'''[[Repository Class\|Repository]]'''</code> object represents the Synthesis repository. All other objects use the functions in this class to read or write data to the repository. This class also contains the functions for importing/exporting XML files.

	*The following objects represent the Synthesis resources. Instances of each class can be used to store data for an existing or new resource.
	**<code>'''[[CAction Class\|cAction]]'''</code>
	**<code>'''[[CCorrectiveTask Class\|cCorrectiveTask]]'''</code>
	**<code>'''[[CScheduledTask Class\|cScheduledTask]]'''</code>
	**<code>'''[[CCrew Class\|cCrew]]'''</code>
	**<code>'''[[CModel Class\|cModel]]'''</code>
	**<code>'''[[CPool Class\|cPool]]'''</code>
	**<code>'''[[CURD Class\|cURD]]'''</code>
	**<code>'''[[CVariable Class\|cVariable]]'''</code>
	**<code>'''[[CXfmeaControl Class\|cXfmeaControl]]'''</code>

	*The following objects build data sets for the Synthesis Data Warehouse (SDW).
	**<code>'''[[RawData Class\|RawData]]'''</code> represents a single data point.
	**<code>'''[[RawDataSet Class\|RawDataSet]]'''</code> serves as the data container for <code>RawData</code> objects.

	*The <code>'''[[XfmeaItem Class\|XfmeaItem]]'''</code> object represents a system hierarchy item. Instances of this class can be used to store data for a system or assembly, as well as build a multi-level system configuration.

	*The following objects represent the FMEA records. Instances of each class can be used to store data for an existing or new FMEA analysis.
	**<code>'''[[XfmeaFunction Class\|XfmeaFunction]]'''</code>
	**<code>'''[[XfmeaCause Class\|XfmeaCause]]'''</code>
	**<code>'''[[XfmeaEffect Class\|XfmeaEffect]]'''</code>
	**<code>'''[[XfmeaFailure Class\|XfmeaFailure]]'''</code>

	*The <code>'''[[WeibullDataSet Class\|WeibullDataSet]]'''</code> object represents a Weibull++ data sheet for life data analysis. Instances of this class are used define a data set and fit a statistical distribution to the data.

	*The <code>'''[[ALTADataSet Class\|ALTADataSet]]'''</code> object represents an ALTA data sheet for accelerated life testing data analysis. Instances of this class are used to define a data set, and fit a distribution and life-stress relationship to the data.

	*The <code>'''[[WAPlots Class\|WAPlots]]'''</code> object represents a plot based on a <code>cModel</code>, <code>WeibullDataSet</code> or <code>ALTADataSet</code> object. Instances of this class are used to display a plot of the analysis results.

Kate Racaza at 16:52, 29 August 2016

2016-08-29T16:52:54Z

← Older revision		Revision as of 16:52, 29 August 2016
Line 19:		Line 19:
	To access these files, you must have the latest version of the Synthesis Platform installed and activated on your computer. The files are 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".)		To access these files, you must have the latest version of the Synthesis Platform installed and activated on your computer. The files are 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".)

	If you plan to run API applications on a Windows server, you’ll need to run the Synthesis API Ante Service ~~in order~~ to allow ~~multiple~~ clients to ~~share~~ access to the ~~API~~ (the service is not required when running ~~the~~ API locally). The API Service may be installed on the server or on a different machine. For instructions on how to install and configure the service, see http://www.synthesisplatform.net/synthesis_ap_ante_service.htm.		If you plan to run API applications on a Windows server, you’ll need to run the Synthesis API Ante Service to allow clients to access the application (the service is not required when running API applications locally). The API Service may be installed on the server or on a different machine. For instructions on how to install and configure the service, see http://www.synthesisplatform.net/synthesis_ap_ante_service.htm.

	====Installing the Latest Version of Synthesis====		====Installing the Latest Version of Synthesis====

Kate Racaza at 15:42, 29 August 2016

2016-08-29T15:42:08Z

← Older revision		Revision as of 15:42, 29 August 2016
Line 21:		Line 21:
	If you plan to run API applications on a Windows server, you’ll need to run the Synthesis API Ante Service in order to allow multiple clients to share access to the API (the service is not required when running the API locally). The API Service may be installed on the server or on a different machine. For instructions on how to install and configure the service, see http://www.synthesisplatform.net/synthesis_ap_ante_service.htm.		If you plan to run API applications on a Windows server, you’ll need to run the Synthesis API Ante Service in order to allow multiple clients to share access to the API (the service is not required when running the API locally). The API Service may be installed on the server or on a different machine. For instructions on how to install and configure the service, see http://www.synthesisplatform.net/synthesis_ap_ante_service.htm.

	===Installing the Latest Version of Synthesis===		====Installing the Latest Version of Synthesis====
	Choose '''File > Help > Check for Updates''' or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.		Choose '''File > Help > Check for Updates''' or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.

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

	===Using the Synthesis API Library Files===		====Using the Synthesis API Library Files====
	To use the classes, methods and events in the Synthesis API object library, you must reference the library file to a project.		To use the classes, methods and events in the Synthesis API object library, you must reference the library file to a project.

Line 52:		Line 52:
	==Getting Started==		==Getting Started==

	===Tutorials===		====Tutorials====
	[[API Tutorials\|Tutorials]] are available to help you learn the core objects of the Synthesis API and start coding right away. The tutorials include code samples for both VBA and VB.NET.		[[API Tutorials\|Tutorials]] are available to help you learn the core objects of the Synthesis API and start coding right away. The tutorials include code samples for both VBA and VB.NET.

	===Examples===		====Examples====
	Sample applications that you can test and tweak yourself are included with the Synthesis Platform installation. 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.)		Sample applications that you can test and tweak yourself are included with the Synthesis Platform installation. 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.)

Kate Racaza at 15:35, 29 August 2016

2016-08-29T15:35:41Z

@@ Line 1: / Line 1: @@
 {{Template:API}}
 =DRAFT for 10.4=
-The Synthesis Platform’s ''Application Programming Interface'' (API) enables you to programmatically read and write data to Synthesis repositories, as well as analyze and plot data sets from external sources. It gives you the flexibility to connect your Synthesis applications and data with other systems and tools used within your organization.
+The Synthesis Platform’s ''Application Programming Interface'' (API) enables you to programmatically read and write data to Synthesis repositories, as well as analyze and plot data sets from external sources. It is provided for Visual Basic for Applications (VBA) and .NET applications, allowing you to create automated solutions using popular Microsoft Office applications, such as Excel and PowerPoint, or create custom applications for your organization.
-The API is available for Visual Basic for Applications (VBA) and .NET applications. You can create automated solutions using popular Microsoft Office applications, such as Excel and PowerPoint, or create custom .NET applications for your organization. The API provides the functionality to:
+Implementing the Synthesis API allows you to connect data in Synthesis repositories with the systems and tools used within your organization. It provides the functionality to:
 *'''Transfer and synchronize data via XML'''
@@ Line 12: / Line 12: @@
 :Read data from published Synthesis models and obtain calculated results such as reliability, probability of failure, BX% life, failure rate and mean time.
 *'''Analyze data'''
-:Use [http://weibull.reliasoft.com/ Weibull++'s] or [http://alta.reliasoft.com/ ALTA’s] analysis and plotting engines to analyze data from third-party sources, and incorporate the functionality into your own custom applications.
+:Use [http://weibull.reliasoft.com/ Weibull++'s] or [http://alta.reliasoft.com/ ALTA’s] analysis and plotting engines to analyze data from third-party sources, and incorporate the functionality into your own custom applications. (Requires a Synthesis API license.)
 ==Getting Started==
@@ Line 23: / Line 59: @@
 The sample applications are available for Excel VBA and VB.NET projects. (To run the Excel examples, macros must be enabled. See [http://office.microsoft.com/en-us/excel-help/enable-or-disable-macros-in-office-documents-HA010031071.aspx this Microsoft article].)
 ==Object Library ==

Kate Racaza at 17:25, 26 August 2016

2016-08-26T17:25:09Z

← Older revision		Revision as of 17:25, 26 August 2016
Line 26:		Line 26:
	===Prerequisites===		===Prerequisites===
	*'''Install the latest version of the Synthesis application'''.		*'''Install the latest version of the Synthesis application'''.
	:Choose '''File > Help > Check for Updates''' or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm.		:Choose '''File > Help > Check for Updates''' or download the latest version at http://www.ReliaSoft.com/synthesis/downloads.htm. 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].)

	~~: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]~~.)		For implementations that need to run on a Windows server, you must run the Synthesis API Ante Service (see www.synthesisplatform.net/synthesis_ap_ante_service.htm).

	*'''Reference the Synthesis API object library'''.		*'''Reference the Synthesis API object library'''.

Kate Racaza at 16:01, 26 August 2016

2016-08-26T16:01:33Z

Kate Racaza at 15:37, 26 August 2016

2016-08-26T15:37:22Z

@@ Line 1: / Line 1: @@
-=DRAFT for 10.1.3=
+{{Template:API}}
-Replace the Object Library section of the page with the following draft:
+The Synthesis API is written for Visual Basic for Applications (VBA) and .NET applications. You can create automated solutions using popular Microsoft Office applications, such as Excel and PowerPoint, as well as create custom applications for your organization. It provides the functionality to:
-'''Object Library'''
+==Getting Started==
-Below is a summary of the core objects in the Synthesis API library. For an alphabetical listing of all classes and enumerations in the object library, see [[API Reference Documentation]].
+===Tutorials===
 *The <code>'''[[Repository Class|Repository]]'''</code> object represents the Synthesis repository. All other objects use the functions in this class to read or write data to the repository. This class also contains the functions for importing/exporting XML files.
@@ Line 23: / Line 64: @@
 *The following objects build data collections for the Synthesis Data Warehouse (SDW).
 **<code>'''[[RawData Class|RawData]]'''</code> represents a single data point.
-**<code>'''[[RawDataSet Class|RawDataSet]]'''</code> serves as the data container for the <code>RawData</code> objects.
+**<code>'''[[RawDataSet Class|RawDataSet]]'''</code> serves as the data container for <code>RawData</code> objects.
 *The <code>'''[[XfmeaItem Class|XfmeaItem]]'''</code> object represents a system hierarchy item. Instances of this class can be used to store data for a system or assembly, as well as build a multi-level system configuration.
@@ Line 33: / Line 74: @@
 **<code>'''[[XfmeaFailure Class|XfmeaFailure]]'''</code>
-*The <code>'''[[WeibullDataSet Class|WeibullDataSet]]'''</code> object represents a Weibull++ standard folio data sheet. Instances of this class are used define a data set and fit a statistical distribution to the data.
+*The <code>'''[[WeibullDataSet Class|WeibullDataSet]]'''</code> object represents a Weibull++ data sheet for life data analysis. Instances of this class are used define a data set and fit a statistical distribution to the data.
-*The <code>'''[[ALTADataSet Class|ALTADataSet]]'''</code> object represents an ALTA standard folio data sheet. Instances of this class are used to define a data set, and fit a distribution and life-stress relationship to the data.
+*The <code>'''[[ALTADataSet Class|ALTADataSet]]'''</code> object represents an ALTA data sheet for accelerated life testing data analysis. Instances of this class are used to define a data set, and fit a distribution and life-stress relationship to the data.
-*The <code>'''[[WAPlots Class|WAPlots]]'''</code> object represents a plot based on the fitted model of a <code>WeibullDataSet</code> or <code>ALTADataSet</code> object. Instances of this class are used to display a plot of the analysis results.
+*The <code>'''[[WAPlots Class|WAPlots]]'''</code> object represents a plot based on a <code>cModel</code>, <code>WeibullDataSet</code> or <code>ALTADataSet</code> object. Instances of this class are used to display a plot of the analysis results.

← Older revision		Revision as of 16:01, 26 August 2016
Line 3:		Line 3:
	The Synthesis Platform’s ''Application Programming Interface'' (API) enables you to programmatically read and write data to Synthesis repositories, as well as analyze and plot data sets from external sources. It gives you the flexibility to connect your Synthesis applications and data with other systems and tools used within your organization.		The Synthesis Platform’s ''Application Programming Interface'' (API) enables you to programmatically read and write data to Synthesis repositories, as well as analyze and plot data sets from external sources. It gives you the flexibility to connect your Synthesis applications and data with other systems and tools used within your organization.

	The ~~Synthesis~~ API is ~~written~~ for Visual Basic for Applications (VBA) and .NET applications. You can create automated solutions using popular Microsoft Office applications, such as Excel and PowerPoint, ~~as well as~~ create custom applications for your organization. It provides the functionality to:		The API is available for Visual Basic for Applications (VBA) and .NET applications. You can create automated solutions using popular Microsoft Office applications, such as Excel and PowerPoint, or create custom .NET applications for your organization. The API provides the functionality to:

	*'''Transfer and synchronize data via XML'''		*'''Transfer and synchronize data via XML'''
	:Use XML files to manage structured data (such as system hierarchies/BOMs, incidents and work orders) between ReliaSoft’s XFRACAS and a variety of different PLMs, ERPs, CMMS and other external systems. You can also use XML files to create reliability block diagrams (RBDs) in BlockSim.		:Use XML files to manage structured data (such as system hierarchies/BOMs, incidents and work orders) between ReliaSoft’s [http://xfracas.reliasoft.com/ XFRACAS] and a variety of different PLMs, ERPs, CMMS and other external systems. You can also use XML files to create reliability block diagrams (RBDs) in [http://blocksim.reliasoft.com/ BlockSim].
	*'''Read/write specific data elements'''		*'''Read/write specific data elements'''
	:Read or write data to Synthesis resources (models, actions, URDs, etc.), system hierarchy items and FMEA records (causes, effects, failures, etc.). ~~You can initiate~~ batch data processing and create custom solutions for importing/exporting data from Synthesis repositories, as well as load data into the Synthesis Data Warehouse (SDW).		:Read or write data to Synthesis resources (models, actions, URDs, etc.), system hierarchy items and FMEA records (causes, effects, failures, etc.). Initiate batch data processing and create custom solutions for importing/exporting data from Synthesis repositories, as well as load data into the Synthesis Data Warehouse (SDW).
	*'''Obtain calculated results'''		*'''Obtain calculated results'''
	:Read data from published Synthesis models and obtain calculated results such as reliability, probability of failure, BX% life, failure rate and mean time.		:Read data from published Synthesis models and obtain calculated results such as reliability, probability of failure, BX% life, failure rate and mean time.
	*'''Analyze data'''		*'''Analyze data'''
	:Use Weibull++'s ~~and~~ ALTA’s analysis and plotting engines to analyze data from third-party sources, and incorporate the functionality into your own custom applications.		:Use [http://weibull.reliasoft.com/ Weibull++'s] or [http://alta.reliasoft.com/ ALTA’s] analysis and plotting engines to analyze data from third-party sources, and incorporate the functionality into your own custom applications.

	==Getting Started==		==Getting Started==
Line 62:		Line 62:
	**<code>'''[[CXfmeaControl Class\|cXfmeaControl]]'''</code>		**<code>'''[[CXfmeaControl Class\|cXfmeaControl]]'''</code>

	*The following objects build data ~~collections~~ for the Synthesis Data Warehouse (SDW).		*The following objects build data sets for the Synthesis Data Warehouse (SDW).
	**<code>'''[[RawData Class\|RawData]]'''</code> represents a single data point.		**<code>'''[[RawData Class\|RawData]]'''</code> represents a single data point.
	**<code>'''[[RawDataSet Class\|RawDataSet]]'''</code> serves as the data container for <code>RawData</code> objects.		**<code>'''[[RawDataSet Class\|RawDataSet]]'''</code> serves as the data container for <code>RawData</code> objects.