Talk:Synthesis API Reference/Notes: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
(Replaced content with '=DRAFT=')
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div style="border:1px solid #D0CDE8; background:#EEEDF7; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em; float:right;">
=DRAFT=
*'''[[API Changelog]]'''
*'''[[Full Synthesis API|Documentation]]
</div>
 
The Synthesis Platform’s ''Application Programming Interface (API)'' enables you to programmatically connect your Synthesis applications and data with other systems and tools used within your organization. The API is written for Visual Basic for Applications (VBA) and Visual Basic.NET. This gives you the ability to create automated solutions using popular Microsoft Office applications, such as Excel and PowerPoint, as well as create custom applications for your organization.
 
'''Transfer and synchronize data via XML'''
 
For structured data (such as system hierarchies/BOMs, incidents and work orders) you can use XML files and the API to manage data transfer and synchronization between XFRACAS and variety of different PLMs, ERPs, CMMS and other external systems. You can also use XML files to create reliability block diagrams diagrams (RBDs) in BlockSim.
 
'''Input/output specific data elements and analyses'''
 
With the Synthesis API, you can read from 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).
 
'''Obtain calculated results'''
 
You can use the Synthesis API to read data from published Synthesis models and obtain calculated results such as the reliability, probability of failure, BX% life, failure rate and mean time.
 
==Getting Started==
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. See [[API Tutorials]].
 
In addition, 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. To learn how, see this [http://office.microsoft.com/en-us/excel-help/enable-or-disable-macros-in-office-documents-HA010031071.aspx Microsoft article].)
 
Here are some requirements to keep in mind before you begin developing for the Synthesis API.
 
* 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.
 
: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 VB.NET applications, use SynthesisAPI.dll.
 
:For help with referencing the library, see this simple [[Referencing_an_Object_Library|How-To Guide]].
 
==Object Library==
Below are the core objects in the Synthesis API library. For an alphabetical listing of all classes and enumerations in the object library, see [[Full Synthesis API]].
 
*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. The class also contains the functions for importing/exporting XML files.
 
*The following objects represent the Synthesis resources. Creating one of these objects will instantiate a Synthesis resource that contains the properties for that particular type of resource. In addition, the cModel class provides methods that enable you to obtain calculated results from a model, such as reliability, probability of failure, etc.
**<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 collections for the SDW: <code>'''[[RawData Class|RawData]]'''</code> represents a single data point, while the <code>'''[[RawDataSet Class|RawDataSet]]'''</code> serves as the data container for the RawData 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.Creating one of these objects will instantiate an FMEA record that contains the properties for that particular type of record.
**<code>'''[[XfmeaFunction Class|XfmeaFunction]]'''</code>
**<code>'''[[XfmeaCause Class|XfmeaCause]]'''</code>
**<code>'''[[XfmeaEffect Class|XfmeaEffect]]'''</code>
**<code>'''[[XfmeaFailure Class|XfmeaFailure]]'''</code>

Latest revision as of 21:14, 30 March 2017

DRAFT

Retrieved from "https://www.reliawiki.com/index.php?title=Talk:Synthesis_API_Reference/Notes&oldid=65022"