New Members and Constants

<< Back to API Main Page

API Changelog

• New Classes and Enumerations
• New Members and Constants
• Deprecated and Removed Members

API Reference Documentation

Below is a summary of all new members that have been added to existing objects in the Synthesis API library since the previous version.

New in 18.0.3

Repository Class

New Methods

• • Project.GetUserAccessibleProjects - Returns 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.GetUserPermissions - Returns 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.

New in 11.0.1

Repository Class

New Methods

• • Profile.AddProfile - Adds a new profile resource to the current project. Returns a Boolean value; when true, indicates a successful save.
  • Profile.GetProfile - Returns 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.GetAllProfiles - Returns an array of cProfile objects that represent the profile resources in the current project.
  • Profile.UpdateProfile - Updates the properties of a given profile resource in the current project. Returns a Boolean value; when true, indicates a successful update.

New in 10.1.4

Repository Class

New Methods

• BlockSim.GetAllRBDs - Gets 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.GetAllFaultTrees - Gets 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.GetRBDBlockData - Returns an RBDBlockData object that represents the properties of a BlockSim block.
• BlockSim.GetAllRBDBlocksData - Gets 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.UpdateRBDBlockData - Sends any changes made to a BlockSim block to the Synthesis repository. Returns a Boolean value; when true, indicates a successful save.

New Events

• Repository.Message - Occurs when an error is produced. Displays an error message.

WeibullDataSet Class

New Events

• GetDistrParameters - Occurs when there is insufficient data to fit a model. Displays a prompt for entering the parameters of the distribution.
• HideCalculationProgress - Occurs when the calculation process is running. Hides the progress bar.
• Message - Occurs when an error is produced. Displays an error message.
• Question - Occurs when an answer to a question is required. Displays a message box with yes and no options.
• ShowCalculationProgress - Occurs when the calculation process is running. Displays a progress bar.
• UpdateCalculationProgress - Occurs when the calculation process is running. Displays messages regarding the progress of the calculations.

ALTADataSet Class

New Events

• HideCalculationProgress - Occurs when the calculation process is running. Hides the progress bar.
• Message - Occurs when an error is produced. Displays an error message.
• ShowCalculationProgress - Occurs when the calculation process is running. Displays a progress bar.
• UpdateCalculationProgress - Occurs when the calculation process is running. Displays messages regarding the progress of the calculations.

New in 10.1.1

Repository Class

New Method

• Repository.Xfmea.GetItemInSystemHierarchy - Returns an XfmeaItem object that represents a given system hierarchy item in the current project.

cXfmeaControl Class and cAction Class

New Properties

• UT1 - Gets or sets the text in the first user-defined text field. String.
• UT2 - Gets or sets the text in the second user-defined text field. String.
• UT3 - Gets or sets the text in the third user-defined text field. String.
• UT4 - Gets or sets the text in the fourth user-defined text field. String.
• UT5 - Gets or sets the text in the fifth user-defined text field. String.

New in 10.0.3

Initial public release for Synthesis API 10.

Repository Class

New Methods

• 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.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.AddXfmeaControl - Adds a new Xfmea control to the current project. Returns a Boolean value; when true, indicates a successful save.
• Control.GetAllXfmeaControls() - Returns an array of cXfmeaControl objects that represent the Xfmea controls in the current project.
• 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.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.
• Control.UpdateXfmeaControl - Updates the properties of a given control resource in the current project. Returns a Boolean value; when true, indicates a successful update.
• 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.
• 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.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.
• 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.
• 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.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.
• 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.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.
• Xfmea.AddItemToSystemHierarchy - Adds 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.AddXfmeaEffect - Adds a new effect to a failure. Returns a Boolean value; when true, indicates a successful save.
• Xfmea.AddXfmeaFailure - Adds 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.GetAllItemsInSystemHierarchy() - Returns 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.GetAllXfmeaCauses() - Returns an array of XfmeaCause objects that represent the causes associated with a failure.
• Xfmea.GetAllXfmeaCausesDictionary() - Returns 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.GetAllXfmeaEffects() - Returns an array of XfmeaEffect objects that represent the effects associated with a failure.
• Xfmea.GetAllXfmeaEffectsDictionary() - Returns 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.GetAllXfmeaFailures() - Returns an array of XfmeaFailure objects that represent the failures associated with an FMEA function.
• Xfmea.GetAllXfmeaFailuresDictionary() - Returns 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.GetAllXfmeaFunctionsDictionary() - Returns 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.GetXfmeaCause - Returns 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.GetXfmeaEffect - Returns 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.GetXfmeaFailure - Returns 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.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.UpdateXfmeaCause - Updates the properties of a given FMEA cause in the current project. Returns a Boolean value; when true, indicates a successful update.
• Xfmea.UpdateXfmeaEffect - Updates the properties of a given FMEA effect in the current project. Returns a Boolean value; when true, indicates a successful update.
• Xfmea.UpdateXfmeaFailure - Updates 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.
• XFRACAS.AddSystemMetric1 - Inserts the time/usage value reported on a particular date for a particular serialized system (Metric 1 only).
• XFRACAS.AddSystemMetric2 - Inserts the time/usage values reported on a particular date for a particular serialized system (Metric 1 and 2).
• XFRACAS.AddSystemMetric3 - Inserts the time/usage values reported on a particular date for a particular serialized system (Metric 1, 2 and 3).

New Properties

• XFRACAS.XFRACASCommandTimeout - Gets or sets the wait time in seconds before terminating the attempt to execute an XFRACAS command. Integer.

cAction Class

New Properties

• ActionDescription - Gets or sets the action description. String.
• ActionType - Gets or sets a value from the ActionType enumeration, which specifies whether the action record is generic or detailed.
• ActualCostPctFacility - Gets or sets the percentage of the actual cost allocated to facility costs. Double.
• ActualCostPctMaterial - Gets or sets the percentage of the actual cost allocated to material costs. Double.
• ActualCostPctPersonnel - Gets or sets the percentage of the actual cost allocated to personnel costs. Double.
• ActualCostPctPersonResponsible - Gets or sets the percentage of the actual cost allocated to the database user responsible for the action. Double.
• ActualDuration - Gets or sets the number of working days from the action's actual start date to its actual completion date. Double.
• ActualManHrs - Gets or sets the number of billable hours from the action's actual start date to its actual completion date. Double.
• ActualStartDate - Gets or sets the date the action actually started. Date.
• AdditionalCost - Gets or sets any other additional costs to perform the action. Double.
• CompletionDate - Gets or sets the date the action was actually completed. Date.
• CreatedByID - Gets the numeric ID of the database user who created the action. Integer.
• CreatedByNm - Gets the display name of the database user who created the action. String.
• CreatedDate - Gets the date the action resource was created. Date.
• FacilityID - Gets or sets the numeric ID of the facility associated with the action and the project plan. Integer.
• FacilityNm - Gets or sets the name of the facility associated with the action and the project plan. String.
• FacilityUsage - Gets or sets the facility's utilization rate. Object.
• FeasibleCost - Gets or sets the estimated cost to date, based on how long the action has been in progress. Double.
• FeasibleDueDate - Gets or sets the expected due date of the action, based on the feasible start date and planned duration. Date.
• FeasibleDuration - Gets or sets the number of working days from the action's feasible start date to its feasible completion date. Double.
• FeasibleManHrs - Gets or sets the estimated man hours to date, based on how long the action has been in progress. Double.
• FeasibleStartDate - Gets or sets the expected start date of the action, taking into account any delays recorded in the project plan. Date.
• IsCostUserDefined - Indicates whether the actual cost/man hours is calculated automatically or user-defined. Boolean.
• ItemApplication - Gets or sets the item's application. (Synthesis identifier) String.
• ItemCategoryID - Gets or sets the category ID. (Synthesis identifier) Integer.
• ItemComments - Gets or sets the comments. (Synthesis identifier) String.
• ItemDescription - Gets or sets the description. (Synthesis identifier) String.
• ItemKeywords - Gets or sets the keywords. (Synthesis identifier) String.
• ItemPartNumber - Gets or sets the part number. (Synthesis identifier) String.
• ItemSupplier - Gets or sets the supplier name. (Synthesis identifier) String.
• ItemVersion - Gets or sets the version number. (Synthesis identifier) String.
• LastUpdated - Gets the date the action was last modified. Date.
• LastUpdatedByID - Gets the numeric ID of the database user who last modified the action. Integer.
• LastUpdatedNm - Gets the display name of the database user who last modified the action. String.
• MaterialID - Gets or sets the numeric ID of the material associated with the action and the project plan. Integer.
• MaterialNm - Gets or sets the name of the material associated with the action and the project plan. String.
• PercentCompleted - Gets or sets the progress of the action.Double.
• PersonnelID - Gets or sets the numeric ID of the team associated with the action and the project plan. Integer.
• PersonnelNm - Gets or sets the name of the team associated with the action and the project plan.String.
• PersonnelUsage - Gets or sets the team's utilization rate. Object.
• PersonRespID - Gets or sets the numeric ID of the database user responsible for the action. Integer.
• PersonRespNm - Gets or sets the name of the database user responsible for the action.String.
• PersonRespUsage - Gets or sets the utilization rate of the database user responsible for the action.Double.
• PlanCost - Gets or set the planned cost to perform the action. Double.
• PlanCostPctFacility - Gets or sets the percentage of the planned cost allocated to facility costs. Double.
• PlanCostPctMaterial - Gets or sets the percentage of the planned cost allocated to material costs. Double.
• PlanCostPctPersonnel - Gets or sets the percentage of the planned cost allocated to personnel costs. Double.
• PlanCostPctPersonResponsible - Gets or sets the percentage of the planned cost allocated to the database user responsible for the the action. Double.
• PlanDuration - Gets or sets the number of working days from the action's planned start date to its planned completion date. Integer.
• PlanManHrs - Gets or sets the planned number of billable hours, based on the planned duration and utilization rate for assigned personnel. Double.
• PriorityType - Gets or sets a value from the PriorityType enumeration, which specifies the priority level of the action (e.g., low, medium, high, etc.)
• ReportAssumptions - Gets or sets the description of the assumptions of the test plan, if the action is part of a test plan. String.
• ReportResults - Gets or sets the description of the results of the test plan, if the action is part of a test plan. String.
• ReportSummary - Gets or sets the summary report of the test plan, if the action is part of a test plan. String.
• ReviewComments - Gets or sets comments or other descriptions relevant to the action.String.
• ReviewDate - Gets or sets the date the action is scheduled for review. Date.
• ReviewerID - Gets or sets the numeric ID of the database user assigned to review the action. Integer.
• ReviewerNm - Gets or sets the name of the database user assigned to review the action. String.
• ReviewOutCome - Gets or sets a value from the ReviewOutcomeEnum enumeration, which specifies the status of the action under review (e.g., approved, rejected and closed, etc.)
• ReviewOutComeString - Gets or sets the description of the action's review outcome. String.
• ShowInTestPlan - Indicates whether the action is eligible to be included in a test plan. Boolean.
• TestCriteria - Gets or sets the description of the the test criteria, if the action is part of a test plan. String.
• TestPlan - Gets or sets the description of the test plan or procedure, if the action is part of a test plan. String.
• TestReq - Gets or sets the description of the requirements for the test plan, if the action is part of a test plan. String.
• TestReqNotes - Gets or sets notes or remarks about the requirements of the test plan, if the action is part of a test plan. String.
• TestSampleSize - Gets or sets the description of the sample size, if the action is part of a test plan. String.
• TestSampleType - Gets or sets the description of the type of samples available, if the action is part of a test plan. String.
• TestSpecMethod - Gets or sets the description of the specifications or methodology of the test plan, if the action is part of a test plan. String.
• TestSpecNotes - Gets or sets notes or remarks about the specifications of the test plan, if the action is part of a test plan. String.

cCorrectiveTask Class

New Methods

• GetCrewIDs - Returns an array containing the numeric IDs of the crews assigned to the task.
• SetCrewIDs - Assigns crews to the task.

New Properties

• ItemApplication - Gets or sets the item's application. (Synthesis identifier) String.
• ItemCategoryID - Gets or sets the category ID. (Synthesis identifier) Integer.
• ItemComments - Gets or sets the comments. (Synthesis identifier) String.
• ItemDescription - Gets or sets the description. (Synthesis identifier) String.
• ItemKeywords - Gets or sets the keywords. (Synthesis identifier) String.
• ItemPartNumber - Gets or sets the part number. (Synthesis identifier) String.
• ItemSupplier - Gets or sets the supplier name. (Synthesis identifier) String.
• ItemVersion - Gets or sets the version number. (Synthesis identifier) String.

cModel Class

New Properties

• ItemApplication - Gets or sets the item's application. (Synthesis identifier) String.
• ItemCategoryID - Gets or sets the category ID. (Synthesis identifier) Integer.
• ItemComments - Gets or sets the comments. (Synthesis identifier) String.
• ItemDescription - Gets or sets the description. (Synthesis identifier) String.
• ItemKeywords - Gets or sets the keywords. (Synthesis identifier) String.
• ItemPartNumber - Gets or sets the part number. (Synthesis identifier) String.
• ItemSupplier - Gets or sets the supplier name. (Synthesis identifier) String.
• ItemVersion - Gets or sets the version number. (Synthesis identifier) String.
• Unit ID - Gets or sets the numeric ID of the model's unit of measurement. Integer .

cScheduledTask Class

New Methods

• GetCrewIDs - Returns an array containing the numeric IDs of the crews assigned to the task. Long.
• SetCrewIDs - Assigns crews to the task.

New Properties

• ItemApplication - Gets or sets the item's application. (Synthesis identifier) String.
• ItemCategoryID - Gets or sets the category ID. (Synthesis identifier) Integer.
• ItemComments - Gets or sets the comments. (Synthesis identifier) String.
• ItemDescription - Gets or sets the description. (Synthesis identifier) String.
• ItemKeywords - Gets or sets the keywords. (Synthesis identifier) String.
• ItemPartNumber - Gets or sets the part number. (Synthesis identifier) String.
• ItemSupplier - Gets or sets the supplier name. (Synthesis identifier) String.
• ItemVersion - Gets or sets the version number. (Synthesis identifier) String.

cCrew Class, cPool Class, cURD Class and cVariable Class

New Properties

• ItemApplication - Gets or sets the item's application. (Synthesis identifier) String.
• ItemCategoryID - Gets or sets the category ID. (Synthesis identifier) Integer.
• ItemComments - Gets or sets the comments. (Synthesis identifier) String.
• ItemDescription - Gets or sets the description. (Synthesis identifier) String.
• ItemKeywords - Gets or sets the keywords. (Synthesis identifier) String.
• ItemPartNumber - Gets or sets the part number. (Synthesis identifier) String.
• ItemSupplier - Gets or sets the supplier name. (Synthesis identifier) String.
• ItemVersion - Gets or sets the version number. (Synthesis identifier) String.