Repository.Model.UpdateModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Applies any changes made to an existing model. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>
<onlyinclude>Sends any changes made to an existing model to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>


This method does not apply to published models, which are model resources that have been published from and are associated with an existing analysis/data source.
This method does not apply to published models, which are model resources that have been published from and are associated with an existing analysis/data source.
Line 18: Line 18:
  '''VBA'''
  '''VBA'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
   
  {{APIComment|'Get model #47 from project #1.}}
  {{APIComment|'Get model #47 from project #1.}}
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  {{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(47)
  {{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(47)
   
   
  {{APIComment|'Change the model's name to "New_Name."}}
  {{APIComment|'Change the model's name to "New_Name."}}
  AModel.Name = {{APIString|"New_Name"}}
  AModel.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the change to the model. Changes are recorded in the Synthesis repository.}}
  {{APIComment|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Model.UpdateModel(AModel)
  {{APIPrefix|Call}} MyRepository.Model.UpdateModel(AModel)


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   
   
   {{APIComment|'Get model #47 from project #1.}}
   {{APIComment|'Get model #47 from project #1.}}
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  AModel = MyRepository.Model.GetModel(47)
  AModel = MyRepository.Model.GetModel(47)
   
   
  {{APIComment|'Change the model's name to "New_Name."}}
  {{APIComment|'Change the model's name to "New_Name."}}
  AModel.Name = {{APIString|"New_Name"}}
  AModel.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the change to the model. Changes are recorded in the Synthesis repository.}}
  {{APIComment|'Send the change to the Synthesis repository.}}
  MyRepository.Model.UpdateModel(AModel)
  MyRepository.Model.UpdateModel(AModel)

Revision as of 18:38, 8 April 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Sends any changes made to an existing model to the Synthesis repository. Returns a Boolean value; when true, indicates a successful save.

This method does not apply to published models, which are model resources that have been published from and are associated with an existing analysis/data source.

Syntax

.Model.UpdateModel(m)

Parameters

m

Required. The cModel object to be updated.


Example

This example assumes that a model with ID #47 exists in the first available project of a repository.

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
   
 'Get model #47 from project #1. 
  Dim AModel As cModel
  MyRepository.Project.SetCurrentProject(1)  
  Set AModel = MyRepository.Model.GetModel(47)

 'Change the model's name to "New_Name." 
  AModel.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Model.UpdateModel(AModel)
VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

  'Get model #47 from project #1. 
  Dim AModel As cModel
  MyRepository.Project.SetCurrentProject(1)  
  AModel = MyRepository.Model.GetModel(47)

 'Change the model's name to "New_Name." 
  AModel.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  MyRepository.Model.UpdateModel(AModel)