Integration points

What is an integration point?

An integration point is the container for information used to query centralized databases containing information relating to many hosts in the network. For each host, the integration point can query the database and extract useful information to populate attributes on the host node in the BMC Atrium Discovery model. For example, the name and contact details of people responsible for a particular server is valuable data, but is not generally held on that server. BMC Atrium Discovery enables you to extract such data from a central database by means of integration points.

An integration point contains one or more of each of the following components:

  • Connection: provides the information (for example, database credentials, driver, IP address) to create a connection from BMC Atrium Discovery to the target database.
  • Query: the SQL query which is passed to the target database to extract the required information. The query is specified in the pattern used to query the target database.

Integration points and queries are created automatically when a pattern that defines them is uploaded. The two are matched up by the integration point name and the name attribute of a Pattern Definitions block. See the Pattern Language Guide for details of Pattern Definitions. Once an integration point is created, you must populate it with at least one connection and one query before it can be used.

Viewing integration points

You view integration points from the Discovery page.

  1. From the Discovery page, click the Integration Points tab
  2. Click the name of an integration point to view it.
    The Details tab on the Integration Point window contains the following sections:
    • Details: basic description of the integration point
    • Related Patterns: lists any patterns on the appliance that use this integration point.
    • Results: lists results for each pattern.
      The Connections tab on the Integration Point window shows a list of connections configured for this integration point.
      The Queries tab on the Integration Point window shows a list of queries configured for this integration point.

Row colors in integration points

The rows have colored backgrounds according to the status of the integration point. The following scheme is used:

  • green: all successful outcomes each time the integration point is called from a pattern.
  • amber: some successful outcomes and some failures when the integration point is called from a pattern.
  • red: all failures each time the integration point is called from a pattern.
  • blue: the integration point has not yet been called from a pattern.
    This color scheme is used for connections and queries too.

Viewing a connection

The Connections tab on the Integration Point window shows a list of connections configured for this integration point.
To view a connection:

  1. From the Connections tab on the Integration Point window, click the connection name.

Viewing a query

The Queries tab on the Integration Point window shows a list of queries configured for this integration point.
To view a query, click the query name.
The Query window is displayed:

  1. From the Query tab on the Integration Point window, click the query name.

Creating a connection

An SQL discovery connection provides the information to create a connection from BMC Atrium Discovery to the target database. Once a connection has been made, the database can be queried. A connection can be represented as a URL which should be immediately familiar to a database administrator. This is shown in the preview section of the window. An example TPL call using the connection is also shown.
To Create a connection in an integration point:

  1. Click the Connections tab on the Integration Point screen.
  2. Click Create at the top right hand side of the Integration Point screen.
    Enter details of the connection.
    Which fields are displayed and whether they are required depends on the database driver selected.

    Field Name

    Details

    Name

    Enter a name for the connection. You can only use numbers, letters, or the underscore character (_). This name is used in TPL to call the connection. An example TPL call using the connection name is shown in the Useful Information section.

    Description

    A free text description of the connection.

    Username

    The database user name which will be used to connect to the database server.

    Password

    The password corresponding to the database user name.

    Database Driver

    The driver to use to connect to the database server. Select the appropriate driver from the drop down list. BMC Atrium Discovery ships with a limited number of database drivers due to licensing restrictions. See adding new drivers for details of how to add further drivers.

    Database IP Address

    The IP address of the database server.

    Port

    The port to use to connect to the database server.

    Database

    The database to connect to in the database server.

    Additional Parameters

    Any additional parameters that you want to supply to the database driver. These are specified as key=value pairs in a semicolon separated list. For example, you may want to specify that a driver which supports it should connect using SSL and with a non-default timeout:
    useSSL=true;timeout=60
    For information about the parameters that can be specified for each driver, you should consult the driver documentation on the internet. Links are provided on the JDBC drivers page.

  3. To save the connection, click Apply.
    The Connection window is displayed showing the details of the connection including the example URL and TPL call, and an empty result section. The results section is updated when the connection is used.

Testing a connection

Once you have created a connection, you should test it. To test a connection:

  1. From the Connection window, click Test.
  2. The screen is refreshed to show a Test Results section below the Connection Details section.
    The following screenshot shows a success:
    This screen illustrates a successful connection.

    The following screenshot shows a failure:
    This screen illustrates a failed connection.

Testing a query

Once you have created a query, you should test it. To test a query:

  1. From the Query window, click Test.
  2. From the Test Query dialog select a connection from the list to use to test the query.
  3. Click Next.
  4. Enter the parameters to be passed with the query.
    The example above shows a query requiring the hostname parameter.
  5. To perform the test, click Test.
    The screen is refreshed to show a Test Results section below the Query Details section.
Was this page helpful? Yes No Submitting... Thank you

Comments