BuildForge Help

Creating a New Adaptor Template

Use this procedure to create a new adaptor template for an external application that you want to interface with a Build Forge project.

  1. Review the XML structure and elements in the adaptor templates provided by the Build Forge product.
    Adaptor templates are located in the following directory:
    <bf-install>\interface
  2. Plan what you want the new adaptor to do:
    • know what commands it will run
    • determine how the commands will be parsed
    • determine what to do with the data gathered from the parsed results
    • know which external environment variables are required
  3. Select one of the adaptor templates in the interface directory to use as a model.

    If possible, select an adaptor based on the same external application. Or, select an adaptor that has a function similar to the one you are creating.

    Use the XML hierarchy, elements, and element attributes in the model as a guide to create the new template.

  4. Using an XML editor, open the model adaptor template. Save the template to the interface directory with a new name.
  5. Using your plan, write the XML code for the new adaptor.
  6. Save the new adaptor template.
  7. Validate the adaptor template using the interface.dtd file in the interface directory.
  8. Reset the adaptor templates to pick up your new template and add it to the list of available templates in the Management Console. See Resetting Adaptor Templates.
  9. Create a project for the adaptor.
  10. Create an environment for the adaptor. See Creating an Environment for the Adaptor.
  11. Create an adaptor using the new adaptor template. See Creating an Adaptor from a Template.
  12. Add the adaptor to the project. See Adding an Adaptor to a Project.
  13. Run the adaptor project to test the adaptor. See Testing the Adaptor.