Add New Synthesis Resources to a Repository - Revision history

Kate Racaza at 15:12, 3 August 2017

2017-08-03T15:12:58Z

← Older revision		Revision as of 15:12, 3 August 2017
Line 103:		Line 103:
	*[[CModel Class\|cModel Class]]		*[[CModel Class\|cModel Class]]
	**[[CModel.SetModel\|cModel.SetModel Method]]		**[[CModel.SetModel\|cModel.SetModel Method]]
	**[[CModel_Constructors\|cModel Constructor (VB.NET Only)]]		**[[CModel_Constructors\|cModel Constructor (.NET Only)]]
	*[[Repository.Model.AddModel\|Repository.Model.AddModel Method]]		*[[Repository.Model.AddModel\|Repository.Model.AddModel Method]]

Kate Racaza at 18:07, 3 April 2017

2017-04-03T18:07:37Z

Kate Racaza at 20:55, 12 May 2016

2016-05-12T20:55:23Z

← Older revision		Revision as of 20:55, 12 May 2016
Line 102:		Line 102:
	===References===		===References===
	*[[CModel Class\|cModel Class]]		*[[CModel Class\|cModel Class]]
	*[[CModel.SetModel\|cModel.SetModel Method]]		**[[CModel.SetModel\|cModel.SetModel Method]]
	*[[CModel_Constructors\|cModel Constructor (VB.NET Only)]]		**[[CModel_Constructors\|cModel Constructor (VB.NET Only)]]
	*[[Repository.Model.AddModel\|Repository.Model.AddModel Method]]		*[[Repository.Model.AddModel\|Repository.Model.AddModel Method]]

Kate Racaza at 18:27, 5 May 2016

2016-05-05T18:27:18Z

← 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}}

	The Synthesis API object library has a class for every type of Synthesis resource (e.g., models, tasks, actions, etc.). In this tutorial, you'll learn how to use the API to create a model resource, define its properties and then save it to a Synthesis repository. A similar approach can be used to create and save other types of Synthesis resources.		The Synthesis API object library has a class for every type of Synthesis resource (e.g., models, tasks, actions, etc.). In this tutorial, you'll learn how to use the API to create a model resource, define its properties and then save it to a Synthesis repository. A similar approach can be used to create and save other types of Synthesis resources.

Kate Racaza at 16:35, 29 April 2016

2016-04-29T16:35:00Z

← Older revision		Revision as of 16:35, 29 April 2016
Line 39:		Line 39:
	{{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"}})		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr10"}}){{APIComment\|'Replace with name and path to test repository.}}
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}

	{{APIComment\|'Send the model to the project.}}		{{APIComment\|'Send the model to the project.}}
Line 79:		Line 79:
	{{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"}})		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr10"}}){{APIComment\|'Replace with name and path to test repository.}}
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}

	Now that we have access to a project, we can use the [[Repository.Model.AddModel\|Model.AddModel]] method to save the model to the project.		Now that we have access to a project, we can use the [[Repository.Model.AddModel\|Model.AddModel]] method to save the model to the project.

Kate Racaza at 16:22, 29 April 2016

2016-04-29T16:22:05Z

← Older revision		Revision as of 16:22, 29 April 2016
Line 2:		Line 2:

	The Synthesis API object library has a class for every type of Synthesis resource (e.g., models, tasks, actions, etc.). In this tutorial, you'll learn how to use the API to create a model resource, define its properties and then save it to a Synthesis repository. A similar approach can be used to create and save other types of Synthesis resources.		The Synthesis API object library has a class for every type of Synthesis resource (e.g., models, tasks, actions, etc.). In this tutorial, you'll learn how to use the API to create a model resource, define its properties and then save it to a Synthesis repository. A similar approach can be used to create and save other types of Synthesis resources.


			==Prerequisistes==
			Before you begin, please create a Synthesis repository for testing purposes.


	==Tutorial: Add a New Synthesis Resource to a Repository==		==Tutorial: Add a New Synthesis Resource to a Repository==
Line 42:		Line 47:
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}
	{{APIPrefix\|End Module}}		{{APIPrefix\|End Module}}


	===Discussion===		===Discussion===
Line 78:		Line 82:
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)

	Now that we have access to a project, we can use the [[Repository.Model.AddModel\|Model.AddModel]] method ~~in the class~~ to save the model to the project~~. Note that for secure databases, you must have the necessary read/write permissions to perform this command~~.		Now that we have access to a project, we can use the [[Repository.Model.AddModel\|Model.AddModel]] method to save the model to the project.

	{{APIComment\|'Send the model to the project.}}		{{APIComment\|'Send the model to the project.}}
Line 86:		Line 90:


	===Notes===		==Notes==
	~~Parameterized constructors are available in~~ the ~~.NET version of the Synthesis API library. This allows you~~ to ~~simplify, for example, the declaration of~~ a ~~cModel object to:~~		In secure databases, you must have the necessary permissions to read/write to a project and create/edit resources.

	~~{{APIPrefix\|Dim}} AModel {{APIPrefix\|As New}} cModel('~~'~~ModelType~~, ~~ModelCategory~~, ~~ModelName, ModelParams~~()~~'')~~		Now that you've learned how to add a model resource to a project, try adding other types of Synthesis resources. For example, to create a Universal Reliability Definition (URD) resource, use the [[CURD_Class\|cURD]] class, and then use the [[Repository.URD.AddURD\|Repository.URD.AddURD]] method to save the URD to the project.

	~~Now that you've learned how to add a model resource to a project, try adding other types~~ of Synthesis ~~resources~~. ~~For example,~~ to ~~create a Universal Reliability Definition (URD) resource~~, ~~use the [[CURD_Class\|cURD]] class~~, ~~and then use~~ the ~~[[Repository.URD.AddURD\|Repository.URD.AddURD]] method to save the URD~~ to ~~the project.~~		====Parameterized Constructors====
			Parameterized constructors are available in the .NET version of the Synthesis API object library. This allows you to simplify, for example, the declaration of a cModel object to:

			{{APIPrefix\|Dim}} AModel {{APIPrefix\|As New}} cModel(''ModelType, ModelCategory, ModelName, ModelParams()'')

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

Kate Racaza at 23:12, 27 April 2016

2016-04-27T23:12:01Z

← 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]]}}

	The Synthesis API object library has a class for every type of Synthesis resource (e.g., models, tasks, actions, etc.). In this tutorial, you'll learn how to use the API to create a model resource, define its properties and then save it to a Synthesis repository. A similar approach can be used to create and save other types of Synthesis resources.		The Synthesis API object library has a class for every type of Synthesis resource (e.g., models, tasks, actions, etc.). In this tutorial, you'll learn how to use the API to create a model resource, define its properties and then save it to a Synthesis repository. A similar approach can be used to create and save other types of Synthesis resources.

Kate Racaza at 21:10, 27 April 2016

2016-04-27T21:10:21Z

← Older revision		Revision as of 21:10, 27 April 2016
Line 11:		Line 11:
	{{APIPrefix\|Imports}} SynthesisAPI		{{APIPrefix\|Imports}} SynthesisAPI

	{{APIPrefix\|Module}} ~~Module~~		{{APIPrefix\|Module}} Module1
	{{APIPrefix\|Sub}} Main()		{{APIPrefix\|Sub}} Main()

Kate Racaza at 20:44, 27 April 2016

2016-04-27T20:44:45Z

Show changes

Kate Racaza: /* References */

2016-02-17T16:32:46Z

References

← Older revision		Revision as of 16:32, 17 February 2016
Line 131:		Line 131:

	===References===		===References===
	To learn more, see the reference documentation for the classes and methods discussed in this ~~section~~:		To learn more, see the reference documentation for the classes and methods discussed in this tutorial:

	*[[CModel Class\|cModel Class]]		*[[CModel Class\|cModel Class]]

← Older revision		Revision as of 15:12, 3 August 2017
Line 103:		Line 103:
	*[[CModel Class\|cModel Class]]		*[[CModel Class\|cModel Class]]
	**[[CModel.SetModel\|cModel.SetModel Method]]		**[[CModel.SetModel\|cModel.SetModel Method]]
	**[[CModel_Constructors\|cModel Constructor (VB.NET Only)]]		**[[CModel_Constructors\|cModel Constructor (.NET Only)]]
	*[[Repository.Model.AddModel\|Repository.Model.AddModel Method]]		*[[Repository.Model.AddModel\|Repository.Model.AddModel Method]]

← Older revision		Revision as of 20:55, 12 May 2016
Line 102:		Line 102:
	===References===		===References===
	*[[CModel Class\|cModel Class]]		*[[CModel Class\|cModel Class]]
	*[[CModel.SetModel\|cModel.SetModel Method]]		**[[CModel.SetModel\|cModel.SetModel Method]]
	*[[CModel_Constructors\|cModel Constructor (VB.NET Only)]]		**[[CModel_Constructors\|cModel Constructor (VB.NET Only)]]
	*[[Repository.Model.AddModel\|Repository.Model.AddModel Method]]		*[[Repository.Model.AddModel\|Repository.Model.AddModel Method]]

← Older revision		Revision as of 16:35, 29 April 2016
Line 39:		Line 39:
	{{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"}})		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr10"}}){{APIComment\|'Replace with name and path to test repository.}}
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}

	{{APIComment\|'Send the model to the project.}}		{{APIComment\|'Send the model to the project.}}
Line 79:		Line 79:
	{{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"}})		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr10"}}){{APIComment\|'Replace with name and path to test repository.}}
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}

	Now that we have access to a project, we can use the [[Repository.Model.AddModel\|Model.AddModel]] method to save the model to the project.		Now that we have access to a project, we can use the [[Repository.Model.AddModel\|Model.AddModel]] method to save the model to the project.

← Older revision		Revision as of 21:10, 27 April 2016
Line 11:		Line 11:
	{{APIPrefix\|Imports}} SynthesisAPI		{{APIPrefix\|Imports}} SynthesisAPI

	{{APIPrefix\|Module}} ~~Module~~		{{APIPrefix\|Module}} Module1
	{{APIPrefix\|Sub}} Main()		{{APIPrefix\|Sub}} Main()

← Older revision		Revision as of 18:07, 3 April 2017
Line 4:		Line 4:


	==~~Prerequisistes~~==		==Prerequisites==
	Before you begin, please create a Synthesis repository for testing purposes.		Before you begin, please create a Synthesis repository for testing purposes.

Line 39:		Line 39:
	{{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 75:		Line 75:
	Next, we'll save the model to a Synthesis repository.		Next, we'll save the model to a Synthesis repository.

	The [[Repository Class\|Repository]] class represents a Synthesis repository. This class contains all the functions that enable you to read or write data to a repository. 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 (for a full discussion on the method, see [[Connect_or_Disconnect_from_a_Synthesis_Repository\|this tutorial]].)		The [[Repository Class\|Repository]] class represents a Synthesis repository. This class contains all the functions that enable you to read or write data to a repository. 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 (for a full discussion on the method, see [[Connect_or_Disconnect_from_a_Synthesis_Repository\|this tutorial]].)

	{{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.}}