Creating Build Forge build definitions

You can create Rational® Build Forge® build definitions that reference a Build Forge build engine.

Before you begin

You have a Build Forge project and build engine available for use.
Note: If you have multiple Build Forge Services Components pointing to the same Build Forge database instance, you can configure a build engine for each Services Component for fail-over support. The two Build Forge Services Components must share the same underlying database, so that the Build Forge project in the build definition can be found through either path. If a build definition references multiple build engines, it uses an algorithm to distribute the build requests. If there is a problem connecting to a build engine, the build definition connects to another configured build engine.


  1. In the Team Artifacts view, expand the project folder.
  2. Right-click Builds; then click New Build Definition.
  3. In the New Build Definition wizard, on the New Build Definition page, accept the defaults and click Next.
  4. On the General Information page, in the Available build templates pane, select Rational Build Forge and click Next.
  5. Optional: If you use Engineering Workflow Management source control, on the Pre-build page, select Jazz Source Control and click Next.
    Note: If you select this option, Build Forge accepts and fetches files from the Jazz® repository within a Build Forge project, using the JazzJBE.xml adapter that is shipped with Build Forge 7.1.2 or later. The JazzJBE.xml adapter uses this configuration to determine how to perform accept and fetch operations.
  6. On the Additional Configuration page, ensure that all options are selected and click Finish.
  7. In the Build Definition editor, on the Overview page, in the Supporting Build Engines area, click Edit.
  8. In the Edit Build Engines dialog box, select the appropriate Build Forge build engine and click OK. You can select multiple Build Forge build engines, but they must point to Services Components that reference the same Build Forge database instance.
  9. Click the Build Forge tab.
  10. Click Get Projects and select a Build Forge project.
  11. Optional: To push build definition properties into the Build Forge project, click Synchronize Properties.
    Note: This action synchronizes new properties that do not exist in either the Build Forge environment or on the Engineering Workflow Management build definition properties page. Existing property values are not synchronized. To reset all properties and values listed on the Engineering Workflow Management build definition properties page to the values defined in a Build Forge project, select a different project on the Engineering Workflow Management Build Forge page and reselect the project. This action removes all Engineering Workflow Management build definition properties and reinitializes them with all of the properties and values that are defined in the Build Forge environment.
  12. Optional: To schedule builds, complete the following steps:
    1. Click the Schedule tab.
    2. To enable build scheduling, under Schedule, select Enabled.
    3. Click Add.
    4. In the Build Time pane, specify either continuous build intervals in minutes, or a specific build time.
    5. In the Build Days pane, select the days of the week that the build runs.
      Note: If you are integrating with Engineering Workflow Management source control in the Build Forge project, create a schedule for your builds from Engineering Workflow Management rather than from Build Forge. Then, the Engineering Workflow Management build result buildResultUUID attribute can be sent to Build Forge, so that it can update contributions back in the Engineering Workflow Management build result.
  13. Optional: If you selected Engineering Workflow Management source control in Step 5, complete the following steps:
    Note: The build definition must refer to a dedicated build workspace, rather than the team stream, so that builds are isolated from ongoing changes in the stream.
    1. Click the Jazz Source Control tab.
    2. To specify a repository workspace, in the Build workspace pane, click Create.
    3. In the New Repository Workspace wizard, on the Select a stream page, select Flow with a stream and in the lower pane, select the repository stream that you want to build from. This selection enables the repository workspace to accept changes from the stream.
    4. Click Next.
    5. On the New Repository Workspace page, in the Repository Workspace Name field, rename the repository workspace and click Next.
    6. On the Components to Add page, ensure that your component is selected.
    7. Ensure that the Load repository workspace after creation check box is cleared and click Finish.
    8. To specify a build user for the build workspace, in the Workspace Owner dialog box, to open the workspace, click Open Workspace.
    9. In the Repository Workspace editor, in the Owned by field, browse to the location of your special-purpose build user.
    10. Click Save.
    11. In the Build Definition editor, in the Load Options pane, in the Load directory field, type the path to the directory on the build machine where workspace files should be loaded.
    12. Optional: To define a subset of component files and folders for the build to load, in the Component load rules field, type the path to the component load rules file.
  14. Click Save.