Add the DRDS-II handler to the BES - Revision history

Ndp: Removing all content from page

2009-04-27T22:44:49Z

Removing all content from page

← Older revision		Revision as of 22:44, 27 April 2009
Line 1:		Line 1:
	~~'''Point Of Contact:''' ''A Human''~~

	~~== Description ==~~
	~~<font size="-2" color="green">''Give a short descriptive name for the use case to serve as a unique identifier.''</font>~~

	~~== Goal ==~~
	~~<font size="-2" color="green">''The goal briefly describes what the user intends to achieve with this use case.''</font>~~

	~~A person who is configuring a BES daemon adds the RDH and viola, the BES can now retrieve data from an RDBMS.~~

	~~== Summary ==~~
	<font size="-2" color="green">''Give a summary of the use case to capture the essence of the use case (no longer than a page). It provides a quick overview and includes the goal and principal actor.''</font>

	~~The RDH handler reads a configuration (parts of the bes.conf file?) from which it learns:~~
	* Which ODBC driver to load.
	* Database connection information (connection URL, database name, username, password, etc.)

	It then connects to the RDMS and uses the introspection methods of ODBC to collect information about the tables and views in the target database. (This activity may happen at startup and be refreshed asynchronously, or it may be gathered each time a request for the cataolg/inventory is received))

	~~This use case covers just how the RDH handler is added to the BES and how it uses it's configuration to establish a connection with an RDBMS.~~

	~~== Actors ==~~
	<font size="-2" color="green">''List actors, people or things outside the system that either acts on the system (primary actors) or is acted on by the system (secondary actors). Primary actors are ones that invoke the use case and benefit from the result. Identify sensors, models, portals and relevant data resources. Identify the primary actor and briefly describe role.''</font>

	~~A data provider or system administrator.~~

	~~== Preconditions ==~~
	<font size="-2" color="green">''Here we state any assumptions about the state of the system that must be met for the trigger (below) to initiate the use case. Any assumptions about other systems can also be stated here, for example, weather conditions. List all preconditions.''</font>

	~~# The BES is installed and configured, except for the RDH~~
	~~# There is an accessible RDBMS with tables and/or views containing data to be served.~~
	~~# ODBC Data Source Definition(s) for the databases to be accessed have been created and tested on the BES host. Data Source Definitions contain the follwoing types of information:~~
	~~#* The name of the Data Source Definition (which is used by processes on the host using ODBC)~~
	~~#* ODBC driver string/id/thingy~~
	~~#* The host name or IP address of the RDBMS system~~
	~~#* The port number of the RDBMS system.~~
	~~#* The user name to use for connecting to the RDBMS~~
	~~#* The password associated with user name~~
	~~#* The name of database in the RDBMS~~

	~~== Triggers ==~~
	<font size="-2" color="green">''Here we describe in detail the event or events that brings about the execution of this use case. Triggers can be external, temporal, or internal. They can be single events or when a set of conditions are met, List all triggers and relationships.''</font>

	The trigger is the need to add this feature to the Hyrax data server. In the case of the IOOS projects, the RDH Handler will provide DAP access to in situ data stored in a RDBMS. Satisfying the requirements for that project will be the trigger. In general, the trigger will be the need to use the features of the RDH with one or more data sets.

	~~== Basic Flow ==~~
	<font size="-2" color="green">''Often referred to as the primary scenario or course of events. In the basic flow we describe the flow that would be followed if the use case where to follow its main plot from start to end. Error states or alternate states that might be highlighted are not included here. This gives any browser of the document a quick view of how the system will work. Here the flow can be documented as a list, a conversation or as a story.(as much as required)''</font>

	~~#User (installer/configurer) installs (builds and installs or installs a binary) of the RDH handler code~~
	~~#The user edits the BES.conf file so that it contains the driver and connection information needed by the RDH handler to locate and connect to the RDBMS~~
	~~#The user (re)starts the BES~~

	~~Here are two relevant lines from the bes.conf file before adding the handler to the server:~~

	~~BES.modules=dap,cmd,ascii,usage,www,nc,h4~~

	~~We would add a ncml handler to the BES.modules line and a regular expression for it to the Typematch line like this:~~

	~~BES.modules=dap,cmd,ascii,usage,www,nc,h4,drds~~
	~~BES.drds.databases=name1,name2,name3~~

	~~Thus any request with file that ends in .ncml (i.e., that matches teh regex .*\.ncml) as its target will be handled by the NcML handler.~~

	~~== Alternate Flow ==~~
	~~<font size="-2" color="green">''Here we give any alternate flows that might occur. May include flows that involve error conditions. Or flows that fall outside of the basic flow.''</font>~~

	~~== Post Conditions ==~~
	~~<font size="-2" color="green">''Here we give any conditions that will be true of the state of the system after the use case has been completed.''</font>~~

	~~== Activity Diagram ==~~
	~~<font size="-2" color="green">''Here a diagram is given to show the flow of events that surrounds the use case.''</font>~~

	~~== Notes ==~~
	~~<font size="-2" color="green">''There is always some piece of information that is required that has no other place to go. This is the place for that information.''</font>~~

	~~== Resources ==~~
	<font size="-2" color="green">''In order to support the capabilities described in this Use Case, a set of resources must be available and/or configured. These resources include data and services, and the systems that offer them. This section will call out examples of these resources.''</font>


	~~{\| cellspacing="0" border="1"~~
	~~\|Resource~~
	~~\|Owner~~
	~~\|Description~~
	~~\|Availability~~
	~~\|Source System~~
	\|-
	~~\|<font size="-2" color="green">''name''</font>~~
	~~\|<font size="-2" color="green">''Organization that owns/ manages resource''</font>~~
	~~\|<font size="-2" color="green">''Short description of the resource''</font>~~
	~~\|<font size="-2" color="green">''How often the resource is available''</font>~~
	~~\|<font size="-2" color="green">''Name of system which provides resource''</font>~~
	\|}

Ndp at 22:40, 27 April 2009

2009-04-27T22:40:02Z

Ndp: /* Preconditions */

2009-04-27T22:37:36Z

Preconditions

← Older revision		Revision as of 22:37, 27 April 2009
Line 30:		Line 30:
	# The BES is installed and configured, except for the DRDS-II handler		# The BES is installed and configured, except for the DRDS-II handler
	# There is an accessible RDBMS with tables and/or views containing data to be served.		# There is an accessible RDBMS with tables and/or views containing data to be served.
	# ODBC ~~data source defintion~~(s) for the databases to be accessed have created. ~~These may include some~~ of the ~~following~~		# ODBC Data Source Definition(s) for the databases to be accessed have been created and tested on the BES host. Data Source Definitions contain the follwoing types of information:
	## ODBC driver string/id/thingy		#* The name of the Data Source Definition (which is used by processes on the host using ODBC)
	## The host name or IP address of the RDBMS system		#* ODBC driver string/id/thingy
	## The port number of the RDBMS system.		#* The host name or IP address of the RDBMS system
	## The user name to use for connecting to the RDBMS		#* The port number of the RDBMS system.
	## The password associated with user name		#* The user name to use for connecting to the RDBMS
	## The name of database in the RDBMS		#* The password associated with user name
			#* The name of database in the RDBMS

	== Triggers ==		== Triggers ==

Ndp: /* Preconditions */

2009-04-27T22:33:51Z

Preconditions

← Older revision		Revision as of 22:33, 27 April 2009
Line 30:		Line 30:
	# The BES is installed and configured, except for the DRDS-II handler		# The BES is installed and configured, except for the DRDS-II handler
	# There is an accessible RDBMS with tables and/or views containing data to be served.		# There is an accessible RDBMS with tables and/or views containing data to be served.
	# ODBC data source defintion(s) for the databases to be accessed have created. These ~~typically~~ include ~~(at least)~~ the following		# ODBC data source defintion(s) for the databases to be accessed have created. These may include some of the following
	## ~~Driver =~~ ODBC driver		## ODBC driver string/id/thingy
	## ~~Server =~~ host name or IP address		## The host name or IP address of the RDBMS system
	## ~~Database = name~~ of ~~database~~		## The port number of the RDBMS system.
	## ~~User =~~ user name		## The user name to use for connecting to the RDBMS
	## ~~Password =~~ password associated with user name		## The password associated with user name
			## The name of database in the RDBMS

	== Triggers ==		== Triggers ==

Ndp: /* Basic Flow */

2009-04-27T22:26:58Z

Basic Flow

← Older revision		Revision as of 22:26, 27 April 2009
Line 52:		Line 52:

	BES.modules=dap,cmd,ascii,usage,www,nc,h4		BES.modules=dap,cmd,ascii,usage,www,nc,h4
	~~BES.drds.driver=~~

	We would add a ncml handler to the BES.modules line and a regular expression for it to the Typematch line like this:		We would add a ncml handler to the BES.modules line and a regular expression for it to the Typematch line like this:

	BES.modules=dap,cmd,ascii,usage,www,nc,h4,drds		BES.modules=dap,cmd,ascii,usage,www,nc,h4,drds
			BES.drds.databases=name1,name2,name3

	Thus any request with file that ends in .ncml (i.e., that matches teh regex .*\.ncml) as its target will be handled by the NcML handler.		Thus any request with file that ends in .ncml (i.e., that matches teh regex .*\.ncml) as its target will be handled by the NcML handler.

Ndp: /* Preconditions */

2009-04-27T22:24:10Z

Preconditions

← Older revision		Revision as of 22:24, 27 April 2009
Line 30:		Line 30:
	# The BES is installed and configured, except for the DRDS-II handler		# The BES is installed and configured, except for the DRDS-II handler
	# There is an accessible RDBMS with tables and/or views containing data to be served.		# There is an accessible RDBMS with tables and/or views containing data to be served.
	# ODBC data source defintion(s) for the databases to be accessed		# ODBC data source defintion(s) for the databases to be accessed have created. These typically include (at least) the following
	## Driver = ODBC driver		## Driver = ODBC driver
	## Server = host name or IP address		## Server = host name or IP address

Ndp: /* Preconditions */

2009-04-27T22:23:26Z

Preconditions

← Older revision		Revision as of 22:23, 27 April 2009
Line 30:		Line 30:
	# The BES is installed and configured, except for the DRDS-II handler		# The BES is installed and configured, except for the DRDS-II handler
	# There is an accessible RDBMS with tables and/or views containing data to be served.		# There is an accessible RDBMS with tables and/or views containing data to be served.
			# ODBC data source defintion(s) for the databases to be accessed
			## Driver = ODBC driver
			## Server = host name or IP address
			## Database = name of database
			## User = user name
			## Password = password associated with user name

	== Triggers ==		== Triggers ==

Ndp: /* Basic Flow */

2009-04-27T22:19:02Z

Basic Flow

@@ Line 38: / Line 38: @@
 == Basic Flow ==
 <font size="-2" color="green">''Often referred to as the primary scenario or course of events. In the basic flow we describe the flow that would be followed if the use case where to follow its main plot from start to end. Error states or alternate states that might be highlighted are not included here. This gives any browser of the document a quick view of how the system will work. Here the flow can be documented as a list, a conversation or as a story.(as much as required)''</font>
 == Alternate Flow ==

Ndp: /* Triggers */

2009-04-27T21:53:55Z

Triggers

← Older revision		Revision as of 21:53, 27 April 2009
Line 33:		Line 33:
	== Triggers ==		== Triggers ==
	<font size="-2" color="green">''Here we describe in detail the event or events that brings about the execution of this use case. Triggers can be external, temporal, or internal. They can be single events or when a set of conditions are met, List all triggers and relationships.''</font>		<font size="-2" color="green">''Here we describe in detail the event or events that brings about the execution of this use case. Triggers can be external, temporal, or internal. They can be single events or when a set of conditions are met, List all triggers and relationships.''</font>

			The trigger is the need to add this feature to the Hyrax data server. In the case of the IOOS projects, the DRDS-II Handler will provide DAP access to in situ data stored in a RDBMS. Satisfying the requirements for that project will be the trigger. In general, the trigger will be the need to use the features of the DRDS-II with one or more data sets.

	== Basic Flow ==		== Basic Flow ==

Ndp: /* Preconditions */

2009-04-27T21:52:18Z

Preconditions

← Older revision		Revision as of 21:52, 27 April 2009
Line 27:		Line 27:
	== Preconditions ==		== Preconditions ==
	<font size="-2" color="green">''Here we state any assumptions about the state of the system that must be met for the trigger (below) to initiate the use case. Any assumptions about other systems can also be stated here, for example, weather conditions. List all preconditions.''</font>		<font size="-2" color="green">''Here we state any assumptions about the state of the system that must be met for the trigger (below) to initiate the use case. Any assumptions about other systems can also be stated here, for example, weather conditions. List all preconditions.''</font>

			# The BES is installed and configured, except for the DRDS-II handler
			# There is an accessible RDBMS with tables and/or views containing data to be served.

	== Triggers ==		== Triggers ==

← Older revision		Revision as of 22:40, 27 April 2009
Line 7:		Line 7:
	<font size="-2" color="green">''The goal briefly describes what the user intends to achieve with this use case.''</font>		<font size="-2" color="green">''The goal briefly describes what the user intends to achieve with this use case.''</font>

	A person who is configuring a BES daemon adds the ~~DRDS-II handler~~ and viola, the BES can now retrieve data from an RDBMS.		A person who is configuring a BES daemon adds the RDH and viola, the BES can now retrieve data from an RDBMS.

	== Summary ==		== Summary ==
	<font size="-2" color="green">''Give a summary of the use case to capture the essence of the use case (no longer than a page). It provides a quick overview and includes the goal and principal actor.''</font>		<font size="-2" color="green">''Give a summary of the use case to capture the essence of the use case (no longer than a page). It provides a quick overview and includes the goal and principal actor.''</font>

	The ~~DRDS-II~~ handler reads a configuration (parts of the bes.conf file?) from which it learns:		The RDH handler reads a configuration (parts of the bes.conf file?) from which it learns:
	* Which ODBC driver to load.		* Which ODBC driver to load.
	* Database connection information (connection URL, database name, username, password, etc.)		* Database connection information (connection URL, database name, username, password, etc.)
Line 18:		Line 18:
	It then connects to the RDMS and uses the introspection methods of ODBC to collect information about the tables and views in the target database. (This activity may happen at startup and be refreshed asynchronously, or it may be gathered each time a request for the cataolg/inventory is received))		It then connects to the RDMS and uses the introspection methods of ODBC to collect information about the tables and views in the target database. (This activity may happen at startup and be refreshed asynchronously, or it may be gathered each time a request for the cataolg/inventory is received))

	This use case covers just how the ~~DRDS-II~~ handler is added to the BES and how it uses it's configuration to establish a connection with an RDBMS.		This use case covers just how the RDH handler is added to the BES and how it uses it's configuration to establish a connection with an RDBMS.

	== Actors ==		== Actors ==
Line 28:		Line 28:
	<font size="-2" color="green">''Here we state any assumptions about the state of the system that must be met for the trigger (below) to initiate the use case. Any assumptions about other systems can also be stated here, for example, weather conditions. List all preconditions.''</font>		<font size="-2" color="green">''Here we state any assumptions about the state of the system that must be met for the trigger (below) to initiate the use case. Any assumptions about other systems can also be stated here, for example, weather conditions. List all preconditions.''</font>

	# The BES is installed and configured, except for the ~~DRDS-II handler~~		# The BES is installed and configured, except for the RDH
	# There is an accessible RDBMS with tables and/or views containing data to be served.		# There is an accessible RDBMS with tables and/or views containing data to be served.
	# ODBC Data Source Definition(s) for the databases to be accessed have been created and tested on the BES host. Data Source Definitions contain the follwoing types of information:		# ODBC Data Source Definition(s) for the databases to be accessed have been created and tested on the BES host. Data Source Definitions contain the follwoing types of information:
Line 42:		Line 42:
	<font size="-2" color="green">''Here we describe in detail the event or events that brings about the execution of this use case. Triggers can be external, temporal, or internal. They can be single events or when a set of conditions are met, List all triggers and relationships.''</font>		<font size="-2" color="green">''Here we describe in detail the event or events that brings about the execution of this use case. Triggers can be external, temporal, or internal. They can be single events or when a set of conditions are met, List all triggers and relationships.''</font>

	The trigger is the need to add this feature to the Hyrax data server. In the case of the IOOS projects, the ~~DRDS-II~~ Handler will provide DAP access to in situ data stored in a RDBMS. Satisfying the requirements for that project will be the trigger. In general, the trigger will be the need to use the features of the ~~DRDS-II~~ with one or more data sets.		The trigger is the need to add this feature to the Hyrax data server. In the case of the IOOS projects, the RDH Handler will provide DAP access to in situ data stored in a RDBMS. Satisfying the requirements for that project will be the trigger. In general, the trigger will be the need to use the features of the RDH with one or more data sets.

	== Basic Flow ==		== Basic Flow ==
	<font size="-2" color="green">''Often referred to as the primary scenario or course of events. In the basic flow we describe the flow that would be followed if the use case where to follow its main plot from start to end. Error states or alternate states that might be highlighted are not included here. This gives any browser of the document a quick view of how the system will work. Here the flow can be documented as a list, a conversation or as a story.(as much as required)''</font>		<font size="-2" color="green">''Often referred to as the primary scenario or course of events. In the basic flow we describe the flow that would be followed if the use case where to follow its main plot from start to end. Error states or alternate states that might be highlighted are not included here. This gives any browser of the document a quick view of how the system will work. Here the flow can be documented as a list, a conversation or as a story.(as much as required)''</font>

	#User (installer/configurer) installs (builds and installs or installs a binary) of the ~~DRDS-II~~ handler code		#User (installer/configurer) installs (builds and installs or installs a binary) of the RDH handler code
	#The user edits the BES.conf file so that it contains the driver and connection information needed by the ~~DRDS-II~~ handler to locate and connect to the RDBMS		#The user edits the BES.conf file so that it contains the driver and connection information needed by the RDH handler to locate and connect to the RDBMS
	#The user (re)starts the BES		#The user (re)starts the BES