The task creates a driver XML file, driver.drxml or level.xml, which contains a set of instructions that is used by a packaging product, such as zBuild or zPackage, to create SMP/E packaging - RELFILEs, SMPMCS, JCLIN, etc. - for a software product.

The task creates the driver for product-level packaging. The task derives the content for the product by gathering information from the product’s files in the specified build workspace. By default the task produces a driver XML file for all items found in the workspace that require packaging. Product packaging content can be limited to a subset of workspace content through use of the classes, componentClasses, exclude, ignoreFiles, and include attributes.

The task can be invoked in its own separate build or it can be included as part of another product or packaging build. The only requirements are that the workspace used for the build must include all of the components associated with the product, that the packaging configuration file described in the following sections must be available, and that the Enterprise Extensions SMP/E Systems Definitions must be available in the specified project area. A sample packaging build script is provided in Build Script Examples section.

The workspace used for the build should include all of the components and projects that are associated with the product. The workspace can also include a build component for build scripts and configuration files; this component can be excluded from the packaging process by using the exclude attribute when invoking the task.

Multiple primary FMIDs can be packaged together using the productComponent element as long as all required parts are in the build workspace. For more information refer to the Product Component Element section.

Attributes

The task supports Team Build Attributes, Build Extensions Debugging Attributes, Build Extensions General Attributes, as well as, its own task specific attributes. Click on a link for more information on the common attributes.

The following table describes the task specific attributes for the task:

Task Specific Attributes
Attribute	Description	Required
classes	Specify a comma-separated list of user assigned class names or MCS classes. When classes is specified, only parts from the identified classes will be included in the resulting driver XML file. If classes is not specified, all parts will be included in the resulting driver XML file regardless of assigned classes.	No
componentClasses	Specify a comma-separated list of component names with a comma-separated list of target classes in the form: `componentName(className)`. For example: componentClasses="com.ibm.ims.core.sys(JCLIN)" componentClasses="com.ibm.ims.core.sys(MAC,MOD,SRC)" componentClasses="com.ibm.ims.core.sys(MYCLASS1,MYCLASS2)" componentClasses="com.ibm.ims.core.sys(MAC,MOD,SRC,MYCLS1,MYCLS2)" componentClasses="com.ibm.ims.core.db(MOD),com.ibm.ims.core.sys(MOD)" The list of target classes may contain MCS classes, as well as, user assigned class names. When componentClasses is specified, only parts from the identified classes for the specified components will be included in the resulting driver XML file. If componentClasses is not specified, all parts will be included in the resulting driver XML file. If both classes and componentClasses are specified, the part will be included if it matches either specification.	No
configurationFile	Specify the full path on the build machine to the configuration file. For more information on the configuration file refer to the Configuration File section. A relative path from the build’s base directory may be specified.	Yes
driverFile	Specify the name of the resulting driver file.	Yes
driverFolder	Specify the full path on the build machine where the driver file is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified.	Yes
exclude	Specify a comma-separated list of component names in the form: `componentName`, or a comma-separated list of component names with a list of comma-separated project names in the form: `componentName(projectName)`. For example: exclude="com.ibm.ims.core.db" exclude="com.ibm.ims.core.db,com.ibm.ims.core.tm" exclude="com.ibm.ims.core.db(com.ibm.ims.core.db.base)" exclude="com.ibm.ims.core.db(com.ibm.ims.core.db.base), com.ibm.ims.core.tm(com.ibm.ims.core.tm.appc,com.ibm.ims.core.tm.base)" When exclude is specified, parts from the identified components or component projects will be excluded from the resulting driver XML file. If exclude is not specified, all parts will be included in the resulting driver XML file. If a component project list is specified, only parts from the specified projects will be excluded; component parts from projects not specified in the list will be included in the resulting driver XML file.	No
failOnContent	Specify `true` to fail the build if no content is found. Specify `false` to continue the build if no content is found. The default is `false`.	No
ignoreFiles	Specify a comma-separated list of file names. When ignoreFiles is specified, parts with the specified names will be excluded from the resulting driver XML file. If ignoreFiles is not specified, all parts will be included in the resulting driver XML file.	No
include	Specify a comma-separated list of component names in the form: `componentName`, or a comma-separated list of component names with a list of comma-separated project names in the form: `componentName(projectName)`. For example: include="com.ibm.ims.core.db" include="com.ibm.ims.core.db,com.ibm.ims.core.tm" include="com.ibm.ims.core.db(com.ibm.ims.core.db.base)" include="com.ibm.ims.core.db(com.ibm.ims.core.db.base), com.ibm.ims.core.tm(com.ibm.ims.core.tm.appc,com.ibm.ims.core.tm.base)" When include is specified, only parts from the identified components or component projects will be included in the resulting driver XML file. If include is not specified, all parts will be included in the resulting driver XML file.	No
logFinalVersion	Specify `true` to log the final version information after all overrides have been processed. The default is `false`. Either the logPackagingVersion or reportPackagingVersion attribute must be set to true for version information to be logged.	No
logNoUuid	Specify `true` to remove UUIDs from log data. The default is `false`. This is an internal testing option.	No
logPackagingConfiguration	Specify `true` to log packaging configuration information. The default is `false`.	No
logPackagingConfigurationFile	Specify the name of a file in which to log packaging configuration information. If logPackagingConfiguration is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingConfigurationFolder	Specify the full path on the build machine where the logPackagingConfigurationFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingConfigurationFile is set, this attribute is required.	No
logPackagingDataset	Specify `true` to log packaging data set information. The default is `false`.	No
logPackagingDatasetFile	Specify the name of a file in which to log packaging data set information. If logPackagingDataset is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingDatasetFolder	Specify the full path on the build machine where the logPackagingDatasetFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingDatasetFile is set, this attribute is required.	No
logPackagingFile	Specify `true` to log packaging file information. The default is `false`.	No
logPackagingFileFile	Specify the name of a file in which to log packaging file information. If logPackagingFile is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingFileFolder	Specify the full path on the build machine where the logPackagingFileFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingFileFile is set, this attribute is required.	No
logPackagingFolder	Specify `true` to log packaging folder information. The default is `false`.	No
logPackagingFolderFile	Specify the name of a file in which to log packaging folder information. If logPackagingFolder is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingFolderFolder	Specify the full path on the build machine where the logPackagingFolderFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingFolderFile is set, this attribute is required.	No
logPackagingLanguage	Specify `true` to log packaging language information. The default is `false`.	No
logPackagingLanguageFile	Specify the name of a file in which to log packaging language information. If logPackagingLanguage is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingLanguageFolder	Specify the full path on the build machine where the logPackagingLanguageFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingLanguageFile is set, this attribute is required.	No
logPackagingVersion	Specify `true` to log packaging version information. The default is `false`.	No
logPackagingVersionFile	Specify the name of a file in which to log packaging version information. If logPackagingVersion is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingVersionFolder	Specify the full path on the build machine where the logPackagingVersionFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingVersionFile is set, this attribute is required.	No
projectArea	Specify the name of the project area that contains the Enterprise Extensions system definitions.	Yes
reportByFmid	Specify `true` to organize report information by FMID. The default is `false`.	No
reportFile	Specify the name of the resulting report file.	No
reportFolder	Specify the full path on the build machine where the report file is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportFile is set, this attribute is required.	No
reportNoUuid	Specify `true` to remove UUIDs from report data. The default is `false`. This is an internal testing option.	No
reportPackagingConfiguration	Specify `true` to generate a packaging configuration report. The default is `false`.	No
reportPackagingConfigurationFile	Specify the name of a file in which to write the packaging configuration report. If reportPackagingConfiguration is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingConfigurationFolder	Specify the full path on the build machine where the reportPackagingConfigurationFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingConfigurationFile is set, this attribute is required.	No
reportPackagingDataset	Specify `true` to generate a packaging data set report. The default is `false`.	No
reportPackagingDatasetFile	Specify the name of a file in which to write the packaging data set report. If reportPackagingDataset is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingDatasetFolder	Specify the full path on the build machine where the reportPackagingDatasetFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingDatasetFile is set, this attribute is required.	No
reportPackagingFile	Specify `true` to generate a packaging file report. The default is `false`.	No
reportPackagingFileFile	Specify the name of a file in which to write the packaging file report. If reportPackagingFile is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingFileFolder	Specify the full path on the build machine where the reportPackagingFileFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingFileFile is set, this attribute is required.	No
reportPackagingFolder	Specify `true` to generate a packaging folder report. The default is `false`.	No
reportPackagingFolderFile	Specify the name of a file in which to write the packaging folder report. If reportPackagingFolder is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingFolderFolder	Specify the full path on the build machine where the reportPackagingFolderFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingFolderFile is set, this attribute is required.	No
reportPackagingLanguage	Specify `true` to generate a packaging language report. The default is `false`.	No
reportPackagingLanguageFile	Specify the name of a file in which to write the packaging language report. If reportPackagingLanguage is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingLanguageFolder	Specify the full path on the build machine where the reportPackagingLanguageFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingLanguageFile is set, this attribute is required.	No
reportPackagingVersion	Specify `true` to generate a packaging version report. The default is `false`.	No
reportPackagingVersionFile	Specify the name of a file in which to write the packaging version report. If reportPackagingVersion is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingVersionFolder	Specify the full path on the build machine where the reportPackagingVersionFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingVersionFile is set, this attribute is required.	No
setProperties	Specify `true` to set Ant packaging properties. The default is `false`. For more information on the packaging properties refer to the Packaging Properties section.	No
skipDefault	Specify `true` to avoid setting default values for each part in the driver XML file. The default is `false`. Default values can be skipped to make the driver file more readable.	No
skipTargets	Specify `true` to avoid adding target data set definitions to the driver XML file. The default is `true`. This attribute has no effect when generating a driver XML file for zPackage.	No
sortContent	Specify `true` to sort file content in the results. The default is `false`.	No
timestamp	Specify a numeric timestamp value to override the current time. This is an internal testing option.	No
workspaceUUID	Specify the UUID of the workspace which contains the components to be packaged. The value of this attribute is typically `${team.scm.workspaceUUID}` because the property is built-in when using the Jazz Build Engine.	Yes
xmlParse	Specify `true` to parse XML files for SMP/E definitions. The default is `false`. This attribute is maintained for compatibility with older versions. Note: if xmlParse is set to true, zService must be set to false.	No
zService	Specify `true` to generate an XML driver file compatible with zService. The default is `true`. Specify `false` to generate an XML driver file compatible with zBuild.	No

Product Component Element

The productComponent element is specified within the element. Each productComponent element identifies a primary FMID to be packaged along with its configuration file. If productComponent elements are specified, primary attributes must not be specified on the element. The following is a list of prohibited primary attributes:

classes
componentClasses
configurationFile
exclude
failOnContent
ignoreFiles
include
logFinalVersion
logNoUuid
logPackagingConfiguration
logPackagingConfigurationFile
logPackagingConfigurationFolder
logPackagingDataset
logPackagingDatasetFile
logPackagingDatasetFolder
logPackagingFile
logPackagingFileFile
logPackagingFileFolder
logPackagingFolder
logPackagingFolderFile
logPackagingFolderFolder
logPackagingLanguage
logPackagingLanguageFile
logPackagingLanguageFolder
logPackagingVersion
logPackagingVersionFile
logPackagingVersionFolder
reportByFmid
reportFile
reportFolder
reportNoUuid
reportPackagingConfiguration
reportPackagingConfigurationFile
reportPackagingConfigurationFolder
reportPackagingDataset
reportPackagingDatasetFile
reportPackagingDatasetFolder
reportPackagingFile
reportPackagingFileFile
reportPackagingFileFolder
reportPackagingFolder
reportPackagingFolderFile
reportPackagingFolderFolder
reportPackagingLanguage
reportPackagingLanguageFile
reportPackagingLanguageFolder
reportPackagingVersion
reportPackagingVersionFile
reportPackagingVersionFolder
setProperties
skipDefault
skipTargets
sortContent

The following table describes the valid productComponent element attribute:

Product Component Element Attributes
Attribute	Description	Required
classes	Specify a comma-separated list of user assigned class names or MCS classes. When classes is specified, only parts from the identified classes will be included in the resulting driver XML file. If classes is not specified, all parts will be included in the resulting driver XML file regardless of assigned classes.	No
componentClasses	Specify a comma-separated list of component names with a comma-separated list of target classes in the form: `componentName(className)`. For example: componentClasses="com.ibm.ims.core.sys(JCLIN)" componentClasses="com.ibm.ims.core.sys(MAC,MOD,SRC)" componentClasses="com.ibm.ims.core.sys(MYCLASS1,MYCLASS2)" componentClasses="com.ibm.ims.core.sys(MAC,MOD,SRC,MYCLS1,MYCLS2)" componentClasses="com.ibm.ims.core.db(MOD),com.ibm.ims.core.sys(MOD)" The list of target classes may contain MCS classes, as well as, user assigned class names. When componentClasses is specified, only parts from the identified classes for the specified components will be included in the resulting driver XML file. If componentClasses is not specified, all parts will be included in the resulting driver XML file. If both classes and componentClasses are specified, the part will be included if it matches either specification.	No
configurationFile	Specify the full path on the build machine to the configuration file. For more information on the configuration file refer to the Configuration File section. A relative path from the build’s base directory may be specified.	Yes
exclude	Specify a comma-separated list of component names in the form: `componentName`, or a comma-separated list of component names with a list of comma-separated project names in the form: `componentName(projectName)`. For example: exclude="com.ibm.ims.core.db" exclude="com.ibm.ims.core.db,com.ibm.ims.core.tm" exclude="com.ibm.ims.core.db(com.ibm.ims.core.db.base)" exclude="com.ibm.ims.core.db(com.ibm.ims.core.db.base), com.ibm.ims.core.tm(com.ibm.ims.core.tm.appc,com.ibm.ims.core.tm.base)" When exclude is specified, parts from the identified components or component projects will be excluded from the resulting driver XML file. If exclude is not specified, all parts will be included in the resulting driver XML file. If a component project list is specified, only parts from the specified projects will be excluded; component parts from projects not specified in the list will be included in the resulting driver XML file.	No
failOnContent	Specify `true` to fail the build if no content is found. Specify `false` to continue the build if no content is found. The default is `false`.	No
ignoreFiles	Specify a comma-separated list of file names. When ignoreFiles is specified, parts with the specified names will be excluded from the resulting driver XML file. If ignoreFiles is not specified, all parts will be included in the resulting driver XML file.	No
include	Specify a comma-separated list of component names in the form: `componentName`, or a comma-separated list of component names with a list of comma-separated project names in the form: `componentName(projectName)`. For example: include="com.ibm.ims.core.db" include="com.ibm.ims.core.db,com.ibm.ims.core.tm" include="com.ibm.ims.core.db(com.ibm.ims.core.db.base)" include="com.ibm.ims.core.db(com.ibm.ims.core.db.base), com.ibm.ims.core.tm(com.ibm.ims.core.tm.appc,com.ibm.ims.core.tm.base)" When include is specified, only parts from the identified components or component projects will be included in the resulting driver XML file. If include is not specified, all parts will be included in the resulting driver XML file.	No
logFinalVersion	Specify `true` to log the final version information after all overrides have been processed. The default is `false`. Either the logPackagingVersion or reportPackagingVersion attribute must be set to true for version information to be logged.	No
logNoUuid	Specify `true` to remove UUIDs from log data. The default is `false`. This is an internal testing option.	No
logPackagingConfiguration	Specify `true` to log packaging configuration information. The default is `false`.	No
logPackagingConfigurationFile	Specify the name of a file in which to log packaging configuration information. If logPackagingConfiguration is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingConfigurationFolder	Specify the full path on the build machine where the logPackagingConfigurationFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingConfigurationFile is set, this attribute is required.	No
logPackagingDataset	Specify `true` to log packaging data set information. The default is `false`.	No
logPackagingDatasetFile	Specify the name of a file in which to log packaging data set information. If logPackagingDataset is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingDatasetFolder	Specify the full path on the build machine where the logPackagingDatasetFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingDatasetFile is set, this attribute is required.	No
logPackagingFile	Specify `true` to log packaging file information. The default is `false`.	No
logPackagingFileFile	Specify the name of a file in which to log packaging file information. If logPackagingFile is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingFileFolder	Specify the full path on the build machine where the logPackagingFileFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingFileFile is set, this attribute is required.	No
logPackagingFolder	Specify `true` to log packaging folder information. The default is `false`.	No
logPackagingFolderFile	Specify the name of a file in which to log packaging folder information. If logPackagingFolder is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingFolderFolder	Specify the full path on the build machine where the logPackagingFolderFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingFolderFile is set, this attribute is required.	No
logPackagingLanguage	Specify `true` to log packaging language information. The default is `false`.	No
logPackagingLanguageFile	Specify the name of a file in which to log packaging language information. If logPackagingLanguage is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingLanguageFolder	Specify the full path on the build machine where the logPackagingLanguageFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingLanguageFile is set, this attribute is required.	No
logPackagingVersion	Specify `true` to log packaging version information. The default is `false`.	No
logPackagingVersionFile	Specify the name of a file in which to log packaging version information. If logPackagingVersion is set to true and a file name is not specified, data will be written to the build log.	No
logPackagingVersionFolder	Specify the full path on the build machine where the logPackagingVersionFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When logPackagingVersionFile is set, this attribute is required.	No
reportByFmid	Specify `true` to organize report information by FMID. The default is `false`.	No
reportFile	Specify the name of the resulting report file.	No
reportFolder	Specify the full path on the build machine where the report file is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportFile is set, this attribute is required.	No
reportNoUuid	Specify `true` to remove UUIDs from report data. The default is `false`. This is an internal testing option.	No
reportPackagingConfiguration	Specify `true` to generate a packaging configuration report. The default is `false`.	No
reportPackagingConfigurationFile	Specify the name of a file in which to write the packaging configuration report. If reportPackagingConfiguration is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingConfigurationFolder	Specify the full path on the build machine where the reportPackagingConfigurationFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingConfigurationFile is set, this attribute is required.	No
reportPackagingDataset	Specify `true` to generate a packaging data set report. The default is `false`.	No
reportPackagingDatasetFile	Specify the name of a file in which to write the packaging data set report. If reportPackagingDataset is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingDatasetFolder	Specify the full path on the build machine where the reportPackagingDatasetFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingDatasetFile is set, this attribute is required.	No
reportPackagingFile	Specify `true` to generate a packaging file report. The default is `false`.	No
reportPackagingFileFile	Specify the name of a file in which to write the packaging file report. If reportPackagingFile is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingFileFolder	Specify the full path on the build machine where the reportPackagingFileFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingFileFile is set, this attribute is required.	No
reportPackagingFolder	Specify `true` to generate a packaging folder report. The default is `false`.	No
reportPackagingFolderFile	Specify the name of a file in which to write the packaging folder report. If reportPackagingFolder is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingFolderFolder	Specify the full path on the build machine where the reportPackagingFolderFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingFolderFile is set, this attribute is required.	No
reportPackagingLanguage	Specify `true` to generate a packaging language report. The default is `false`.	No
reportPackagingLanguageFile	Specify the name of a file in which to write the packaging language report. If reportPackagingLanguage is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingLanguageFolder	Specify the full path on the build machine where the reportPackagingLanguageFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingLanguageFile is set, this attribute is required.	No
reportPackagingVersion	Specify `true` to generate a packaging version report. The default is `false`.	No
reportPackagingVersionFile	Specify the name of a file in which to write the packaging version report. If reportPackagingVersion is set to true and a file name is not specified, the report will be written to the build log.	No
reportPackagingVersionFolder	Specify the full path on the build machine where the reportPackagingVersionFile is to be written. If the folder is not found, it will be created. A relative path from the build’s base directory may be specified. When reportPackagingVersionFile is set, this attribute is required.	No
setProperties	Specify `true` to set Ant packaging properties. The default is `false`. For more information on the packaging properties refer to the Packaging Properties section.	No
skipDefault	Specify `true` to avoid setting default values for each part in the driver XML file. The default is `false`. Default values can be skipped to make the driver file more readable.	No
skipTargets	Specify `true` to avoid adding target data set definitions to the driver XML file. The default is `true`. This attribute has no effect when generating a driver XML file for zPackage.	No
sortContent	Specify `true` to sort file content in the results. The default is `false`.	No

Configuration File

The packaging configuration information that is defined in a packaging configuration file is used to control and customize how a product is packaged. This information is combined with Enterprise Extensions build information and the contents of the specified build work space to create a driver file. The driver file is used by the packaging product to create the SMP/E installable data sets for the product.

The packaging configuration file describes the packaging environment to the packaging process. The packaging configuration file consists of a single <configuration> XML element and a set of sub-elements.

Elements

The <configuration> element is the only required and acceptable element in the packaging configuration file.

The <configuration> element has a set of sub-elements which are described in the following table. Note that all sub-element attribute values may be specified using Ant properties.

Configuration Sub-elements
Element	Description	Required
<driver>	The driver element is used to declare the name associated with the driver to be created. This element has one required attribute, name, which specifies the driver name. A value such as COPYSENT is a typical driver name.	Yes
<fmid>	The fmid element is used to override the default FMID ID for packaging. This element has one required attribute, id, which specifies the overriding default ID. If the fmid element is omitted, the default ID defined in the Enterprise Extensions Version definition is used.	No
<fmidDel>	The fmidDel element identifies the list of FMIDs to include in the DELETE operand of the ++VER MCS statement for the product build. For example, a delete list might contain a list of all previous versions of a product that are to be deleted from the target SMP set. This element has two optional attributes, file and list. The file attribute specifies the name and location of a file which contains a list of blank or comma-separated FMIDs. The list attribute specifies the list of blank or comma-separated FMIDs. If this element is omitted, the information defined in the Enterprise Extensions Version definition is used.	No
<fmidNpr>	The fmidNpr element identifies the list of FMIDs to include in the NPRE operand of the ++VER MCS statement for the product build. This element has two optional attributes, file and list. The file attribute specifies the name and location of a file which contains a list of blank or comma-separated FMIDs. The list attribute specifies the list of blank or comma-separated FMIDs. If this element is omitted, the information defined in the Enterprise Extensions Version definition is used.	No
<fmidPre>	The fmidPre element identifies the list of FMIDs to include in the PRE operand of the ++VER MCS statement for the product build. This element has two optional attributes, file and list. The file attribute specifies the name and location of a file which contains a list of blank or comma-separated FMIDs. The list attribute specifies the list of blank or comma-separated FMIDs. If this element is omitted, the information defined in the Enterprise Extensions Version definition is used.	No
<fmidReq>	The fmidReq element identifies the list of FMIDs to include in the REQ operand of the ++VER MCS statement for the product build. This element has two optional attributes, file and list. The file attribute specifies the name and location of a file which contains a list of blank or comma-separated FMIDs. The list attribute specifies the list of blank or comma-separated FMIDs. If this element is omitted, the information defined in the Enterprise Extensions Version definition is used.	No
<fmidSup>	The fmidSup element identifies the list of FMIDs to include in the SUP operand of the ++VER MCS statement for the product build. This element has two optional attributes, file and list. The file attribute specifies the name and location of a file which contains a list of blank or comma-separated FMIDs. The list attribute specifies the list of blank or comma-separated FMIDs. If this element is omitted, the information defined in the Enterprise Extensions Version definition is used.	No
<fmidVer>	The fmidVer element identifies the list of FMIDs to include in the VERSION operand of the ++VER MCS statement for the product build. This element has two optional attributes, file and list. The file attribute specifies the name and location of a file which contains a list of blank or comma-separated FMIDs. The list attribute specifies the list of blank or comma-separated FMIDs. If this element is omitted, the information defined in the Enterprise Extensions Version definition is used.	No
<host>	The host element is used to define the DNS name of the z/OS system which contains the files to be packaged. This element has one required attribute, name, which specifies the URL/URI of the target z/OS host.	Yes
<part>	The part element is used to define the URI to be used for access to the product parts. This element has one required attribute, uri, which specifies the URL/URI of a data set access service on the target z/OS host.	Yes (when using zService)
<package>	The package element defines the driver’s package attribute values. This element has three required attributes: type, csect, and rework. The type attribute defines the type of packaging. Valid values are: `PRODUCT` and `?`. The csect attribute controls whether or not CSECT operands are generated for SMP/E ++MOD elements statements in the resulting MCSDATA. Valid values are: `YES` and `NO`. The rework attribute defines the packaging rework date. Valid values are: `` (asterisk) and a date in one of two forms `YYYYDDD` or `YYDDDSSS`. The typical rework* value for a product build is . The typical rework* value for a service build is a date value.	Yes
<prefix>	The prefix element defines the resource prefix from the build definition; the high-level-qualifier for the build data sets. This is the same value as specified in the build definition’s "Resource prefix" field. This element has one required attribute, name, which specifies the resource prefix.	Yes
<version>	The version element defines the version ID to use for the packaging build. This element has one required attribute, id, which specifies a version ID value defined in the Enterprise Extensions Version definition.	Yes

Example

<?xml version="1.0" encoding="UTF-8"?>
<!--
    Licensed Materials - Property of IBM
    (c) Copyright IBM Corporation 2014, 2017. All Rights Reserved.
    
    Note to U.S. Government Users Restricted Rights:
    Use, duplication or disclosure restricted by GSA ADP Schedule
    Contract with IBM Corp.
-->
<configuration>
    <host    name="${pkgcfg.host}"/>
    <driver  name="COPYSENT"/>
    <package type="${pkgcfg.package.type}" csect="${pkgcfg.package.csect}" rework="${pkgcfg.package.rework}"/>
    <part    uri="https://nasw.pok.ibm.com:8451/zos/jaxrs/dataset/"/>
    <prefix  name="IMSPKG.HMK1400.PRODUCT"/>
    <version id="141"/>
    <fmid    id="00"/>
    <fmidDel file="${pkgcfg.fmidDelFile}"/>
    <fmidSup file="${pkgcfg.fmidSupFile}"/>
</configuration>

Packaging Properties

The packaging properties are set by the task when the setProperties attribute is set to true. The packaging properties are used to pass information from the packaging process back to the Ant script that invoked the task.

The following table describes the packaging properties created by the task:

Name	Value	Description
team.enterprise.smpe.packaging.driver.components		Contains a semicolon-separated list of the names of the components that were packaged.
team.enterprise.smpe.packaging.driver.contents		Contains a semicolon-separated list of the names of the parts that were packaged.
team.enterprise.smpe.packaging.driver.fmidAll		Contains a semicolon-separated list of the names of all FMIDs that were packaged.
team.enterprise.smpe.packaging.driver.fmidBase		Contains the name of the base FMID.
team.enterprise.smpe.packaging.driver.fmidReferenced		Contains a semicolon-separated list of the names of all referenced FMIDs that were packaged.

Notes

The easiest way to get started is to import the sample project and modify it for your needs. Download the sample zip archive to a temporary directory on your machine and use Eclipse^® Project Explorer import the archive as an existing project.

Build Script Examples

Minimum specification:

<?xml version="1.0" encoding="UTF-8"?>
<project
        name=""
        default="main"
        xmlns:es="antlib:com.ibm.team.enterprise.smpe.toolkit">
    
    <target name="main" description="main">
        
        <es:
            repositoryAddress="${repositoryAddress}"
            userId="${userId}"
            password="${password}"
            configurationFile="./properties/hmk1400zsv.xml"
            driverFile="${pkg.driverFile}"
            driverFolder="${pkg.driverFolder}"
            projectArea="${projectArea}"
            workspaceUUID="${workspaceUUID}"
        />
        
    </target>
    
</project>

Maximum specification:

<?xml version="1.0" encoding="UTF-8"?>
<project
        name=""
        default="main"
        xmlns:es="antlib:com.ibm.team.enterprise.smpe.toolkit">
    
    <target name="main" description="main">
        
        <es:
            repositoryAddress="${repositoryAddress}"
            userId="${userId}"
            password="${password}"
            configurationFile="./properties/hmk1400zsv.xml"
            driverFile="${pkg.driverFile}"
            driverFolder="${pkg.driverFolder}"
            exclude="${exclude}"
            failOnContent="${failOnContent}"
            ignoreFiles="${ignoreFiles}"
            include="${include}"
            logNoUuid="${logNoUuid}"
            logFinalVersion="${logFinalVersion}"
            logPackagingConfiguration="${logPackagingConfiguration}"
            logPackagingConfigurationFile="${logPackagingConfigurationFile}"
            logPackagingConfigurationFolder="${logPackagingConfigurationFolder}"
            logPackagingDataset="${logPackagingDataset}"
            logPackagingDatasetFile="${logPackagingDatasetFile}"
            logPackagingDatasetFolder="${logPackagingDatasetFolder}"
            logPackagingFile="${logPackagingFile}"
            logPackagingFileFile="${logPackagingFileFile}"
            logPackagingFileFolder="${logPackagingFileFolder}"
            logPackagingFolder="${logPackagingFolder}"
            logPackagingFolderFile="${logPackagingFolderFile}"
            logPackagingFolderFolder="${logPackagingFolderFolder}"
            logPackagingLanguage="${logPackagingLanguage}"
            logPackagingLanguageFile="${logPackagingLanguageFile}"
            logPackagingLanguageFolder="${logPackagingLanguageFolder}"
            logPackagingVersion="${logPackagingVersion}"
            logPackagingVersionFile="${logPackagingVersionFile}"
            logPackagingVersionFolder="${logPackagingVersionFolder}"
            projectArea="${projectArea}"
            reportByFmid="${pkg.reportByFmid}"
            reportFile="${pkg.reportFile}"
            reportFolder="${pkg.reportFolder}"
            reportNoUuid="${reportNoUuid}"
            reportPackagingConfiguration="${reportPackagingConfiguration}"
            reportPackagingConfigurationFile="${reportPackagingConfigurationFile}"
            reportPackagingConfigurationFolder="${reportPackagingConfigurationFolder}"
            reportPackagingDataset="${reportPackagingDataset}"
            reportPackagingDatasetFile="${reportPackagingDatasetFile}"
            reportPackagingDatasetFolder="${reportPackagingDatasetFolder}"
            reportPackagingFile="${reportPackagingFile}"
            reportPackagingFileFile="${reportPackagingFileFile}"
            reportPackagingFileFolder="${reportPackagingFileFolder}"
            reportPackagingFolder="${reportPackagingFolder}"
            reportPackagingFolderFile="${reportPackagingFolderFile}"
            reportPackagingFolderFolder="${reportPackagingFolderFolder}"
            reportPackagingLanguage="${reportPackagingLanguage}"
            reportPackagingLanguageFile="${reportPackagingLanguageFile}"
            reportPackagingLanguageFolder="${reportPackagingLanguageFolder}"
            reportPackagingVersion="${reportPackagingVersion}"
            reportPackagingVersionFile="${reportPackagingVersionFile}"
            reportPackagingVersionFolder="${reportPackagingVersionFolder}"
            setProperties="${setProperties}"
            skipDefault="${skipDefault}"
            skipTargets="${skipTargets}"
            sortContent="true"
            timestamp="0"
            workspaceUUID="${workspaceUUID}"
            xmlParse="${xmlParse}"
            zService="${zService}"
        />
        
    </target>
    
</project>

Product component elements:

<?xml version="1.0" encoding="UTF-8"?>
<!--
    Licensed Materials - Property of IBM
    (c) Copyright IBM Corporation 2017. All Rights Reserved.
    
    Note to U.S. Government Users Restricted Rights:
    Use, duplication or disclosure restricted by GSA ADP Schedule
    Contract with IBM Corp.
-->
<project name="zPackage" default="all"
    xmlns:es="antlib:com.ibm.team.enterprise.smpe.toolkit"
    xmlns:hs="antlib:com.ibm.hostservices.ant"
    xmlns:zp="antlib:com.ibm.zpackage.ant">
    <description>zPackage.create</description>
    
    <!-- Set global properties -->
    <property name="debugOn"              value="true"/>
    <property name="timer"                value="true"/>
    <property name="trace"                value="true"/>
    
    <property name="root"                 value="${team.scm.fetchDestination}"/>
    <property name="work"                 value="${root}${file.separator}.work"/>
    <property name="level"                value="${work}/level.xml"/>
    
    <property name="checkContent"         value="true"/>
    <property name="configurationFile"    value="../config/hrbt.xml"/>
    <property name="reportByFmid"         value="true"/>
    <property name="reportFile"           value="report.xml"/>
    <property name="reportFolder"         value="${work}"/>
    <property name="streamName"           value="zOS Integration 6.0.5"/>
    
    <property name="smpmcsallocation"
        value="new catalog cyl space(1,5) dsorg(ps) recfm(f,b) lrecl(80) blksize(8800) vol(${volser})" />
    <mkdir dir="${work}"/>
    
    <taskdef
        name="artifactFilePublisher"
        classname="com.ibm.team.build.ant.task.ArtifactFilePublisherTask" />
    
    <property name="property.dir" value="${team.scm.fetchDestination}/EWM-EE/config"/>
    <property file="${property.dir}/${build.level}.properties"/>
    
    <!-- The location of the liberty server that is used to service EWM -->
    <property name="zservice.uri" value="https://${zservice.host}:${zservice.port}" />
    
    <!-- The location of the liberty server running on a z/OS host that is used to package EWM -->
    <property name="zpackage.uri" value="https://${zos.package.host}:${zos.package.port}" />
    
    <!-- Authentication credentials to use when communicating with security enabled servers -->
    <hs:auth user="${user}" password="${password.xor}" />
    <hs:trustall />
    
    <!-- - - - - - - - - - - - - - - - - - - *
    *  init                                  *
    *- - - - - - - - - - - - - - - - - - - -->
    <target name="init" description="init"/>
    
    <!-- - - - - - - - - - - - - - - - - - - *
    *  main                                  *
    *- - - - - - - - - - - - - - - - - - - -->
    <target name="create" description="Create Level xml">
        
        <es:
            repositoryAddress="${repositoryAddress}"
            userId="${jazzUser}"
            password="${jazzPassword}"
            driverFile="level.xml"
            driverFolder="${work}"
            projectArea="IBM Engineering Workflow Management"
            workspaceUUID="${team.scm.workspaceUUID}"
            timestamp="0">
            
            <es:productComponent
                configurationFile="../config/hrba.xml"
                include="Build zComponents(zOS.samples.HRBA)"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrbt.xml"
                include="Build Modules HFS generated(com.ibm.team.enterprise.zos.build.linkeditparser),
                        Build zComponents(com.ibm.teamz.member.encoding,zOS.samples.HRBT),
                        Deployment zComponents,ISPF Client,Promotion zComponents"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrcc.xml"
                include="Build zComponents(
                            com.ibm.teamz.config.utility,
                            com.ibm.teamz.config.utility.helps,
                            com.ibm.teamz.config.utility.jp,
                            zOS.samples.HRCC),
                        SMPE zComponents(zOS.smpe)"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrcm.xml"
                include="Build zComponents(zOS.samples.HRCM)"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrdv.xml"
                include="Build zComponents(zOS.samples.HRDV)"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrgc.xml"
                include="Build zComponents(zOS.samples.HRGC)"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrjs.xml"
                include="Build zComponents(zOS.samples.HRJS)"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrli.xml"
                include="Build zComponents(zOS.samples.HRLI)"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrqm.xml"
                include="Build zComponents(zOS.samples.HRQM)"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrre.xml"
                include="Build zComponents(zOS.samples.HRRE)"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrrm.xml"
                include="Build zComponents(zOS.samples.HRRM)"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrrs.xml"
                include="Build zComponents(zOS.samples.HRRS)"
                sortContent="true"
            />
            <es:productComponent
                configurationFile="../config/hrwl.xml"
                include="Build zComponents(zOS.samples.HRWL)"
                sortContent="true"
            />
        </es:>
        
        <artifactFilePublisher
            buildResultUUID="${buildResultUUID}"
            filePath="${work}/level.xml"
            label="Level XML"
            repositoryAddress="${repositoryAddress}"
            userId="${jazzUser}"
            password="${jazzPassword}"
        />
        
    </target>
    
    <!-- - - - - - - - - - - - - - - - - - - *
    *  Create SMP/E package                  *
    *- - - - - - - - - - - - - - - - - - - -->
    <target name="package" description="Create SMPE package">
        
        <zp:package uri="${zpackage.uri}" level="${level}" hlq="${hlq}"/>
        
    </target>
    
    <!-- - - - - - - - - - - - - - - - - - - *
    *  term                                  *
    *- - - - - - - - - - - - - - - - - - - -->
    <target name="term" description="term"/>
    
    <target depends="init,create,package,term" description="all" name="all"/>
    <target name="end"/>
</project>

getTaskNameHdr()