Appboard/2.5/builder/data sources/third party/omnibus: Difference between revisions

imported>Jason.nicholls
m (1 revision)
imported>Jason.nicholls
 
(6 intermediate revisions by 3 users not shown)
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.
|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.
|-
|-
|'''timeout'''
|'''Username'''
|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.
|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>
|}
|}


=== Query ===
=== Query ===
Line 60: 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. 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)]]'''
|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'''

Latest revision as of 07:57, 6 January 2015

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 SHIM Expressions.

Template-note.png
This data adapter requires the Sybase jConnect 5.5 (jconn2.jar) for JDBC database driver - see the Loading Database Drivers page for more information.


Data Source Configuration

Configure Connection Settings

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

Name Description
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.
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 4100.
Database Name The name of the Netcool/OMNIbus database. Default value: NCOMS

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.


Template-note.png
When creating a new adapter, or upgrading an existing adapter from a previous version of AppBoard the alertsstatus entity is protected and cannot be renamed.


Queries - Entity Settings Screen:

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.
Query Timeout (seconds) 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 appboard.jdbc.queryTimeout 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.
Cache Timeout (seconds) 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 statement defining the records to be returned by the query.
Data Processing Script(s) List of one or more Data Processing Scripts to be run on the query.
Retrieved from "http://ab.edge-technologies.com/docs/index.php?title=Appboard/2.5/builder/data_sources/third_party/omnibus&oldid=6521"