Talk:Edit Existing Synthesis Resources/Notes: Difference between revisions

Revision as of 21:24, 27 April 2016

In the 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.

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.

Prerequisites

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.

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.

Tutorial: Edit an Existing Synthesis Resource

The following example demonstrates how to retrieve a Synthesis resource from a repository and overwrite existing data about the resource with new information. A discussion of the example follows.

A VBA version of the code sample is available here.

VB.NET

Imports SynthesisAPI 

Public Module Module1
   Sub Main()
 
   'Connect to a Synthesis repository and project. 
    Dim MyRepository As New Repository
    MyRepository.ConnectToRepository("C:\RSRepository1.rsr10") 'Replace with name and path to test repository. 
    MyRepository.Project.SetCurrentProject(1) 'Replace with the object ID of test project. 
  
   'Retrieve a model from the repository.  
    Dim Amodel As New cModel
    AModel = MyRepository.Model.GetModel(21) 'Replace with the object ID of test model. 

   'Edit the model's name, description and part number. 
    Amodel.Name = "MyNewModel_Updated"
    Amodel.ItemDescription = "A specific type of light bulb."
    Amodel.ItemPartNumber = "PN5461"   

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

   End Sub
End Module

====

Create a new module and begin by connecting to a Synthesis repository and project. The following code assumes that a standard repository called "RSRepository1.rsr10" exists in the C drive.

 'Connect to the Synthesis repository and set project ID#1 as the current project. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToRepository("C:\RSRepository1.rsr10")
  MyRepository.Project.SetCurrentProject(1)

2. Retrieve a model from the repository. Use the GetModel method to retrieve the model. The following code assumes that the repository contains a model with ID number 21.

VBA

 'Retrieve the model with ID# 21 from the repository. 
  Dim Amodel As New cModel
  Set AModel = MyRepository.Model.GetModel(21)

VB.NET

 'Retrieve the model with ID# 21 from the repository.  
  Dim Amodel As New cModel
  AModel = MyRepository.Model.GetModel(21)

3. Edit the model's properties. For example, let's edit the model's name, description and part number, as shown in the following code.

  'Edit the model's name, description and part number. 
  Amodel.Name = "MyNewModel_Updated"
  Amodel.ItemDescription = "A specific type of light bulb."
  Amodel.ItemPartNumber = "PN5461"

4. Use the UpdateModel method to apply the changes to the model.

VBA

 'Apply the changes to the model. 
  Call MyRepository.Model.UpdateModel(AModel)

VB.NET
 
 'Apply the changes to the model. 
  MyRepository.Model.UpdateModel(AModel)

Test the Code

Below are the complete code lists for this example. To test them, run the application by clicking Start on the Debug menu. Then verify that the model's properties have been updated by checking the Resource Manager. (You may need to display the Description and Part Number columns of the Resource Manager by right-clicking a column header and choosing Select Columns.)

VBA

Sub Main()

 'Connect to the Synthesis repository and set project ID#1 as the current project. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToRepository("C:\RSRepository1.rsr10")
  MyRepository.Project.SetCurrentProject(1)

 'Retrieve the model with ID# 21 from the repository. 
  Dim Amodel As New cModel
  Set AModel = MyRepository.Model.GetModel(21)

  'Edit the model's name, description and part number. 
  Amodel.Name = "MyNewModel_Updated"
  Amodel.ItemDescription = "A specific type of light bulb."
  Amodel.ItemPartNumber = "PN5461"   
 
 'Apply the changes to the model. 
  Call MyRepository.Model.UpdateModel(AModel)

End Sub

VB.NET

Imports SynthesisAPI 

Public Class Form1
   Private Sub Button1_Click(sender As System.Object, e As System.EventArgs) Handles Button1.Click
  
   'Connect to the Synthesis repository and set project ID#1 as the current project. 
    Dim MyRepository As New Repository
    MyRepository.ConnectToRepository("C:\RSRepository1.rsr10")
    MyRepository.Project.SetCurrentProject(1)
  
   'Retrieve the model with ID# 21 from the repository.  
    Dim Amodel As New cModel
    AModel = MyRepository.Model.GetModel(21)

   'Edit the model's name, description and part number. 
    Amodel.Name = "MyNewModel_Updated"
    Amodel.ItemDescription = "A specific type of light bulb."
    Amodel.ItemPartNumber = "PN5461"   

   'Apply the changes to the model. 
    MyRepository.Model.UpdateModel(AModel)

   End Sub
End Class

Notes

You can use a similar approach to update the properties of other types of Synthesis repositories. For example, to update the properties of an existing URD, you would use the Repository.URD.GetURD method to retrieve the URD from the repository, and then use the Repository.URD.UpdateURD method to apply the changes.

References

To learn more, see the reference documentation for the methods discussed in this tutorial:

Next: Calculate Results from a Model >>

@@ Line 1: / Line 1: @@
 {{Template:API}}
-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 retrieving 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.
 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 8: / Line 8: @@
 Before you begin:
-*Create a model in a test repository 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.
-*Display the object IDs in the Synthesis application, so you can obtain the model's ID number and trace the response from the API (Choose '''File > Application Setup'''. Then click '''Other''' under the Synthesis Settings heading in the navigation panel. Select the check box for '''Display Object IDs'''.)
+*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.