Repository.Model.UpdateModel - Revision history

Kate Racaza at 20:34, 18 August 2016

2016-08-18T20:34:54Z

← Older revision		Revision as of 20:34, 18 August 2016
Line 4:		Line 4:
	<onlyinclude>Updates the properties of a given model resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>		<onlyinclude>Updates the properties of a given model resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</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.
			'''Remarks''': 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 ==		== Syntax ==

Kate Racaza at 17:10, 9 June 2016

2016-06-09T17:10:05Z

← Older revision		Revision as of 17:10, 9 June 2016
Line 2:		Line 2:


	<onlyinclude>~~Sends any changes made to an existing~~ model to the ~~Synthesis repository~~. Returns a '''Boolean''' value; when true, indicates a successful ~~save~~.</onlyinclude>		<onlyinclude>Updates the properties of a given model resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</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 10:		Line 10:
	=== Parameters ===		=== Parameters ===
	''m''		''m''
	:Required. The [[CModel Class\|cModel]] object to be updated.		:Required. The [[CModel Class\|cModel]] object that represents the model resource to be updated.

Kate Racaza at 18:38, 8 April 2016

2016-04-08T18:38:20Z

← Older revision		Revision as of 18:38, 8 April 2016
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)

Kate Racaza at 22:16, 13 November 2015

2015-11-13T22:16:07Z

← Older revision		Revision as of 22:16, 13 November 2015
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb~~\|10~~\|.[[Repository Class\|Repository]]}}		{{Template:API}}{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}

Kate Racaza at 23:12, 9 September 2015

2015-09-09T23:12:21Z

← Older revision		Revision as of 23:12, 9 September 2015
Line 4:		Line 4:
	<onlyinclude>Applies any changes made to an existing model. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>		<onlyinclude>Applies any changes made to an existing model. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>

	This method does not ~~affect~~ 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.

	== Syntax ==		== Syntax ==

Kate Racaza at 20:50, 24 August 2015

2015-08-24T20:50:08Z

← Older revision		Revision as of 20:50, 24 August 2015
Line 2:		Line 2:


	<onlyinclude>~~Updates the properties of~~ an existing model ~~in the current project. Changes are reflected in the repository immediately upon refresh~~. Returns a '''Boolean''' value; when true, indicates a successful ~~update~~.</onlyinclude>		<onlyinclude>Applies any changes made to an existing model. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>

	This method does not affect published models, which are model resources that have been published from and are associated with an existing analysis/data source.		This method does not affect published models, which are model resources that have been published from and are associated with an existing analysis/data source.
Line 10:		Line 10:
	=== Parameters ===		=== Parameters ===
	''m''		''m''
	:The [[CModel Class\|cModel]] object to be updated.		:Required. The [[CModel Class\|cModel]] object to be updated.


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

	'''VBA'''		'''VBA'''
Line 31:		Line 31:
	AModel.Name = {{APIString\|"New_Name"}}		AModel.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the ~~update~~ to the model. Changes ~~will be reflected~~ in the repository.}}		{{APIComment\|'Apply the change to the model. Changes are recorded in the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Model.UpdateModel(AModel)		{{APIPrefix\|Call}} MyRepository.Model.UpdateModel(AModel)

Line 47:		Line 47:
	AModel.Name = {{APIString\|"New_Name"}}		AModel.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the ~~update~~ to the model. Changes ~~will be reflected~~ in the repository.}}		{{APIComment\|'Apply the change to the model. Changes are recorded in the Synthesis repository.}}
	MyRepository.Model.UpdateModel(AModel)		MyRepository.Model.UpdateModel(AModel)

Kate Racaza at 22:12, 20 July 2015

2015-07-20T22:12:04Z

← Older revision		Revision as of 22:12, 20 July 2015
Line 1:		Line 1:
	~~<noinclude>~~{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}~~</noinclude>~~		{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}

	Updates the properties of an existing model in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.
			<onlyinclude>Updates the properties of an existing model in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>

	This method does not affect published models, which are model resources that have been published from and are associated with an existing analysis/data source.		This method does not affect published models, which are model resources that have been published from and are associated with an existing analysis/data source.
	~~<noinclude>~~
	== Syntax ==		== Syntax ==
	'''.Model.UpdateModel'''(''m'')		'''.Model.UpdateModel'''(''m'')
Line 48:		Line 49:
	{{APIComment\|'Apply the update to the model. Changes will be reflected in the repository.}}		{{APIComment\|'Apply the update to the model. Changes will be reflected in the repository.}}
	MyRepository.Model.UpdateModel(AModel)		MyRepository.Model.UpdateModel(AModel)
	~~</noinclude>~~

Kate Racaza at 20:23, 20 July 2015

2015-07-20T20:23:06Z

← Older revision		Revision as of 20:23, 20 July 2015
Line 1:		Line 1:
	<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|[[Repository Class\|Repository]]}}</noinclude>		<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}</noinclude>

	~~Saves all updates to a~~ model. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.		Updates the properties of an existing model in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.

	~~Note that you can apply updates only to~~ models ~~that were created manually (i.e.~~, ~~models~~ that ~~were~~ published from ~~analyses cannot be updated via the API)~~.		This method does not affect published models, which are model resources that have been published from and are associated with an existing analysis/data source.
	<noinclude>		<noinclude>
	== Syntax ==		== Syntax ==
	'~~'object~~''.'''~~Model.UpdateModel~~(''m'')~~'''~~		'''.Model.UpdateModel'''(''m'')

	~~where ''object'' is a variable that represents a Repository object.~~

	=== Parameters ===		=== Parameters ===
	~~{\| {{APITable}}~~		''m''
	\|-		:The [[CModel Class\|cModel]] object to be updated.
	~~\|m{{APIParam\|Required}}\|\|~~The [[CModel Class\|cModel]] object to be updated.
	\|}


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

	'''VBA'''		'''VBA'''

	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIComment\|'Add code to connect to a Synthesis repository.}}
	{{APIComment\|..~~.'Add code to connect to a Synthesis repository~~.}}		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			{{APIComment\|...}}


	{{APIComment\|'Get model #47 from project #1.}}		{{APIComment\|'Get model #47 from project #1.}}

Kate Racaza at 17:20, 17 July 2015

2015-07-17T17:20:22Z

← Older revision		Revision as of 17:20, 17 July 2015
Line 1:		Line 1:
	<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|Repository}}</noinclude>		<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|[[Repository Class\|Repository]]}}</noinclude>

	Saves all updates to a model. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.		Saves all updates to a model. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.

Kate Racaza at 21:51, 16 July 2015

2015-07-16T21:51:22Z

← Older revision		Revision as of 21:51, 16 July 2015
Line 1:		Line 1:
	{{Template:APIBreadcrumb\|10\|Repository}}		<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|Repository}}</noinclude>
	~~{{Template:API}}~~
	Saves all updates to a model. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.		Saves all updates to a model. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.

	Note that you can apply updates only to models that were created manually (i.e., models that were published from analyses cannot be updated via the API).		Note that you can apply updates only to models that were created manually (i.e., models that were published from analyses cannot be updated via the API).
			<noinclude>
	== Syntax ==		== Syntax ==
	''object''.'''Model.UpdateModel(''m'')'''		''object''.'''Model.UpdateModel(''m'')'''
Line 13:		Line 13:
	{\| {{APITable}}		{\| {{APITable}}
	\|-		\|-
	\|m{{APIParam\|Required}}\|\|The ~~'''~~[[CModel Class\|cModel]]~~'''~~ object to be updated.		\|m{{APIParam\|Required}}\|\|The [[CModel Class\|cModel]] object to be updated.
	\|}		\|}

Line 30:		Line 30:
	{{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 = "New_Name"		AModel.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the update to the model. Changes will be reflected in the repository.}}		{{APIComment\|'Apply the update to the model. Changes will be reflected in the repository.}}
Line 46:		Line 46:
	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 = "New_Name"		AModel.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the update to the model. Changes will be reflected in the repository.}}		{{APIComment\|'Apply the update to the model. Changes will be reflected in the repository.}}
	MyRepository.Model.UpdateModel(AModel)		MyRepository.Model.UpdateModel(AModel)
			</noinclude>

← Older revision		Revision as of 18:38, 8 April 2016
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)