Connect or Disconnect from a Synthesis Repository - Revision history

Kate Racaza at 18:00, 3 April 2017

2017-04-03T18:00:26Z

Kate Racaza at 18:05, 17 June 2016

2016-06-17T18:05:21Z

← Older revision		Revision as of 18:05, 17 June 2016
Line 59:		Line 59:
	Once you are connected to a repository, you can specify which of its projects is the current (or active) project. Specifying the current project is required only if you plan to read/write data stored in projects (e.g., updating the properties of a URD resource, calculating metrics from a model resource, etc.).		Once you are connected to a repository, you can specify which of its projects is the current (or active) project. Specifying the current project is required only if you plan to read/write data stored in projects (e.g., updating the properties of a URD resource, calculating metrics from a model resource, etc.).

	~~Here, we used~~ the [[Repository.Project.GetAllProjects\|Project.GetAllProjects]] method to get an array of all the projects in the repository. The method returns a [[NameIdPair_Class\|NameIDPair]] ~~object~~ that ~~represents~~ the name and ID pair of each project.		Use the [[Repository.Project.GetAllProjects\|Project.GetAllProjects]] method to get an array of all the projects in the repository. The method returns an array of [[NameIdPair_Class\|NameIDPair]] objects that represent the name and ID pair of each project.

	The [[Repository.Project.SetCurrentProject\|Project.SetCurrentProject]] method is then used to select the desired project. In this case, we've chosen the first project in the array. Any time you wish to switch to another project in the current repository, use this method again to specify the new active project.		The [[Repository.Project.SetCurrentProject\|Project.SetCurrentProject]] method is then used to select the desired project. In this case, we've chosen the first project in the array. Any time you wish to switch to another project in the current repository, use this method again to specify the new active project.

Kate Racaza at 20:54, 12 May 2016

2016-05-12T20:54:57Z

← Older revision		Revision as of 20:54, 12 May 2016
Line 97:		Line 97:
	===References===		===References===
	*[[Repository Class]]		*[[Repository Class]]
			**[[Repository.ConnectToRepository\|Repository.ConnectToRepository Method]]
			**[[Repository.DisconnectFromRepository\|Repository.DisconnectFromRepository Method]]
			**[[Repository.Project.GetAllProjects\|Repository.Project.GetAllProjects Method]]
			**[[Repository.Project.SetCurrentProject\|Repository.Project.SetCurrentProject Method]]
			**[[Repository.Project.GetCurrentProject\|Repository.Project.GetCurrentProject Method]]
	*[[NameIdPair Class]]		*[[NameIdPair Class]]
	*[[Repository.ConnectToRepository\|Repository.ConnectToRepository Method]]
	*[[Repository.DisconnectFromRepository\|Repository.DisconnectFromRepository Method]]
	*[[Repository.Project.GetAllProjects\|Repository.Project.GetAllProjects Method]]
	*[[Repository.Project.SetCurrentProject\|Repository.Project.SetCurrentProject Method]]
	*[[Repository.Project.GetCurrentProject\|Repository.Project.GetCurrentProject Method]]

Kate Racaza at 18:27, 5 May 2016

2016-05-05T18:27:01Z

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

Kate Racaza at 16:05, 29 April 2016

2016-04-29T16:05:16Z

← Older revision		Revision as of 16:05, 29 April 2016
Line 46:		Line 46:
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}
	{{APIPrefix\|End Module}}		{{APIPrefix\|End Module}}


	===Discussion===		===Discussion===
Line 89:		Line 88:


	===Notes===		==Notes==
	To connect to an SQL repository, use the [[Repository.ConnectToSQLRepository\|ConnectToSQLRepository]] method.		To connect to an SQL repository, use the [[Repository.ConnectToSQLRepository\|ConnectToSQLRepository]] method.

Line 95:		Line 94:

	Note that in a secure database, you must at least have "read" permissions in the repository in order to connect successfully.		Note that in a secure database, you must at least have "read" permissions in the repository in order to connect successfully.


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

Kate Racaza at 15:56, 29 April 2016

2016-04-29T15:56:21Z

← Older revision		Revision as of 15:56, 29 April 2016
Line 49:		Line 49:

	===Discussion===		===Discussion===
	The [[Repository Class\|Repository]] class represents a Synthesis repository. It provides several methods for connecting to either a standard or enterprise repository. In this example, we used the basic [[Repository.ConnectToRepository\|ConnectToRepository]] method to connect to a standard repository. (To connect to an SQL repository, use the [[Repository.ConnectToSQLRepository\|ConnectToSQLRepository]] method. To connect to an Oracle repository, use the [[Repository.ConnectToOracleRepository\|ConnectToOracleRepository]] method.)		The [[Repository Class\|Repository]] class represents a Synthesis repository. It provides several methods for connecting to either a standard or enterprise repository. In this example, we used the basic [[Repository.ConnectToRepository\|ConnectToRepository]] method to connect to a standard repository.

	~~Note that to connect successfully, you must at least have "read" permissions in the~~ repository.

	{{APIComment\|'Declare a new Repository object.}}		{{APIComment\|'Declare a new Repository object.}}
Line 60:		Line 58:
	MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr10"}})		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr10"}})

	Once you are connected to a repository, you ~~must~~ specify which of its projects is the current (or active) project. ~~Here, we used~~ the ~~[[Repository.Project.GetAllProjects\|Project.GetAllProjects]] method~~ to ~~return an array of all the~~ projects ~~in the repository~~. ~~The method returns a [[NameIdPair_Class\|NameIDPair]] object that represents~~ the ~~name and ID pair~~ of ~~each project~~.		Once you are connected to a repository, you can specify which of its projects is the current (or active) project. Specifying the current project is required only if you plan to read/write data stored in projects (e.g., updating the properties of a URD resource, calculating metrics from a model resource, etc.).

	~~The~~ [[Repository.Project.~~SetCurrentProject~~\|Project.~~SetCurrentProject~~]] method ~~is then used~~ to ~~select~~ the ~~desired project~~. ~~In this case, we've chosen~~ the ~~first~~ project ~~in the array~~.		Here, we used the [[Repository.Project.GetAllProjects\|Project.GetAllProjects]] method to get an array of all the projects in the repository. The method returns a [[NameIdPair_Class\|NameIDPair]] object that represents the name and ID pair of each project.

	Any time you wish to switch to another project in the current repository, use ~~the <code>Project.SetCurrentProject</code>~~ method again to specify the new active project.		The [[Repository.Project.SetCurrentProject\|Project.SetCurrentProject]] method is then used to select the desired project. In this case, we've chosen the first project in the array. Any time you wish to switch to another project in the current repository, use this method again to specify the new active project.

	{{APIComment\|'Declare a new NameIdPair object.}}		{{APIComment\|'Declare a new NameIdPair object.}}
Line 75:		Line 73:
	MyRepository.Project.SetCurrentProject(ListofProjects(0).ID)		MyRepository.Project.SetCurrentProject(ListofProjects(0).ID)

	In the ~~following section~~, ~~we've used~~ the [[Repository.Project.GetCurrentProject\|Project.GetCurrentProject]] method ~~to return~~ the name and ID ~~pair of the current project~~.		To show the name and ID of the current project in an output, use the [[Repository.Project.GetCurrentProject\|Project.GetCurrentProject]] method. The following example displays the current project's name and ID in a message box.

	{{APIComment\|'Display the name and object ID number of the current project.}}		{{APIComment\|'Display the name and object ID number of the current project.}}
Line 85:		Line 83:
	MsgBox ({{APIString\|"You are currently connected to: "}} & ProjectName & {{APIString\|", ID#"}} & ProjectID)		MsgBox ({{APIString\|"You are currently connected to: "}} & ProjectName & {{APIString\|", ID#"}} & ProjectID)

	Finally, the following code disconnects the session from the current repository.		Finally, the following code disconnects the session from the current repository. This allows you to connect the <code>Repository</code> object to a new Synthesis repository, if desired.

	{{APIComment\|'Disconnect from the Synthesis repository.}}		{{APIComment\|'Disconnect from the Synthesis repository.}}
	MyRepository.DisconnectFromRepository		MyRepository.DisconnectFromRepository


			===Notes===
			To connect to an SQL repository, use the [[Repository.ConnectToSQLRepository\|ConnectToSQLRepository]] method.

			To connect to an Oracle repository, use the [[Repository.ConnectToOracleRepository\|ConnectToOracleRepository]] method.

			Note that in a secure database, you must at least have "read" permissions in the repository in order to connect successfully.

Kate Racaza at 23:11, 27 April 2016

2016-04-27T23:11:27Z

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




	==Tutorial: Connect and Disconnect from a Synthesis Repository==		==Tutorial: Connect and Disconnect from a Synthesis Repository==

Kate Racaza at 18:42, 27 April 2016

2016-04-27T18:42:43Z

← Older revision		Revision as of 18:42, 27 April 2016
Line 2:		Line 2:

	==Tutorial: Connect and Disconnect from a Synthesis Repository==		==Tutorial: Connect and Disconnect from a Synthesis Repository==
	The following example demonstrates how to connect to a standard Synthesis repository, access one of its projects, and then disconnect from the repository. A ~~step-by-step walkthrough~~ of the example follows.		The following example demonstrates how to connect to a standard Synthesis repository, access one of its projects, and then disconnect from the repository. A discussion of the example follows.

	A VBA version of the code sample is available [[Connect_or_Disconnect_from_a_Synthesis_Repository/VBA\|here]].		A VBA version of the code sample is available [[Connect_or_Disconnect_from_a_Synthesis_Repository/VBA\|here]].
Line 42:		Line 42:
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}
	{{APIPrefix\|End Module}}		{{APIPrefix\|End Module}}


	===Discussion===		===Discussion===
Line 84:		Line 85:
	{{APIComment\|'Disconnect from the Synthesis repository.}}		{{APIComment\|'Disconnect from the Synthesis repository.}}
	MyRepository.DisconnectFromRepository		MyRepository.DisconnectFromRepository


	===References===		===References===
Line 93:		Line 95:
	*[[Repository.Project.SetCurrentProject\|Repository.Project.SetCurrentProject Method]]		*[[Repository.Project.SetCurrentProject\|Repository.Project.SetCurrentProject Method]]
	*[[Repository.Project.GetCurrentProject\|Repository.Project.GetCurrentProject Method]]		*[[Repository.Project.GetCurrentProject\|Repository.Project.GetCurrentProject Method]]

Kate Racaza at 23:47, 26 April 2016

2016-04-26T23:47:06Z

Show changes

Kate Racaza at 23:44, 9 February 2016

2016-02-09T23:44:19Z

← Older revision		Revision as of 23:44, 9 February 2016
Line 4:		Line 4:

	'''Basics'''		'''Basics'''
	#Connect or Disconnect from a Synthesis Repository		#[[Connect or Disconnect from a Synthesis Repository]]
	#[[~~APISynthesisResourcesTutorial2\|Create a~~ New Synthesis ~~Resource~~]]		#[[Add New Synthesis Resources to a Repository]]
	#[[~~APISynthesisResourcesTutorial3\|Update an~~ Existing ~~Resource~~]]		#[[Edit Existing Synthesis Resources]]
	#[[~~APISynthesisResourcesTutorial4\|~~Calculate Results from a Model]]		#[[Calculate Results from a Model]]
	</div>		</div>

Line 151:		Line 151:


	'''<span style="color:#808080;">Next: [[~~APISynthesisResourcesTutorial2~~\|~~Create a~~ New Synthesis ~~Resource~~ >>]]</span>'''		'''<span style="color:#808080;">Next: [[Add New Synthesis Resources to a Repository\|Add New Synthesis Resources to a Repository >>]]</span>'''

← Older revision		Revision as of 18:00, 3 April 2017
Line 21:		Line 21:

	{{APIComment\|'Specify the full path to the standard repository. Assume that}}		{{APIComment\|'Specify the full path to the standard repository. Assume that}}
	{{APIComment\|'a standard repository called "RSRepository1.~~rsr10~~" exists in the C drive.}}		{{APIComment\|'a standard repository called "RSRepository1.rsr11" exists in the C drive.}}
	MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.~~rsr10~~"}})		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr11"}})

	{{APIComment\|'Declare a new NameIdPair object.}}		{{APIComment\|'Declare a new NameIdPair object.}}
Line 54:		Line 54:

	{{APIComment\|'Specify the full path to the Synthesis repository. Assume that}}		{{APIComment\|'Specify the full path to the Synthesis repository. Assume that}}
	{{APIComment\|'a standard repository called "RSRepository1.~~rsr10~~" exists in the C drive.}}		{{APIComment\|'a standard repository called "RSRepository1.rsr11" exists in the C drive.}}
	MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.~~rsr10~~"}})		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr11"}})

	Once you are connected to a repository, you can specify which of its projects is the current (or active) project. Specifying the current project is required only if you plan to read/write data stored in projects (e.g., updating the properties of a URD resource, calculating metrics from a model resource, etc.).		Once you are connected to a repository, you can specify which of its projects is the current (or active) project. Specifying the current project is required only if you plan to read/write data stored in projects (e.g., updating the properties of a URD resource, calculating metrics from a model resource, etc.).
Line 82:		Line 82:
	MsgBox ({{APIString\|"You are currently connected to: "}} & ProjectName & {{APIString\|", ID#"}} & ProjectID)		MsgBox ({{APIString\|"You are currently connected to: "}} & ProjectName & {{APIString\|", ID#"}} & ProjectID)

	Finally, the following code disconnects the session from the current repository~~. This allows you to connect the <code>Repository</code> object to a new Synthesis repository, if desired~~.		Finally, the following code disconnects the session from the current repository.

	{{APIComment\|'Disconnect from the Synthesis repository.}}		{{APIComment\|'Disconnect from the Synthesis repository.}}