This documentation supports the 20.02 version of BMC CMDB.

To view an earlier version, select the version from the Product version menu.

Creating federated data plugins

Plugins use adapters to connect an external source of data to BMC Configuration Management Database (BMC CMDB). If you want to federate data on a JDBC-compliant database or the forms residing on a AR System server, you can create a plugin by using an adapter that is installed with BMC CMDB. 

To create 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 database driver. Many database drivers are available on the internet.

Note

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

  1. On the left side of the BMC Core Console, click Application Launcher.
  2. Hover over Applications, and then select Federation Manager.
  3. In the toolbar, click Configure repository plugins and adapters
    The Configure Repository Plugins and Adapters dialog box is displayed.
  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:

    The following table describes the parameters for creating JDBC plugin

    Field

    Description

    Adapter

    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 be changed 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 the server that hosts 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

    Password to log on to the database.

    JDBC URL (Other only)

    The JDBC connection information to the database. You must enter the values for your particular database. For example, the MySQL database: jdbc:mysql://localhost:3306/mysql
    For more 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 also fetch the data from views only, or both tables and views. 
      The Filter options are displayed.
    2. For performance reasons, enter a pattern to filter the tables.
      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 displays No for the new plugin.
  8. From 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 the 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 should now 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. Check 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 CMDB environment uses a server group, make sure the same plugin is configured on all the 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 from the ar.cfg file to the file on your system. Change the server name to that of the local server.
    3. Restart the server.
  16. Close the Configure Repository Plugins and Adapters dialog box.
    You must now create a data store to represent the external data in your database. 

To create a plugin by using the AR adapter

The following procedure includes an example for a Calbro Services administrator who wants to create a custom AR plugin for the form on the AR System server that stores printer service records. In this case, creating an AR plugin instead of a JDBC plugin is easier for federation because form names are typically easier to read than table names from the AR System database.

  1. Open Federation Manager.
  2. In the toolbar, click Configure Repository Plugins and Adapters.
  3. In the Configure Repository Plugins and Adapters dialog box, click New.
  4. In the General tab of the Details section, enter the following information:

    Parameters for creating AR plugin

    Field

    Description

    Adapter

    Select AR from the list of available adapters.

    Plugin Name

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

    User Name

    User name to access the AR System server.

    Password

    Password to access the server.

    AR Server

    Name of the server.

    Port

    Port number of the specified server.


    For example, Allen, the Calbro Services administrator, would select the AR adapter, name the new plugin ARServer_PLUGIN_CalbroSJ, and enter the user name, password, server name, and port of the AR System server. 

    Creating an AR plugin 
  5. (optional) In the Details section, click the Filter Options tab to fetch the data from a particular type of form on the AR System server.
    You can retrieve data from the following forms:

    Form types from which you can retrieve data

    Form

    Description

    Regular Forms

    Default setting.

    Specified Forms

    Enter the form in the Form Name field.

    All Forms

    Includes all form types.

    Join Forms

    Includes all join forms.

    View Forms

    Includes all view forms.

    Join Forms that depend on

    Includes all join forms that depend on the form specified in the Form Name field.

    Join Forms that are depended on by

    Includes all join forms that the form specified in the Form Name field depends on.

    Dialogs

    Includes all dialog forms.

    Forms with Data

    Includes all forms that contain data.

    Vendor Forms

    Includes all vendor forms.

  6. In the Changed since field, enter the date and time to limit the forms to those modified after the specified time.
  7. In the Include Hidden Forms field, specify whether to include hidden forms (the default value) or not.
  8. Click Add.
    The Loaded column in the Configure Repository Plugins and Adapters dialog box displays No for the new plugin.
  9. In the list of repository plugins, select the new plugin.
  10. Click Show XML.
  11. In the Plugin XML dialog box, copy all of the text from <plugin> to <\plugin>, including those tags.
  12. 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.
  13. 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 11 as a new <plugin> entry.
  14. 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.
  15. Click Refresh.
    The Loaded column in the Configure Repository Plugins and Adapters dialog box should now 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. Check 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.
  16. If your BMC Configuration Management Database (BMC CMDB) environment uses a server group, make sure the same plugin is configured on all the 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 that of the local server.
    3. Restart the server.
  17. Close the Configure Repository Plugins and Adapters dialog box.
    You must now create a data store to represent the external data in your AR System form. 


Was this page helpful? Yes No Submitting... Thank you

Comments