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

imported>Andy.hopper
(Created page with '{{DISPLAYTITLE:Tivoli Netcool Omnibus Data Adapter}} This page provides details for configuring Netcool/Omnibus adapters in AppBoard. For information on creating the database ad…')
 
imported>Jason.nicholls
No edit summary
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Tivoli Netcool Omnibus Data Adapter}}
{{DISPLAYTITLE:Netcool/OMNIbus Data Adapter}}
This page provides details for configuring Netcool/Omnibus adapters in AppBoard. For information on creating the database adapter, or other AppBoard adapters, see [[appboard/2.4/builder/data_sources|AppBoard Data Sources]]
[[Category:AppBoard 2.4]]
This page provides details for configuring IBM Tivoli Netcool/OMNIbus adapters in AppBoard. This data adapter retrieves information directly from an OMNIbus ObjectServer.


This adapter retrieves data from a Netcool/Omnibus database using SQL queries to create a data set. This is frequently used to transform data through the use of SQL to prepare data for use in AppBoard.
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.4/builder/shim_expressions|SHIM Expressions]].


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.4/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.4/admin/db_drivers|Loading Database Drivers]] page for more information.}}




== Database Data Source Configuration ==
== Data Source Configuration ==


=== Configure Database Connection Settings ===
=== Configure Connection Settings ===


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


{|class="wikitable"
{|class="wikitable"
!Name
!Name
!Description
!Description
|-
|'''host'''
|  The hostname or IP address referring to the Netcool/Omnibus database.
|-
|'''port'''
|  The TCP port of the Netcool/Omnibus database.
|-
|'''dbname'''
|  The name of the Netcool/Omnibus database. Default:"NCOMS"
|-
|-
|'''connectTimeout'''
|'''connectTimeout'''
|Time (in seconds) after a timeout occurs to wait before attempting to re-establish the connection. Setting this value too low can impact the performance of the system.
|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'''
|'''timeout'''
|Time to wait (in seconds) before timing out on connecting to the datasource. If there is latency between AppBoard and the database, due to network configuration, this value may need to be increased.
|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 37: Line 29:
|'''password'''
|'''password'''
|User password credential used to connect to database.
|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.
=== 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:
<b>Queries - Entity Settings</b> Screen:
Line 53: Line 59:
|-
|-
|'''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.
|-
|-
|'''[[appboard/2.4/builder/caching_and_polling|Cache Timeout (seconds)]]'''
|'''[[appboard/2.4/builder/caching_and_polling|Cache Timeout (seconds)]]'''
Line 59: Line 65:
|-
|-
|'''SQL Query'''
|'''SQL Query'''
|SQL statement defining the records to be returned by the query
|SQL statement defining the records to be returned by the query.
|-
|-
|'''[[appboard/2.4/builder/data_processing_scripts|Data Processing Script(s)]]'''
|'''[[appboard/2.4/builder/data_processing_scripts|Data Processing Script(s)]]'''
|List of one or more Data Processing Scripts to be run on the query.
|List of one or more Data Processing Scripts to be run on the query.
|}
|}

Latest revision as of 02:55, 1 April 2014

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
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 4100.
dbname 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.
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.
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.4/builder/data_sources/third_party/omnibus&oldid=5037"