BuildForge Help

Adaptor Task Overview

This topic covers all of the tasks required to create a source code adaptor, connect it to a project with an adaptor link, and run the adaptor-linked project in test mode.

Create an Adaptor by Selecting a Template

  1. Select Projects > Adaptors.
  2. Click Add Adaptor.
  3. At Name, enter a unique name for the adaptor. The adaptor name must be unique across the entire set of adaptors.
  4. At Type, select the adaptor type.
  5. At Template, select the template. The list contains the adaptor templates installed with the Build Forge product.

    ClearCase and ClearQuest adaptors do not require a separate license key. Other adaptors are separately licensed through the Adaptor Toolkit.

  6. At Access, select an access group. The ability to view or edit the adaptor is restricted to these group members.
  7. Click Save Adaptor.

Create an Empty Environment

  1. Select Projects > Environments.
  2. Click Add Environment.
  3. At Name, enter the environment name. Assign a name that describes the purpose of the environment.
  4. At Access, select an access group. The ability to view or edit the environment is restricted to these group members.
  5. Click Save Environment.

Add the Adaptor to the Project

  1. Select Projects > Adaptor Links.
  2. Click Add Adaptor Link.
  3. At Adaptor, select the adaptor (and adaptor template) that you created.
  4. At Project, select the project. The list displays the projects that are not already linked to an adaptor.
  5. At State, select Active.
  6. At Environment, select the empty environment that you created for the adaptor link.
  7. At Populate Environment, select Yes. The application environment variables in the adaptor template are added to the environment.
  8. Click Save to link the adaptor to the project. The adaptor and the project are added to the list of adaptor links.

Edit Environment Variables

  1. Select Environments.
  2. For the environment you created, click the Figure shows edit (pencil) icon icon.

    The main content pane displays the adaptor environment variables automatically added to the environment.

  3. Review the default values for the environment variables provided by the adaptor template.
  4. Change the default values for your source code application as necessary to run the adaptor project.

Run the Adaptor in Test Mode

  1. Select Administration > System.
  2. In the list of system configuration parameters, select Link Debug Mode.
  3. At Link Debug Mode, select Yes.
  4. Click Save.
  5. Select Jobs > Start.
  6. In the list of projects, select the adaptor-linked project you created from the Start Project page.
  7. Click Execute.

View Job Status and Logs

To view the job status and log information for the adaptor project:
  1. Open Jobs.
  2. In the list of projects, locate the adaptor-linked project to view job pass/fail status.
  3. To view job logs:
    • Select the Tag Name for the adaptor project to access job log information.
    • Select the Bill of Materials to access the BOM report.