Repository Class

Member of: SynthesisAPI

Represents a Synthesis repository. Use any of the first four methods to establish a connection to a Synthesis repository. Once you have a connection, you can use the methods in the Project, Unit, Model, etc. sections to read and write data to the repository.

Constructors

Name	Description
Repository	Creates an instance of the Repository class.

Methods

Name	Description
ConnectToRepository	Connects to a standard or enterprise repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
ConnectToAccessRepository	Connects to a standard repository (cannot be used to connect to an enterprise repository). Returns a Boolean value; when true, indicates a successful connection to the repository.
ConnectToSQLRepository	Connects to a SQL Server repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
ConnectToOracleRepository	Connects to an Oracle repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
DisconnectFromRepository	Disconnects from the current repository.

Project

Name	Description
Project.GetAllProjects	Returns an array of NameIDPair objects that represent the name and ID pairs of the projects associated with the Repository object.
Project.GetCurrentProject	Returns a NameIDPair object that represents the name and ID pair of the current project.
Project.SetCurrentProject	Sets the current (active) project for the repository. Returns a Boolean value; when true, indicates a successful connection to that project.

Unit

Name	Description
Unit.GetAllUnits	Returns an array of UnitInfo objects that represent the units of measurement associated with the Repository object.

Model

Name	Description
Model.GetAllModels	Returns an array of cModel objects that represent the model resources in the current project.
Model.AddModel	Adds a new model resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Model.UpdateModel	Updates the properties of a given model resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Model.GetModel	Returns a cModel object that represents a given model resource in the current project. Returns nothing if the model does not exist or is not in the current project.*
Model.IsModelUsed	Checks whether the model is used by other items in the project. Returns a Boolean value; when true, indicates that the model is in use.*
Model.DeleteModel	Deletes an unused model from the current project. Throws an exception if the model is in use. Returns a Boolean value; when true, indicates a successful deletion.*
Model.GetAllModelsInfo	This method has been deprecated, but remains as part of the object model for backward compatibility. Do not use it in new applications.

URD

Name	Description
URD.GetAllURDs	Returns an array of cURD objects that represent the universal reliability definitions (URDs) in the current project.
URD.AddURD	Adds a new universal reliability definition (URD) resource to the current project. Returns a Boolean value; when true, indicates a successful save.
URD.UpdateURD	Updates the properties of a given URD resource in the current project. Returns a Boolean value; when true, indicates a successful update.
URD.GetURD	Returns a cURD object that represents a given URD resource in the current project. Returns nothing if the URD does not exist or is not in the current project.

Variable

Name	Description
Variables.GetAllVariables	Returns an array of cVariable objects that represent the variable resources in the current project.
Variables.AddVariable	Adds a new variable resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Variables.UpdateVariable	Updates the properties of a given variable resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Variables.GetVariable	Returns a cVariable object that represents a given variable resource in the current project. Returns nothing if the variable does not exist or is not in the current project.*

Task

Name	Description
Task.GetAllCorrectiveTasks	Returns an array of cCorrectiveTask objects that represent the corrective tasks in the current project.
Task.AddCorrectiveTask	Adds a new corrective task to the current project. Returns a Boolean value; when true, indicates a successful save.
Task.UpdateCorrectiveTask	Updates the properties of a given corrective task in the current project. Returns a Boolean value; when true, indicates a successful update.
Task.GetCorrectiveTask	Returns a cCorrectiveTask object that represents a given corrective task resource in the current project. Returns nothing if the task does not exist or is not in the current project.*
Task.GetAllScheduledTasks	Returns an array of cScheduledTask objects that represent the scheduled tasks in the current project.
Task.AddScheduledTask	Adds a new scheduled task to the current project. Returns a Boolean value; when true, indicates a successful save.
Task.UpdateScheduledTask	Updates the properties of a given scheduled task in the current project. Returns a Boolean value; when true, indicates a successful update.
Task.GetScheduledTask	Returns a cScheduledTask object that represents a given scheduled task resource in the current project. Returns nothing if the task does not exist or is not in the current project.*
Task.GetAllTaskTypes	Returns an array of TaskTypeInfo objects that represent the RCM++ or RBI task types associated with the Repository object.

Crew

Name	Description
Crew.GetAllCrews	Returns an array of cCrew objects that represent the crew resources in the current project.
Crew.AddCrew	Adds a new crew resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Crew.UpdateCrew	Updates the properties of a given crew resource in the current project. Returns a Boolean value; when true, indicates a successful save.
Crew.GetCrew	Returns a cCrew object that represents a given crew resource in the current project. Returns nothing if the crew does not exist or is not in the current project.*

Pool

Name	Description
Pool.GetAllPools	Returns an array of cPool objects that represent the spare part pools in the current project.
Pool.AddPool	Adds a new spare part pool to the current project. Returns a Boolean value; when true, indicates indicates a successful save.
Pool.UpdatePool	Updates the properties of a given spare part pool in the current project. Returns a Boolean value; when true, indicates a successful update.
Pool.GetPool	Returns a cPool object that represents a given spare part pool resource in the current project. Returns nothing if the spare part pool does not exist or is not in the current project.*

Action

Name	Description
Action.GetAllActionsDictionary	Returns a dictionary object that contains all available action resources in the current project. The dictionary syntax is Dictionary(Of Integer, cAction), where the ID numbers are the keys and the cAction objects that represent the action resources are the associated values. (.NET only) *
Action.GetAllActions	Returns an array of cAction objects that represent the action resources in the current project.
Action.AddAction	Adds a new action to the current project. The action description or name must be unique. Returns a Boolean value; when true, indicates a successful save.
Action.UpdateAction	Updates the properties of a given action resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Action.GetAction	Returns a cAction object that represents a given action resource in the current project. Returns nothing if the action does not exist or is not in the current project.*

Control

Name	Description
Control.GetAllXfmeaControlsDictionary	Returns a dictionary object that contains all available Xfmea controls in the current project. The dictionary syntax is Dictionary (Of Integer, cXfmeaControl), where the ID numbers are the keys and the cXfmeaControl objects that represent the controls are the associated values. (.NET only)*
Control.GetAllXfmeaControls	Returns an array of cXfmeaControl objects that represent the Xfmea controls in the current project.*
Control.AddXfmeaControl	Adds a new Xfmea control to the current project. Returns a Boolean value; when true, indicates a successful save.*
Control.UpdateXfmeaControl	Updates the properties of a given control resource in the current project. Returns a Boolean value; when true, indicates a successful update.*
Control.GetXfmeaControl	Returns a cXfmeaControl object that represents a given control resource in the current project. Returns nothing if the control does not exist or is not in the current project.*

BlockSim

Name	Description
BlockSim.ImportBlockSimXMLFile	Imports data from an XML file into the current BlockSim project. Returns a Boolean value; when true, indicates a successful import.
BlockSim.ExportBlockSimXMLFile	Exports data from the current BlockSim project to a new XML file. Returns a Boolean value; when true, indicates a successful export.

DataWarehouse

Name	Description
DataWarehouse.SaveRawDataSet	Adds a new Synthesis Data Warehouse (SDW) data collection to the associated Repository object. Returns a Boolean value; when true, indicates a successful save.

XFRACAS

Name	Description
XFRACAS.GetAllXFRACASEntities
XFRACAS.ImportXFRACASXML	Uploads an import file byte stream for processing and returns the system ID of the uploaded byte array.
XFRACAS.ImportXFRACASXMLFile	Uploads an import file for processing and returns the system ID of the uploaded XML file.
XFRACAS.ImportXFRACASXMLString	Uploads an import file string for processing and returns the system ID of the uploaded XML string.
XFRACAS.SerializeXMLObjectToByteArray	A helper function to create an array of bytes from a serializable XML object.
XFRACAS.ProcessXfracasImports	Runs the import process.
XFRACAS.WriteMessageToDiagnosticsLog	Writes a message to the diagnostics log
XFRACAS.WriteExceptionToDiagnosticsLog	Writes exception information to the diagnostics log
XFRACAS.XFRACASCommandTimeout	Gets or sets the wait time before terminating the attempt to execute an XFRACAS command. *
XFRACAS.AddSystemMetric1	This can be used to insert reported run hours and the date of the reported run hours. *
XFRACAS.AddSystemMetric2	This can be used to insert reported run hours, number of starts, and the date. *
XFRACAS.AddSystemMetric3	This can be used to insert reported run hours, number of starts, kw run hours, and the date. *

Xfmea

Name	Description
Xfmea.GetAllItemsInSystemHierarchyDictionary	Returns a dictionary object that contains all available system hierarchy items in the current project. The dictionary syntax is Dictionary(Of Integer, XfmeaItem), where the ID numbers are the keys, and the XfmeaItem objects that represent the system hierarchy items are the associated values. (.NET only) *
Xfmea.GetAllItemsInSystemHierarchy	Returns an array of XfmeaItem objects that represent the system hierarchy items in the current project. *
Xfmea.AddItemToSystemHierarchy	Adds a new system hierarchy item to the current project. Returns a Boolean value; when true, indicates a successful save. *
Xfmea.UpdateItemInSystemHierarchy	Updates the properties of a given system hierarchy item in the current project. Returns a Boolean value; when true, indicates a successful update. *
Xfmea.GetAllXfmeaFunctionsDictionary	Returns a dictionary containing all XfmeaFunctions that belong to the item. The keys are the IDs of the XfmeaFunctions. *
Xfmea.GetAllXfmeaFunctions	Returns an array containing all XfmeaFunctions that belong to the item. *
Xfmea.GetXfmeaFunction	Returns XfmeaFunction with the provided ID. *
Xfmea.AddXfmeaFunction	Adds a new XfmeaFunction in the repository. *
Xfmea.UpdateXfmeaFunction	Updates the XfmeaFunction in the repository. *
Xfmea.GetAllXfmeaFailuresDictionary	Returns a dictionary containing all XfmeaFailures that belong to the function. The keys are the IDs of the XfmeaFailures. *
Xfmea.GetAllXfmeaFailures	Returns an array containing all XfmeaFailures that belong to the function. *
Xfmea.GetXfmeaFailure	Returns XfmeaFailure with the provided ID. *
Xfmea.AddXfmeaFailure	Adds a new XfmeaFailure in the repository. *
Xfmea.UpdateXfmeaFailure	Updates the XfmeaFailure in the repository. *
Xfmea.GetAllXfmeaEffectsDictionary	Returns a dictionary containing all XfmeaEffects that belong to the failure. The keys are the IDs of the XfmeaEffects. *
Xfmea.GetAllXfmeaEffects	Returns an array containing all XfmeaEffects that belong to the failure. *
Xfmea.GetXfmeaEffect	Returns XfmeaEffect with the provided ID. *
Xfmea.AddXfmeaEffect	Adds a new XfmeaEffect in the repository. *
Xfmea.UpdateXfmeaEffect	Updates the XfmeaEffect in the repository. *
Xfmea.GetAllXfmeaCausesDictionary	Returns a dictionary containing all XfmeaCauses that belong to the failure. The keys are the IDs of the XfmeaCauses. *
Xfmea.GetAllXfmeaCauses	Returns an array containing all XfmeaCauses that belong to the failure. *
Xfmea.GetXfmeaCause	Returns XfmeaCause with the provided ID. *
Xfmea.AddXfmeaCause	Adds a new XfmeaCause in the repository. *
Xfmea.UpdateXfmeaCause	Updates the XfmeaCause in the repository. *

Properties

Name

Description

EnforceRENOCompliance

Template:InProgress Member of: SynthesisAPI Represents a Synthesis repository. Use any of the first four methods to establish a connection to a Synthesis repository. Once you have a connection, you can use the methods in the Project, Unit, Model, etc. sections to read and write data to the repository. Constructors Name Description Repository Creates an instance of the Repository class. Methods Name Description ConnectToRepository Connects to a standard or enterprise repository. Returns a Boolean value; when true, indicates a successful connection to the repository. ConnectToAccessRepository Connects to a standard repository (cannot be used to connect to an enterprise repository). Returns a Boolean value; when true, indicates a successful connection to the repository. ConnectToSQLRepository Connects to a SQL Server repository. Returns a Boolean value; when true, indicates a successful connection to the repository. ConnectToOracleRepository Connects to an Oracle repository. Returns a Boolean value; when true, indicates a successful connection to the repository. DisconnectFromRepository Disconnects from the current repository. Project Name Description Project.GetAllProjects Returns an array of NameIDPair objects that represent the name and ID pairs of the projects associated with the Repository object. Project.GetCurrentProject Returns a NameIDPair object that represents the name and ID pair of the current project. Project.SetCurrentProject Sets the current (active) project for the repository. Returns a Boolean value; when true, indicates a successful connection to that project. Unit Name Description Unit.GetAllUnits Returns an array of UnitInfo objects that represent the units of measurement associated with the Repository object. Model Name Description Model.GetAllModels Returns an array of cModel objects that represent the model resources in the current project. Model.AddModel Adds a new model resource to the current project. Returns a Boolean value; when true, indicates a successful save. Model.UpdateModel Updates the properties of a given model resource in the current project. Returns a Boolean value; when true, indicates a successful update. Model.GetModel Returns a cModel object that represents a given model resource in the current project. Returns nothing if the model does not exist or is not in the current project.* Model.IsModelUsed Checks whether the model is used by other items in the project. Returns a Boolean value; when true, indicates that the model is in use.* Model.DeleteModel Deletes an unused model from the current project. Throws an exception if the model is in use. Returns a Boolean value; when true, indicates a successful deletion.* Model.GetAllModelsInfo This method has been deprecated, but remains as part of the object model for backward compatibility. Do not use it in new applications. URD Name Description URD.GetAllURDs Returns an array of cURD objects that represent the universal reliability definitions (URDs) in the current project. URD.AddURD Adds a new universal reliability definition (URD) resource to the current project. Returns a Boolean value; when true, indicates a successful save. URD.UpdateURD Updates the properties of a given URD resource in the current project. Returns a Boolean value; when true, indicates a successful update. URD.GetURD Returns a cURD object that represents a given URD resource in the current project. Returns nothing if the URD does not exist or is not in the current project. Variable Name Description Variables.GetAllVariables Returns an array of cVariable objects that represent the variable resources in the current project. Variables.AddVariable Adds a new variable resource to the current project. Returns a Boolean value; when true, indicates a successful save. Variables.UpdateVariable Updates the properties of a given variable resource in the current project. Returns a Boolean value; when true, indicates a successful update. Variables.GetVariable Returns a cVariable object that represents a given variable resource in the current project. Returns nothing if the variable does not exist or is not in the current project.* Task Name Description Task.GetAllCorrectiveTasks Returns an array of cCorrectiveTask objects that represent the corrective tasks in the current project. Task.AddCorrectiveTask Adds a new corrective task to the current project. Returns a Boolean value; when true, indicates a successful save. Task.UpdateCorrectiveTask Updates the properties of a given corrective task in the current project. Returns a Boolean value; when true, indicates a successful update. Task.GetCorrectiveTask Returns a cCorrectiveTask object that represents a given corrective task resource in the current project. Returns nothing if the task does not exist or is not in the current project.* Task.GetAllScheduledTasks Returns an array of cScheduledTask objects that represent the scheduled tasks in the current project. Task.AddScheduledTask Adds a new scheduled task to the current project. Returns a Boolean value; when true, indicates a successful save. Task.UpdateScheduledTask Updates the properties of a given scheduled task in the current project. Returns a Boolean value; when true, indicates a successful update. Task.GetScheduledTask Returns a cScheduledTask object that represents a given scheduled task resource in the current project. Returns nothing if the task does not exist or is not in the current project.* Task.GetAllTaskTypes Returns an array of TaskTypeInfo objects that represent the RCM++ or RBI task types associated with the Repository object. Crew Name Description Crew.GetAllCrews Returns an array of cCrew objects that represent the crew resources in the current project. Crew.AddCrew Adds a new crew resource to the current project. Returns a Boolean value; when true, indicates a successful save. Crew.UpdateCrew Updates the properties of a given crew resource in the current project. Returns a Boolean value; when true, indicates a successful save. Crew.GetCrew Returns a cCrew object that represents a given crew resource in the current project. Returns nothing if the crew does not exist or is not in the current project.* Pool Name Description Pool.GetAllPools Returns an array of cPool objects that represent the spare part pools in the current project. Pool.AddPool Adds a new spare part pool to the current project. Returns a Boolean value; when true, indicates indicates a successful save. Pool.UpdatePool Updates the properties of a given spare part pool in the current project. Returns a Boolean value; when true, indicates a successful update. Pool.GetPool Returns a cPool object that represents a given spare part pool resource in the current project. Returns nothing if the spare part pool does not exist or is not in the current project.* Action Name Description Action.GetAllActionsDictionary Returns a dictionary object that contains all available action resources in the current project. The dictionary syntax is Dictionary(Of Integer, cAction), where the ID numbers are the keys and the cAction objects that represent the action resources are the associated values. (.NET only) * Action.GetAllActions Returns an array of cAction objects that represent the action resources in the current project. Action.AddAction Adds a new action to the current project. The action description or name must be unique. Returns a Boolean value; when true, indicates a successful save. Action.UpdateAction Updates the properties of a given action resource in the current project. Returns a Boolean value; when true, indicates a successful update. Action.GetAction Returns a cAction object that represents a given action resource in the current project. Returns nothing if the action does not exist or is not in the current project.* Control Name Description Control.GetAllXfmeaControlsDictionary Returns a dictionary object that contains all available Xfmea controls in the current project. The dictionary syntax is Dictionary (Of Integer, cXfmeaControl), where the ID numbers are the keys and the cXfmeaControl objects that represent the controls are the associated values. (.NET only)* Control.GetAllXfmeaControls Returns an array of cXfmeaControl objects that represent the Xfmea controls in the current project.* Control.AddXfmeaControl Adds a new Xfmea control to the current project. Returns a Boolean value; when true, indicates a successful save.* Control.UpdateXfmeaControl Updates the properties of a given control resource in the current project. Returns a Boolean value; when true, indicates a successful update.* Control.GetXfmeaControl Returns a cXfmeaControl object that represents a given control resource in the current project. Returns nothing if the control does not exist or is not in the current project.* BlockSim Name Description BlockSim.ImportBlockSimXMLFile Imports data from an XML file into the current BlockSim project. Returns a Boolean value; when true, indicates a successful import. BlockSim.ExportBlockSimXMLFile Exports data from the current BlockSim project to a new XML file. Returns a Boolean value; when true, indicates a successful export. DataWarehouse Name Description DataWarehouse.SaveRawDataSet Adds a new Synthesis Data Warehouse (SDW) data collection to the associated Repository object. Returns a Boolean value; when true, indicates a successful save. XFRACAS Name Description XFRACAS.GetAllXFRACASEntities XFRACAS.ImportXFRACASXML Uploads an import file byte stream for processing and returns the system ID of the uploaded byte array. XFRACAS.ImportXFRACASXMLFile Uploads an import file for processing and returns the system ID of the uploaded XML file. XFRACAS.ImportXFRACASXMLString Uploads an import file string for processing and returns the system ID of the uploaded XML string. XFRACAS.SerializeXMLObjectToByteArray A helper function to create an array of bytes from a serializable XML object. XFRACAS.ProcessXfracasImports Runs the import process. XFRACAS.WriteMessageToDiagnosticsLog Writes a message to the diagnostics log XFRACAS.WriteExceptionToDiagnosticsLog Writes exception information to the diagnostics log XFRACAS.XFRACASCommandTimeout Gets or sets the wait time before terminating the attempt to execute an XFRACAS command. * XFRACAS.AddSystemMetric1 This can be used to insert reported run hours and the date of the reported run hours. * XFRACAS.AddSystemMetric2 This can be used to insert reported run hours, number of starts, and the date. * XFRACAS.AddSystemMetric3 This can be used to insert reported run hours, number of starts, kw run hours, and the date. * Xfmea Name Description Xfmea.GetAllItemsInSystemHierarchyDictionary Returns a dictionary object that contains all available system hierarchy items in the current project. The dictionary syntax is Dictionary(Of Integer, XfmeaItem), where the ID numbers are the keys, and the XfmeaItem objects that represent the system hierarchy items are the associated values. (.NET only) * Xfmea.GetAllItemsInSystemHierarchy Returns an array of XfmeaItem objects that represent the system hierarchy items in the current project. * Xfmea.AddItemToSystemHierarchy Adds a new system hierarchy item to the current project. Returns a Boolean value; when true, indicates a successful save. * Xfmea.UpdateItemInSystemHierarchy Updates the properties of a given system hierarchy item in the current project. Returns a Boolean value; when true, indicates a successful update. * Xfmea.GetAllXfmeaFunctionsDictionary Returns a dictionary containing all XfmeaFunctions that belong to the item. The keys are the IDs of the XfmeaFunctions. * Xfmea.GetAllXfmeaFunctions Returns an array containing all XfmeaFunctions that belong to the item. * Xfmea.GetXfmeaFunction Returns XfmeaFunction with the provided ID. * Xfmea.AddXfmeaFunction Adds a new XfmeaFunction in the repository. * Xfmea.UpdateXfmeaFunction Updates the XfmeaFunction in the repository. * Xfmea.GetAllXfmeaFailuresDictionary Returns a dictionary containing all XfmeaFailures that belong to the function. The keys are the IDs of the XfmeaFailures. * Xfmea.GetAllXfmeaFailures Returns an array containing all XfmeaFailures that belong to the function. * Xfmea.GetXfmeaFailure Returns XfmeaFailure with the provided ID. * Xfmea.AddXfmeaFailure Adds a new XfmeaFailure in the repository. * Xfmea.UpdateXfmeaFailure Updates the XfmeaFailure in the repository. * Xfmea.GetAllXfmeaEffectsDictionary Returns a dictionary containing all XfmeaEffects that belong to the failure. The keys are the IDs of the XfmeaEffects. * Xfmea.GetAllXfmeaEffects Returns an array containing all XfmeaEffects that belong to the failure. * Xfmea.GetXfmeaEffect Returns XfmeaEffect with the provided ID. * Xfmea.AddXfmeaEffect Adds a new XfmeaEffect in the repository. * Xfmea.UpdateXfmeaEffect Updates the XfmeaEffect in the repository. * Xfmea.GetAllXfmeaCausesDictionary Returns a dictionary containing all XfmeaCauses that belong to the failure. The keys are the IDs of the XfmeaCauses. * Xfmea.GetAllXfmeaCauses Returns an array containing all XfmeaCauses that belong to the failure. * Xfmea.GetXfmeaCause Returns XfmeaCause with the provided ID. * Xfmea.AddXfmeaCause Adds a new XfmeaCause in the repository. * Xfmea.UpdateXfmeaCause Updates the XfmeaCause in the repository. * Properties Name Description EnforceRENOCompliance Version Information Methods and properties marked with an asterisk (*) require Synthesis API Version 10 or greater. Important: If you have upgraded from Version 9 and have existing code written using Synthesis API version 9, you should modify your code. In Version 9, all methods existed in the Repository class, in Version 10 they were moved into sections, according to the object type they apply to. For instance, Repository.GetAllModels is now Repository.Model.GetAllModels; Repository.ImportBlockSimXMLFile is now Repository.BlockSim.ImportBlockSimXMLFile etc. The Version 9 methods still exist so your code is not broken, but they are deprecated and may be removed in future versions of the API.

Version Information

Methods and properties marked with an asterisk (*) require Synthesis API Version 10 or greater.

Important: If you have upgraded from Version 9 and have existing code written using Synthesis API version 9, you should modify your code. In Version 9, all methods existed in the Repository class, in Version 10 they were moved into sections, according to the object type they apply to. For instance, Repository.GetAllModels is now Repository.Model.GetAllModels; Repository.ImportBlockSimXMLFile is now Repository.BlockSim.ImportBlockSimXMLFile etc. The Version 9 methods still exist so your code is not broken, but they are deprecated and may be removed in future versions of the API.