Appboard/2.5/builder/data sources/third party/omnibus - Revision history

imported>Jason.nicholls: /* Query */

2015-01-06T07:57:46Z

Query

← Older revision		Revision as of 07:57, 6 January 2015
Line 58:		Line 58:
	\|-		\|-
	\|'''Query Timeout (seconds)'''		\|'''Query Timeout (seconds)'''
	\|Maximum time (in seconds) to wait before timing out an executing ~~sql~~ query ~~(dependent on JDBC driver support)~~. If not set the ~~system~~ default (~~configured via '~~appboard.jdbc.queryTimeout~~' system configuration settings~~) ~~will be applied~~. If set to zero ~~(0)~~, ~~then~~ a ~~query timeout~~ will ~~not be set~~.		\|Maximum time (in seconds) to wait before timing out an executing SQL query. By default this is not set and the global default applies (see <tt>appboard.jdbc.queryTimeout</tt> in appboard.config). To disable the timeout set the value to zero, or to override the global default set to a positive value. Note: this option uses a feature of the JDBC driver and whether it is supported and the actual behaviour will depend on the driver.
	\|-		\|-
	\|'''[[appboard/2.5/builder/caching_and_polling\|Cache Timeout (seconds)]]'''		\|'''[[appboard/2.5/builder/caching_and_polling\|Cache Timeout (seconds)]]'''

imported>Doug yeager: /* Query */

2014-11-20T06:29:07Z

Query

← Older revision		Revision as of 06:29, 20 November 2014
Line 56:		Line 56:
	\|'''Description'''		\|'''Description'''
	\|A summary of the purpose of the query and any details or notes to provide for the system administrator.		\|A summary of the purpose of the query and any details or notes to provide for the system administrator.
			\|-
			\|'''Query Timeout (seconds)'''
			\|Maximum time (in seconds) to wait before timing out an executing sql query (dependent on JDBC driver support). If not set the system default (configured via 'appboard.jdbc.queryTimeout' system configuration settings) will be applied. If set to zero (0), then a query timeout will not be set.
	\|-		\|-
	\|'''[[appboard/2.5/builder/caching_and_polling\|Cache Timeout (seconds)]]'''		\|'''[[appboard/2.5/builder/caching_and_polling\|Cache Timeout (seconds)]]'''

imported>Doug yeager: /* Configure Connection Settings */

2014-11-20T06:22:48Z

Configure Connection Settings

← Older revision		Revision as of 06:22, 20 November 2014
Line 18:		Line 18:
	!Description		!Description
	\|-		\|-
	\|'''~~timeout~~'''		\|'''Timeout'''
	\|The maximum duration (in seconds) to establish a successful connection. Setting this value too low, in the case where OMNIbus cannot service the connections fast enough, will result in degraded performance.		\|The maximum duration (in seconds) to establish a successful connection. Setting this value too low, in the case where OMNIbus cannot service the connections fast enough, will result in degraded performance.
	\|-		\|-
	\|'''~~username~~'''		\|'''Username'''
	\|User name credential used to connect to database.		\|User name credential used to connect to database.
	\|-		\|-
	\|'''~~password~~'''		\|'''Password'''
	\|User password credential used to connect to database.		\|User password credential used to connect to database.
	\|-		\|-
	\|'''~~host~~'''		\|'''Host'''
	\| The hostname or IP address referring to the Netcool/OMNIbus database.		\| The hostname or IP address referring to the Netcool/OMNIbus database.
	\|-		\|-
	\|'''~~port~~'''		\|'''Port'''
	\| The TCP port of the Netcool/OMNIbus database. Default value is <tt>4100</tt>.		\| The TCP port of the Netcool/OMNIbus database. Default value is <tt>4100</tt>.
	\|-		\|-
	\|'''~~dbname~~'''		\|'''Database Name'''
	\| The name of the Netcool/OMNIbus database. Default value: <tt>NCOMS</tt>		\| The name of the Netcool/OMNIbus database. Default value: <tt>NCOMS</tt>
	\|}		\|}

imported>Jason.nicholls: /* Query */

2014-10-10T08:17:41Z

Query

← Older revision		Revision as of 08:17, 10 October 2014
Line 58:		Line 58:
	\|-		\|-
	\|'''[[appboard/2.5/builder/caching_and_polling\|Cache Timeout (seconds)]]'''		\|'''[[appboard/2.5/builder/caching_and_polling\|Cache Timeout (seconds)]]'''
	\|Maximum time a response from the database is kept before discarding.		\|Maximum time (in seconds) a response from the database is kept before discarding and re-querying for new data. If set to zero then no caching is performed at all.
	\|-		\|-
	\|'''SQL Query'''		\|'''SQL Query'''

imported>Jason.nicholls: /* Configure Connection Settings */

2014-10-10T08:17:02Z

Configure Connection Settings

← Older revision		Revision as of 08:17, 10 October 2014
Line 19:		Line 19:
	\|-		\|-
	\|'''timeout'''		\|'''timeout'''
	\|The maximum duration (in seconds) to establish a successful ~~database~~ connection. Setting this value too low, in the case where ~~the database~~ cannot service the connections fast enough, will result in degraded performance.		\|The maximum duration (in seconds) to establish a successful connection. Setting this value too low, in the case where OMNIbus cannot service the connections fast enough, will result in degraded performance.
	\|-		\|-
	\|'''username'''		\|'''username'''

imported>Jason.nicholls: /* Configure Connection Settings */

2014-10-10T08:14:34Z

Configure Connection Settings

← Older revision		Revision as of 08:14, 10 October 2014
Line 19:		Line 19:
	\|-		\|-
	\|'''timeout'''		\|'''timeout'''
	\|~~Time~~ (in seconds) to ~~wait for the host to respond before abandoning the establishment of~~ a connection ~~to a datasource~~. ~~If there is latency between AppBoard and~~ the database, ~~due to network configuration, this value may need to be increased~~.		\|The maximum duration (in seconds) to establish a successful database connection. Setting this value too low, in the case where the database cannot service the connections fast enough, will result in degraded performance.
	\|-		\|-
	\|'''username'''		\|'''username'''

imported>Johnfraleigh: /* Configure Connection Settings */

2014-09-29T15:58:16Z

Configure Connection Settings

← Older revision		Revision as of 15:58, 29 September 2014
Line 18:		Line 18:
	!Description		!Description
	\|-		\|-
	\|'''~~connectTimeout~~'''		\|'''timeout'''
	\|Time (in seconds) to wait for the host to respond before abandoning the establishment of a connection to a datasource. If there is latency between AppBoard and the database, due to network configuration, this value may need to be increased.		\|Time (in seconds) to wait for the host to respond before abandoning the establishment of a connection to a datasource. If there is latency between AppBoard and the database, due to network configuration, this value may need to be increased.
	\|-
	~~\|'''timeout'''~~
	\|Time to wait (in seconds) to wait before abandoning the retrieval of a new connection from the datasource. In the case that a great number of connections are made to this host, the size of the pool may need to be increased as a timeout typically indicates that the pool is exhausted and are waiting for a new connection "slot" to become available.
	\|-		\|-
	\|'''username'''		\|'''username'''
Line 39:		Line 36:
	\| The name of the Netcool/OMNIbus database. Default value: <tt>NCOMS</tt>		\| The name of the Netcool/OMNIbus database. Default value: <tt>NCOMS</tt>
	\|}		\|}


	=== Query ===		=== Query ===

imported>Jason.nicholls: 1 revision

2014-06-26T15:52:08Z

1 revision

← Older revision	Revision as of 15:52, 26 June 2014
(No difference)

imported>Jason.nicholls at 02:55, 1 April 2014

2014-04-01T02:55:30Z

New page

{{DISPLAYTITLE:Netcool/OMNIbus Data Adapter}}
[[Category:AppBoard 2.5]]
This page provides details for configuring IBM Tivoli Netcool/OMNIbus adapters in AppBoard. This data adapter retrieves information directly from an OMNIbus ObjectServer.

In many cases, you will want to pass a parameter value into a query rather than using a static query definition. AppBoard provides a system of variable expressions, called SHIM, that can be used for this purpose. For instructions on this option, see [[appboard/2.5/builder/shim_expressions|SHIM Expressions]].

{{Note|This data adapter requires the Sybase jConnect 5.5 (jconn2.jar) for JDBC database driver - see the [[appboard/2.5/admin/db_drivers|Loading Database Drivers]] page for more information.}}

== Data Source Configuration ==

=== Configure Connection Settings ===

The table below details the settings you can configure for a <b>Tivoli Netcool/OMNIbus</b> Data Source:

{|class="wikitable"
!Name
!Description
|-
|'''connectTimeout'''
|Time (in seconds) to wait for the host to respond before abandoning the establishment of a connection to a datasource. If there is latency between AppBoard and the database, due to network configuration, this value may need to be increased.
|-
|'''timeout'''
|Time to wait (in seconds) to wait before abandoning the retrieval of a new connection from the datasource. In the case that a great number of connections are made to this host, the size of the pool may need to be increased as a timeout typically indicates that the pool is exhausted and are waiting for a new connection "slot" to become available.
|-
|'''username'''
|User name credential used to connect to database.
|-
|'''password'''
|User password credential used to connect to database.
|-
|'''host'''
| The hostname or IP address referring to the Netcool/OMNIbus database.
|-
|'''port'''
| The TCP port of the Netcool/OMNIbus database. Default value is <tt>4100</tt>.
|-
|'''dbname'''
| The name of the Netcool/OMNIbus database. Default value: <tt>NCOMS</tt>
|}

=== Query ===

You can configure one or more queries in each Netcool/OMNIbus adapter configuration. Each configured query will have a different name and result in a different Data Collection with that name. When naming a query, only alphanumeric characters, underscores, and hyphens are permitted.

{{Note|When creating a new adapter, or upgrading an existing adapter from a previous version of AppBoard the <tt>alertsstatus</tt> entity is protected and cannot be renamed.}}

<b>Queries - Entity Settings</b> Screen:

{|class="wikitable"
!Name
!Description
|-
|'''Name'''
|Name of this SQL query entity. Note: if editing the name all references internal to AppBoard are updated automatically, however in some cases Data Processing Scripts may have hardcoded references that will break as a result of the rename. In cases where AppBoard can detect this an error message is presented to the administrator identifying the affected scripts.
|-
|'''Description'''
|A summary of the purpose of the query and any details or notes to provide for the system administrator.
|-
|'''[[appboard/2.5/builder/caching_and_polling|Cache Timeout (seconds)]]'''
|Maximum time a response from the database is kept before discarding.
|-
|'''SQL Query'''
|SQL statement defining the records to be returned by the query.
|-
|'''[[appboard/2.5/builder/data_processing_scripts|Data Processing Script(s)]]'''
|List of one or more Data Processing Scripts to be run on the query.
|}