Package configuration properties
The original template file for these properties is WCB_installdir/wcbd-build.properties.template.
Property Summary unit.test.lib.dir The directory where unit test libraries (such as JUnit) that the build process requires to compile unit test code are kept. source.dir The directory to which source code is extracted. module.dir The directory in ${source.dir} where the modules are located. dist.dir The distribution directory where deployment packages are created. dist.server.dir The distribution directory where server deployment packages are created. dist.toolkit.dir The distribution directory where toolkit deployment packages are created. log.dir The build log directory. log.file The build log file. log.zip.file The compressed file that contains build logs that are attached to build failure notifications. working.dir The working directory used to store temporary files that are generated by the build process. working.compile.dir The working directory for compilation. working.archive.dir The working directory for archiving module binary files. working.package.server.dir The working directory for creating server deployment packages. working.package.toolkit.dir The working directory for creating toolkit deployment packages. imported.classes.dir The directory that contains class files packaged into the modules. connector.module.list The comma-separated list of connector modules to build. connector.src.dir The Java source directory of connector modules. connector.bin.dir The Java binary directory of connector modules. ejb.module.list The comma-separated list of EJB modules to build. ejb.src.dir The Java source directory of EJB modules. ejb.bin.dir The Java binary directory of EJB modules. java.module.list The comma-separated list of Java utility modules to build. java.src.dir The Java source directory of Java utility modules. java.bin.dir The Java binary directory of Java utility modules. web.module.list The comma-separated list of web modules to build. web.src.dir The Java source directory of web modules. web.resource.dir The Java resource directory of web modules. web.bin.dir The Java binary directory of web modules. web.content.dir The web content directory of web modules. data.module.name The name of the module that contains data assets. static.web.module.name The name of the module that contains static web server assets. ext.compile.class.path The class path that contains more files required for compilation. Folders can contain loose Java classes (.class files). Java archives (.JAR files) must be listed individually. Files and folders must be delineated by a colon. wc.home The WebSphere Commerce or WebSphere Commerce Developer installation directory. was.home The WebSphere Application Server installation directory. db.type The name of the database vendor that the build processes uses to configure the compilation and ejbdeploy class paths. ejbdeploy.dbvendor The name of the database vendor that the ejbdeploy utility uses to determine database column types, mapping information, DDL, and other information. ejbdeploy.codegen Whether the Java files generated by the ejbdeploy utility are kept. ejbdeploy.keep.generated Whether the working directory is kept after the ejbdeploy utility completes. ejbdeploy.quiet Whether all but error messages reported by ejbdeploy utility are suppressed. ejbdeploy.no.validate Whether validation messages reported by the ejbdeploy utility are suppressed. ejbdeploy.trace Whether internal tracing for the ejbdeploy utility is enabled. ejbdeploy.jvm.max.memory The maximum memory size to be used by the ejbdeploy utility. run.extract Whether source code extraction is done. extract.ant.file The Ant build file used to extract source code. extract.update.mode Whether source code extraction is done as an updating to the previously extracted source code, or as a full extraction after the previously extracted source code is deleted. ear.dir.includes The comma-separated list of files in ${module.dir}/WC to be included in the deployment packages. ear.dir.excludes The comma-separated list of files in ${module.dir}/WC to be excluded in the deployment packages. deploy.server.dir The directory that contains deployment scripts to be included in the server deployment package. deploy.toolkit.dir The directory that contains deployment scripts to be included in the toolkit deployment package. run.package.server Whether a server deployment package is created. run.package.toolkit Whether a toolkit deployment package is created. run.dos2unix Whether to convert the newline characters that are contained in the files in the server deployment package from DOS format (CRLF) to UNIX format (CR). dos2unix.includes The comma-separated list of files in ${working.package.dir}/server to be included for dos2unix conversion. dos2unix.excludes The comma-separated list of files in ${working.package.dir}/server to be excluded from dos2unix conversion. run.deploy.server Whether centralized server deployment runs. deploy.server.workspace.dir The directory where server deployment packages are installed for centralized server deployment. deploy.server.target.env.list The comma-separated list of identifiers for target environments against which centralized server deployment is run. deploy.server.command The command that invokes the server deployment process. deploy.server.command.args The command-line arguments to pass into ${deploy.server.command}. run.clean.working.dir Whether the working directory is cleaned at the end of the build process. run.mail.success Whether build success notifications are sent. run.mail.failure Whether build failure notifications are sent. mail.from The sender email address of build status notifications. mail.success.tolist The comma-separated list of email addresses that receive build success notifications. mail.failure.tolist The comma-separated list of email addresses that receive build failure notifications. mail.mailhost The host name of the SMTP server. mail.mailport The TCP port of the SMTP server. mail.ssl Whether the SMTP server uses TLS/SSL for encryption. mail.success.subject The subject of build success notifications. mail.failure.subject The subject of build failure notifications. mail.success.message The message body of build success notifications. mail.failure.message The message body of build failure notifications.
Property detail
- app.type
- The application where the WCBD build process is to deploy assets. The WebSphere Commerce search (Solr) application is separated into a different application than the WebSphere Commerce EAR. Users must specify the application type before the WCBD build process runs. Each application type provides a different set of classes when users run the WCBD build process. When the build process runs, a new wcbd-build-classpath-application_type.xml file is created. The selected application type determines which class paths the build process uses to compile and package the assets for deployment. We can specify the following application types as the valid values for this property:
- wc
- The WebSphere Commerce WC.ear application. WC is the default value.
- search
- The WebSphere Commerce search Search.ear application.
- xc
- Build packages for the WebSphere Commerce Customization server.
- crs
- Build packages for the WebSphere Commerce Store server.
- source.dir
- The directory to which source code is extracted. By default, the source directory path is associated with a particular build as specified by ${build.label}. If you intend to use the repository update feature that some SCMs such as CVS and Subversion provides, we must set this property to a static value without reference to ${build.label}.
- Default
- ${basedir}/source/${build.label}
- module.dir
- The directory in ${source.dir} where the modules are located. The structure of this directory corresponds to the WebSphere Commerce Developer workspace, as explained in the "WebSphere Commerce Build tool repository structure" topic in the WebSphere Commerce Information Center.
- Default
- ${source.dir}/workspace
- dist.dir
- The distribution directory where deployment packages are created.
- Default
- ${basedir}/dist
- dist.server.dir
- The distribution directory where server deployment packages are created.
- Default
- ${dist.dir}/server
- dist.toolkit.dir
- The distribution directory where toolkit deployment packages are created.
- Default
- ${dist.dir}/toolkit
- log.dir
- The build log directory.
- Default
- ${basedir}/logs/${build.type.prefix}${build.label}-${tstamp}
- log.file
- The build log file.
- Default
- ${log.dir}/wcbd-build.log
- log.zip.file
- The compressed file that contains build logs that are attached to build failure notifications.
- Default
- ${log.dir}/wcbd-build-log-${build.label}.zip
- working.dir
- The working directory used to store temporary files that are generated by the build process.
- Default
- ${basedir}/working
- working.compile.dir
- The working directory for compilation.
- Default
- ${working.dir}/compile
- working.archive.dir
- The working directory for archiving module binary files.
- Default
- ${working.dir}/archive
- working.package.server.dir
- The working directory for creating server deployment packages.
- Default
- ${working.dir}/package/server
- working.package.toolkit.dir
- The working directory for creating toolkit deployment packages.
- Default
- ${working.dir}/package/toolkit
- imported.classes.dir
- The directory that contains class files packaged into the modules. This property is used for Java EE modules that are imported from binary archives.
- Default
- ImportedClasses
- connector.module.list
- The comma-separated list of connector modules to build. Leave the value of this property empty if no such modules need to build.
- Example
- TestConnector1,TestConnector2
- connector.src.dir
- The Java source directory of connector modules.
- Default
connectorModule
- connector.bin.dir
- The Java binary directory of connector modules.
- Default
- connectorModule
- ejb.module.list
- The comma-separated list of EJB modules to build. Leave the value of this property empty if no such modules need to build.
- Example
- WebSphereCommerceServerExtensionsData,TestEJB1
- ejb.src.dir
- The Java source directory of EJB modules.
- Default
- ejbModule
- ejb.bin.dir
- The Java binary directory of EJB modules.
- Default
- ejbModule
- java.module.list
- The comma-separated list of Java utility modules to build. Leave the value of this property empty if no such modules need to be built.
- Example
- WebSphereCommerceServerExtensionsLogic,TestJava1
- java.src.dir
- The Java source directory of Java utility modules.
- Default
- src
- java.bin.dir
- The Java binary directory of Java utility modules.
- Default
- bin
- web.module.list
- The comma-separated list of web modules to build. Leave the value of this property empty if no such modules need to build.
- Example
- SiteAdministration,Stores,TestWeb1
- web.src.dir
- The Java source directory of web modules.
- Default
- src
- web.resource.dir
The Java resource directory of web modules.
- web.bin.dir
- The Java binary directory of web modules.
- Default
- ${web.content.dir}/WEB-INF/classes
- web.content.dir
- The web content directory of web modules.
- Default
- WebContent
- data.module.name
- The name of the module that contains data assets.
- Default
- DataLoad
- static.web.module.name
- The name of the module that contains static web server assets.
- Default
- StaticWeb
- ext.compile.class.path
- The class path that contains more files required for compilation. Folders can contain loose Java classes (.class files). Java archives (.JAR files) must be listed individually. Files and folders must be delineated by a colon. Users must ensure that any class path entries that are also required in run time are available to the WebSphere Commerce enterprise application. In general, make such resources available as part of the WebSphere Commerce application, and included merely as external class path entries.
- wc.home
- The WebSphere Commerce or WebSphere Commerce Developer installation directory.
- was.home
- The WebSphere Application Server installation directory.
- db.type
- The name of the database vendor that the build processes uses to configure the compilation and ejbdeploy class paths. Set the value to be the corresponding value for the database vendor type.
- Default
- db2
- Valid values
- (DB2) db2
- (Oracle) oracle
- (IBM i) (DB2) os400
- ejbdeploy.dbvendor
- Optional: The name of the database vendor that the ejbdeploy utility uses to determine database column types, mapping information, DDL, and other information. Ensure that the value corresponds to the database backend ID that the EJB projects use in our customization. Otherwise, the ejbdeploy utility generates a top-down mapping that is based on the EJB metadata, which might not match the actual database schema. Whenever possible, use one of the following values that are supported by default. If we must use a non-default provided value, ensure that it is valid according to the ejbdeploy utility usage in either the WebSphere Application Server documentation or the command-line interface.
- Default
- DB2UDB_V95
- For other valid values, see WebSphere Application Server ejbdeploy command.
- ejbdeploy.codegen
- Whether the Java files generated by the ejbdeploy utility are kept.
- Default
- false
- Valid values
- true
- false
- ejbdeploy.keep.generated
- Whether the working directory is kept after the ejbdeploy utility completes.
- Default
- false
- Valid values
- true
- false
- ejbdeploy.quiet
- Whether all but error messages reported by ejbdeploy utility is suppressed. This property does not suppress validation messages, which are controlled by ${ejbdeploy.no.validate}.
- Default
- true
- Valid values
- true
- false
- ejbdeploy.no.validate
- Whether validation messages reported by the ejbdeploy utility is suppressed.
- Default
- true
- Valid values
- true
- false
- ejbdeploy.trace
- Whether internal tracing for the ejbdeploy utility is enabled.
- Default
- false
- Valid values
- true
- false
- ejbdeploy.jvm.max.memory
- The maximum memory size to be used by the ejbdeploy utility.
- Default
- 256M
- run.extract
- Whether source code extraction is done.
- Default
true
- Valid values
- true
- false
- extract.ant.file
- The Ant build file used to extract source code. Refer to the documentation for details on creating a custom extract Ant file with the template that is provided.
- extract.update.mode
- Whether source code extraction is done as an updating to the previously extracted source code, or as a full extraction after the previously extracted source code is deleted. In addition to setting this property to true, the following conditions must also be met to use this source code update mode:
- ${source.dir} must be set to a static path, for example, ${basedir}/source.
- Default
- false
- Valid values
- true
- false
- ear.dir.includes
- The comma-separated list of files in ${module.dir}/WC to be included in the deployment packages. Leave the value of this property empty to include all files.
- ear.dir.excludes
- The comma-separated list of files in ${module.dir}/WC to be excluded in the deployment packages. Leave the value of this property empty to not exclude any file.
- deploy.server.dir
- The directory that contains deployment scripts to be included in the server deployment package.
- Default
- ${basedir}/deploy/server
- deploy.toolkit.dir
- The directory that contains deployment scripts to be included in the toolkit deployment package.
- Default
- ${basedir}/deploy/toolkit
- run.package.server
- Whether a server deployment package is created.
- Default
- true
- Valid values
- true
- false
- run.package.toolkit
- Whether a toolkit deployment package is created.
- Default
- true
- Valid values
- true
- false
- run.dos2unix
- Whether to convert the newline characters that are contained in the files in the server deployment package from DOS format (CRLF) to UNIX format (CR). Set this property to true when server deployment is run on a UNIX system. Some UNIX shells cannot process the extraneous LF character that is part of the DOS format newline character, resulting in syntax errors.
- Default
- false
- Valid values
- true
- false
- dos2unix.includes
- The comma-separated list of files in ${working.package.dir}/server to be included for dos2unix conversion. Include all shell scripts. Do not include binary files, which can be corrupted when include.
- Default
- setenv,wcbd-ant,wcbd-encode-properties,wcbd-setenv.template
- dos2unix.excludes
- The comma-separated list of files in ${working.package.dir}/server to be excluded from dos2unix conversion. Leave the value of this property empty to not exclude any file.
- run.deploy.server
- Whether centralized server deployment runs.
- Default
- false
- Valid values
- true
- false
- deploy.server.workspace.dir
- The directory where server deployment packages are installed for centralized server deployment.
- Default
- ${basedir}/deploy-server-workspace
- deploy.server.target.env.list
- The comma-separated list of identifiers for target environments against which centralized server deployment is run.
- deploy.server.command
- The command that invokes the server deployment process. Unless customized, the command is typically wcbd-ant.bat for Windows, or wcbd-ant for all other platforms.
- Default
- wcbd-ant
- deploy.server.command.args
- The command-line arguments to pass into ${deploy.server.command}. By default, the -Dtarget.env=target-env argument is automatically passed in based on the values in ${deploy.server.target.env.list}, so it is not included in this property.
- Default
- -buildfile wcbd-deploy.xml
- run.clean.working.dir
- Whether the working directory is cleaned at the end of the build process.
- Default
- false
- Valid values
- true
- false
- run.mail.success
- Whether build success notifications are sent.
- Default
- false
- Valid values
- true
- false
- run.mail.failure
- Whether build failure notifications are sent.
- Default
- false
- Valid values
- true
- false
- mail.from
- The sender email address of build status notifications.
- mail.success.tolist
- The comma-separated list of email addresses that receive build success notifications.
- mail.failure.tolist
- The comma-separated list of email addresses that receive build failure notifications.
- mail.mailhost
- The host name of the SMTP server.
- mail.mailport
- The TCP port of the SMTP server.
- Default
- 25
- mail.ssl
- Whether the SMTP server uses TLS/SSL for encryption.
- Default
- false
- Valid values
- true
- false
- mail.success.subject
- The subject of build success notifications.
- Default
- WCBD Build Successful: ${build.label}
- mail.failure.subject
- The subject of build failure notifications.
- Default
- WCBD Build FAILED: ${build.label}
- mail.success.message
The message body of build success notifications.
- mail.failure.message
- The message body of build failure notifications.
- Default
- Check attached logs for details.
Related reference
Security-sensitive build configuration properties
Package structure of customized code