Configuring a z/OS 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.
    • 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.
    • 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 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, select either Create, Add, or Remove, then select the build engine that you want and click OK.
      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 z/OS 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 machine where you want to store all packages. Note: Blanks or $ character are not supported in the Package root directory.
    3. Optional: In the HFS root directory field of the Package tab, specify the root directory for the HFS files. Ignore this step if the ship list contains no HFS files.
      Note: If the HFS outputs directory on the Build Definition panel is specified, contents from HFS outputs directory is pre-filled in the HFS root directory field.
    4. Optional: In the Package pre-command field of the Package tab, specify a command to run on the build machine before packaging.
    5. Optional: In the Package post-command field of the Package tab, specify a command to run on the build machine after packaging.
      Note: If you want to call a REXX script from the package pre-command or package post-command fields, see Configuring the ISPF gateway for build, deployment, and promotion support.
    6. In the z/OS ISPF gateway script field, specify the path to the z/OS® UNIX System Services (USS) shell script, which is used for running REXX EXEC files. The location of this shell script depends on how you configured your Build System Toolkit on z/OS. The default directory is /etc/jazz602/ccm/
    7. Select Delete obsolete work item outputs to analyze the change sets of the work items being packaged and locate outputs no longer being created by the files in the change sets. There are limitations to the deletion of outputs.
      • For any files being packaged, the current outputs are compared with the outputs from the previous build. If there are outputs from the previous build, they are deleted from the target system. For older changes in the file history, finding obsolete outputs is limited.
      • For any files in the change sets that have been deleted, outputs produced before the file was deleted are deleted from the target system.
      When the package is deployed, obsolete output files that exist on the target system are deleted.
    8. In the UrbanCode Deploy packaging options section:
      UrbanCode Deploy package type
      Select this option to generate an UrbanCode Deploy package from this package definition. If you clear the check box, Engineering Workflow Management packages are generated.
      Generate UrbanCode Deploy package
      Select this option to create a component version by using the UrbanCode Deploy z/OS toolkit. If you clear the check box, a package request generates a ship list file in the package root directory, in a subdirectory named for the package definition UUID and the packaging time stamp.
      UrbanCode Deploy Toolkit script
      Enter the path name of the toolkit script that creates z/OS versions; for example, /var/ucd611/agent/bin/
      Property manifest input file
      Enter the path of the property manifest, which is an HFS directory where the build agent that does the packaging is running; for example, /u/builder/babin0/test605s5/propTemplate/property/Manifest3.xml.
      UrbanCode Deploy Component name
      Enter the name of the UrbanCode Deploy component for which the versions are being created.
      UrbanCode Deploy version naming convention
      Select one of the following choices:
      Creates a component version name based on the time of the package request.
      First work item number selected for packaging
      The resulting component version name is the first work item number that is selected on the package request followed by a timestamp.
      Prompt on request
      You specify the component version name when you request the package.
      Prefix for UrbanCode Deploy version name
      Specified text is prepended to the version name, regardless of which naming convention you select.
    9. Optional: If the ship lists contains both MVS and HFS resources, the Resource filters to include and exclude panel separates them into categories.
      • MVS members and files
      • HFS files
      Select the file and click Add next to the Include or the Exclude fields to open the Ship List Manager wizard.
    10. Next to 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 members, and then indicate a PDS (partitioned data set), a member, 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 Member filter field to package all of the members in the data set you indicated.
        • Enter a partial member name and an asterisk (for example, "EPSM*") in the Member filter field so that the data set members that match your member filter are packaged.
        • Enter the name of a file that contains multiple member filters. Then, you can reuse the same set of member 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 Engineering Workflow Management client is running. Only file-based URIs are supported.

          The file is a simple list of member names, one on each line. These member names are absolute but unqualified; they are processed in uppercase. Member names are silently ignored if they meet any of the following criteria:
          • They are invalid according to the normal rules of PDS member 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.
        • Optional: 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 members, enter an asterisk (*) in the Dataset filter and Member fields and click Run. All the output members that are associated with the build definition are displayed. Select specific members and then click OK
      • Optional: If HFS files are included, you need to select Select specific files from the build to add HFS resources from the list of outputs from the build definition.
    11. Next to 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 members, and then indicate a PDS, a member, and a type in the appropriate fields. Click OK.
    12. On the Options tab, in the restore mapping table, specify the PDSs to package and where to deploy them.
    13. Click Add to open the Mapping Entry Manager wizard.
    14. To add a PDS mapping, click Add. Enter the original PDS in the From PDS field, and the target PDS in the To PDS field. Click OK.
      • Complete these steps for all PDS mappings.
      • By default, the packaged contents are restored to the same PDS you saved them from when you ran the package. To deploy the members to different PDSs, you can either specify those mappings on the Options tab within the z/OS Packaging tab in your package definition, or from the Deploy tab within the z/OS Deployment tab in your deployment definition.
    15. 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.
    16. Select one or more packaging report options, including:
      • Publish manifest
      • Publish package
    17. 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 call. 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.

video icon Video channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community forums library

support icon Support

IBM Support Community
Deployment wiki