This documentation applies to the 8.1 version of BMC Atrium Core, which is in "End of Version Support." You will not be able to leave comments.

To view the latest version, select the version from the Product version menu.

Creating a JDBC plugin

The following procedure includes an example for a Calbro Services administrator who wants to create a custom JDBC plugin for a Microsoft SQL Server database that contains workgroup and data transfer information about computer system Configuration Items (CIs).

The JDBC plugin requires a database driver. If you do not want to use one of the drivers (SQL Server, Oracle, IBM DB2, or Sybase) that BMC provides, you must use your own. Many drivers are available on the internet.


If your BMC Atrium Configuration Management Database (BMC Atrium CMDB) environment uses a server group, you must install that driver in the same directory path on each server in the group.

To create a JDBC plugin

  1. On the left side of the BMC Atrium Core Console, click the Application Launcher.
  2. Mouse over Applications, and then select Federation Manager.
  3. In the toolbar, click Configure repository plugins and adapters.

    Configure Repository Plugins and Adapters dialog box
  4. In the Configure Repository Plugins and Adapters dialog box, click New.
  5. In the General tab of the Details section, enter the following information for the JDBC plugin:

    Parameters for creating JDBC plugin




    From the list of available adapters, select JDBC.

    Database Type

    Select a database from the list (for example, SQL Server). To select a different type of database (for example, MySQL), select Other from the Database Type list. You must then specify the parameters for the database, including login information, JDBC URL, and so on.

    Plugin Name

    Unique name for the plugin. This name cannot change after you save the plugin. To make the name descriptive in a meaningful, consistent way, consider using the following naming convention: <databaseType><databaseName>_PLUGIN<hostName>

    Host Name

    Actual name of server hosting your database (for example, Calbro_server_SJ). Note: Do not use localhost.

    Database Name

    Name of the particular database to be used (for example, Northwind). For DB2, enter a schema name. The schema name is case-sensitive and must be specified in uppercase characters (for example, MYSCHEMA ).

    Service Name (Oracle only)

    Alias to an Oracle instance

    Port Number

    • DB2 — 50000
    • Oracle — 1521
    • SQL Server — 1433
    • Sybase — 5001
      Note: These port numbers are the default values for the respective databases. You could use a different port number for your database.

    User Name

    User name to log on to the database (for example, sa).


    Password to log on to the database.

    JDBC URL (Other only)

    The JDBC connection information to the database. You must enter the proper values for your particular database. For example, the MySQL database: jdbc:mysql://localhost:3306/mysql
    For specific information about constructing JDBC URLs, see the documentation for your specific database.

    JDBC Driver (Other only)

    The full name of the JDBC driver class. You must enter the proper values for your particular database. For example, the MySQL database: com.mysql.jdbc.Driver

    For example, Allen, the Calbro Services administrator, selects the JDBC adapter and SQL Server database type, names the new plugin SQLServer_Northwind_CalbroSJ, and enters the remaining parameters for the Microsoft SQL Server server database.
  6. (optional) Click the Filter Options tab of the Details section.
    1. Select the source of the data that you want to fetch.
      By default, the JDBC Adapter fetches data from tables only. You can fetch the data from views only, or both tables and views.

      Filter options to limit the data returned
    2. For performance reasons, enter a pattern to filter the tables returned.
      For example, if you enter Ab%, only the tables starting with the Ab pattern are retrieved from the database.
  7. Click Add.
    The Loaded column in the Configure Repository Plugins and Adapters dialog box reads No for the new plugin.
  8. In the list of repository plugins, select the new plugin.
  9. Click Show XML.
  10. In the Plugin XML dialog box, copy all of the text from <plugin> to <\plugin>, including those tags, and then close the dialog box.
  11. On the plugin server computer, open the pluginsvr_config.xml file for editing.
    By default, the pluginsvr_config.xml file is in the <installDir>\BMC Software\AtriumCore\cmdb\plugins\shared directory.
  12. In the <pluginsvr_config> section of the pluginsvr_config.xml file, paste the <plugin> text that you copied from the Plugin XML dialog box in step 10 as a new <plugin> entry.
  13. Save and close the pluginsvr_config.xml file.
    The Loaded column in the Configure Repository Plugins and Adapters dialog box displays No when you first create the new plugin.
  14. Click Refresh.
    The Loaded column in the Configure Repository Plugins and Adapters dialog box now should display Yes for the new plugin. If the Loaded column continues to display No, one of the following conditions exists:
    • An error occurred in connecting to the external data source. Examine the AtriumPluginSvr.log file for errors. By default, the AtriumPluginSvr.log file is in the <installDir>\BMC Software\AtriumCore\Logs directory.
    • The external data source returns no external tables. No errors are logged in this case.
  15. If your BMC Atrium CMDB environment uses a server group, make sure the same plugin is configured on all servers in the server group. Repeat the following steps for each server:
    1. Copy the same plugin configuration information in the pluginsvr_config.xml file for each server. Make the appropriate changes in the <filename> and <pathelement> tags to correct the jar paths for the local server if required.
    2. Copy and paste the Server Plugin Alias entry in the ar.cfg file. Change the server name to the local server.
    3. Restart the server.
  16. Close the Configure Repository Plugins and Adapters dialog box.
    You now must create a data store to represent the external data in your database. For more information, see Managing federated data stores.

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.


  1. Daniel Hudsky

     I've looked through the links of this configuration and I can't find any reference to an important component of the configuration. Namely the "Adapter Registration". I am going to add a screen capture of that interface here because it's missing.

    Screen cap:


    The JDBC (java database client) adapter will use the federation-jdbc.jar file but it is also using a generic sqljdbc client file. "sqljdbc-1.2.jar" that was compatible with MSSSQL 2008. For newer version of MSSQL database, or any database for that matter you will need to make sure that the client file is compatible. If not, then find the compatible client file either from anther data transformation client, such as the Pentaho plugin ( i.e. C:\Program Files\BMC Software\ARSystem\diserver\data-integration\libext\JDBC\sqljdbc4.jar) or get it from the vendor. Once you get the file you'll need to make sure that the path to jdbc driver is updated in this panel.

    If you are using federation for older databases while also federating to newer databases then this configuration panel would have the Path line reflect the jdbc driver used for that connection and vice versa. This screen capture shows a federation connection to JDBC adapter connecting to MSSQL 2008.


    Dec 05, 2016 09:33