ReliaWiki - User contributions [en]

User:Mross

2017-09-07T23:28:18Z

Mross: Initial page creation.

Software Engineer

CURD.GetScheduledTaskIDs Method

2017-08-17T21:28:14Z

Mross: Change VB.NET to .NET.

{{DISPLAYTITLE:cURD.GetScheduledTaskIDs Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[CURD_Class|cURD]]}}

<onlyinclude>Returns an array containing the numeric IDs of of the scheduled tasks assigned to the URD. '''Long'''.</onlyinclude>

'''Remarks''': Alternatively, .NET users can use the <code>ScheduledTaskIDs()</code> property in the class to get or set the task IDs.

== Syntax ==
'''.GetScheduledTaskIDs'''(''arr()'')

===Parameters===
''arr()''
:Required. Long. An array of the numeric IDs of the scheduled tasks assigned to the URD.

== Example ==
'''VBA'''

{{APIComment|...}}

{{APIComment|'Add code to get an existing URD.}}
{{APIPrefix|Dim}} aURD {{APIPrefix|As}} cURD
{{APIComment|...}}

{{APIComment|'Get the IDs of the tasks assigned to the URD.}}
{{APIPrefix|Dim}} myarray() {{APIPrefix|As Long}}
{{APIPrefix|Call}} aURD.GetScheduledTaskIDs(myarray)

{{APIComment|'Sample output.}}
{{APIPrefix|Dim}} i {{APIPrefix|As Integer}}
{{APIPrefix|Dim}} upper {{APIPrefix|As Integer}}
{{APIPrefix|Dim}} lower {{APIPrefix|As Integer}}

lower = {{APIPrefix|LBound}}(myarray)
upper = {{APIPrefix|UBound}}(myarray)

{{APIPrefix|For}} i = lower {{APIPrefix|To}} upper
MsgBox (myarray(i))
{{APIPrefix|Next}} i

CScheduledTask.SetCrewIDs Method

2017-08-17T21:28:04Z

Mross: Change VB.NET to .NET.

{{DISPLAYTITLE:cScheduledTask.SetCrewIDs Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[CScheduledTask_Class|cScheduledTask]]}}

<onlyinclude>Assigns crews to the task. </onlyinclude>

'''Remarks''': Alternatively, .NET users can use the <code>CrewIDs()</code> property in the class to get or set the crew IDs.

== Syntax ==
'''.SetCrewIDs'''(''arr()'')

===Parameters===
''arr()''
:Required. Long. An array of the numeric IDs of the crews to be assigned to the task.

== Example ==
This example assumes that the repository contains existing crews.
'''VBA'''

{{APIComment|...}}

{{APIComment|'Add code to create a new task or get an existing task.}}
{{APIPrefix|Dim}} aTask {{APIPrefix|As}} cScheduledTask
{{APIComment|...}}

{{APIComment|'Create an array and define the crews to be assigned. For this example,}}
{{APIComment|'assume that crew ID#2 and ID#4 are to be assigned to the task.}}
{{APIPrefix|Dim}} myarray(1) {{APIPrefix|As Long}}
myarray(0) = 2
myarray(1) = 4

{{APIComment|'Assign the crews to the task.}}
{{APIPrefix|Call}} aTask.SetCrewIDs(myarray)

CScheduledTask.GetCrewIDs Method

2017-08-17T21:23:50Z

Mross: Change VB.NET to .NET.

{{DISPLAYTITLE:cScheduledTask.GetCrewIDs Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[CScheduledTask_Class|cScheduledTask]]}}

<onlyinclude>Returns an array containing the numeric IDs of the crews assigned to the task. '''Long'''.</onlyinclude>

'''Remarks''': Alternatively, .NET users can use the <code>CrewIDs()</code> property in the class to get or set the crew IDs.

== Syntax ==
'''.GetCrewIDs'''(''arr()'')

===Parameters===
''arr()''
:Required. Long. An array of the numeric IDs of the crews assigned to the task.

== Example ==
'''VBA'''

{{APIComment|...}}

{{APIComment|'Add code to get an existing scheduled task.}}
{{APIPrefix|Dim}} aTask {{APIPrefix|As}} cScheduledTask
{{APIComment|...}}

{{APIComment|'Get the IDs of the crews assigned to the task.}}
{{APIPrefix|Dim}} myarray() {{APIPrefix|As Long}}
{{APIPrefix|Call}} aTask.GetCrewIDs(myarray)

{{APIComment|'Sample output.}}
{{APIPrefix|Dim}} i {{APIPrefix|As Integer}}
{{APIPrefix|Dim}} upper {{APIPrefix|As Integer}}
{{APIPrefix|Dim}} lower {{APIPrefix|As Integer}}

lower = {{APIPrefix|LBound}}(myarray)
upper = {{APIPrefix|UBound}}(myarray)

{{APIPrefix|For}} i = lower {{APIPrefix|To}} upper
MsgBox (myarray(i))
{{APIPrefix|Next}} i

CURD.SetScheduledTaskIDs Method

2017-08-17T21:22:41Z

Mross: Change VB.NET to .NET.

{{DISPLAYTITLE:cURD.SetScheduledTaskIDs Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[CURD_Class|cURD]]}}

<onlyinclude>Assigns scheduled tasks to the URD.</onlyinclude>

'''Remarks''': Alternatively, .NET users can use the <code>ScheduledTaskIDs()</code> property in the class to get or set the task IDs.

== Syntax ==
'''.SetScheduledTaskIDs'''(''arr()'')

===Parameters===
''arr()''
:Required. Long. An array of the numeric IDs of the scheduled tasks to be assigned to the URD.

== Example ==
This example assumes that the repository contains existing tasks.
'''VBA'''

{{APIComment|...}}

{{APIComment|'Add code to create a new URD or get an existing URD.}}
{{APIPrefix|Dim}} aURD {{APIPrefix|As}} cURD
{{APIComment|...}}

{{APIComment|'Create an array and define the tasks to be assigned. For this example,}}
{{APIComment|'assume that task ID#2 and ID#4 are to be assigned to the URD.}}
{{APIPrefix|Dim}} myarray(1) {{APIPrefix|As Long}}
myarray(0) = 2
myarray(1) = 4

{{APIComment|'Assign the tasks to the URD.}}
{{APIPrefix|Call}} aURD.SetScheduledTaskIDs(myarray)

ReliaSoft API Reference

2017-08-03T22:52:14Z

Mross:

{{Template:API}}

<div style="border:1px solid #D0CDE8; background:#EEEDF7; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em; float:right;">
*'''[[API Changelog|Changelog]]'''
*'''[[API Reference Documentation|API Documentation]]
*'''[[API Tutorials|Tutorials]]
</div>

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==
*'''Getting the latest version'''
:The Synthesis API consists of a library file that contains the classes, methods and events that provide access to Synthesis applications. 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.

*'''32- vs. 64-bit'''
:For VBA, the bit version 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 Visual Studio projects targeting the .NET Framework 4.5 and compiled to run an any platform (Any CPU), turn off the '''Prefer 32-bit''' property of the build configuration if you want to run a 64-bit application as a 64-bit application; otherwise, the application will run as a 32-bit application on both 32- and 64-bit versions of Windows.

*'''Running API applications on a server
:If you plan to run the API on a Windows server, 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 http://www.synthesisplatform.net/reliasoft_api_ante_service.htm.

*'''Access to calculations functionality
:Access to Weibull++'s and ALTA’s analysis and plotting engines require a Synthesis API license. To obtain a license, please [http://www.reliasoft.com/contact.htm contact ReliaSoft].

==Getting Started==

====Referencing the Synthesis API Library File====

<onlyinclude>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 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'''.
:#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
:::*msvcp110.dll
:::*msvcr110.dll
:::*RSDB.dll
:::*RSLM8nCodeDotNetWrapper.dll
:::*utlibr.dll
</onlyinclude>
====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\Examples11\API. (For Version 10, see C:\Users\Public\Public Documents\ReliaSoft\Examples10\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].)

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

==Object Library ==
Below is a summary of the core objects in the Synthesis API library. For an alphabetical listing of all objects in the latest version, see [[API Reference Documentation]]. (Click [[API Reference Documentation 10| here]] for the list of objects in Version 10.)

*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>'''[[CProfile Class|cProfile]]'''</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 to 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.

ReliaSoft API Reference

2017-08-03T22:52:05Z

Mross: