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 an AR plugin

The following procedure includes an example for a Calbro Services administrator who wants to create a custom AR plugin for the form on the BMC Remedy AR System server used to store 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.

To create a plugin using the AR adapter

  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 this 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 BMC Remedy 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 BMC Remedy AR System server.

    Creating an AR plugin
  5. (optional) Click the Filter Options tab of the Details section to fetch the data from a particular type of form on the BMC Remedy 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 depend on.

    Dialogs

    Includes all dialog forms.

    Forms with Data

    Includes all forms with data in them.

    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 reads 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 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.
  16. If your BMC Atrium Configuration Management Database (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.
  17. Close the Configure Repository Plugins and Adapters dialog box.
    You now must create a data store to represent the external data in your BMC Remedy AR System form. 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.

Comments