Edit Existing Synthesis Resources - Revision history

Kate Racaza at 18:15, 3 April 2017

2017-04-03T18:15:55Z

Kate Racaza at 17:17, 8 September 2016

2016-09-08T17:17:15Z

← Older revision		Revision as of 17:17, 8 September 2016
Line 79:		Line 79:

	==Notes==		==Notes==
	To update a model's parameters, category or type, use the [[CModel.SetModel\|cModel.SetModel]] method to edit the data, and then follow it up with the [[Repository.Model.UpdateModel]] method to save the changes to the repository.		*To update a model's parameters, category or type, use the [[CModel.SetModel\|cModel.SetModel]] method to edit the data, and then follow it up with the [[Repository.Model.UpdateModel]] method to save the changes to the repository.

	To retrieve all other types of Synthesis resources, you can use the same approach demonstrated in the example. For example, to update the properties of an existing URD, you would use the [[Repository.URD.GetURD]] method to retrieve a single URD from the repository, and then use the [[Repository.URD.UpdateURD]] method to apply the changes.		*To retrieve all other types of Synthesis resources, you can use the same approach demonstrated in the example. For example, to update the properties of an existing URD, you would use the [[Repository.URD.GetURD]] method to retrieve a single URD from the repository, and then use the [[Repository.URD.UpdateURD]] method to apply the changes.

	To perform batch updates, use the [[Repository.Model.GetAllModels]] method to get an array of all available models in the repository. Similar methods exist for all other types of Synthesis resources (e.g., [[Repository.URD.GetAllURDs]], [[Repository.Action.GetAllActions]], etc.). See the [[Repository Class]] reference doc for the complete list.		*To perform batch updates, use the [[Repository.Model.GetAllModels]] method to get an array of all available models in the repository. Similar methods exist for all other types of Synthesis resources (e.g., [[Repository.URD.GetAllURDs]], [[Repository.Action.GetAllActions]], etc.). See the [[Repository Class]] reference doc for the complete list.

	===References===		===References===

Kate Racaza at 19:02, 2 June 2016

2016-06-02T19:02:12Z

← Older revision		Revision as of 19:02, 2 June 2016
Line 83:		Line 83:
	To retrieve all other types of Synthesis resources, you can use the same approach demonstrated in the example. For example, to update the properties of an existing URD, you would use the [[Repository.URD.GetURD]] method to retrieve a single URD from the repository, and then use the [[Repository.URD.UpdateURD]] method to apply the changes.		To retrieve all other types of Synthesis resources, you can use the same approach demonstrated in the example. For example, to update the properties of an existing URD, you would use the [[Repository.URD.GetURD]] method to retrieve a single URD from the repository, and then use the [[Repository.URD.UpdateURD]] method to apply the changes.

	To perform batch updates, use the [[Repository.Model.GetAllModels]] method to get an array of all available models in the repository. Similar methods ~~exists~~ for all other types of Synthesis resources (e.g., [[Repository.URD.GetAllURDs]], [[Repository.Action.GetAllActions]], etc.). See the [[Repository Class]] reference doc for the complete list.		To perform batch updates, use the [[Repository.Model.GetAllModels]] method to get an array of all available models in the repository. Similar methods exist for all other types of Synthesis resources (e.g., [[Repository.URD.GetAllURDs]], [[Repository.Action.GetAllActions]], etc.). See the [[Repository Class]] reference doc for the complete list.

	===References===		===References===

Kate Racaza at 20:55, 12 May 2016

2016-05-12T20:55:55Z

← Older revision		Revision as of 20:55, 12 May 2016
Line 86:		Line 86:

	===References===		===References===
	*[[Repository.Model.GetModel\|Repository.Model.GetModel Method]]
	*[[Repository.Model.UpdateModel\|Repository.Model.UpdateModel Method]]
	*[[Repository Class]]		*[[Repository Class]]
			**[[Repository.Model.GetModel\|Repository.Model.GetModel Method]]
			**[[Repository.Model.UpdateModel\|Repository.Model.UpdateModel Method]]

Kate Racaza at 18:27, 5 May 2016

2016-05-05T18:27:33Z

← Older revision		Revision as of 18:27, 5 May 2016
Line 1:		Line 1:
	{{Template:API}}{{Template:BacktoPrevPage~~\|[[API Tutorials\|<< Back to Tutorials Main Page]]~~}}		{{Template:API}}{{Template:BacktoPrevPage}}

	In the [[Add_New_Synthesis_Resources_to_a_Repository\|previous tutorial]], you learned how to write data to a Synthesis repository; specifically, how to create new Synthesis resources (e.g., models, actions, URDs, etc.) and save them to a database. In this tutorial, you'll learn how to retrieve an existing Synthesis resource from a database, and then overwrite existing data about the resource with new information.		In the [[Add_New_Synthesis_Resources_to_a_Repository\|previous tutorial]], you learned how to write data to a Synthesis repository; specifically, how to create new Synthesis resources (e.g., models, actions, URDs, etc.) and save them to a database. In this tutorial, you'll learn how to retrieve an existing Synthesis resource from a database, and then overwrite existing data about the resource with new information.

Kate Racaza at 16:39, 29 April 2016

2016-04-29T16:39:52Z

← Older revision		Revision as of 16:39, 29 April 2016
Line 10:		Line 10:
	*Create a Synthesis repository for testing purposes. Then create a model via the Resource Manager ('''Project > Synthesis> Resource Manager'''). Do not use published models for this tutorial (i.e., model resources that have been published from and are associated with an existing analysis/data source). Published models are read-only and therefore cannot be used to demonstrate the goals of this tutorial.		*Create a Synthesis repository for testing purposes. Then create a model via the Resource Manager ('''Project > Synthesis> Resource Manager'''). Do not use published models for this tutorial (i.e., model resources that have been published from and are associated with an existing analysis/data source). Published models are read-only and therefore cannot be used to demonstrate the goals of this tutorial.

	*Note down the model's object ID number. ~~This~~ will ~~help you trace~~ the ~~response~~ from the ~~API~~. To display the object IDs, choose '''File > Application Setup''', then click '''Other''' under the Synthesis Settings heading in the navigation panel. Select the '''Display Object IDs''' check box. The object ID of the model is displayed in the Resource Manager.		*Note down the model's object ID number. You will use the ID# to retrieve the model from the database. (To display the object IDs, choose '''File > Application Setup''', then click '''Other''' under the Synthesis Settings heading in the navigation panel. Select the '''Display Object IDs''' check box. The object ID of the model is displayed in the Resource Manager.)


	==Tutorial: Edit an Existing Synthesis Resource==		==Tutorial: Edit an Existing Synthesis Resource==
Line 32:		Line 33:
	{{APIPrefix\|Dim}} Amodel {{APIPrefix\|As New}} cModel		{{APIPrefix\|Dim}} Amodel {{APIPrefix\|As New}} cModel

	{{APIComment\|'Retrieve a model from the ~~repository~~.}}		{{APIComment\|'Retrieve a model from the project.}}
	AModel = MyRepository.Model.GetModel(21){{APIComment\|'Replace with the object ID of test model.}}		AModel = MyRepository.Model.GetModel(21){{APIComment\|'Replace with the object ID of test model.}}

Line 40:		Line 41:
	Amodel.ItemPartNumber = {{APIString\|"PN5461"}}		Amodel.ItemPartNumber = {{APIString\|"PN5461"}}

	{{APIComment\|'Send the changes to the ~~Synthesis repository~~.}}		{{APIComment\|'Send the changes to the project.}}
	MyRepository.Model.UpdateModel(AModel)		MyRepository.Model.UpdateModel(AModel)

Line 47:		Line 48:

	===Discussion===		===Discussion===
	Begin by connecting to a Synthesis repository and project (for details, see [[Connect_or_Disconnect_from_a_Synthesis_Repository\|this tutorial]].) The ~~section of code~~ below demonstrates how to connect to a standard repository and open one of its projects. It assumes that a standard repository called "RSRepository1.rsr10" exists in the C drive and that we're accessing project ID#1. If you're copying this section of code, be sure to replace the inputs with appropriate data for your test repository.		Begin by connecting to a Synthesis repository and project (for details, see [[Connect_or_Disconnect_from_a_Synthesis_Repository\|this tutorial]].) The example below demonstrates how to connect to a standard repository and open one of its projects. It assumes that a standard repository called "RSRepository1.rsr10" exists in the C drive and that we're accessing project ID#1. If you're copying this section of code, be sure to replace the inputs with appropriate data for your test repository.

	{{APIComment\|'Connect to a Synthesis repository and project.}}		{{APIComment\|'Connect to a Synthesis repository and project.}}
Line 59:		Line 60:
	{{APIPrefix\|Dim}} Amodel {{APIPrefix\|As New}} cModel		{{APIPrefix\|Dim}} Amodel {{APIPrefix\|As New}} cModel

	{{APIComment\|'Retrieve a model from the ~~repository~~.}}		{{APIComment\|'Retrieve a model from the project.}}
	AModel = MyRepository.Model.GetModel(21){{APIComment\|'Replace with the object ID of test model.}}		AModel = MyRepository.Model.GetModel(21){{APIComment\|'Replace with the object ID of test model.}}

	You can then edit the model's properties. In this example, we edited the model's name, description and part number, as shown ~~in the following code~~.		You can then edit the model's properties. In this example, we edited the model's name, description and part number, as shown.

	{{APIComment\|'Edit the model's name, description and part number.}}		{{APIComment\|'Edit the model's name, description and part number.}}
Line 69:		Line 70:
	Amodel.ItemPartNumber = {{APIString\|"PN5461"}}		Amodel.ItemPartNumber = {{APIString\|"PN5461"}}

	Use the [[Repository.Model.UpdateModel\|Model.UpdateModel]] method to save the new information ~~about the model~~ to the Synthesis repository.		Use the [[Repository.Model.UpdateModel\|Model.UpdateModel]] method to save the new information to the Synthesis repository.

	{{APIComment\|'Send the changes to the ~~Synthesis repository~~.}}		{{APIComment\|'Send the changes to the project.}}
	MyRepository.Model.UpdateModel(AModel)		MyRepository.Model.UpdateModel(AModel)

Line 77:		Line 78:


	===Notes===		==Notes==
	To update a model's parameters, category or type, use the [[CModel.SetModel\|cModel.SetModel]] method to edit the data, and then follow it up with the [[Repository.Model.UpdateModel]] method to save the changes to the repository.		To update a model's parameters, category or type, use the [[CModel.SetModel\|cModel.SetModel]] method to edit the data, and then follow it up with the [[Repository.Model.UpdateModel]] method to save the changes to the repository.

Line 83:		Line 84:

	To perform batch updates, use the [[Repository.Model.GetAllModels]] method to get an array of all available models in the repository. Similar methods exists for all other types of Synthesis resources (e.g., [[Repository.URD.GetAllURDs]], [[Repository.Action.GetAllActions]], etc.). See the [[Repository Class]] reference doc for the complete list.		To perform batch updates, use the [[Repository.Model.GetAllModels]] method to get an array of all available models in the repository. Similar methods exists for all other types of Synthesis resources (e.g., [[Repository.URD.GetAllURDs]], [[Repository.Action.GetAllActions]], etc.). See the [[Repository Class]] reference doc for the complete list.


	===References===		===References===

Kate Racaza at 17:32, 28 April 2016

2016-04-28T17:32:27Z

← Older revision		Revision as of 17:32, 28 April 2016
Line 8:		Line 8:
	Before you begin:		Before you begin:

	*Create a repository for testing purposes. Then create a model via the Resource Manager ('''Project > Synthesis> Resource Manager'''). Do not use published models for this tutorial (i.e., model resources that have been published from and are associated with an existing analysis/data source). Published models are read-only and therefore cannot be used to demonstrate the goals of this tutorial.		*Create a Synthesis repository for testing purposes. Then create a model via the Resource Manager ('''Project > Synthesis> Resource Manager'''). Do not use published models for this tutorial (i.e., model resources that have been published from and are associated with an existing analysis/data source). Published models are read-only and therefore cannot be used to demonstrate the goals of this tutorial.

	*Note down the model's object ID number. This will help you trace the response from the API. To display the object IDs, choose '''File > Application Setup''', then click '''Other''' under the Synthesis Settings heading in the navigation panel. Select the '''Display Object IDs''' check box. The object ID of the model is displayed in the Resource Manager.		*Note down the model's object ID number. This will help you trace the response from the API. To display the object IDs, choose '''File > Application Setup''', then click '''Other''' under the Synthesis Settings heading in the navigation panel. Select the '''Display Object IDs''' check box. The object ID of the model is displayed in the Resource Manager.

Kate Racaza: /* Prerequisites */

2016-04-27T23:25:59Z

Prerequisites

← Older revision		Revision as of 23:25, 27 April 2016
Line 10:		Line 10:
	*Create a repository for testing purposes. Then create a model via the Resource Manager ('''Project > Synthesis> Resource Manager'''). Do not use published models for this tutorial (i.e., model resources that have been published from and are associated with an existing analysis/data source). Published models are read-only and therefore cannot be used to demonstrate the goals of this tutorial.		*Create a repository for testing purposes. Then create a model via the Resource Manager ('''Project > Synthesis> Resource Manager'''). Do not use published models for this tutorial (i.e., model resources that have been published from and are associated with an existing analysis/data source). Published models are read-only and therefore cannot be used to demonstrate the goals of this tutorial.

	*Note down the model's object ID number. This will help you trace the response from the API. To display the object IDs, choose '''File > Application Setup''', then click '''Other''' under the Synthesis Settings heading in the navigation panel. Select the ~~check box for~~ '''Display Object IDs'''. The object ID of the model is displayed in the Resource Manager.		*Note down the model's object ID number. This will help you trace the response from the API. To display the object IDs, choose '''File > Application Setup''', then click '''Other''' under the Synthesis Settings heading in the navigation panel. Select the '''Display Object IDs''' check box. The object ID of the model is displayed in the Resource Manager.


	==Tutorial: Edit an Existing Synthesis Resource==		==Tutorial: Edit an Existing Synthesis Resource==

Kate Racaza at 23:12, 27 April 2016

2016-04-27T23:12:16Z

← Older revision		Revision as of 23:12, 27 April 2016
Line 1:		Line 1:
	{{Template:API}}		{{Template:API}}{{Template:BacktoPrevPage\|[[API Tutorials\|<< Back to Tutorials Main Page]]}}

	In the [[Add_New_Synthesis_Resources_to_a_Repository\|previous tutorial]], you learned how to write data to a Synthesis repository; specifically, how to create new Synthesis resources (e.g., models, actions, URDs, etc.) and save them to a database. In this tutorial, you'll learn how to retrieve an existing Synthesis resource from a database, and then overwrite existing data about the resource with new information.		In the [[Add_New_Synthesis_Resources_to_a_Repository\|previous tutorial]], you learned how to write data to a Synthesis repository; specifically, how to create new Synthesis resources (e.g., models, actions, URDs, etc.) and save them to a database. In this tutorial, you'll learn how to retrieve an existing Synthesis resource from a database, and then overwrite existing data about the resource with new information.

Kate Racaza at 22:50, 27 April 2016

2016-04-27T22:50:46Z

Show changes

← Older revision		Revision as of 18:15, 3 April 2017
Line 1:		Line 1:
	{{Template:API}}{{Template:BacktoPrevPage}}		{{Template:API}}{{Template:BacktoPrevPage}}

	In the [[Add_New_Synthesis_Resources_to_a_Repository\|previous tutorial]], you learned ~~how to write data to a Synthesis repository; specifically,~~ how to create new Synthesis resources (e.g., models, actions, URDs, etc.) and save them to a database. In this tutorial, you'll learn how to retrieve an existing Synthesis resource from a database, and then overwrite existing data about the resource with new information.		In the [[Add_New_Synthesis_Resources_to_a_Repository\|previous tutorial]], you learned how to create new Synthesis resources (e.g., models, actions, URDs, etc.) and save them to a database. In this tutorial, you'll learn how to retrieve an existing Synthesis resource from a database, and then overwrite existing data about the resource with new information.

	You'll use a model resource to work with the example. A similar approach can be used when working with other types of Synthesis resources.		You'll use a model resource to work with the example. A similar approach can be used when working with other types of Synthesis resources.
Line 10:		Line 10:
	*Create a Synthesis repository for testing purposes. Then create a model via the Resource Manager ('''Project > Synthesis> Resource Manager'''). Do not use published models for this tutorial (i.e., model resources that have been published from and are associated with an existing analysis/data source). Published models are read-only and therefore cannot be used to demonstrate the goals of this tutorial.		*Create a Synthesis repository for testing purposes. Then create a model via the Resource Manager ('''Project > Synthesis> Resource Manager'''). Do not use published models for this tutorial (i.e., model resources that have been published from and are associated with an existing analysis/data source). Published models are read-only and therefore cannot be used to demonstrate the goals of this tutorial.

	*Note down the model's object ID ~~number~~. You will use the ID# to retrieve the model from the database. (To display the object IDs, choose '''File > Application Setup''', then click '''Other''' under the Synthesis Settings heading in the navigation panel. Select the '''Display Object IDs''' check box. The object ID of the model is displayed in the Resource Manager.)		*Note down the model's [[Synthesis_API_Object_IDs\|object ID]]. You will use the object ID to retrieve the model from the database.


Line 27:		Line 27:
	{{APIComment\|'Connect to a Synthesis repository and project.}}		{{APIComment\|'Connect to a Synthesis repository and project.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.~~rsr10~~"}}){{APIComment\|'Replace with name and path to test repository.}}		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr11"}}){{APIComment\|'Replace with name and path to test repository.}}
	MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}		MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}

Line 48:		Line 48:

	===Discussion===		===Discussion===
	Begin by connecting to a Synthesis repository and project (for details, see [[Connect_or_Disconnect_from_a_Synthesis_Repository\|this tutorial]].) The example below demonstrates how to connect to a standard repository and open one of its projects. It assumes that a standard repository called "RSRepository1.~~rsr10~~" exists in the C drive and that we're accessing project ID#1. If you're copying this section of code, be sure to replace the inputs with appropriate data for your test repository.		Begin by connecting to a Synthesis repository and project (for details, see [[Connect_or_Disconnect_from_a_Synthesis_Repository\|this tutorial]].) The example below demonstrates how to connect to a standard repository and open one of its projects. It assumes that a standard repository called "RSRepository1.rsr11" exists in the C drive and that we're accessing project ID#1. If you're copying this section of code, be sure to replace the inputs with appropriate data for your test repository.

	{{APIComment\|'Connect to a Synthesis repository and project.}}		{{APIComment\|'Connect to a Synthesis repository and project.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.~~rsr10~~"}}){{APIComment\|'Replace with name and path to test repository.}}		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr11"}}){{APIComment\|'Replace with name and path to test repository.}}
	MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}		MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}

Line 63:		Line 63:
	AModel = MyRepository.Model.GetModel(21){{APIComment\|'Replace with the object ID of test model.}}		AModel = MyRepository.Model.GetModel(21){{APIComment\|'Replace with the object ID of test model.}}

	You can then edit the model's properties. In this example, we edited the model's name, description and part number, as shown.		You can then edit the model's properties. In this example, we edited the model's name, description and part number, as shown. (To update a model's parameters, category or type, use the [[CModel.SetModel\|cModel.SetModel]] method.)

	{{APIComment\|'Edit the model's name, description and part number.}}		{{APIComment\|'Edit the model's name, description and part number.}}
Line 79:		Line 79:

	==Notes==		==Notes==
	*To update a model's parameters, category or type, use the [[CModel.SetModel\|cModel.SetModel]] method to edit the data, and then follow it up with the [[Repository.Model.UpdateModel]] method to save the changes to the repository.

	*To retrieve all other types of Synthesis resources, you can use the same approach demonstrated in the example. For example, to update the properties of an existing URD, you would use the [[Repository.URD.GetURD]] method to retrieve a single URD from the repository, and then use the [[Repository.URD.UpdateURD]] method to apply the changes.		*To retrieve all other types of Synthesis resources, you can use the same approach demonstrated in the example. For example, to update the properties of an existing URD, you would use the [[Repository.URD.GetURD]] method to retrieve a single URD from the repository, and then use the [[Repository.URD.UpdateURD]] method to apply the changes.

	*To perform batch updates, use the [[Repository.Model.GetAllModels]] method to get an array of all available models in the repository. Similar methods exist for all other types of Synthesis resources (e.g., [[Repository.URD.GetAllURDs]], [[Repository.Action.GetAllActions]], etc.). See the [[Repository Class]] reference ~~doc~~ for the complete list.		*To perform batch updates, use the [[Repository.Model.GetAllModels]] method to get an array of all available models in the repository. Similar methods exist for all other types of Synthesis resources (e.g., [[Repository.URD.GetAllURDs]], [[Repository.Action.GetAllActions]], etc.). See the [[Repository Class]] reference documentation for the complete list.

	===References===		===References===