Implementing custom adapters

You can implement a custom adapter by uploading the information required to define an adapter type to the repository. You can use this new type to configure an adapter on a grid.

To implement a custom adapter

  1. In the Grid Manager application, select the Manage tab, and then select the Adapters tab.
  2. Click Upload adapter.
  3. Select Custom adapter.
  4. Enter the adapter type that you want in the Type field.
  5. Enter the version and revision for this adapter type.
  6. Enter a description for the custom adapter type.
  7. Click Browse or the folder icon next to the JAR File field.
  8. Navigate to the location of the JAR file to be used by the custom adapter; then click Open to select the file.
  9. Enter the class name for the custom adapter.


    This class name must refer to a valid class within the specified JAR file.
    If you do not provide a valid class name, an adapter that uses this type will fail to start when enabled on a peer. Even though an upload is successful, if the information provided is not correct, the use of this adapter type will result in a nonfunctional adapter when it is enabled on a peer.

    If the custom adapter requires additional files to function properly, you can add them as dependent files.

To add dependent files to the custom adapter

  1. Click the Browse button adjacent to the Dependencies field.
  2. Navigate to the location of the dependent file for the custom adapter; then click Open to select the file.
  3. (Optional) If more than one additional file is required, click the More Dependencies text.
    The first file is moved into the Dependencies table, which is below the Dependencies field.
  4. Repeat steps 1 through 3 for as many dependent files as necessary for the custom adapter.
    You can disassociate files in the Dependencies table from the adapter by clicking the Delete icon.

    If you are enabling custom logging for the adapter, you must add the configDescriptor.xml file as a dependency (Enabling custom logging with custom adapters). You must be using BMC Atrium Orchestrator Platform version 7.8 or later.

  5. If platform-specific libraries are required by the custom adapter, follow these steps to upload the platform-specific libraries:
    1. Click the Browse button adjacent to the Platform Libraries field.
    2. Navigate to the location of the zip file containing the libraries for the custom adapter; then click Open to select the file.


      All required platform libraries must be contained in a single zip file.

  6. When you have entered all upload information, click OK.

    The specified information is uploaded to the repository and available for use to configure an adapter. The upload process does not create an adapter configuration; it adds the custom adapter type to the repository where it can be selected for configuring an adapter on a specific grid.
  7. Perform one of the following actions:
    • To facilitate adding an adapter configuration for the newly uploaded adapter, click Continue.
    • To return to the main Adapters screen without adding a configuration, click the bottom option and then click Continue.
  8. (Optional) Proceed with the configuration as described in To configure an adapter.
Was this page helpful? Yes No Submitting... Thank you