Repository Class

From ReliaWiki

Jump to: navigation, search


Member of: SynthesisAPI
Other Versions: Version 10


Represents a Synthesis repository.


Remarks: Use any of the first four methods to establish a connection to a Synthesis repository. Once you have a connection, you can use any of the rest of the methods to read/write data to the repository.

Constructors

Name Description
RepositoryCreates an instance of the Repository class.


Methods

Name Description
ConnectToAccessRepositoryConnects 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.
ConnectToOracleRepositoryConnects to an Oracle repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
ConnectToRepositoryConnects to a standard or enterprise repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
ConnectToSQLRepositoryConnects to a SQL Server repository. Returns a Boolean value; when true, indicates a successful connection to the repository.
DisconnectFromRepositoryDisconnects from the current repository.


Action

Name Description
Action.AddActionAdds 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.GetActionReturns 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.
Action.GetAllActionsReturns an array of cAction objects that represent the action resources in the current project.
Action.GetAllActionsDictionaryReturns 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.UpdateActionUpdates the properties of a given action resource in the current project. Returns a Boolean value; when true, indicates a successful update.


BlockSim

Name Description
BlockSim.ExportBlockSimXMLFileExports data from the current BlockSim project to a new XML file. Returns a Boolean value; when true, indicates a successful export.
BlockSim.GetAllFaultTreesGets a list of all BlockSim fault trees associated with a project. Returns a NameIdPair object that represents the name and ID pairs of the fault trees.
BlockSim.GetAllRBDBlocksDataGets an array containing the data of all blocks in a BlockSim reliability block diagram (RBD) or fault tree. Returns an RBDBlockData object that represents the properties of each block.
BlockSim.GetAllRBDsGets a list of all BlockSim reliability block diagrams (RBDs) associated with a project. Returns a NameIdPair object that represents the name and ID pairs of the RBDs.
BlockSim.GetRBDBlockDataReturns an RBDBlockData object that represents the properties of a BlockSim block.
BlockSim.ImportBlockSimXMLFileImports data from an XML file into the current BlockSim project. Returns a Boolean value; when true, indicates a successful import.
BlockSim.UpdateRBDBlockDataSends any changes made to a BlockSim block to the Synthesis repository. Returns a Boolean value; when true, indicates a successful save.


Control

Name Description
Control.AddXfmeaControlAdds a new Xfmea control to the current project. Returns a Boolean value; when true, indicates a successful save.
Control.GetAllXfmeaControlsReturns an array of cXfmeaControl objects that represent the Xfmea controls in the current project.
Control.GetAllXfmeaControlsDictionaryReturns 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.GetXfmeaControlReturns 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.
Control.UpdateXfmeaControlUpdates the properties of a given control resource in the current project. Returns a Boolean value; when true, indicates a successful update.


Crew

Name Description
Crew.AddCrewAdds a new crew resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Crew.GetAllCrewsReturns an array of cCrew objects that represent the crew resources in the current project.
Crew.GetCrewReturns 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.
Crew.UpdateCrewUpdates the properties of a given crew resource in the current project. Returns a Boolean value; when true, indicates a successful save.


Data Warehouse

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


Model

Name Description
Model.AddModelAdds a new model resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Model.DeleteModelDeletes 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.GetAllModelsReturns an array of cModel objects that represent the model resources in the current project.
Model.GetModelReturns 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.IsModelUsedChecks 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.UpdateModelUpdates the properties of a given model resource in the current project. Returns a Boolean value; when true, indicates a successful update.
Model.GetAllModelsInfo  Deprecated   Returns an array of NameIdPair objects that represent the name and ID pairs of the model resources in the current project. This includes internal models automatically created with any new repository (model ID#s 1 to 20).


Pool

Name Description
Pool.AddPoolAdds a new spare part pool to the current project. Returns a Boolean value; when true, indicates indicates a successful save.
Pool.GetAllPoolsReturns an array of cPool objects that represent the spare part pools in the current project.
Pool.GetPoolReturns 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.
Pool.UpdatePoolUpdates the properties of a given spare part pool in the current project. Returns a Boolean value; when true, indicates a successful update.


Profiles

Name Description
Profile.AddProfileAdds a new profile resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Profile.GetProfileReturns a cProfile object that represents a given profile resource in the current project. Returns nothing if the profile does not exist or is not in the current project.
Profile.GetAllProfilesReturns an array of cProfile objects that represent the profile resources in the current project.
Profile.UpdateProfileUpdates the properties of a given profile resource in the current project. Returns a Boolean value; when true, indicates a successful update.


Project

Name Description
Project.GetAllProjectsReturns an array of NameIDPair objects that represent the name and ID pairs of the projects associated with the Repository object.
Project.GetCurrentProjectReturns a NameIDPair object that represents the name and ID pair of the current project.
Project.GetUserAccessibleProjectsReturns an array of NameIDPair objects containing all project names and their IDs from the current repository to which the user has access. Connected user must have Admin permissions to obtain the list of projects for another user. Admin permissions are not required to obtain a list of project for your own account.
Project.GetUserPermissionsReturns an array of UserPermissionEnum of all permissions the user has for the specified project. Connected user must have Admin permissions to obtain the list of permissions for another user. Admin permissions are not required to a list of permissions for your own account.
Project.SetCurrentProjectSets the current (active) project for the repository. Returns a Boolean value; when true, indicates a successful connection to that project.

Task

Name Description
Task.AddCorrectiveTaskAdds a new corrective task to the current project. Returns a Boolean value; when true, indicates a successful save.
Task.AddScheduledTaskAdds a new scheduled task to the current project. Returns a Boolean value; when true, indicates a successful save.
Task.GetAllCorrectiveTasksReturns an array of cCorrectiveTask objects that represent the corrective tasks in the current project.
Task.GetAllScheduledTasksReturns an array of cScheduledTask objects that represent the scheduled tasks in the current project.
Task.GetAllTaskTypesReturns an array of TaskTypeInfo objects that represent the RCM++ or RBI task types associated with the Repository object.
Task.GetCorrectiveTaskReturns 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.GetScheduledTaskReturns 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.UpdateCorrectiveTaskUpdates the properties of a given corrective task in the current project. Returns a Boolean value; when true, indicates a successful update.
Task.UpdateScheduledTaskUpdates the properties of a given scheduled task in the current project. Returns a Boolean value; when true, indicates a successful update.


Unit

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


URD

Name Description
URD.AddURDAdds a new universal reliability definition (URD) resource to the current project. Returns a Boolean value; when true, indicates a successful save.
URD.GetAllURDsReturns an array of cURD objects that represent the universal reliability definitions (URDs) in the current project.
URD.GetURDReturns 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.
URD.UpdateURDUpdates the properties of a given URD resource in the current project. Returns a Boolean value; when true, indicates a successful update.


Variable

Name Description
Variables.AddVariableAdds a new variable resource to the current project. Returns a Boolean value; when true, indicates a successful save.
Variables.GetAllVariablesReturns an array of cVariable objects that represent the variable resources in the current project.
Variables.GetVariableReturns 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.
Variables.UpdateVariableUpdates the properties of a given variable resource in the current project. Returns a Boolean value; when true, indicates a successful update.


Xfmea

Name Description
Xfmea.AddItemToSystemHierarchyAdds a new system hierarchy item to the current project. Returns a Boolean value; when true, indicates a successful save.
Xfmea.AddXfmeaCause Adds a new cause to an effect. Returns a Boolean value; when true, indicates a successful save.
Xfmea.AddXfmeaEffectAdds a new effect to a failure. Returns a Boolean value; when true, indicates a successful save.
Xfmea.AddXfmeaFailureAdds a new failure to an FMEA function. Returns a Boolean value; when true, indicates a successful save.
Xfmea.AddXfmeaFunction Adds a new FMEA function to a system hierarchy item. Returns a Boolean value; when true, indicates a successful save.
Xfmea.GetAllItemsInSystemHierarchyReturns an array of XfmeaItem objects that represent the system hierarchy items in the current project.
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.GetAllXfmeaCausesReturns an array of XfmeaCause objects that represent the causes associated with a failure.
Xfmea.GetAllXfmeaCausesDictionaryReturns a dictionary object that contains all available causes associated with a failure. The dictionary syntax is Dictionary(Of Integer, XfmeaCause), where the ID numbers are the keys, and the XfmeaCause objects that represent the causes are the associated values. (.NET only)
Xfmea.GetAllXfmeaEffectsReturns an array of XfmeaEffect objects that represent the effects associated with a failure.
Xfmea.GetAllXfmeaEffectsDictionaryReturns a dictionary object that contains all available effects associated with a failure. The dictionary syntax is Dictionary(Of Integer, XfmeaEffect), where the ID numbers are the keys, and the XfmeaEffect objects that represent the effects are the associated values. (.NET only)
Xfmea.GetAllXfmeaFailuresReturns an array of XfmeaFailure objects that represent the failures associated with an FMEA function.
Xfmea.GetAllXfmeaFailuresDictionaryReturns a dictionary object that contains all available failures associated with an FMEA function. The dictionary syntax is Dictionary(Of Integer, XfmeaFailure), where the ID numbers are the keys, and the XfmeaFailure objects that represent the failures are the associated values. (.NET only)
Xfmea.GetAllXfmeaFunctions Returns an array of XfmeaFunction objects that represent the FMEA functions associated with a system hierarchy item.
Xfmea.GetAllXfmeaFunctionsDictionaryReturns a dictionary object that contains all available FMEA functions associated with a system hierarchy item. The dictionary syntax is Dictionary(Of Integer, XfmeaFunction), where the ID numbers are the keys, and the XfmeaFunction objects that represent the FMEA functions are the associated values. (.NET only)
Xfmea.GetItemInSystemHierarchyReturns an XfmeaItem object that represents a given system hierarchy item in the current project.
Xfmea.GetXfmeaCauseReturns an XfmeaCause object that represents a given FMEA cause in the current project. Returns nothing if the cause does not exist or is not in the current project.
Xfmea.GetXfmeaEffectReturns an XfmeaEffect object that represents a given FMEA effect in the current project. Returns nothing if the effect does not exist or is not in the current project.
Xfmea.GetXfmeaFailureReturns an XfmeaFailure object that represents a given FMEA failure in the current project. Returns nothing if the failure does not exist or is not in the current project.
Xfmea.GetXfmeaFunction Returns an XfmeaFunction object that represents a given FMEA function in the current project. Returns nothing if the FMEA function does not exist or is not in the current project.
Xfmea.UpdateItemInSystemHierarchyUpdates the properties of a given system hierarchy item in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.UpdateXfmeaCauseUpdates the properties of a given FMEA cause in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.UpdateXfmeaEffectUpdates the properties of a given FMEA effect in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.UpdateXfmeaFailureUpdates the properties of a given FMEA failure in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.UpdateXfmeaFunction Updates the properties of a given FMEA function in the current project. Returns a Boolean value; when true, indicates a successful update.
Xfmea.AssignActionToXfmeaCause Assigns an action to a cause. Returns a Boolean value; when true, indicates the action was assigned successfully.
Xfmea.AssignControlToXfmeaCause Assigns a control to a cause. Returns a Boolean value; when true, indicates the control was assigned successfully.
Xfmea.GetXfmeaCauseActions Returns an array cActions objects for all actions associated to the specified Cause ID.
Xfmea.GetXfmeaCauseActionsDictionary Returns a dictionary object containing all actions (cAction) currently assigned to a certain cause 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)
Xfmea.GetXfmeaCauseControls Returns an array of cXfmeaControl objects that represent the associated controls for the specified Cause ID in the current project.
Xfmea.GetXfmeaCauseControlsDictionary Returns a dictionary object containing all controls (cXfmeaControl) currently assigned to a certain cause 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 control resources are the associated values. (.NET only)

XFRACAS

Name Description
XFRACAS.AddSystemMetric1 Inserts the time/usage value reported on a particular date for a particular serialized system (Metric 1 only).
XFRACAS.AddSystemMetric2Inserts the time/usage values reported on a particular date for a particular serialized system (Metric 1 and 2).
XFRACAS.AddSystemMetric3Inserts the time/usage values reported on a particular date for a particular serialized system (Metric 1, 2 and 3).
XFRACAS.GetAllXFRACASEntities Returns an array of NameIDPair objects (effectively Dictionaries) that represent the name and ID pairs of the XFRACAS entities in the database.
XFRACAS.ImportXFRACASXML Uploads the XML byte array to the XFRACAS import queue. Returns an Integer that represents the record ID of the byte array.
XFRACAS.ImportXFRACASXMLFile Uploads the XML file to the XFRACAS import queue. Returns an Integer that represents the import file's record ID.
XFRACAS.ImportXFRACASXMLString Uploads the XML string to the XFRACAS import queue. Returns an Integer that represents the import file's record ID.
XFRACAS.ProcessXfracasImports Immediately processes all XML files in the XFRACAS import queue.
XFRACAS.SerializeXMLObjectToByteArraySerializes the XML file for import into XFRACAS. Returns a Boolean value; when true, indicates a successful serialization.
XFRACAS.WriteExceptionToDiagnosticsLogWrites exception information to the XFRACAS diagnostics log.
XFRACAS.WriteMessageToDiagnosticsLogWrites a message to the XFRACAS diagnostics log.

Properties

Name Description
EnforceRENOComplianceIndicates whether spaces and special characters are allowed in the names of models created via the Synthesis API. Boolean. Default value = True.
Use EventsIndicates whether to enable user-defined event procedures for the Repository object. Boolean. Default value = False.
XFRACAS.XFRACASCommandTimeoutGets or sets the wait time in seconds before terminating the attempt to execute an XFRACAS command. Integer.


Events

Name Description
MessageOccurs when an error is produced. Displays an error message.
Personal tools
ReliaWiki.org
Create a book