Using the Ant with Enterprise Extensions build definition editor

Create and configure an Ant with Enterprise Extensions build definition to run a build.

About this task

In the Ant with Enterprise Extensions Build Definition editor, configure your build definition by performing these steps:


  1. On the Build Definition editor Overview tab, describe your definition (optional), select Ignore warnings when computing overall status, and in the Pruning Policy field, specify the number of build results to keep (optional).
  2. Click Create to create a new build engine or Add to add an existing build engine to the list of Supporting Build Engines. The build engine type is Rational Build Agent.
  3. Optional: Right-click your build engine–expand your project area > Builds > Build Engines– to open it and make sure that the Build Agent tab contains the following values:
    • Hostname: your build machine IP address or hostname
    • Port: 5555 or the port number you configured in your bfagent.conf file
    • User name: the z/OS® RACF® user ID of the builder on the target build machine
    • Password and Confirm Password: the z/OS RACF password
  4. After you have configured the Build Agent tab, click Test Connection to test the connection to your build agent. If the connection was successful, you should see results that are similar to these:
    Message: Socket created successfully.
    Authentication Pass.
    Platform: os/390 19.00 03
    PingResult: PingOk
    ExitStatus: 0
  5. Optional: In the Build Definition editor, open the Schedule tab to set up automatic builds.
    1. Select Enabled, then Add, to add a build to run automatically, or Remove to cancel an automatic build.
    2. In the Build time field, select either Continuous interval in minutes, then indicate that interval; or select At, and choose a time at which you want your automatic build to run.
    3. In the Build days field, choose the days of the week on which you want your build to run.
  6. Open the Properties tab to add or remove build definition properties. Double click the item listed in the propertis field to open the Edit Build Property panel to edit build definition properties.
    Important: Add the JAZZ_USER property to your build definition or build engine. Set the Value field to the value of the JAZZ_USER environment variable that is defined in the script that you use to start the Rational® Build Agent on your build machine. If you do not add a JAZZ_USER property with build, package, and promotion permissions, the ADMIN ID is used to run promotions and packages by default. The ADMIN ID typically does not have the required permissions, so your promotions and packages fail.
  7. On the Job Output Publishing tab, make sure that you select Publish job output logs. You can also select Publish only when an error occurred to reduce the attached job output logs.
    Note: A lot of build machine CPU time and server disk space are used to publish build results. You can modify the names of the data set definitions you want to publish by changing the build property, which is set by default to SYSPRINT,ANTPRINT in the build.xml file.
  8. On the Jazz Source Control - z/OS tab, set the following values:
    Click Select to select the repository workspace to be built.
    Load directory
    Specify an absolute path in USS to use to store non-MVS build artifacts such as the Ant with Enterprise Extensions build.xml file. The builder user ID must have read, write, and execute permissions on this directory.
    Data set prefix
    Specify the prefix you want to add to managed data sets. For example, if you specified BUILDER.TEST as the data set prefix, the data set BUILDER.TEST.COBOL will be allocated for the COBOL zFolder associated with the COBOL data set definition in previous steps.
    Delete directory before loading
    Select to delete the metadata associated with your resource prefix.
    Tip: Metadata stores information about the files you load from Engineering Workflow Management. When a build fails because of corrupted metadata, select Delete directory before loading to clean up the metadata and resolve the issue. However, when metadata is not corrupted and you select this option, your build might take longer to complete. Select this option only if you want to clean up the load directory and associated metadata.
    Accept Options
    Select one or more of the following:
    • Accept latest changes before loading (creates a snapshot of the build workspace)
    • Build only if there are changes accepted
  9. On the Ant with Enterprise Extensions tab, you can generate the build file automatically by selecting Generate build file or select Use an existing build file and list the absolute USS path of the Ant with Enterprise Extensions build file.
    Note: When you choose to generate the build file automatically, the available language definitions are added to the list by default. As new language definitions are added, the list is updated automatically. However, if you change the default language definitions manually, language definitions that are added later will not be automatically detected and they will not be automatically added to the list.
    1. Optional: Select Create build maps
    2. Optional: Select Reuse ISPF Session for the translators with a call method that is ISPF command or EXEC.
      Note: Selecting the Reuse ISPF Session option is only intended for advanced use cases.
    3. Optional: In the BPXWDYN Options field, define any additional options you want to pass to the BPXWDYN interface, which you use to allocate data sets. The default value is MSG(1), which means that messages are directed to file descriptor 1, which is the build log file for all Ant with Enterprise Extensions and dependency builds.
  10. In the Ant with Enterprise Extensions Configuration field, specify any configuration details, including the following:
    • Ant home
    • Ant arguments. The default is -verbose.
    • Working directory
    • Java™ home
    • Java VM arguments. The default is -Xquickstart.
    • Properties file
  11. Click Save.