ReliaSoft API Reference - Revision history

Melinda Caroline at 20:00, 12 April 2024

2024-04-12T20:00:59Z

← Older revision		Revision as of 20:00, 12 April 2024
Line 35:		Line 35:

	*'''Running API applications on a server		*'''Running API applications on a server
	:If you plan to run the API on a Windows server, you must use [https://help.reliasoft.com/basics/content/reliasoft_installation_and_licensing.htm locally hosted licensing] and you’ll need to install the ReliaSoft API Ante Service to scale the implementation (the service is not required when running the API on a Windows desktop environment). For instructions on how to install and configure the service, see https://support.hbmprenscia.com/s/article/ReliaSoft-API-Ante-Service.		:If you plan to run the API on a Windows server, you must use [https://help.reliasoft.com/basics/content/reliasoft_installation_and_licensing.htm locally hosted licensing] with Prenscia Access.

	*'''Access to calculations functionality		*'''Access to calculations functionality

Melinda Caroline: /* Prerequisites */

2024-03-11T21:43:32Z

Prerequisites

← Older revision		Revision as of 21:43, 11 March 2024
Line 35:		Line 35:

	*'''Running API applications on a server		*'''Running API applications on a server
	:If you plan to run the API on a Windows server, you must use [https://~~www~~.~~hbkworld~~.com/en/~~knowledge~~/~~resource-center/resources/2022/locally-hosted-licensing~~ locally hosted licensing] and you’ll need to install the ReliaSoft API Ante Service to scale the implementation (the service is not required when running the API on a Windows desktop environment). For instructions on how to install and configure the service, see https://support.hbmprenscia.com/s/article/ReliaSoft-API-Ante-Service.		:If you plan to run the API on a Windows server, you must use [https://help.reliasoft.com/basics/content/reliasoft_installation_and_licensing.htm locally hosted licensing] and you’ll need to install the ReliaSoft API Ante Service to scale the implementation (the service is not required when running the API on a Windows desktop environment). For instructions on how to install and configure the service, see https://support.hbmprenscia.com/s/article/ReliaSoft-API-Ante-Service.

	*'''Access to calculations functionality		*'''Access to calculations functionality

Melinda Caroline: /* Prerequisites */

2024-03-11T21:42:21Z

Prerequisites

← Older revision		Revision as of 21:42, 11 March 2024
Line 35:		Line 35:

	*'''Running API applications on a server		*'''Running API applications on a server
	:If you plan to run the API on a Windows server, you must use [https://www.hbkworld.com/en/knowledge/resource-center/resources/2022/locally-hosted-licensing locally hosted licensing] and you’ll need to install the ReliaSoft API Ante Service to scale the implementation (the service is not required when running the API on a Windows desktop environment). For instructions on how to install and configure the service, see https://~~www~~.~~hbkworld~~.com/en/~~knowledge~~/~~resource~~-~~center/resources/2022/reliasoft-api~~-~~ante~~-~~service~~.		:If you plan to run the API on a Windows server, you must use [https://www.hbkworld.com/en/knowledge/resource-center/resources/2022/locally-hosted-licensing locally hosted licensing] and you’ll need to install the ReliaSoft API Ante Service to scale the implementation (the service is not required when running the API on a Windows desktop environment). For instructions on how to install and configure the service, see https://support.hbmprenscia.com/s/article/ReliaSoft-API-Ante-Service.

	*'''Access to calculations functionality		*'''Access to calculations functionality

Melinda Caroline at 17:06, 13 July 2023

2023-07-13T17:06:03Z

← Older revision		Revision as of 17:06, 13 July 2023
Line 14:		Line 14:
	:Use XML files to manage structured data (such as system hierarchies/BOMs, incidents and work orders) between ReliaSoft’s [https://www.hbkworld.com/en/products/software/analysis-simulation/reliability/xfracas-failure-reporting-analysis-corrective-action-system-fracas-software 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 [https://www.hbkworld.com/en/products/software/analysis-simulation/reliability/blocksim-system-reliability-availability-maintainability-ram-analysis-software BlockSim].		:Use XML files to manage structured data (such as system hierarchies/BOMs, incidents and work orders) between ReliaSoft’s [https://www.hbkworld.com/en/products/software/analysis-simulation/reliability/xfracas-failure-reporting-analysis-corrective-action-system-fracas-software 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 [https://www.hbkworld.com/en/products/software/analysis-simulation/reliability/blocksim-system-reliability-availability-maintainability-ram-analysis-software BlockSim].
	*'''Read/write specific data elements'''		*'''Read/write specific data elements'''
	:Read or write data to 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 ReliaSoft repositories, as well as load data into the ~~Synthesis~~ Data Warehouse (~~SDW~~).		:Read or write data to 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 ReliaSoft repositories, as well as load data into the Reliability Data Warehouse (RDW).
	*'''Obtain calculated results'''		*'''Obtain calculated results'''
	:Read data from published models and obtain calculated results such as reliability, probability of failure, BX% life, failure rate and mean time.		:Read data from published models and obtain calculated results such as reliability, probability of failure, BX% life, failure rate and mean time.
Line 87:		Line 87:
	**<code>'''[[CXfmeaControl Class\|cXfmeaControl]]'''</code>		**<code>'''[[CXfmeaControl Class\|cXfmeaControl]]'''</code>

	*The following objects build data sets for the ~~Synthesis~~ Data Warehouse (~~SDW~~).		*The following objects build data sets for the Reliability Data Warehouse (RDW).
	**<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.

Melinda Caroline at 17:00, 13 July 2023

2023-07-13T17:00:48Z

← Older revision		Revision as of 17:00, 13 July 2023
Line 30:		Line 30:

	*'''32- vs. 64-bit'''		*'''32- vs. 64-bit'''
	:For VBA, the bit version of the ReliaSoft applications 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.)		:For VBA, the bit version of the ReliaSoft applications 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.

	:For Visual Studio projects targeting the .NET Framework 4.5 (or later) and compiled to run an any platform (Any CPU), turn off the '''Prefer 32-bit''' property of the build configuration if you want instances of your application to run as a 64-bit process; otherwise, the application will run as a 32-bit process on both 32- and 64-bit versions of Windows. It is necessary to ensure your application bitness matches the bitness of the ReliaSoft desktop applications installed wherever your application is run due to dependencies on platform-specific libraries.		:For Visual Studio projects targeting the .NET Framework 4.5 (or later) and compiled to run an any platform (Any CPU), turn off the '''Prefer 32-bit''' property of the build configuration if you want instances of your application to run as a 64-bit process; otherwise, the application will run as a 32-bit process on both 32- and 64-bit versions of Windows. It is necessary to ensure your application bitness matches the bitness of the ReliaSoft desktop applications installed wherever your application is run due to dependencies on platform-specific libraries.

Melinda Caroline at 16:34, 13 July 2023

2023-07-13T16:34:04Z

← Older revision		Revision as of 16:34, 13 July 2023
Line 12:		Line 12:

	*'''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 [https://www.~~reliasoft~~.com/products/reliability~~-management~~/xfracas/ 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~~://www.~~reliasoft~~.com/products/reliability-analysis~~/blocksim~~ BlockSim].		:Use XML files to manage structured data (such as system hierarchies/BOMs, incidents and work orders) between ReliaSoft’s [https://www.hbkworld.com/en/products/software/analysis-simulation/reliability/xfracas-failure-reporting-analysis-corrective-action-system-fracas-software 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 [https://www.hbkworld.com/en/products/software/analysis-simulation/reliability/blocksim-system-reliability-availability-maintainability-ram-analysis-software BlockSim].
	*'''Read/write specific data elements'''		*'''Read/write specific data elements'''
	:Read or write data to 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 ReliaSoft repositories, as well as load data into the Synthesis Data Warehouse (SDW).		:Read or write data to 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 ReliaSoft repositories, as well as load data into the Synthesis Data Warehouse (SDW).
Line 18:		Line 18:
	:Read data from published models and obtain calculated results such as reliability, probability of failure, BX% life, failure rate and mean time.		:Read data from published models and obtain calculated results such as reliability, probability of failure, BX% life, failure rate and mean time.
	*'''Analyze data'''		*'''Analyze data'''
	:Use [~~http~~://~~www.reliasoft~~.com/products/reliability-analysis~~/weibull~~ Weibull++'s~~] or [http://www.reliasoft.com/products/reliability-analysis/alta ALTA’s~~] analysis and plotting engines to analyze data from third-party sources, and incorporate the functionality into your own custom applications. (Requires a ReliaSoft API license.)		:Use [https://hbkworld.com/en/products/software/analysis-simulation/reliability/weibull-life-data-analysis-software Weibull++'s] analysis and plotting engines to analyze data from third-party sources, and incorporate the functionality into your own custom applications. (Requires a ReliaSoft API license.)

	==Prerequisites==		==Prerequisites==
	*'''Getting the latest version'''		*'''Getting the latest version'''
	:The ReliaSoft API consists of a library file that contains the classes, methods and events that provide access to ReliaSoft applications. The file is located in the folder where the ReliaSoft desktop applications are installed. By default, this folder is at "C:\Program Files\ReliaSoft\ReliaSoft ~~2019~~." ~~As of Version 2019, the library names are now version dependent.~~ For VBA, you will use the '''~~ReliaSoftAPI19~~.tlb''' file; for .NET applications, you will use the '''~~ReliaSoftAPI19~~.dll''' file. Prior to Version 2019, the files to use were SynthesisAPI.tlb (VBA) and SynthesisAPI.dll (.NET).		:The ReliaSoft API consists of a library file that contains the classes, methods and events that provide access to ReliaSoft applications. The file is located in the folder where the ReliaSoft desktop applications are installed. By default, this folder is at "C:\Program Files\ReliaSoft\ReliaSoft 2023." For VBA, you will use the '''ReliaSoftAPI23.tlb''' file; for .NET applications, you will use the '''ReliaSoftAPI23.dll''' file. Prior to Version 2019, the files to use were SynthesisAPI.tlb (VBA) and SynthesisAPI.dll (.NET).

	:To obtain the latest version of the library file and the ReliaSoft applications, choose '''File > Help > Check for Updates''' or download the latest version from the [https://support.hbmprenscia.com HBM Prenscia Support Portal].		:To obtain the latest version of the library file and the ReliaSoft applications, choose '''File > Help > Check for Updates''' or download the latest version from the [https://support.hbmprenscia.com HBM Prenscia Support Portal].

	*'''Build environment'''		*'''Build environment'''
	:For Visual Studio projects using Version 10 or 11, at minimum you will need Visual Studio 2010 and the .NET Framework 4.0 runtime. Version 2018 and later require Visual Studio 2015 and the .NET Framework 4.6.1 developer pack and runtime.		:For Visual Studio projects using Version 10 or 11, at minimum you will need Visual Studio 2010 and the .NET Framework 4.0 runtime. Version 2018 and later require Visual Studio 2015 and the .NET Framework 4.6.1 developer pack and runtime. Starting in Version 2022, .NET Framework 4.8 developer pack is required.

	*'''32- vs. 64-bit'''		*'''32- vs. 64-bit'''
	:For VBA, the bit version of the ReliaSoft applications 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.)		:For VBA, the bit version of the ReliaSoft applications 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.)

	:For Visual Studio projects targeting the .NET Framework 4.5 (or later) and compiled to run an any platform (Any CPU), turn off the '''Prefer 32-bit''' property of the build configuration if you want instances of your application to run as a 64-bit process; otherwise, the application will run as a 32-bit process on both 32- and 64-bit versions of Windows. ~~Note that when using [https://www.reliasoft.com/locally-hosted-licensing locally hosted licensing], it~~ is necessary to ensure your application bitness matches the bitness of the ReliaSoft desktop applications installed wherever your application is run due to dependencies on platform-specific libraries.		:For Visual Studio projects targeting the .NET Framework 4.5 (or later) and compiled to run an any platform (Any CPU), turn off the '''Prefer 32-bit''' property of the build configuration if you want instances of your application to run as a 64-bit process; otherwise, the application will run as a 32-bit process on both 32- and 64-bit versions of Windows. It is necessary to ensure your application bitness matches the bitness of the ReliaSoft desktop applications installed wherever your application is run due to dependencies on platform-specific libraries.

	*'''Running API applications on a server		*'''Running API applications on a server
	:If you plan to run the API on a Windows server, you must use [https://www.~~reliasoft~~.com/locally-hosted-licensing locally hosted licensing] and you’ll need to install the ReliaSoft API Ante Service to scale the implementation (the service is not required when running the API on a Windows desktop environment). For instructions on how to install and configure the service, see https://www.~~reliasoft~~.com/reliasoft-api-ante-service.		:If you plan to run the API on a Windows server, you must use [https://www.hbkworld.com/en/knowledge/resource-center/resources/2022/locally-hosted-licensing locally hosted licensing] and you’ll need to install the ReliaSoft API Ante Service to scale the implementation (the service is not required when running the API on a Windows desktop environment). For instructions on how to install and configure the service, see https://www.hbkworld.com/en/knowledge/resource-center/resources/2022/reliasoft-api-ante-service.

	*'''Access to calculations functionality		*'''Access to calculations functionality
	:Access to Weibull++'s ~~and ALTA’s~~ analysis and plotting engines ~~require~~ a ReliaSoft API license. To obtain a license, please see [~~http~~://www.~~reliasoft~~.com/contact~~.htm~~ contact ReliaSoft].		:Access to Weibull++'s analysis and plotting engines requires a ReliaSoft API license. To obtain a license, please see [https://www.hbkworld.com/en/contact-us/reliasoft-worldwide-contacts contact ReliaSoft].

	==Getting Started==		==Getting Started==
Line 44:		Line 44:
	====Referencing the ReliaSoft API Library File====		====Referencing the ReliaSoft API Library File====
	<!-- This "onlyinclude" section is transcluded into the API Tutorials page -->		<!-- This "onlyinclude" section is transcluded into the API Tutorials page -->
	<onlyinclude>To use the ReliaSoft API in your code, you must reference the ReliaSoft API library in your VBA or .NET projects. The file is located in the folder where the ReliaSoft desktop applications are installed. By default for Version ~~2019~~, this folder is at "C:\Program Files\ReliaSoft\ReliaSoft ~~2019~~." For VBA, you will use the '''~~ReliaSoftAPI19~~.tlb''' file; for .NET applications, you will use the '''~~ReliaSoftAPI19~~.dll''' file.		<onlyinclude>To use the ReliaSoft API in your code, you must reference the ReliaSoft API library in your VBA or .NET projects. The file is located in the folder where the ReliaSoft desktop applications are installed. By default for Version 2023, this folder is at "C:\Program Files\ReliaSoft\ReliaSoft 2023." For VBA, you will use the '''ReliaSoftAPI23.tlb''' file; for .NET applications, you will use the '''ReliaSoftAPI23.dll''' file.

	'''To reference the library in VBA''':		'''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]).		:#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'''.		:#In the VBA environment, choose '''Tools > References'''.
	:#Click '''Browse''' and find the ~~ReliaSoftAPI19~~.tlb file on your computer. Click '''OK'''.		:#Click '''Browse''' and find the ReliaSoftAPI23.tlb file on your computer. Click '''OK'''.

	'''To reference the library in Visual Studio:'''		'''To reference the library in Visual Studio:'''
	:#In the Solution Explorer, right-click the '''References''' node and choose '''Add References'''.		:#In the Solution Explorer, right-click the '''References''' node of your project and choose '''Add References'''.
	:#In the Reference Manager window, click the '''Browse''' tab and find the ~~ReliaSoftAPI19~~.dll file on your computer. Click '''OK'''.		:#In the Reference Manager window, click the '''Browse''' tab and find the ReliaSoftAPI23.dll file on your computer. Click '''OK'''.
	:#~~Copy~~ the following ~~files from~~ the ~~ReliaSoft installation folder to your target folder~~ (~~e.g., bin/Debug or bin/Release Folder~~).		:#Edit your project file, either directly using any text editor, or by right-clicking your project and choosing '''Unload Project''', then right-clicking your project again and choosing '''Edit Project File'''
	:~~::*licncr.dll~~		:#Insert the following line just before the last </Project> clause (change the path if necessary):
	:::*licncr.dll.nsign		:::
	:~~::*licshr.dll~~		::::::<Import Project="C:\Program Files\ReliaSoft\ReliaSoft 2023\ReliaSoftAPI.targets" />
	:::*licshr.dll.nsign		:::
	:::*msvcp110.~~dll~~		:::This will ensure the required files are copied into your project’s destination folder during the build.
	:::*msvcr110.dll		:#<li value="5">Save the project file. If you unloaded the project in step 3, right-click the project and choose '''Reload Project'''.</li>
	:::*RSDB.~~dll~~
	:~~::*RSLM8nCodeDotNetWrapper~~.~~dll~~
	~~:::*utlibr~~.~~dll~~
	</onlyinclude>		</onlyinclude>
	====Examples====		====Examples====
	Sample applications that you can test and tweak yourself are included with the ReliaSoft installation. The files are stored on your computer at C:\Users\Public\Public Documents\ReliaSoft\~~Examples19~~\API.		Sample applications that you can test and tweak yourself are included with the ReliaSoft installation. The files are stored on your computer at C:\Users\Public\Public Documents\ReliaSoft\Examples23\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].)		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].)

Lisa Hacker: Removed protection from "ReliaSoft API Reference"

2023-02-01T21:15:04Z

Removed protection from "ReliaSoft API Reference"

← Older revision	Revision as of 21:15, 1 February 2023
(No difference)

David J. Groebel: moved Synthesis API Reference to ReliaSoft API Reference: Remove reference to "Synthesis"

2019-03-14T16:56:08Z

moved Synthesis API Reference to ReliaSoft API Reference: Remove reference to "Synthesis"

← Older revision	Revision as of 16:56, 14 March 2019
(No difference)

David J. Groebel at 15:50, 14 March 2019

2019-03-14T15:50:00Z

← Older revision		Revision as of 15:50, 14 March 2019
Line 24:		Line 24:
	:The ReliaSoft API consists of a library file that contains the classes, methods and events that provide access to ReliaSoft applications. The file is located in the folder where the ReliaSoft desktop applications are installed. By default, this folder is at "C:\Program Files\ReliaSoft\ReliaSoft 2019." As of Version 2019, the library names are now version dependent. For VBA, you will use the '''ReliaSoftAPI19.tlb''' file; for .NET applications, you will use the '''ReliaSoftAPI19.dll''' file. Prior to Version 2019, the files to use were SynthesisAPI.tlb (VBA) and SynthesisAPI.dll (.NET).		:The ReliaSoft API consists of a library file that contains the classes, methods and events that provide access to ReliaSoft applications. The file is located in the folder where the ReliaSoft desktop applications are installed. By default, this folder is at "C:\Program Files\ReliaSoft\ReliaSoft 2019." As of Version 2019, the library names are now version dependent. For VBA, you will use the '''ReliaSoftAPI19.tlb''' file; for .NET applications, you will use the '''ReliaSoftAPI19.dll''' file. Prior to Version 2019, the files to use were SynthesisAPI.tlb (VBA) and SynthesisAPI.dll (.NET).

	:To obtain the latest version of the library file and the ReliaSoft applications, choose '''File > Help > Check for Updates''' or download the latest version from the [https://support.hbmprenscia.com Support Portal].		:To obtain the latest version of the library file and the ReliaSoft applications, choose '''File > Help > Check for Updates''' or download the latest version from the [https://support.hbmprenscia.com HBM Prenscia Support Portal].

	*'''Build environment'''		*'''Build environment'''

David J. Groebel at 15:49, 14 March 2019

2019-03-14T15:49:37Z

← Older revision		Revision as of 15:49, 14 March 2019
Line 24:		Line 24:
	:The ReliaSoft API consists of a library file that contains the classes, methods and events that provide access to ReliaSoft applications. The file is located in the folder where the ReliaSoft desktop applications are installed. By default, this folder is at "C:\Program Files\ReliaSoft\ReliaSoft 2019." As of Version 2019, the library names are now version dependent. For VBA, you will use the '''ReliaSoftAPI19.tlb''' file; for .NET applications, you will use the '''ReliaSoftAPI19.dll''' file. Prior to Version 2019, the files to use were SynthesisAPI.tlb (VBA) and SynthesisAPI.dll (.NET).		:The ReliaSoft API consists of a library file that contains the classes, methods and events that provide access to ReliaSoft applications. The file is located in the folder where the ReliaSoft desktop applications are installed. By default, this folder is at "C:\Program Files\ReliaSoft\ReliaSoft 2019." As of Version 2019, the library names are now version dependent. For VBA, you will use the '''ReliaSoftAPI19.tlb''' file; for .NET applications, you will use the '''ReliaSoftAPI19.dll''' file. Prior to Version 2019, the files to use were SynthesisAPI.tlb (VBA) and SynthesisAPI.dll (.NET).

	:To obtain the latest version of the library file and the ReliaSoft applications, choose '''File > Help > Check for Updates''' or download the latest version from the ~~Support Portal at~~ https://support.hbmprenscia.com.		:To obtain the latest version of the library file and the ReliaSoft applications, choose '''File > Help > Check for Updates''' or download the latest version from the [https://support.hbmprenscia.com Support Portal].

	*'''Build environment'''		*'''Build environment'''