Edge Documentation

{{DISPLAYTITLE:Netcool/OMNIbus Data Adapter}}
[[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.

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.}}


== 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.4/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.4/builder/data_processing_scripts|Data Processing Script(s)]]'''
|List of one or more Data Processing Scripts to be run on the query.
|}