Configuring an IBM i package definition

After you create a package definition, you can specify which binary files to package or where to store the package by modifying your package definition.


  1. In the Team Artifacts view, expand the Enterprise Extensions node, then the Packages node.
    1. To create a package definition, right-click Packages, then select New Package Definition. The New Package Definition wizard opens. Select the appropriate options for your package, and click Finish.
      For more information about creating a packaging definition, see Creating a package definition.
    2. To modify an existing package definition, right-click the package definition that you want to modify and select Open Package Definition.
      The Package Definition editor opens.
  2. On the Overview tab in the Package Definition editor, make sure that all of the default settings are correct. Change any that are not.
    1. Optional: In the General Information Description section, briefly describe your definition.
    2. Select Ignore warnings when computing overall status.
    3. In the Supporting Build Engines field, click Add to add a build engine, or Create to create one.
      Note: You must associate a build engine with your package definition. For more information, see Creating build engines.
    4. Optional: In the Pruning Policy section, select Prune build results, then set the number of successful and failed builds to save.
  3. Optional: Go to the Properties tab.
    1. In the Properties table, click Add, then select one of the following property types:
      • String
      • Repository Workspace
      • Resource Definition
      • Translator
      Click OK.
      The Add Build Property window opens.
    2. In the Add Build Property window, specify a Name, Value, and Description for your new build property. Click Edit to modify the Value field.
  4. Go to the IBM i Packaging tab.
    1. On the Package tab, select a build definition.
    2. In the Package root directory field of the Package tab, choose a directory on the build systems where you want to store all packages.
      Note: It is advised to avoid using blanks or $ in the path as these characters (or their national language equivalents) can cause inconsistent results.
    3. Optional: In the Package pre-command field of the Package tab, specify a command to run on the build system before packaging.
    4. Optional: In the Package post-command field of the Package tab, specify a command to run on the build system after packaging.
    5. In the IBM i intermediate save file library field, enter a library name to temporarily store objects on the IBM® i server.
    6. Optional: In the IBM i save file options field, add TGTRLS VRM_release_level, where VRM_release_level is a valid target release for saving objects on the packaging host; for example, *CURRENT, *PRV, or V6R1M0. If you do not specify this option, the objects are saved at TGTRLS(*CURRENT).
    7. For the Include field, click Add to open the Ship List Manager wizard. In the Ship List Manager wizard, select either Add generic filter or Select specific objects, and then indicate a library, an object, and a type in the appropriate fields. Click OK.
      • If you select Add generic filter, you can specify a filter in different ways:
        • Enter an asterisk (*) in the Object and Type fields to include all of the objects in the library you indicated.
        • Enter partial names and an asterisk in the Object and Type fields so that the objects that match your filter are packaged.
        • Enter the name of a file that contains multiple object filters. Then, you can reuse the same set of object filters, rather than tediously reentering them repeatedly.

          To do this, enter file:/// followed by the name of a file in the file system on which the Rational Team Concert client is running. Only file-based URIs are supported.

          The file is a simple list of object names, one on each line. These object names are absolute but unqualified; they are processed in uppercase. Object names are silently ignored if they meet any of the following criteria:
          • They are invalid according to the normal rules of IBM i object names.
          • They contain wildcards such as ? and *.
          • They are duplicates.
          • They are valid but do not match any of the outputs for this particular package build.
        • If HFS files are included, you need to enter the directory for the Ant FileSet and its inclusion pattern. The directory must be relative to the outputs directory.
        Then, click OK.
      • If you select Select specific objects, enter an asterisk (*) in the Object and Type fields and click Run. Select specific files and then click OK.
    8. For the Exclude field, click Add to open the Ship List Manager wizard. In the Ship List Manager wizard, select either Add Generic Filter or Select Specific Objects, and then indicate a library, an object, and a type in the appropriate fields. Click OK.
    9. On the Options tab, in the restore mapping table, specify the libraries to package and where to deploy them.
    10. Click Add to open the Mapping Entry Manager wizard.
    11. To add a library mapping, click Add. Enter the original library in the From library field, and the target library in the To library field. Click OK.
      • Complete these steps for all library mappings.
      • By default, packaged contents are restored to the same libraries you saved them from when you ran the package. To deploy the objects to different libraries, you can either specify those mappings on the Options tab within the IBM i Packaging tab in your package definition, or from the Deploy tab within the IBM i Deployment tab in your deployment definition.
    12. Select Auto clean to delete a package from the package root directory so that you have more package space available.
      Note: Before you select Auto clean, delete the package result that is associated with the package you want to clean from the package root directory. For more information, see Configuring the auto clean option.
    13. Select one or more packaging report options, including:
      • Publish manifest
      • Publish package
    1. Click Save.
  5. Optional: Go to the Ant tab.
    1. In the Build File and Targets section, specify the Ant file and targets you want your definition to start. Reference properties by using this format: ${propertyName}.
    2. In the Ant Configuration section, select Include the Jazz build toolkit tasks on the Ant library path if you want to add the -lib Ant argument with the path to the Jazz® buildtoolkit directory.
    3. Specify any other configuration details, including the following options:
      • Ant home
      • Ant arguments. The default is -verbose.
      • Working directory
      • Java™ home
      • Java VM arguments. The default is -Xquickstart.
      • Properties file
  6. Click Save.